Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9aa1bd821e | ||
|
|
a967d6ffd9 | ||
|
|
a2ce95441a | ||
|
|
e74e49538e | ||
|
|
11c66d7030 | ||
|
|
56bd4c000e | ||
|
|
a7cc4e2d7e | ||
|
|
f306445e0d | ||
|
|
9f4de49495 | ||
|
|
54c25a70ed | ||
|
|
6befa3cca3 | ||
|
|
0463ae8222 | ||
|
|
b36675dc23 | ||
|
|
2515464977 | ||
|
|
1cf4da3a0d | ||
|
|
ed46b34376 | ||
|
|
49a5b9cef5 | ||
|
|
faa9df1306 | ||
|
|
5c1a887b07 | ||
|
|
cc0a286471 | ||
|
|
690f56945a | ||
|
|
a764e419e7 | ||
|
|
272bc7a543 | ||
|
|
35f5355c8e | ||
|
|
57493f57cf | ||
|
|
7f446b810c | ||
|
|
9b1a8f6068 | ||
|
|
94350873a9 | ||
|
|
1e6f59eb79 | ||
|
|
a64b859e46 | ||
|
|
689376adfe | ||
|
|
52d46b58d8 | ||
|
|
157eff3a61 | ||
|
|
5ed6fec6e9 | ||
|
|
e3c53860f7 | ||
|
|
ce48f072cb | ||
|
|
d067937138 | ||
|
|
60ff7e41bf | ||
|
|
9f67d41786 | ||
|
|
adacda7ee5 | ||
|
|
356c563e95 | ||
|
|
d3e134ce73 | ||
|
|
df0a0e2daa | ||
|
|
c9080dae4e | ||
|
|
08b68e224d | ||
|
|
2e09686675 | ||
|
|
5186dcb967 | ||
|
|
24b839227a | ||
|
|
12e45a7f38 | ||
|
|
d5c2f726f9 | ||
|
|
1e4d729eb7 | ||
|
|
64371b7d65 | ||
|
|
e116bb1deb | ||
|
|
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 |
@@ -1,3 +1,15 @@
|
||||
DROPBOX_APP_KEY=
|
||||
ONEDRIVE_CLIENT_ID=
|
||||
ONEDRIVE_AUTHORITY=https://
|
||||
REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683
|
||||
REMOTELYSAVE_CLIENT_ID=cli-xxx
|
||||
GOOGLEDRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
|
||||
GOOGLEDRIVE_CLIENT_SECRET=GOCSPX-sss
|
||||
BOX_CLIENT_ID=
|
||||
BOX_CLIENT_SECRET=
|
||||
PCLOUD_CLIENT_ID=
|
||||
PCLOUD_CLIENT_SECRET=
|
||||
YANDEXDISK_CLIENT_ID=
|
||||
YANDEXDISK_CLIENT_SECRET=
|
||||
KOOFR_CLIENT_ID=
|
||||
KOOFR_CLIENT_SECRET=
|
||||
|
||||
@@ -19,6 +19,18 @@ jobs:
|
||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
|
||||
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
|
||||
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
|
||||
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
|
||||
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
|
||||
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
|
||||
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
|
||||
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
|
||||
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -29,10 +41,18 @@ jobs:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
lfs: true
|
||||
submodules: recursive
|
||||
- name: Checkout LFS
|
||||
run: git lfs checkout
|
||||
- name: Checkout LFS file list
|
||||
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 }}
|
||||
uses: actions/setup-node@v2
|
||||
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,18 @@ jobs:
|
||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
|
||||
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
|
||||
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
|
||||
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
|
||||
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
|
||||
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
|
||||
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
|
||||
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
|
||||
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -32,10 +44,18 @@ jobs:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
lfs: true
|
||||
submodules: recursive
|
||||
- name: Checkout LFS
|
||||
run: git lfs checkout
|
||||
- name: Checkout LFS file list
|
||||
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 }}
|
||||
uses: actions/setup-node@v2
|
||||
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
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
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 .
|
||||
|
||||
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.
|
||||
|
||||
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/ .
|
||||
|
||||
@@ -19,17 +19,25 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
||||
- Supports:
|
||||
- Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
|
||||
- Dropbox
|
||||
- OneDrive for personal
|
||||
- Webdav
|
||||
- OneDrive for personal (App Folder)
|
||||
- OneDrive for personal (Full) (PRO feature)
|
||||
- Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
|
||||
- Webdis
|
||||
- Google Drive (GDrive) (PRO feature)
|
||||
- Box (PRO feature)
|
||||
- pCloud (PRO feature)
|
||||
- Yandex Disk (PRO feature)
|
||||
- Koofr (PRO feature)
|
||||
- Azure Blob Storage (PRO feature)
|
||||
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
|
||||
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
||||
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
|
||||
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
||||
- **Skip Large files** and **skip paths** by custom regex conditions!
|
||||
- **Fully open source under [Apache-2.0 License](./LICENSE).**
|
||||
- **[Sync Algorithm open](./docs/sync_algorithm/v3/intro.md) for discussion.**
|
||||
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** now, more to come!
|
||||
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
|
||||
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Smart Conflict Handling](./pro/README.md)** for PRO version.
|
||||
- Source Available. See [License](./LICENSE) for details.
|
||||
|
||||
## Limitations
|
||||
|
||||
@@ -67,11 +75,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- [腾讯云 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)
|
||||
- [又拍云](./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. The bucket should be empty and solely for syncing a vault.
|
||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name.
|
||||
- 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).
|
||||
- Download and enable 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.
|
||||
- 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.
|
||||
@@ -85,11 +94,11 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- 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 (App Folder)
|
||||
|
||||
- **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
|
||||
- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
|
||||
- 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. **The free version of Remotely Save only connects to App Folder, while the PRO version can connect to the root folder in Onedrive. See below PRO part.**
|
||||
- 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.
|
||||
@@ -98,11 +107,16 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
### webdav
|
||||
|
||||
- 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)
|
||||
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/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)
|
||||
- [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
|
||||
- [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
|
||||
- [Apache (with Docker)](./docs/remote_services/webdav_apache/README.md)
|
||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
|
||||
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
@@ -115,18 +129,63 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- Mostly experimental.
|
||||
- You have to setup and protect your web server by yourself.
|
||||
|
||||
### Onedrive (Full access) (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Onedrive (Full)" allows users to to sync with Onedrive root folder. Tutorials and limitations are documented [here](./docs/remote_services/onedrivefull/README.md).
|
||||
|
||||
### Google Drive (GDrive) (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md).
|
||||
|
||||
### Box (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](./docs/remote_services/box/README.md).
|
||||
|
||||
### pCloud (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/pcloud/README.md).
|
||||
|
||||
### Yandex Disk (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
|
||||
|
||||
### Koofr (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
|
||||
|
||||
### Azure Blob Storage (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Azure Blob Storage" allows users to to sync with Azure Blob Storage. Tutorials and limitations are documented [here](./docs/remote_services/azureblobstorage/README.md).
|
||||
|
||||
## Smart Conflict (PRO feature)
|
||||
|
||||
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||
|
||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||
|
||||
See documents [here](./docs/pro/README.md)
|
||||
|
||||
## Scheduled Auto Sync
|
||||
|
||||
- You can configure auto syncing every N minutes in settings.
|
||||
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
||||
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
||||
|
||||
## Sync On Save
|
||||
|
||||
- You can configure sync on save in settings.
|
||||
- In sync on save mode, if any error occurs, the plugin would **fail silently**.
|
||||
|
||||
## How To Deal With Hidden Files Or Folders
|
||||
|
||||
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
|
||||
|
||||
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](./docs/pro/README.md) for more details.
|
||||
|
||||
## How To Debug
|
||||
|
||||
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,53 @@
|
||||
# PRO Features
|
||||
|
||||
From version 0.5.x, Remotely Save introduces PRO (paid) features. Users need to subscribe to (pay) them to use them.
|
||||
|
||||
**If you are using basic features only, you don't need an online account, and you don't need to pay for the plugin.**
|
||||
|
||||
# Links
|
||||
|
||||
* Remotely Save official website: <https://remotelysave.com>
|
||||
* Sign up / Sign in: <https://remotelysave.com/user/signupin>
|
||||
* User profile: <https://remotelysave.com/user/profile>
|
||||
|
||||
# Disclaimer
|
||||
|
||||
It's different from, and NOT affiliated with Obsidian account.
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of signing up and signing in
|
||||
|
||||
1. Go to the website, sign up and sign in. You can directly visit <https://remotelysave.com/user/signupin> or click the link in Remotely Save plugin setting page.
|
||||

|
||||
2. Use an email and your password as usual. Don't need to be GMail account.
|
||||
|
||||
## Steps of connecting
|
||||
|
||||
You need to connect your plugin to your online account. In Obsidian, in your Remotely Save plugin setting, you can click the button "Connect" to start the flow.
|
||||
|
||||
1. You will see a special address on website. Click it and visit the website
|
||||
2. Click "allow" on the website.
|
||||
3. In the end of the auth flow on the website, you will be shown up a code, please copy it...
|
||||
4. And paste the code back to the plugin modal inside Obsidian, and confirm.
|
||||
|
||||

|
||||
|
||||
## Steps of subscribing to some features.
|
||||
|
||||
1. Firstly please visit your [profile page](https://remotelysave.com/user/profile) online.
|
||||
2. You can subscribe to some features. Prices vary.
|
||||

|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled.
|
||||

|
||||
4. Sync and enjoy your PRO features!
|
||||
|
||||
## Why so complicated?
|
||||
|
||||
Because we don't have a payment method inside the plugin, so we have to:
|
||||
|
||||
* build a website,
|
||||
* require users having online accounts
|
||||
* and connect the plugin to the online account.
|
||||
|
||||
Moreover, an online account allows flexible management of subscriptions.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:8c73da29a621d225387640b76ec0dcfb56b3ffad151dab374d3b7cc76067a1a0
|
||||
size 94377
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:116c2a8ec1a277a3985f4056b390574fc57145ec5635d44accf2a7445666264a
|
||||
size 626668
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4c45c08e6fc487341032aac511c332e3f9978a44e9b93377a73648b56b684b62
|
||||
size 155427
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:08d128125dba033f5dd18a6ea8d942b284ddca6c5c3b0362c47dcb4a7153a8f9
|
||||
size 395800
|
||||
@@ -0,0 +1,107 @@
|
||||
# Azure Blob Storage (GDrive) (PRO)
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Microsoft / Azure product, and just uses Azure Blob Storage's public api.**
|
||||
|
||||
# Disclaimer
|
||||
|
||||
I (author of Remotely Save) is **NOT** an expert of Azure products. The tutorials here are for references only. Azure products are very complex.
|
||||
|
||||
***As far as the law allows, the software (Remotely Save) 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.***
|
||||
|
||||
# Steps
|
||||
|
||||
Please read through the following steps before you actually connect.
|
||||
|
||||
## Preparation In Azure Blob Storage Side
|
||||
|
||||
You only need to do this **once**, before the Container SAS Url expires in the future.
|
||||
|
||||
In short, you need to: configure CORS and configure a policy and cobtain a Container SAS Url.
|
||||
|
||||
1. Connect to the service:
|
||||
|
||||
Download Microsoft's free [Azure Storage Explorer](https://azure.microsoft.com/en-us/products/storage/storage-explorer). The following tutorial uses this app. Actually you may be able to find the same settings on Azure official website.
|
||||
|
||||
Use this app to connect to your Blob Storage service or account.
|
||||
|
||||
2. CORS:
|
||||
|
||||
Right click on `Blob containers`, click "configure CORS". Add a rule, enter the following and save:
|
||||
```
|
||||
Allowed Origins: *
|
||||
Allowed Methods: DELETE,GET,HEAD,MERGE,POST,PATCH,OPTIONS,PUT
|
||||
Allowed Headers: x-ms-*, content-type
|
||||
Exposed Headers: x-ms-*, content-type
|
||||
Max Age (in seconds): 5
|
||||
```
|
||||
|
||||

|
||||
|
||||
3. Create the container:
|
||||
|
||||
Create the container if you don't have one. In this tutorial, we use `example-container`.
|
||||
|
||||

|
||||
|
||||
4. Generate a policy:
|
||||
|
||||
* Right click on you container, click "Manage Stored Access Policies".
|
||||
* Choose your id, for example `example-container-0000001`.
|
||||
* Change to Expiry time to an appropriate date. **By default it is only valid for a week.** After its expiration, you need come back and adjust the expiry date again! In this tutorial, we set it to a year.
|
||||
* And allow these methods: Read, Add, Create, Write, Delete, List.
|
||||
* Save
|
||||
|
||||
Read Microsoft's official [doc](https://learn.microsoft.com/en-us/rest/api/storageservices/define-stored-access-policy) for more info. The main benefit of generating an access policy is easier revocation of SAS Url if anything goes bad.
|
||||
|
||||

|
||||

|
||||
|
||||
5. Generate a Container SAS Url:
|
||||
|
||||
Then we want to create a container level SAS (shared access signature) url.
|
||||
|
||||
* Right click on you container, click "Get Shared Access Signature".
|
||||
* In access policy, choose the previous one you created: for example `example-container-0000001`.
|
||||
* Save the setting
|
||||
* You will see a url is generated, which starts with `https://` or `http://`. It should looks like `https://<account>.blob.core.windows.net/<container name>?sv=...&sig=...`
|
||||
* Save the Container SAS Url somewhere, and you will need this later.
|
||||
|
||||
Read Microsoft's official [doc](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for more info.
|
||||
|
||||

|
||||

|
||||
|
||||
### Why so complicated in Azure settings?
|
||||
|
||||
Because Azure Blob Storage's api has some limitation in browser environment, so we need to configure CORS and SAS. Because we want to revoke the SAS when needed, we need to use a policy.
|
||||
|
||||
### Revocation
|
||||
|
||||
If you suspect someone read the resource unexpectedly, you can revoke the SAS by changing the name or expiry date of the policy. And generate the SAS Url again.
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Azure Blob Storage" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Azure Blob Storage should be detected.
|
||||
|
||||
## Steps of Connecting to your Azure Blob Storage
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, **and prepared the Container SAS Url**, you can connect to your Azure Blob Storage account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Azure Blob Storage.
|
||||
2. Input your Container SAS Url
|
||||
3. Input your container name.
|
||||
4. By default, the plugin will save your vault remotely with a prefix `<your vault name>/`. You can change the prefix. No prefix is not allowed.
|
||||
5. Check the connection. A notice will tell you that you've connected or not.
|
||||
7. Sync! The plugin will upload the fils and "folders" of your vault into your Azure Blob Storage with the preix.
|
||||
8. **Read the caveats below.**
|
||||
|
||||

|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in alpha stage. **Back up your vault before using this feature.**
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:83caba9a42772f995035e3c879c6119eabcd6d3c27298cf0fb067b3676680571
|
||||
size 107057
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ef2d525d3ac7ecca26f7f8b6782fb1056d54f8c558a8d77586571defb7e6b5be
|
||||
size 41282
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:cba5bf27e76eaf8ea21e51e43172501fc4867539c90c1758a02945477dc261ea
|
||||
size 132487
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:0b2add8a559eab0b7073f7ed52d4a3e4efae68b499c7b924d1ac50278758961b
|
||||
size 193894
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:582a69a7aee2cfab72dc14324e4a864acab92c145d533e799f8ceea61a8f0102
|
||||
size 478941
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:cbb8863d98d8826739b5bf9fa4c7a2de3ba49fde4bbe3c4988a877ba74f89abd
|
||||
size 143007
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ddc30f97d75d7c3a6061cbb30cc991cbdf1f4039aad3547ef88998c3dd9be666
|
||||
size 132904
|
||||
@@ -0,0 +1,34 @@
|
||||
# Box (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://www.box.com/>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Box product, and just uses Box's public api.**
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Box" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Box should be detected.
|
||||
|
||||
## Steps of Connecting to your Box
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Box account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Box.
|
||||
2. Click Auth, visit the link, go to Box website to start.
|
||||
3. Follow the instruction on Box, and allow Remotely Save to connect.
|
||||
4. You will be redirected back to Remotely Save plugin.
|
||||
5. A notice will tell you that you've connected or not.
|
||||
6. Sync! The plugin will create a vault folder in the root of your Box and upload notes into that folder.
|
||||
7. **Read the caveats below.**
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
|
||||
@@ -0,0 +1,59 @@
|
||||
# Google Drive (GDrive) (PRO)
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Google product, and just uses Google Drive's public api.**
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Google Drive" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Google Drive should be detected.
|
||||
|
||||
## Steps of Connecting to your Google Drive
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Google Drive account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Google Drive.
|
||||

|
||||
2. Click Auth, visit the link, go to Remotely Save website to start.
|
||||

|
||||
3. On the website, click the link to go to Google Drive auth page.
|
||||
4. Follow the instruction on Google website, and allow (continue) Remotely Save to connect.
|
||||

|
||||
5. You will be redirected to Remotely Save website, and you will get a code. Copy it...
|
||||

|
||||
6. ... And paste the code back to the plugin inside Obsidian. Click submit.
|
||||

|
||||
7. A notice will tell you that you've connected or not.
|
||||
8. Sync! The plugin will create a vault folder in the root of your Google Drive and upload notes into that folder.
|
||||
9. **Read the caveats below.**
|
||||
|
||||
# Why so complicated?
|
||||
|
||||
Because Google Drive's api doesn't fit into the special envorinment of Obsidian plugin. So we need a website.
|
||||
|
||||
# The credential
|
||||
|
||||
The website does **NOT** store or save the Google drive credential (the code you obtian in the end of the flow). The website is just a "bridge" to help you obtain that code, and just manage your subscription to PRO features.
|
||||
|
||||
But please be aware that the code is saved locally in your Obsidian. It works like a special password. So that the plugin can upload or download or modify the files for you.
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
|
||||
|
||||
* The plugin can **only** sees, reads or writes the files and folders created by itself!
|
||||
|
||||
It means that, you CANNOT manually create the vault folder in your Google Drive account. And if you manually upload any files using Google's official website, the plugin does **NOT** see them. All operations must go through Obsidian and uploaded by the plugin.
|
||||
|
||||
You can, however, view, and download the files on Google Drive [official web page](https://drive.google.com/drive/u/0/my-drive).
|
||||
|
||||
Precisely speaking, the plugin applies for the `drive.file` scope recommended by Google. See [the doc](https://developers.google.com/drive/api/guides/api-specific-auth#benefits) by Google for the scope's benefits. Basically the plugin will never (is unable to) mess up your other files or folders.
|
||||
|
||||
Moreover, this scope is "not-sensitive", so that the plugin doesn't need to go through Google's complicated verification process while applying for it.
|
||||
|
||||
* Google Drive, unlike other cloud storage, allows files of same name co-existing in the same folder! (hmmmmm...) It may or may not make the plugin stop working. Users might need to remove the duplicated file manually on Google's official website.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:eaa9aa8ba6b066dfefdce08a8d1da1d97089f5c2de0ba4c0c026d6df9eb9ece8
|
||||
size 99896
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6683a63718053603ae7dde44063a3807ba0def7e935da0b40fcc8e181afd24ae
|
||||
size 342848
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:310bd4c7d5fe19521ec7184b2eee749f0eecf00397f2b8e68480c23b4fd7c943
|
||||
size 153504
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:dcebb1f73829670883071447a8eee46c972b26fe8735c7422949cb6fe927b8ab
|
||||
size 179369
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7e5a85c28f5614e4de75eacc021c2876d36596bcb77f0744a6edcff7777b9530
|
||||
size 155004
|
||||
@@ -0,0 +1,38 @@
|
||||
# Koofr (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://koofr.eu/>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Koofr product, and just uses Koofr's public api.**
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Koofr" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Koofr should be detected.
|
||||
|
||||
## Steps of Connecting to your Koofr
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Koofr account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Koofr.
|
||||
2. Click Auth, visit the link, go to Koofr website to start.
|
||||
3. Follow the instruction on Koofr, and allow Remotely Save to connect.
|
||||
4. You will be redirected back to Remotely Save plugin.
|
||||
5. A notice will tell you that you've connected or not.
|
||||
6. Sync! The plugin will create a vault folder in the root of your Koofr and upload notes into that folder.
|
||||
7. **Read the caveats below.**
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
|
||||
|
||||
# Why not use webdav?
|
||||
|
||||
The Remotely Save PRO feture "sync with Koofr" is developed using Koofr's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
|
||||
@@ -1,7 +1,7 @@
|
||||
# OneDrive
|
||||
# OneDrive (App Folder)
|
||||
|
||||
- **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.
|
||||
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.**The free version of Remotely Save only connects to App Folder, while the PRO version can connect to the root folder in Onedrive.**
|
||||
- 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.
|
||||
@@ -21,3 +21,11 @@ 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!
|
||||
|
||||
### Empty file is not uploaded
|
||||
|
||||
Onedrive's API does not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings.
|
||||
|
||||
### How to connect to root folder rather than the App Folder?
|
||||
|
||||
As of June 2024, this is a new PRO feature. See the [doc](../onedrivefull/README.md).
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
# Onedrive (Full) (PRO)
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Microsoft / Onedrive product, and just uses Onedrive's public api.**
|
||||
* This still only applies to Onedrive for personal. The dev team doesn't have Onedrive for business account to develop and test on it.
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Onedrive (Full)" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Onedrive (Full) should be detected.
|
||||
|
||||
## Steps of Connecting to your Onedrive
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Onedrive account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Onedrive (Full).
|
||||
2. Click Auth, visit the link, go to Onedrive website to start.
|
||||
3. Follow the instruction on Onedrive, and allow Remotely Save to connect.
|
||||
4. You will be redirected back to Remotely Save plugin.
|
||||
5. A notice will tell you that you've connected or not.
|
||||
6. Sync! The plugin will create a vault folder **in the root** of your Onedrive and upload notes into that folder.
|
||||
7. **Read the caveats below.**
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage.
|
||||
* **Back up your vault before using this feature.**
|
||||
* **Back up everything in your Onedrive (besides the sync sub folder) before using this feature!**
|
||||
* Onedrive's API does not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings.
|
||||
|
||||
# What's the difference of Onedrive (App Folder) and Onedrive (Full)?
|
||||
|
||||
Due to history reasons, Remotely Save only supported uploading to App Folder back to year 2021. Because that greatly ensured the security and ensure not messing up with others files.
|
||||
|
||||
However, repeatedly some users want to sync to arbitrary root folder rather than `/Apps/remotely-save/` folder. Thus as of June 2024, the new PRO feature is finally developed.
|
||||
|
||||
As of June 2024, connecting to Onedrive (App Folder) is free, but connecting to Onedrive (Full) is a PRO feature.
|
||||
@@ -0,0 +1,40 @@
|
||||
# pCloud (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://www.pcloud.com/>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official pCloud product, and just uses pCloud's public api.**
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with pCloud" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with pCloud should be detected.
|
||||
|
||||
## Steps of Connecting to your pCloud
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your pCloud account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to pCloud.
|
||||
2. Click Auth, visit the link, go to pCloud website to start.
|
||||
3. Follow the instruction on pCloud, and allow Remotely Save to connect.
|
||||
4. You will be redirected back to Remotely Save plugin.
|
||||
5. A notice will tell you that you've connected or not.
|
||||
6. Sync! The plugin will create a vault folder in the root of your pCloud and upload notes into that folder.
|
||||
7. **Read the caveats below.**
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
|
||||
* pCloud's API seems to not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings.
|
||||
|
||||
# Why not use webdav?
|
||||
|
||||
1. pCloud only provides webdav for Premium. If you are a Premium user, you can still use pCloud webdav with Remotely Save.
|
||||
2. The Remotely Save PRO feture "sync with pCloud" is developed using pCloud's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
|
||||
@@ -0,0 +1,62 @@
|
||||
# Apache Webdav
|
||||
|
||||
The following tutorial uses Apache with Docker in Linux, using the image [`bytemark/webdav`](https://hub.docker.com/r/bytemark/webdav/).
|
||||
|
||||
You can also checkout the official doc from Bytemark [here](https://docs.bytemark.co.uk/article/run-your-own-webdav-server-with-docker/). The tutorial you are reading here is a little different from Bytemark's article.
|
||||
|
||||
Assuming you want a webdav server on Linux satisfying that:
|
||||
|
||||
1. Data is saved in your host machine's `./dav1` folder,
|
||||
2. WebDAV is accessed by a user `user1` with password `password1`,
|
||||
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
|
||||
4. Use Basic auth type.
|
||||
|
||||
Install docker nd set its permission properly. Then run this in terminal:
|
||||
|
||||
```bash
|
||||
mkdir ./dav1 # create the local folder
|
||||
|
||||
docker container run --rm \
|
||||
-p 127.0.0.1:8080:80 \
|
||||
-v ./dav1:/var/lib/dav \
|
||||
-e USERNAME=user1 \
|
||||
-e PASSWORD=password1 \
|
||||
-e AUTH_TYPE=Basic \
|
||||
bytemark/webdav
|
||||
```
|
||||
|
||||
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
|
||||
|
||||
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
|
||||
|
||||
```
|
||||
Server: http://127.0.0.1:8080
|
||||
User: user1
|
||||
Password: password1
|
||||
Auth Type: Basic
|
||||
Depth Header Sent To Servers: only supports depth='1'
|
||||
```
|
||||
|
||||

|
||||
|
||||
Then the server should be connected! You can sync now!
|
||||
|
||||
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
|
||||
|
||||
```
|
||||
ls ./dav1/
|
||||
## data DavLock DavLock.dir DavLock.pag
|
||||
|
||||
ls ./dav1/data/
|
||||
## <your vault name or your base dir>
|
||||
```
|
||||
|
||||
# Auth type
|
||||
|
||||
You can change the auth type while calling Docker, between `Basic` and `Digest`. And please rememberto adjust the Remotely Save's settings. Both works.
|
||||
|
||||
# Notice
|
||||
|
||||
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
|
||||
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
|
||||
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:264e50d3adaeb4fc4e76b00273459d7d021f1b44af7f07b00a5c40741e65194d
|
||||
size 658482
|
||||
@@ -0,0 +1,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,51 @@
|
||||
# Nginx Webdav
|
||||
|
||||
The following tutorial uses Nginx with Docker in Linux, using the image [docker-nginx-webdav-nononsense](https://github.com/dgraziotin/docker-nginx-webdav-nononsense). It contains `ngx_http_dav_module` and `nginx-dav-ext-module`.
|
||||
|
||||
The description is adapted from the pull request [`dgraziotin/docker-nginx-webdav-nononsense#123`](https://github.com/dgraziotin/docker-nginx-webdav-nononsense/pull/123) by Remotely Save author.
|
||||
|
||||
Assuming you want a webdav server on Linux satisfying that:
|
||||
|
||||
1. Data is saved in your host machine's `./dav1` folder,
|
||||
2. WebDAV is accessed by a user `user1` with password `password1`,
|
||||
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
|
||||
4. (Only Basic auth type is supported.)
|
||||
|
||||
Install docker nd set its permission properly. Then run this in terminal:
|
||||
|
||||
```bash
|
||||
mkdir ./dav1 # create the local folder
|
||||
|
||||
docker container run --rm \
|
||||
-p 127.0.0.1:8080:80 \
|
||||
-v ./dav1:/data \
|
||||
-e WEBDAV_USERNAME=user1 \
|
||||
-e WEBDAV_PASSWORD=password1 \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
dgraziotin/nginx-webdav-nononsense
|
||||
```
|
||||
|
||||
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
|
||||
|
||||
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
|
||||
|
||||
```
|
||||
Server: http://127.0.0.1:8080
|
||||
User: user1
|
||||
Password: password1
|
||||
Auth Type: Basic
|
||||
Depth Header Sent To Servers: only supports depth='1'
|
||||
```
|
||||
|
||||

|
||||
|
||||
Then the server should be connected! You can sync now!
|
||||
|
||||
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
|
||||
|
||||
# Notice
|
||||
|
||||
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
|
||||
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
|
||||
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:92059e0819d25640a02d2494ba9da0bfa7a69003cdba36ced985bed9e29b0354
|
||||
size 254978
|
||||
@@ -0,0 +1,21 @@
|
||||
# Open Media Vault WebDAV
|
||||
|
||||
## Link
|
||||
https://www.openmediavault.org
|
||||
|
||||
## Steps
|
||||
|
||||
1. In Open Media Vault's UI, install the WebDAV plugin:
|
||||
* System → Plugins → openmediavault-webdav
|
||||
2. Create a new Shared Folder
|
||||
* Storage → Shared Folders → Create
|
||||
3. Enable WebDAV server
|
||||
* Services → WedDAV → Enable → Select previously created Shared Folder
|
||||
4. Make sure Group is "webdav-users"
|
||||
5. Add {your username} to "webdav-users" group
|
||||
* Users → Groups → webdav-users → Edit → Members
|
||||
6. Set folder permissions
|
||||
* Storage → Shared Folders select the corresponding shared folder → Permissions → Set both {your username} and "webdav-users" group to "Read/Write" permissions
|
||||
7. Back to Shared Folders, set specific Access Control List permissions
|
||||
* Select the shared folder → Access Control List → set {your username}, "webdav-users" and "www-data" to "Read/Write" permissions
|
||||
8. Install Remotely Save in Obsidian, select WebDAV, add the URL http://[your-server-ip]/webdav, use your user credentials and connect.
|
||||
@@ -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,44 @@
|
||||
# Yandex Disk (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://disk.yandex.com/client/disk>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Yandex Disk or Yandex product, and just uses Yandex Disk's public api.**
|
||||
|
||||
# Steps
|
||||
|
||||
## Steps of Remotely Save subscription
|
||||
|
||||
1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
|
||||
2. Subscribe to "sync with Yandex Disk" feature online.
|
||||
3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Yandex Disk should be detected.
|
||||
|
||||
## Steps of Connecting to your Yandex Disk
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Yandex Disk account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Yandex Disk.
|
||||
2. Click Auth, visit the link, go to Yandex Disk website to start.
|
||||
3. Follow the instruction on Yandex Disk, and allow Remotely Save to connect.
|
||||
4. You will be redirected back to Remotely Save plugin.
|
||||
5. A notice will tell you that you've connected or not.
|
||||
6. Sync! The plugin will create a vault folder in the root of your Yandex Disk and upload notes into that folder.
|
||||
7. **Read the caveats below.**
|
||||
|
||||
# The caveats
|
||||
|
||||
* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
|
||||
|
||||
# Why not use webdav?
|
||||
|
||||
1. The Remotely Save PRO feture "sync with Yandex Disk" is developed using Yandex Disk's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
|
||||
2. Some users prefer oauth2 method to authorize themselves.
|
||||
|
||||
# Bonus: where to register the app
|
||||
|
||||
* <https://oauth.yandex.com/client/new/> or <https://oauth.yandex.ru/client/new/>
|
||||
* redirect uri can be set to <https://oauth.yandex.com/verification_code> or <https://oauth.yandex.ru/verification_code>.
|
||||
@@ -6,37 +6,42 @@ The plugin works under the browser environment in Obsidian, so CORS is an issue.
|
||||
|
||||
The list is for information purposes only.
|
||||
|
||||
| Service | Connectable | by S3 | by WebDAV | by other protocol | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian |
|
||||
| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
|
||||
| Amazon S3 | Yes | Yes | | | Yes | [CORS config needed.](./s3_cors_configure.md) |
|
||||
| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
|
||||
| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | Yes | CORS config needed. |
|
||||
| Backblaze B2 Cloud Storage | Yes | Yes | | | Yes | Its CORS rules doesn't allow no-http(s) origins. |
|
||||
| [Wasabi](https://wasabi.com) | ? | ? | | | | |
|
||||
| [filebase](https://filebase.com/) | Yes | Yes | | | Yes | CORS config needed. |
|
||||
| QingStor 青云 | ? | ? | | | | |
|
||||
| [MinIO](https://min.io/) | ? | ? | | | | |
|
||||
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. |
|
||||
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? |
|
||||
| NextCloud | Yes | | Yes | | Yes? | No CORS config by default. |
|
||||
| OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. |
|
||||
| Seafile | Yes | | Yes | | Yes? | No CORS config by default. |
|
||||
| `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. |
|
||||
| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes | | Yes | | Yes | No CORS support. |
|
||||
| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. |
|
||||
| Dropbox | Yes | | | Yes | | |
|
||||
| OneDrive for personal | Yes | | | Yes | | |
|
||||
| OneDrive for Business | Yes | | | ? | | |
|
||||
| Google Drive | In the plan | | | ? | | |
|
||||
| [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | |
|
||||
| Google Cloud Storage | ? | | | May be possible but needs further development. | | |
|
||||
| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | | |
|
||||
| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | | |
|
||||
| https://put.io/ | ? | | | ? | | |
|
||||
| Yandex Disk | ? | | | ? | | |
|
||||
| FTP / FTPS | Never | | | Technically never possible to be implemented. | | |
|
||||
| SFTP | Never | | | Technically never possible to be implemented. | | |
|
||||
| Jottacloud | No | | | No. It seems that no open api is available. | | |
|
||||
| Mega | Never | | | No. No js api is available. | | |
|
||||
| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | | |
|
||||
| | | | | | | |
|
||||
|
||||
| Service | Connectable | by S3 | by WebDAV | by other protocol |
|
||||
| ------ | ------ | ------ | ------ | ------ |
|
||||
| Amazon S3 | Yes | Yes | | |
|
||||
| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | |
|
||||
| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | |
|
||||
| Backblaze B2 Cloud Storage | Yes | Yes | | |
|
||||
| [Wasabi](https://wasabi.com) | ? | ? | | |
|
||||
| [filebase](https://filebase.com/) | Yes | Yes | | |
|
||||
| QingStor 青云 | ? | ? | | |
|
||||
| [MinIO](https://min.io/) | Yes | Yes | | |
|
||||
| Azure Blob Storage | Yes (PRO) | | | Yes (PRO) |
|
||||
| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | |
|
||||
| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes | | Yes | |
|
||||
| NextCloud | Yes | | Yes | |
|
||||
| OwnCloud | Yes? | | Yes? | |
|
||||
| Seafile | Yes | | Yes | |
|
||||
| `rclone serve webdav` | Yes | | Yes | |
|
||||
| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes (partially) | | Yes (partially) | |
|
||||
| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | |
|
||||
| Seafile | ? | | ? | ? |
|
||||
| Dropbox | Yes | | | Yes |
|
||||
| OneDrive for personal | Yes | | | Yes |
|
||||
| OneDrive for Business | Yes | | | ? |
|
||||
| Google Drive | Yes (with limitations) (PRO) | | | Yes (with limitations) (PRO) |
|
||||
| [Box](https://www.box.com/) | Yes (PRO) | | | Yes (PRO) |
|
||||
| [pCloud](https://www.pcloud.com/) | Yes (PRO) | | Yes | Yes (PRO) |
|
||||
| Google Cloud Storage | ? | | | May be possible but needs further development. |
|
||||
| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. |
|
||||
| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. |
|
||||
| <https://put.io/> | ? | | | ? |
|
||||
| Yandex Disk | Yes (PRO) | | Yes | Yes (PRO) |
|
||||
| FTP / FTPS | Never | | | Technically never possible to be implemented. |
|
||||
| SFTP | Never | | | Technically never possible to be implemented. |
|
||||
| Jottacloud | No | | | No. It seems that no open api is available. |
|
||||
| Mega | Never | | | No. No js api is available. |
|
||||
| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. |
|
||||
| [Koofr](https://koofr.eu/) | ? | | ? | ? |
|
||||
| [Blomp](https://www.blomp.com/) | ? | | | May be possible but needs further development. |
|
||||
|
||||
@@ -52,7 +52,7 @@ Bidirectional:
|
||||
| local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | (11/12/13/14/15) conflict |
|
||||
|
||||
Incremental push only:
|
||||
Incremental push:
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
|
||||
@@ -61,7 +61,7 @@ Incremental push only:
|
||||
| local deleted | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
|
||||
|
||||
Incremental pull only:
|
||||
Incremental pull:
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
|
||||
@@ -69,3 +69,21 @@ Incremental pull only:
|
||||
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
|
||||
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
|
||||
|
||||
Incremental push and delete (diff decisionBranch: 38):
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
|
||||
| local unchanged | (02/21) do nothing | **(26) conflict push** | **(32) conflict push** | (??) conflict |
|
||||
| local modified | (10) push | **(25) conflict push** | (08) push | (??) conflict |
|
||||
| local deleted | **(38) delete remote** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
|
||||
|
||||
Incremental pull and delete (diff decisionBranch: 39):
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
|
||||
| local unchanged | (02/21) do nothing | (09) pull | **(39) delete local** | (??) conflict |
|
||||
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
|
||||
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
|
||||
|
||||
+39
-5
@@ -1,7 +1,7 @@
|
||||
import dotenv from "dotenv/config";
|
||||
import "dotenv/config";
|
||||
import esbuild from "esbuild";
|
||||
import process from "process";
|
||||
import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
|
||||
import process from "process";
|
||||
// import builtins from 'builtin-modules'
|
||||
|
||||
const banner = `/*
|
||||
@@ -17,6 +17,20 @@ const prod = process.argv[2] === "production";
|
||||
const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
|
||||
const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
|
||||
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 || "";
|
||||
const DEFAULT_GOOGLEDRIVE_CLIENT_ID = process.env.GOOGLEDRIVE_CLIENT_ID || "";
|
||||
const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
|
||||
process.env.GOOGLEDRIVE_CLIENT_SECRET || "";
|
||||
const DEFAULT_BOX_CLIENT_ID = process.env.BOX_CLIENT_ID || "";
|
||||
const DEFAULT_BOX_CLIENT_SECRET = process.env.BOX_CLIENT_SECRET || "";
|
||||
const DEFAULT_PCLOUD_CLIENT_ID = process.env.PCLOUD_CLIENT_ID || "";
|
||||
const DEFAULT_PCLOUD_CLIENT_SECRET = process.env.PCLOUD_CLIENT_SECRET || "";
|
||||
const DEFAULT_YANDEXDISK_CLIENT_ID = process.env.YANDEXDISK_CLIENT_ID || "";
|
||||
const DEFAULT_YANDEXDISK_CLIENT_SECRET =
|
||||
process.env.YANDEXDISK_CLIENT_SECRET || "";
|
||||
const DEFAULT_KOOFR_CLIENT_ID = process.env.KOOFR_CLIENT_ID || "";
|
||||
const DEFAULT_KOOFR_CLIENT_SECRET = process.env.KOOFR_CLIENT_SECRET || "";
|
||||
|
||||
esbuild
|
||||
.context({
|
||||
@@ -37,6 +51,7 @@ esbuild
|
||||
"http",
|
||||
"https",
|
||||
"vm",
|
||||
// "process",
|
||||
// ...builtins
|
||||
],
|
||||
inject: ["./esbuild.injecthelper.mjs"],
|
||||
@@ -49,12 +64,31 @@ esbuild
|
||||
minify: prod,
|
||||
outfile: "main.js",
|
||||
define: {
|
||||
"process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
|
||||
"process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
|
||||
"global.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
|
||||
"global.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
|
||||
"global.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
|
||||
"global.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`,
|
||||
"global.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`,
|
||||
"global.DEFAULT_GOOGLEDRIVE_CLIENT_ID": `"${DEFAULT_GOOGLEDRIVE_CLIENT_ID}"`,
|
||||
"global.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET": `"${DEFAULT_GOOGLEDRIVE_CLIENT_SECRET}"`,
|
||||
"global.DEFAULT_BOX_CLIENT_ID": `"${DEFAULT_BOX_CLIENT_ID}"`,
|
||||
"global.DEFAULT_BOX_CLIENT_SECRET": `"${DEFAULT_BOX_CLIENT_SECRET}"`,
|
||||
"global.DEFAULT_PCLOUD_CLIENT_ID": `"${DEFAULT_PCLOUD_CLIENT_ID}"`,
|
||||
"global.DEFAULT_PCLOUD_CLIENT_SECRET": `"${DEFAULT_PCLOUD_CLIENT_SECRET}"`,
|
||||
"global.DEFAULT_YANDEXDISK_CLIENT_ID": `"${DEFAULT_YANDEXDISK_CLIENT_ID}"`,
|
||||
"global.DEFAULT_YANDEXDISK_CLIENT_SECRET": `"${DEFAULT_YANDEXDISK_CLIENT_SECRET}"`,
|
||||
"global.DEFAULT_KOOFR_CLIENT_ID": `"${DEFAULT_KOOFR_CLIENT_ID}"`,
|
||||
"global.DEFAULT_KOOFR_CLIENT_SECRET": `"${DEFAULT_KOOFR_CLIENT_SECRET}"`,
|
||||
global: "window",
|
||||
"process.env.NODE_DEBUG": `undefined`, // ugly fix
|
||||
"process.env.DEBUG": `undefined`, // ugly fix
|
||||
// "process.version": `"v20.10.0"`, // who's using this?
|
||||
// "process":`undefined`,
|
||||
// "global.process":`undefined`,
|
||||
|
||||
// make azure blob storage happy
|
||||
// https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-util/src/checkEnvironment.ts
|
||||
"globalThis.process.versions": `undefined`,
|
||||
},
|
||||
plugins: [inlineWorkerPlugin()],
|
||||
})
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export let Buffer = require("buffer").Buffer;
|
||||
export let process = require("process/browser");
|
||||
export const Buffer = require("buffer").Buffer;
|
||||
export const process = require("process/browser");
|
||||
|
||||
+2
-2
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.4.19",
|
||||
"version": "0.5.12",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
"authorUrl": "https://github.com/fyears",
|
||||
"isDesktopOnly": false,
|
||||
"fundingUrl": "https://github.com/remotely-save/donation"
|
||||
"fundingUrl": "https://remotelysave.com"
|
||||
}
|
||||
|
||||
+2
-2
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.4.19",
|
||||
"version": "0.5.12",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
"authorUrl": "https://github.com/fyears",
|
||||
"isDesktopOnly": false,
|
||||
"fundingUrl": "https://github.com/remotely-save/donation"
|
||||
"fundingUrl": "https://remotelysave.com"
|
||||
}
|
||||
|
||||
+13
-5
@@ -1,15 +1,15 @@
|
||||
{
|
||||
"name": "remotely-save",
|
||||
"version": "0.4.19",
|
||||
"version": "0.5.12",
|
||||
"description": "This is yet another sync plugin for Obsidian app.",
|
||||
"scripts": {
|
||||
"dev2": "node esbuild.config.mjs --watch",
|
||||
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"build": "webpack --mode production",
|
||||
"dev": "webpack --mode development --watch",
|
||||
"format": "npx prettier --trailing-comma es5 --write .",
|
||||
"format": "npx @biomejs/biome check --apply .",
|
||||
"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": {
|
||||
"path": "path-browserify",
|
||||
@@ -23,8 +23,9 @@
|
||||
"source": "main.ts",
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "Apache-2.0",
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"devDependencies": {
|
||||
"@biomejs/biome": "1.7.3",
|
||||
"@microsoft/microsoft-graph-types": "^2.40.0",
|
||||
"@types/chai": "^4.3.14",
|
||||
"@types/chai-as-promised": "^7.1.8",
|
||||
@@ -44,7 +45,7 @@
|
||||
"mocha": "^10.4.0",
|
||||
"npm-check-updates": "^16.14.20",
|
||||
"obsidian": "^1.5.7",
|
||||
"prettier": "^3.2.5",
|
||||
"openapi-typescript": "^7.0.0-rc.0",
|
||||
"ts-loader": "^9.5.1",
|
||||
"ts-node": "^10.9.2",
|
||||
"tslib": "^2.6.2",
|
||||
@@ -60,9 +61,11 @@
|
||||
"@aws-sdk/signature-v4-crt": "^3.556.0",
|
||||
"@aws-sdk/types": "^3.535.0",
|
||||
"@azure/msal-node": "^2.7.0",
|
||||
"@azure/storage-blob": "^12.23.0",
|
||||
"@fyears/rclone-crypt": "^0.0.7",
|
||||
"@fyears/tsqueue": "^1.0.1",
|
||||
"@microsoft/microsoft-graph-client": "^3.0.7",
|
||||
"@sanity/diff-match-patch": "^3.1.1",
|
||||
"@smithy/fetch-http-handler": "^2.5.0",
|
||||
"@smithy/protocol-http": "^3.3.0",
|
||||
"@smithy/querystring-builder": "^2.2.0",
|
||||
@@ -70,6 +73,7 @@
|
||||
"aggregate-error": "^5.0.0",
|
||||
"assert": "^2.1.0",
|
||||
"aws-crt": "^1.21.2",
|
||||
"box-typescript-sdk-gen": "^1.0.0",
|
||||
"buffer": "^6.0.3",
|
||||
"crypto-browserify": "^3.12.0",
|
||||
"dropbox": "^10.34.0",
|
||||
@@ -77,13 +81,17 @@
|
||||
"http-status-codes": "^2.3.0",
|
||||
"localforage": "^1.10.0",
|
||||
"localforage-getitems": "^1.4.2",
|
||||
"localforage-removeitems": "^1.4.0",
|
||||
"lodash": "^4.17.21",
|
||||
"lucide": "^0.376.1",
|
||||
"mime-types": "^2.1.35",
|
||||
"mustache": "^4.2.0",
|
||||
"nanoid": "^5.0.7",
|
||||
"node-diff3": "^3.1.2",
|
||||
"openapi-fetch": "^0.9.7",
|
||||
"p-queue": "^8.0.1",
|
||||
"path-browserify": "^1.0.1",
|
||||
"pcloud-sdk-js": "^2.0.0",
|
||||
"process": "^0.11.10",
|
||||
"qrcode": "^1.5.3",
|
||||
"rfc4648": "^1.5.3",
|
||||
|
||||
+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,45 @@
|
||||
# Pro Features
|
||||
|
||||
## What?
|
||||
|
||||
Remotely Save has some "pro features", which users have to pay for using them.
|
||||
|
||||
## Sign Up / Sign In And Connect
|
||||
|
||||
See the tutorial about your PRO account [here](.../docs/pro/README.md).
|
||||
|
||||
## Smart Conflict (PRO feature)
|
||||
|
||||
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||
|
||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||
|
||||
## Google Drive (GDrive) (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](../docs/remote_services/googledrive/README.md).
|
||||
|
||||
## Box (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](../docs/remote_services/box/README.md).
|
||||
|
||||
## pCloud (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/pcloud/README.md).
|
||||
|
||||
## Yandex Disk (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/yandexdisk/README.md).
|
||||
|
||||
## Koofr (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](../docs/remote_services/koofr/README.md).
|
||||
|
||||
### Azure Blob Storage (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Azure Blob Storage" allows users to to sync with Azure Blob Storage. Tutorials and limitations are documented [here](../docs/remote_services/azureblobstorage/README.md).
|
||||
|
||||
## License
|
||||
|
||||
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
|
||||
|
||||
Suggestions are welcome.
|
||||
@@ -0,0 +1,328 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import {
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
type RemotelySavePluginSettings,
|
||||
type SUPPORTED_SERVICES_TYPE,
|
||||
} from "../../src/baseTypes";
|
||||
import {
|
||||
COMMAND_CALLBACK_PRO,
|
||||
type FeatureInfo,
|
||||
PRO_CLIENT_ID,
|
||||
type PRO_FEATURE_TYPE,
|
||||
PRO_WEBSITE,
|
||||
type ProConfig,
|
||||
} from "./baseTypesPro";
|
||||
import { codeVerifier2CodeChallenge } from "./oauth2";
|
||||
|
||||
const site = PRO_WEBSITE;
|
||||
console.debug(`remotelysave official website: ${site}`);
|
||||
|
||||
export const DEFAULT_PRO_CONFIG: ProConfig = {
|
||||
accessToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
refreshToken: "",
|
||||
enabledProFeatures: [],
|
||||
email: "",
|
||||
};
|
||||
|
||||
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 (
|
||||
config: RemotelySavePluginSettings,
|
||||
pluginVersion: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
): Promise<true> => {
|
||||
console.debug(`checkProRunnableAndFixInplace`);
|
||||
|
||||
// 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;
|
||||
}
|
||||
}
|
||||
|
||||
const errorMsgs = [];
|
||||
|
||||
// check for smart_conflict
|
||||
if (config.conflictAction === "smart_conflict") {
|
||||
if (
|
||||
config.pro.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-smart_conflict"
|
||||
).length === 1
|
||||
) {
|
||||
// good to go
|
||||
} else {
|
||||
errorMsgs.push(
|
||||
`You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.`
|
||||
);
|
||||
}
|
||||
} else {
|
||||
// good to go
|
||||
}
|
||||
|
||||
const toChecked: {
|
||||
feature: PRO_FEATURE_TYPE;
|
||||
service: SUPPORTED_SERVICES_TYPE;
|
||||
name: string;
|
||||
}[] = [
|
||||
{
|
||||
feature: "feature-google_drive",
|
||||
service: "googledrive",
|
||||
name: "Google Drive",
|
||||
},
|
||||
{
|
||||
feature: "feature-onedrive_full",
|
||||
service: "onedrivefull",
|
||||
name: "Onedrive (Full)",
|
||||
},
|
||||
{ feature: "feature-box", service: "box", name: "Box" },
|
||||
{ feature: "feature-pcloud", service: "pcloud", name: "pCloud" },
|
||||
{
|
||||
feature: "feature-yandex_disk",
|
||||
service: "yandexdisk",
|
||||
name: "Yandex Disk",
|
||||
},
|
||||
{
|
||||
feature: "feature-koofr",
|
||||
service: "koofr",
|
||||
name: "Koofr",
|
||||
},
|
||||
{
|
||||
feature: "feature-azure_blob_storage",
|
||||
service: "azureblobstorage",
|
||||
name: "Azure Blob Storage",
|
||||
},
|
||||
];
|
||||
|
||||
for (const { feature, service, name } of toChecked) {
|
||||
console.debug(`checking "${feature}", serviceType=${config.serviceType}`);
|
||||
if (config.serviceType === service) {
|
||||
if (
|
||||
config.pro.enabledProFeatures.filter((x) => x.featureName === feature)
|
||||
.length === 1
|
||||
) {
|
||||
// good to go
|
||||
} else {
|
||||
errorMsgs.push(
|
||||
`You're trying to use "sync with ${name}" PRO feature but you haven't subscribe to it.`
|
||||
);
|
||||
}
|
||||
} else {
|
||||
// good to go
|
||||
}
|
||||
}
|
||||
|
||||
if (errorMsgs.length !== 0) {
|
||||
throw Error(errorMsgs.join("\n\n"));
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
@@ -0,0 +1,17 @@
|
||||
# checklist for adding new service
|
||||
|
||||
1. `fsXxx.ts`
|
||||
2. `settingsXxx.ts`
|
||||
3. add callback and `xxxConfig` in `baseTypesPro.ts`
|
||||
4. add `xxxConfig` to `DEFAULT_SETTINGS` and `RemotelySavePluginSettings` in `main.ts`
|
||||
5. add `registerObsidianProtocolHandler`, if undefinded, `let xxxExpired`, expired notice in `main.ts`
|
||||
6. add `langs/`
|
||||
7. add css into `styles.css`
|
||||
8. general `settings.ts` add: config part, chooser, import export
|
||||
9. `generateProSettingsPart.ts`
|
||||
10. `importExport.ts`
|
||||
11. `fsGetter.ts`
|
||||
12. `sync.ts` checking for PRO: `checkProRunnableAndFixInplace`
|
||||
13. `configPersist.test.ts`
|
||||
14. `README.md` add service at menu and detail
|
||||
15. `docs/` add service
|
||||
@@ -0,0 +1,191 @@
|
||||
////////////////////////////////////////////////////////////
|
||||
// hacks
|
||||
////////////////////////////////////////////////////////////
|
||||
|
||||
declare global {
|
||||
var DEFAULT_REMOTELYSAVE_WEBSITE: string;
|
||||
var DEFAULT_REMOTELYSAVE_CLIENT_ID: string;
|
||||
var DEFAULT_GOOGLEDRIVE_CLIENT_ID: string;
|
||||
var DEFAULT_GOOGLEDRIVE_CLIENT_SECRET: string;
|
||||
var DEFAULT_BOX_CLIENT_ID: string;
|
||||
var DEFAULT_BOX_CLIENT_SECRET: string;
|
||||
var DEFAULT_PCLOUD_CLIENT_ID: string;
|
||||
var DEFAULT_PCLOUD_CLIENT_SECRET: string;
|
||||
var DEFAULT_YANDEXDISK_CLIENT_ID: string;
|
||||
var DEFAULT_YANDEXDISK_CLIENT_SECRET: string;
|
||||
var DEFAULT_KOOFR_CLIENT_ID: string;
|
||||
var DEFAULT_KOOFR_CLIENT_SECRET: string;
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// PRO
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro";
|
||||
export const PRO_CLIENT_ID = global.DEFAULT_REMOTELYSAVE_CLIENT_ID;
|
||||
export const PRO_WEBSITE = global.DEFAULT_REMOTELYSAVE_WEBSITE;
|
||||
|
||||
export type PRO_FEATURE_TYPE =
|
||||
| "feature-smart_conflict"
|
||||
| "feature-onedrive_full"
|
||||
| "feature-google_drive"
|
||||
| "feature-box"
|
||||
| "feature-pcloud"
|
||||
| "feature-yandex_disk"
|
||||
| "feature-koofr"
|
||||
| "feature-azure_blob_storage";
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// smart conflict
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const MERGABLE_SIZE = 1000 * 1000; // 1 MB
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Google Drive
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export interface GoogleDriveConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: "https://www.googleapis.com/auth/drive.file";
|
||||
kind: "googledrive";
|
||||
}
|
||||
|
||||
export const GOOGLEDRIVE_CLIENT_ID = global.DEFAULT_GOOGLEDRIVE_CLIENT_ID;
|
||||
export const GOOGLEDRIVE_CLIENT_SECRET =
|
||||
global.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET;
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// box
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_BOX = "remotely-save-cb-box";
|
||||
export const BOX_CLIENT_ID = global.DEFAULT_BOX_CLIENT_ID;
|
||||
export const BOX_CLIENT_SECRET = global.DEFAULT_BOX_CLIENT_SECRET;
|
||||
|
||||
export interface BoxConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
kind: "box";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// pCloud
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_PCLOUD = "remotely-save-cb-pcloud";
|
||||
export const PCLOUD_CLIENT_ID = global.DEFAULT_PCLOUD_CLIENT_ID;
|
||||
export const PCLOUD_CLIENT_SECRET = global.DEFAULT_PCLOUD_CLIENT_SECRET;
|
||||
|
||||
export interface PCloudConfig {
|
||||
accessToken: string;
|
||||
hostname: "eapi.pcloud.com" | "api.pcloud.com";
|
||||
locationid: 1 | 2;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
kind: "pcloud";
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
emptyFile: "skip" | "error";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Yandex Disk
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_YANDEXDISK = "remotely-save-cb-yandexdisk";
|
||||
export const YANDEXDISK_CLIENT_ID = global.DEFAULT_YANDEXDISK_CLIENT_ID;
|
||||
export const YANDEXDISK_CLIENT_SECRET = global.DEFAULT_YANDEXDISK_CLIENT_SECRET;
|
||||
|
||||
export interface YandexDiskConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: string;
|
||||
kind: "yandexdisk";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Koofr
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_KOOFR = "remotely-save-cb-koofr";
|
||||
export const KOOFR_CLIENT_ID = global.DEFAULT_KOOFR_CLIENT_ID;
|
||||
export const KOOFR_CLIENT_SECRET = global.DEFAULT_KOOFR_CLIENT_SECRET;
|
||||
|
||||
export interface KoofrConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: string;
|
||||
api: string;
|
||||
mountID: string;
|
||||
kind: "koofr";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Azure Blob Storage
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export interface AzureBlobStorageConfig {
|
||||
containerSasUrl: string;
|
||||
containerName: string;
|
||||
remotePrefix: string;
|
||||
generateFolderObject: boolean;
|
||||
partsConcurrency: number;
|
||||
kind: "azureblobstorage";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Onedrive (Full)
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_ONEDRIVEFULL = "remotely-save-cb-onedrivefull";
|
||||
|
||||
export interface OnedriveFullConfig {
|
||||
accessToken: string;
|
||||
clientID: string;
|
||||
authority: string;
|
||||
refreshToken: string;
|
||||
accessTokenExpiresInSeconds: number;
|
||||
accessTokenExpiresAtTime: number;
|
||||
deltaLink: string;
|
||||
username: string;
|
||||
credentialsShouldBeDeletedAtTime?: number;
|
||||
remoteBaseDir?: string;
|
||||
emptyFile: "skip" | "error";
|
||||
kind: "onedrivefull";
|
||||
}
|
||||
@@ -0,0 +1,377 @@
|
||||
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;
|
||||
}
|
||||
|
||||
function arraysAreEqual(arr1: ArrayBuffer, arr2: ArrayBuffer) {
|
||||
if (arr1.byteLength !== arr2.byteLength) {
|
||||
return false;
|
||||
}
|
||||
const u1 = new Uint8Array(arr1);
|
||||
const u2 = new Uint8Array(arr2);
|
||||
|
||||
for (let i = 0; i < u1.byteLength; ++i) {
|
||||
if (u1[i] !== u2[i]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. download remote
|
||||
* 2. compare
|
||||
* 3. if the same, update local but not upload
|
||||
* 4. if not the same, rename local and save remote
|
||||
*/
|
||||
async function tryDuplicateFileForSameSizes(
|
||||
key: string,
|
||||
key2: string,
|
||||
fsLocal: FakeFs,
|
||||
fsRemote: FakeFs,
|
||||
uploadCallback: (entity: Entity | undefined) => Promise<any>,
|
||||
downloadCallback: (entity: Entity | undefined) => Promise<any>
|
||||
) {
|
||||
console.debug(`tryDuplicateFileForSameSizes: ${key}`);
|
||||
|
||||
// 1. download
|
||||
const remoteContent = await fsRemote.readFile(key);
|
||||
|
||||
// 2. compare
|
||||
const localContent = await fsLocal.readFile(key);
|
||||
const eq = arraysAreEqual(localContent, remoteContent);
|
||||
|
||||
if (eq) {
|
||||
// 3. if the same, update local but not upload
|
||||
// read meta of remote, as if we have downloaded the file
|
||||
console.debug(`tryDuplicateFileForSameSizes: ${key} content equal`);
|
||||
const entityRemote = await fsRemote.stat(key);
|
||||
|
||||
// write
|
||||
const downloadResultEntity = await fsLocal.writeFile(
|
||||
key,
|
||||
remoteContent,
|
||||
entityRemote.mtimeCli ?? Date.now(),
|
||||
entityRemote.mtimeCli ?? Date.now()
|
||||
);
|
||||
await downloadCallback(downloadResultEntity);
|
||||
|
||||
// no uploadCallback here
|
||||
} else {
|
||||
// 4. if not the same, rename local and save remote
|
||||
console.debug(`tryDuplicateFileForSameSizes: ${key} content not equal`);
|
||||
|
||||
await fsLocal.rename(key, key2);
|
||||
|
||||
const entityRemote = await fsRemote.stat(key);
|
||||
const downloadResultEntity = await fsLocal.writeFile(
|
||||
key,
|
||||
remoteContent,
|
||||
entityRemote.mtimeCli ?? Date.now(),
|
||||
entityRemote.mtimeCli ?? Date.now()
|
||||
);
|
||||
await downloadCallback(downloadResultEntity);
|
||||
|
||||
const entityLocal = await fsLocal.stat(key2); // key2 here!
|
||||
const uploadResultEntity = await fsRemote.writeFile(
|
||||
key2, // key2 here!
|
||||
localContent,
|
||||
entityLocal.mtimeCli ?? Date.now(),
|
||||
entityLocal.mtimeCli ?? Date.now()
|
||||
);
|
||||
await uploadCallback(uploadResultEntity);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* local: x.md -> x.dup.md -> upload to remote
|
||||
* remote: x.md -> download to local -> using original name x.md
|
||||
*/
|
||||
async function tryDuplicateFileForDiffSizes(
|
||||
key: string,
|
||||
key2: string,
|
||||
fsLocal: FakeFs,
|
||||
fsRemote: FakeFs,
|
||||
uploadCallback: (entity: Entity | undefined) => Promise<any>,
|
||||
downloadCallback: (entity: Entity | undefined) => Promise<any>
|
||||
) {
|
||||
console.debug(`tryDuplicateFileForDiffSizes: ${key}`);
|
||||
|
||||
await fsLocal.rename(key, key2);
|
||||
|
||||
/**
|
||||
* x.dup.md -> upload to remote
|
||||
*/
|
||||
async function f1() {
|
||||
const k = await copyFile(key2, fsLocal, fsRemote);
|
||||
await uploadCallback(k.entity);
|
||||
return k.entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* x.md -> download to local
|
||||
*/
|
||||
async function f2() {
|
||||
const k = await copyFile(key, fsRemote, fsLocal);
|
||||
await downloadCallback(k.entity);
|
||||
return k.entity;
|
||||
}
|
||||
|
||||
const [resUpload, resDownload] = await Promise.all([f1(), f2()]);
|
||||
|
||||
return {
|
||||
upload: resUpload,
|
||||
download: resDownload,
|
||||
};
|
||||
}
|
||||
|
||||
export async function tryDuplicateFile(
|
||||
key: string,
|
||||
fsLocal: FakeFs,
|
||||
fsRemote: FakeFs,
|
||||
uploadCallback: (entity: Entity | undefined) => Promise<any>,
|
||||
downloadCallback: (entity: Entity | undefined) => Promise<any>
|
||||
) {
|
||||
let key2 = getFileRename(key);
|
||||
let usable = false;
|
||||
do {
|
||||
try {
|
||||
const s = await fsLocal.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);
|
||||
|
||||
const localSize = await fsLocal.stat(key);
|
||||
const remoteSize = await fsRemote.stat(key);
|
||||
|
||||
if (
|
||||
localSize !== undefined &&
|
||||
remoteSize !== undefined &&
|
||||
localSize.sizeRaw === remoteSize.sizeRaw
|
||||
) {
|
||||
return await tryDuplicateFileForSameSizes(
|
||||
key,
|
||||
key2,
|
||||
fsLocal,
|
||||
fsRemote,
|
||||
uploadCallback,
|
||||
downloadCallback
|
||||
);
|
||||
} else {
|
||||
return await tryDuplicateFileForDiffSizes(
|
||||
key,
|
||||
key2,
|
||||
fsLocal,
|
||||
fsRemote,
|
||||
uploadCallback,
|
||||
downloadCallback
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,342 @@
|
||||
import * as path from "path";
|
||||
import {
|
||||
AnonymousCredential,
|
||||
BaseRequestPolicy,
|
||||
type BlobGetPropertiesResponse,
|
||||
BlobServiceClient,
|
||||
BlobUploadCommonResponse,
|
||||
BlockBlobClient,
|
||||
ContainerClient,
|
||||
newPipeline,
|
||||
} from "@azure/storage-blob";
|
||||
import type { Entity } from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import { arrayBufferToHex, getFolderLevels } from "../../src/misc";
|
||||
import type { AzureBlobStorageConfig } from "./baseTypesPro";
|
||||
|
||||
export const simpleTransRemotePrefix = (x: string) => {
|
||||
if (x === undefined) {
|
||||
return "";
|
||||
}
|
||||
let y = path.posix.normalize(x.trim());
|
||||
if (y === undefined || y === "" || y === "/" || y === ".") {
|
||||
return "";
|
||||
}
|
||||
if (y.startsWith("/")) {
|
||||
y = y.slice(1);
|
||||
}
|
||||
if (!y.endsWith("/")) {
|
||||
y = `${y}/`;
|
||||
}
|
||||
return y;
|
||||
};
|
||||
|
||||
export const DEFAULT_AZUREBLOBSTORAGE_CONFIG: AzureBlobStorageConfig = {
|
||||
containerSasUrl: "",
|
||||
containerName: "",
|
||||
remotePrefix: "",
|
||||
generateFolderObject: false,
|
||||
partsConcurrency: 5,
|
||||
kind: "azureblobstorage",
|
||||
};
|
||||
|
||||
const getNormPath = (fileOrFolderPath: string, remotePrefix: string) => {
|
||||
if (remotePrefix.startsWith("/") || !remotePrefix.endsWith("/")) {
|
||||
throw Error(
|
||||
`remotePrefix should not have leading slash but should have tailing slash: ${remotePrefix}`
|
||||
);
|
||||
}
|
||||
if (!fileOrFolderPath.startsWith(remotePrefix)) {
|
||||
throw Error(`${fileOrFolderPath} does not start with ${remotePrefix}!`);
|
||||
}
|
||||
return fileOrFolderPath.slice(remotePrefix.length);
|
||||
};
|
||||
|
||||
const getBlobPath = (fileOrFolderPath: string, remotePrefix: string) => {
|
||||
if (remotePrefix.startsWith("/") || !remotePrefix.endsWith("/")) {
|
||||
throw Error(
|
||||
`remotePrefix should not have leading slash but should have tailing slash: ${remotePrefix}`
|
||||
);
|
||||
}
|
||||
return `${remotePrefix}${fileOrFolderPath}`;
|
||||
};
|
||||
|
||||
const fromBlobPropsToEntity = (
|
||||
name: string,
|
||||
props: BlobGetPropertiesResponse,
|
||||
remotePrefix: string
|
||||
): Entity => {
|
||||
const key = getNormPath(name, remotePrefix);
|
||||
|
||||
let mtimeCli = props.lastModified!.valueOf();
|
||||
const mtimeStr = props.metadata?.mtime;
|
||||
if (mtimeStr !== undefined && mtimeStr !== "") {
|
||||
try {
|
||||
mtimeCli = new Date(mtimeStr).valueOf();
|
||||
} catch {}
|
||||
}
|
||||
|
||||
let hash: undefined | string = undefined;
|
||||
if (props.contentMD5 !== undefined) {
|
||||
hash = arrayBufferToHex(props.contentMD5.buffer);
|
||||
}
|
||||
|
||||
const entity: Entity = {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeCli: mtimeCli,
|
||||
mtimeSvr: props.lastModified!.valueOf(),
|
||||
size: props.contentLength ?? 0,
|
||||
sizeRaw: props.contentLength ?? 0,
|
||||
hash: hash,
|
||||
};
|
||||
|
||||
if (key.endsWith("/")) {
|
||||
entity.synthesizedFolder = false;
|
||||
}
|
||||
|
||||
return entity;
|
||||
};
|
||||
|
||||
export class FakeFsAzureBlobStorage extends FakeFs {
|
||||
kind: string;
|
||||
config: AzureBlobStorageConfig;
|
||||
vaultName: string;
|
||||
containerClient: ContainerClient;
|
||||
remotePrefix: string;
|
||||
synthFoldersCache: Record<string, Entity>;
|
||||
|
||||
constructor(config: AzureBlobStorageConfig, vaultName: string) {
|
||||
super();
|
||||
this.kind = "azureblobstorage";
|
||||
this.config = config;
|
||||
this.vaultName = vaultName;
|
||||
this.synthFoldersCache = {};
|
||||
|
||||
this.remotePrefix = `${vaultName}/`;
|
||||
const k = simpleTransRemotePrefix(this.config.remotePrefix);
|
||||
if (k !== "") {
|
||||
// we have prefix
|
||||
this.remotePrefix = k;
|
||||
}
|
||||
|
||||
this.containerClient = new ContainerClient(this.config.containerSasUrl);
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
const entities: Entity[] = [];
|
||||
const realEntities = new Set<string>();
|
||||
for await (const blob of this.containerClient.listBlobsFlat({
|
||||
prefix: this.remotePrefix,
|
||||
includeMetadata: true,
|
||||
})) {
|
||||
const blockBlobClient = this.containerClient.getBlockBlobClient(
|
||||
blob.name
|
||||
);
|
||||
const props = await blockBlobClient.getProperties();
|
||||
|
||||
// console.debug(blob.name)
|
||||
|
||||
const entity = fromBlobPropsToEntity(blob.name, props, this.remotePrefix);
|
||||
entities.push(entity);
|
||||
|
||||
// so we need to fake the folders
|
||||
realEntities.add(entity.key!);
|
||||
for (const f of getFolderLevels(entity.key!, true)) {
|
||||
if (realEntities.has(f)) {
|
||||
delete this.synthFoldersCache[f];
|
||||
continue;
|
||||
}
|
||||
if (
|
||||
!this.synthFoldersCache.hasOwnProperty(f) ||
|
||||
entity.mtimeSvr! >= this.synthFoldersCache[f].mtimeSvr!
|
||||
) {
|
||||
this.synthFoldersCache[f] = {
|
||||
key: f,
|
||||
keyRaw: f,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
sizeEnc: 0,
|
||||
mtimeSvr: entity.mtimeSvr,
|
||||
mtimeSvrFmt: entity.mtimeSvrFmt,
|
||||
mtimeCli: entity.mtimeCli,
|
||||
mtimeCliFmt: entity.mtimeCliFmt,
|
||||
synthesizedFolder: true,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
for (const key of Object.keys(this.synthFoldersCache)) {
|
||||
entities.push(this.synthFoldersCache[key]);
|
||||
}
|
||||
return entities;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
const entities: Entity[] = [];
|
||||
for await (const blob of this.containerClient.listBlobsByHierarchy("/", {
|
||||
prefix: this.remotePrefix,
|
||||
includeMetadata: true,
|
||||
})) {
|
||||
if (blob.kind === "prefix") {
|
||||
continue;
|
||||
}
|
||||
const blockBlobClient = this.containerClient.getBlockBlobClient(
|
||||
blob.name
|
||||
);
|
||||
const props = await blockBlobClient.getProperties();
|
||||
|
||||
const entity = fromBlobPropsToEntity(blob.name, props, this.remotePrefix);
|
||||
entities.push(entity);
|
||||
}
|
||||
return entities;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
const remotePath = getBlobPath(key, this.remotePrefix);
|
||||
const blockBlobClient = this.containerClient.getBlockBlobClient(remotePath);
|
||||
const props = await blockBlobClient.getProperties();
|
||||
|
||||
const entity = fromBlobPropsToEntity(remotePath, props, this.remotePrefix);
|
||||
return entity;
|
||||
}
|
||||
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime?: number | undefined,
|
||||
ctime?: number | undefined
|
||||
): Promise<Entity> {
|
||||
if (!key.endsWith("/")) {
|
||||
throw new Error(`You should not call mkdir on ${key}!`);
|
||||
}
|
||||
|
||||
const generateFolderObject = this.config.generateFolderObject ?? false;
|
||||
if (!generateFolderObject) {
|
||||
const synth = {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
sizeEnc: 0,
|
||||
mtimeSvr: mtime,
|
||||
mtimeCli: mtime,
|
||||
synthesizedFolder: true,
|
||||
};
|
||||
this.synthFoldersCache[key] = synth;
|
||||
return synth;
|
||||
}
|
||||
|
||||
return await this.writeFile(
|
||||
key,
|
||||
new ArrayBuffer(0),
|
||||
mtime ?? Date.now(),
|
||||
ctime ?? Date.now()
|
||||
);
|
||||
}
|
||||
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
const blobPath = getBlobPath(key, this.remotePrefix);
|
||||
|
||||
const blobClient = this.containerClient.getBlockBlobClient(blobPath);
|
||||
const metadata: Record<string, string> = {
|
||||
mtime: new Date(mtime).toISOString(),
|
||||
ctime: new Date(ctime).toISOString(),
|
||||
};
|
||||
|
||||
if (key.endsWith("/")) {
|
||||
console.debug(`yeah we have folder upload`);
|
||||
const generateFolderObject = this.config.generateFolderObject ?? false;
|
||||
if (!generateFolderObject) {
|
||||
throw Error(
|
||||
`if not generate folder object, the func should not go here`
|
||||
);
|
||||
}
|
||||
metadata["hdi_isfolder"] = "true";
|
||||
}
|
||||
|
||||
const uploadResult = await blobClient.uploadData(content, {
|
||||
metadata: metadata,
|
||||
concurrency: this.config.partsConcurrency ?? 5,
|
||||
});
|
||||
|
||||
if (key.endsWith("/")) {
|
||||
console.debug(`yeah we have folder upload`);
|
||||
console.debug(uploadResult);
|
||||
}
|
||||
|
||||
if (uploadResult._response.status >= 300) {
|
||||
throw Error(`upload ${key} failed with ${JSON.stringify(uploadResult)}`);
|
||||
}
|
||||
|
||||
return await this.stat(key);
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
const blobPath = getBlobPath(key, this.remotePrefix);
|
||||
const blobClient = this.containerClient.getBlockBlobClient(blobPath);
|
||||
const rsp = await blobClient.download();
|
||||
if (rsp._response.status >= 300) {
|
||||
throw Error(`download ${key} failed with ${JSON.stringify(rsp)}`);
|
||||
}
|
||||
return await (await rsp.blobBody)!.arrayBuffer();
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
const blobPath = getBlobPath(key, this.remotePrefix);
|
||||
if (key.endsWith("/")) {
|
||||
if (this.synthFoldersCache.hasOwnProperty(key)) {
|
||||
delete this.synthFoldersCache[key];
|
||||
}
|
||||
|
||||
// in blob the folder may not exist, so we make our best effort.
|
||||
// do NOT read this.config.generateFolderObject
|
||||
// because the folder might be generated by previous setting
|
||||
try {
|
||||
const blobClient = this.containerClient.getBlockBlobClient(blobPath);
|
||||
await blobClient.deleteIfExists();
|
||||
} catch (e) {}
|
||||
} else {
|
||||
// the file should really exist
|
||||
const blobClient = this.containerClient.getBlockBlobClient(blobPath);
|
||||
const rsp = await blobClient.deleteIfExists();
|
||||
if (!rsp.succeeded) {
|
||||
throw Error(
|
||||
`something goes wrong while deleting ${key}: ${JSON.stringify(rsp)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can walk, we can connect
|
||||
try {
|
||||
await this.walkPartial();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async revokeAuth(): Promise<any> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,926 @@
|
||||
import {
|
||||
BoxOAuth,
|
||||
OAuthConfig,
|
||||
} from "box-typescript-sdk-gen/lib/box/oauth.generated";
|
||||
import * as mime from "mime-types";
|
||||
import { DEFAULT_CONTENT_TYPE, type Entity } from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import {
|
||||
BOX_CLIENT_ID,
|
||||
BOX_CLIENT_SECRET,
|
||||
type BoxConfig,
|
||||
COMMAND_CALLBACK_BOX,
|
||||
} from "./baseTypesPro";
|
||||
|
||||
import { BoxDeveloperTokenAuth } from "box-typescript-sdk-gen/lib/box/developerTokenAuth.generated";
|
||||
import { BoxClient } from "box-typescript-sdk-gen/lib/client.generated";
|
||||
import type { FileFull } from "box-typescript-sdk-gen/lib/schemas/fileFull.generated";
|
||||
import type { FileFullOrFolderMiniOrWebLink } from "box-typescript-sdk-gen/lib/schemas/fileFullOrFolderMiniOrWebLink.generated";
|
||||
import type { FolderFull } from "box-typescript-sdk-gen/lib/schemas/folderFull.generated";
|
||||
import type { Items } from "box-typescript-sdk-gen/lib/schemas/items.generated";
|
||||
import PQueue from "p-queue";
|
||||
import {
|
||||
delay,
|
||||
getFolderLevels,
|
||||
getSha1,
|
||||
splitFileSizeToChunkRanges,
|
||||
unixTimeToStr,
|
||||
} from "../../src/misc";
|
||||
|
||||
export const DEFAULT_BOX_CONFIG: BoxConfig = {
|
||||
accessToken: "",
|
||||
refreshToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
credentialsShouldBeDeletedAtTimeMs: 0, // 60 days https://developer.box.com/guides/authentication/tokens/refresh/
|
||||
kind: "box",
|
||||
};
|
||||
|
||||
export const generateAuthUrl = () => {
|
||||
const config = new OAuthConfig({
|
||||
clientId: BOX_CLIENT_ID ?? "",
|
||||
clientSecret: BOX_CLIENT_SECRET ?? "",
|
||||
});
|
||||
const oauth = new BoxOAuth({ config: config });
|
||||
|
||||
// the URL to redirect the user to
|
||||
const authorize_url = oauth.getAuthorizeUrl({
|
||||
redirectUri: `obsidian://${COMMAND_CALLBACK_BOX}`,
|
||||
});
|
||||
// console.debug(authorize_url)
|
||||
return authorize_url;
|
||||
};
|
||||
|
||||
/**
|
||||
* https://developer.box.com/guides/authentication/oauth2/without-sdk/
|
||||
*/
|
||||
export const sendAuthReq = async (authCode: string, errorCallBack: any) => {
|
||||
try {
|
||||
const k = {
|
||||
code: authCode,
|
||||
grant_type: "authorization_code",
|
||||
client_id: BOX_CLIENT_ID ?? "",
|
||||
client_secret: BOX_CLIENT_SECRET ?? "",
|
||||
// redirect_uri: `obsidian://${COMMAND_CALLBACK_BOX}`,
|
||||
};
|
||||
// console.debug(k);
|
||||
const resp1 = await fetch(`https://api.box.com/oauth2/token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams(k),
|
||||
});
|
||||
const resp2 = await resp1.json();
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
if (errorCallBack !== undefined) {
|
||||
await errorCallBack(e);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* https://developer.box.com/guides/authentication/tokens/refresh/
|
||||
*/
|
||||
export const sendRefreshTokenReq = async (refreshToken: string) => {
|
||||
console.debug(`refreshing token`);
|
||||
const x = await fetch("https://api.box.com/oauth2/token", {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: BOX_CLIENT_ID ?? "",
|
||||
client_secret: BOX_CLIENT_SECRET ?? "",
|
||||
grant_type: "refresh_token",
|
||||
refresh_token: refreshToken,
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
if (x.status === 200) {
|
||||
const y = await x.json();
|
||||
console.debug(`new token obtained`);
|
||||
return y;
|
||||
} else {
|
||||
throw Error(`cannot refresh an access token`);
|
||||
}
|
||||
};
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: BoxConfig,
|
||||
authRes: any,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresAtTimeMs =
|
||||
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
|
||||
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
|
||||
config.refreshToken = authRes.refresh_token || config.refreshToken;
|
||||
|
||||
// manually set it expired after 60 days;
|
||||
config.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + 1000 * 60 * 60 * 24 * 59;
|
||||
|
||||
await saveUpdatedConfigFunc?.();
|
||||
|
||||
console.info("finish updating local info of Box token");
|
||||
};
|
||||
|
||||
interface CreateUploadSessionRawResponse {
|
||||
id: string;
|
||||
type: "upload_session";
|
||||
num_parts_processed: number;
|
||||
part_size: number;
|
||||
session_endpoints: {
|
||||
abort: string;
|
||||
commit: string;
|
||||
list_parts: string;
|
||||
log_event: string;
|
||||
status: string;
|
||||
upload_part: string;
|
||||
};
|
||||
session_expires_at: string;
|
||||
total_parts: number;
|
||||
}
|
||||
|
||||
interface UploadChunkRawResponse {
|
||||
part: {
|
||||
offset: number;
|
||||
part_id: string;
|
||||
sha1: string;
|
||||
size: number;
|
||||
};
|
||||
}
|
||||
|
||||
interface BoxEntity extends Entity {
|
||||
id: string;
|
||||
parentID: string | undefined;
|
||||
parentIDPath: string | undefined;
|
||||
isFolder: boolean;
|
||||
hashSha1: string | undefined;
|
||||
}
|
||||
|
||||
const fromBoxItemToEntity = (
|
||||
boxItem: FileFullOrFolderMiniOrWebLink | FolderFull,
|
||||
parentID: string,
|
||||
parentFolderPath: string | undefined /* for bfs */
|
||||
): BoxEntity => {
|
||||
if (parentID === undefined || parentID === "" || parentID === "0") {
|
||||
throw Error(`parentID=${parentID} should not be in fromBoxItemToEntity`);
|
||||
}
|
||||
|
||||
let keyRaw = boxItem.name!;
|
||||
|
||||
if (
|
||||
parentFolderPath !== undefined &&
|
||||
parentFolderPath !== "" &&
|
||||
parentFolderPath !== "/"
|
||||
) {
|
||||
if (!parentFolderPath.endsWith("/")) {
|
||||
throw Error(
|
||||
`parentFolderPath=${parentFolderPath} should not be in fromFileToBoxEntity`
|
||||
);
|
||||
}
|
||||
keyRaw = `${parentFolderPath}${boxItem.name!}`;
|
||||
}
|
||||
|
||||
if (boxItem.type === "folder") {
|
||||
keyRaw = `${keyRaw}/`;
|
||||
const mtime =
|
||||
(boxItem as FolderFull).contentModifiedAt?.value.valueOf() ??
|
||||
(boxItem as FolderFull).modifiedAt?.value.valueOf() ??
|
||||
Date.now();
|
||||
return {
|
||||
key: keyRaw,
|
||||
keyRaw: keyRaw,
|
||||
mtimeCli: mtime,
|
||||
mtimeSvr: mtime,
|
||||
id: boxItem.id,
|
||||
parentID: parentID,
|
||||
isFolder: true,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
hash: undefined,
|
||||
hashSha1: undefined,
|
||||
parentIDPath: parentFolderPath,
|
||||
};
|
||||
} else if (boxItem.type === "file") {
|
||||
const mtime =
|
||||
boxItem.contentModifiedAt?.value.valueOf() ??
|
||||
boxItem.modifiedAt?.value.valueOf() ??
|
||||
Date.now();
|
||||
return {
|
||||
key: keyRaw,
|
||||
keyRaw: keyRaw,
|
||||
mtimeCli: mtime,
|
||||
mtimeSvr: mtime,
|
||||
id: boxItem.id,
|
||||
parentID: parentID,
|
||||
isFolder: false,
|
||||
size: boxItem.size!,
|
||||
sizeRaw: boxItem.size!,
|
||||
hash: boxItem.sha1,
|
||||
hashSha1: boxItem.sha1,
|
||||
parentIDPath: parentFolderPath,
|
||||
};
|
||||
} else {
|
||||
throw Error(`we do not support web link Box item`);
|
||||
}
|
||||
};
|
||||
|
||||
const fromRawResponseToEntity = (
|
||||
boxItem: any,
|
||||
parentID: string,
|
||||
parentFolderPath: string | undefined /* for bfs */
|
||||
): BoxEntity => {
|
||||
if (parentID === undefined || parentID === "" || parentID === "0") {
|
||||
throw Error(
|
||||
`parentID=${parentID} should not be in fromRawResponseToEntity`
|
||||
);
|
||||
}
|
||||
|
||||
let keyRaw = boxItem.name!;
|
||||
|
||||
if (
|
||||
parentFolderPath !== undefined &&
|
||||
parentFolderPath !== "" &&
|
||||
parentFolderPath !== "/"
|
||||
) {
|
||||
if (!parentFolderPath.endsWith("/")) {
|
||||
throw Error(
|
||||
`parentFolderPath=${parentFolderPath} should not be in fromFileToBoxEntity`
|
||||
);
|
||||
}
|
||||
keyRaw = `${parentFolderPath}${boxItem.name!}`;
|
||||
}
|
||||
|
||||
if (boxItem.type === "folder") {
|
||||
keyRaw = `${keyRaw}/`;
|
||||
} else if (boxItem.type === "file") {
|
||||
// pass
|
||||
} else {
|
||||
throw Error(`we do not support web link Box item`);
|
||||
}
|
||||
|
||||
const mtimeStr = boxItem.content_modified_at ?? boxItem.modified_at;
|
||||
let mtime = Date.now();
|
||||
if (mtimeStr !== undefined) {
|
||||
mtime = new Date(mtimeStr).valueOf();
|
||||
}
|
||||
|
||||
return {
|
||||
key: keyRaw,
|
||||
keyRaw: keyRaw,
|
||||
mtimeCli: mtime,
|
||||
mtimeSvr: mtime,
|
||||
id: boxItem.id,
|
||||
parentID: parentID,
|
||||
isFolder: false,
|
||||
size: boxItem.size ?? 0,
|
||||
sizeRaw: boxItem.size ?? 0,
|
||||
hash: boxItem.sha1 ?? undefined,
|
||||
hashSha1: boxItem.sha1 ?? undefined,
|
||||
parentIDPath: parentFolderPath,
|
||||
};
|
||||
};
|
||||
|
||||
export class FakeFsBox extends FakeFs {
|
||||
kind: string;
|
||||
boxConfig: BoxConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
keyToBoxEntity: Record<string, BoxEntity>;
|
||||
|
||||
baseDirID: string;
|
||||
|
||||
constructor(
|
||||
boxConfig: BoxConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "box";
|
||||
this.boxConfig = boxConfig;
|
||||
this.remoteBaseDir = this.boxConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
this.keyToBoxEntity = {};
|
||||
this.baseDirID = "";
|
||||
}
|
||||
|
||||
async _init() {
|
||||
const access = await this._getAccessToken();
|
||||
|
||||
if (this.vaultFolderExists) {
|
||||
// pass
|
||||
} else {
|
||||
const auth = new BoxDeveloperTokenAuth({ token: access });
|
||||
const client = new BoxClient({ auth });
|
||||
|
||||
// find
|
||||
let itemsInRoot: Items | undefined = undefined;
|
||||
|
||||
let offset = 0;
|
||||
const limitPerPage = 1000; // max 1000
|
||||
|
||||
while (!this.vaultFolderExists) {
|
||||
itemsInRoot = await client.folders.getFolderItems("0", {
|
||||
queryParams: {
|
||||
fields: [
|
||||
"id",
|
||||
"type",
|
||||
"name",
|
||||
"sha1",
|
||||
"size",
|
||||
"created_at",
|
||||
"modified_at",
|
||||
"expires_at",
|
||||
"parent",
|
||||
"content_created_at",
|
||||
"content_modified_at",
|
||||
"etag",
|
||||
],
|
||||
offset: offset,
|
||||
limit: limitPerPage,
|
||||
},
|
||||
});
|
||||
// console.debug(`this.remoteBaseDir=${this.remoteBaseDir}`);
|
||||
// console.debug(`itemsInRoot:`);
|
||||
// console.debug(itemsInRoot);
|
||||
if (
|
||||
(itemsInRoot.entries?.filter((x) => x.name === this.remoteBaseDir)
|
||||
.length ?? 0) > 0
|
||||
) {
|
||||
// we find it!
|
||||
const f = itemsInRoot.entries?.filter(
|
||||
(x) => x.name === this.remoteBaseDir
|
||||
)[0]!;
|
||||
this.baseDirID = f.id;
|
||||
this.vaultFolderExists = true;
|
||||
break;
|
||||
}
|
||||
|
||||
if ((itemsInRoot.offset ?? 0) >= (itemsInRoot.totalCount ?? 0)) {
|
||||
break;
|
||||
}
|
||||
|
||||
offset += limitPerPage;
|
||||
}
|
||||
|
||||
if (!this.vaultFolderExists) {
|
||||
// create
|
||||
const f = await client.folders.createFolder({
|
||||
name: this.remoteBaseDir,
|
||||
parent: { id: "0" },
|
||||
});
|
||||
this.baseDirID = f.id;
|
||||
this.vaultFolderExists = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async _getAccessToken() {
|
||||
if (this.boxConfig.refreshToken === "") {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
const ts = Date.now();
|
||||
const comp = this.boxConfig.accessTokenExpiresAtTimeMs > ts;
|
||||
// console.debug(`this.boxConfig.accessTokenExpiresAtTimeMs=${this.boxConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
|
||||
if (comp) {
|
||||
return this.boxConfig.accessToken;
|
||||
}
|
||||
|
||||
// refresh
|
||||
const k = await sendRefreshTokenReq(this.boxConfig.refreshToken);
|
||||
this.boxConfig.accessToken = k.access_token;
|
||||
this.boxConfig.accessTokenExpiresInMs = k.expires_in * 1000;
|
||||
this.boxConfig.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
this.boxConfig.refreshToken =
|
||||
k.refresh_token || this.boxConfig.refreshToken;
|
||||
await this.saveUpdatedConfigFunc();
|
||||
console.info("Box accessToken updated");
|
||||
return this.boxConfig.accessToken;
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const allFiles: BoxEntity[] = [];
|
||||
|
||||
// bfs
|
||||
const queue = new PQueue({
|
||||
concurrency: 5, // TODO: make it configurable?
|
||||
autoStart: true,
|
||||
});
|
||||
queue.on("error", (error) => {
|
||||
queue.pause();
|
||||
queue.clear();
|
||||
throw error;
|
||||
});
|
||||
|
||||
let parents = [
|
||||
{
|
||||
id: this.baseDirID, // special init, from already created root folder ID
|
||||
folderPath: "",
|
||||
},
|
||||
];
|
||||
|
||||
while (parents.length !== 0) {
|
||||
// console.debug('enter while loop 1 of parents array');
|
||||
const children: typeof parents = [];
|
||||
for (const { id, folderPath } of parents) {
|
||||
queue.add(async () => {
|
||||
const filesUnderFolder = await this._walkFolder(id, folderPath);
|
||||
for (const f of filesUnderFolder) {
|
||||
allFiles.push(f);
|
||||
if (f.isFolder) {
|
||||
// keyRaw itself already has a tailing slash, no more slash here
|
||||
// keyRaw itself also already has full path
|
||||
const child = {
|
||||
id: f.id,
|
||||
folderPath: f.keyRaw,
|
||||
};
|
||||
// console.debug(
|
||||
// `looping result of _walkFolder(${id},${folderPath}), adding child=${JSON.stringify(
|
||||
// child
|
||||
// )}`
|
||||
// );
|
||||
children.push(child);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
await queue.onIdle();
|
||||
parents = children;
|
||||
}
|
||||
|
||||
// console.debug(`in the end of walk:`);
|
||||
// console.debug(allFiles);
|
||||
// console.debug(this.keyToBoxEntity);
|
||||
return allFiles;
|
||||
}
|
||||
|
||||
async _walkFolder(
|
||||
parentID: string,
|
||||
parentFolderPath: string
|
||||
): Promise<BoxEntity[]> {
|
||||
// console.debug(
|
||||
// `input of single level: parentID=${parentID}, parentFolderPath=${parentFolderPath}`
|
||||
// );
|
||||
const filesOneLevel: BoxEntity[] = [];
|
||||
const access = await this._getAccessToken();
|
||||
const auth = new BoxDeveloperTokenAuth({ token: access });
|
||||
const client = new BoxClient({ auth });
|
||||
|
||||
if (parentID === undefined || parentID === "" || parentID === "root") {
|
||||
// we should never start from root
|
||||
// because we encapsulate the vault inside a folder
|
||||
throw Error(`something goes wrong walking folder`);
|
||||
}
|
||||
|
||||
let items: Items | undefined = undefined;
|
||||
|
||||
let offset = 0;
|
||||
const limitPerPage = 1000; // max 1000
|
||||
do {
|
||||
// console.debug(`entering paging of parentID=${parentID}, offset=${offset}`);
|
||||
items = await client.folders.getFolderItems(parentID, {
|
||||
queryParams: {
|
||||
fields: [
|
||||
"id",
|
||||
"type",
|
||||
"name",
|
||||
"sha1",
|
||||
"size",
|
||||
"created_at",
|
||||
"modified_at",
|
||||
"expires_at",
|
||||
"parent",
|
||||
"content_created_at",
|
||||
"content_modified_at",
|
||||
"etag",
|
||||
],
|
||||
offset: offset,
|
||||
limit: limitPerPage,
|
||||
},
|
||||
});
|
||||
// console.debug(`items of parentID=${parentID},offset=${offset}:`);
|
||||
// console.debug(items);
|
||||
|
||||
for (const item of items.entries ?? []) {
|
||||
const entity = fromBoxItemToEntity(item, parentID, parentFolderPath);
|
||||
this.keyToBoxEntity[entity.keyRaw] = entity; // build cache
|
||||
filesOneLevel.push(entity);
|
||||
}
|
||||
|
||||
offset += limitPerPage;
|
||||
// console.debug(`end of current loop parentID=${parentID}, and offset=${offset}`);
|
||||
} while (offset < (items?.totalCount ?? 0));
|
||||
|
||||
return filesOneLevel;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const filesInLevel = await this._walkFolder(this.baseDirID, "");
|
||||
return filesInLevel;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
|
||||
// TODO: we already have a cache, should we call again?
|
||||
const cachedEntity = this.keyToBoxEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const access = await this._getAccessToken();
|
||||
const auth = new BoxDeveloperTokenAuth({ token: access });
|
||||
const client = new BoxClient({ auth });
|
||||
|
||||
let f: FileFull | FolderFull | undefined;
|
||||
if (cachedEntity.isFolder) {
|
||||
f = await client.folders.getFolderById(fileID);
|
||||
} else {
|
||||
f = await client.files.getFileById(fileID);
|
||||
}
|
||||
const entity = fromBoxItemToEntity(
|
||||
f,
|
||||
cachedEntity.parentID!,
|
||||
cachedEntity.parentIDPath!
|
||||
);
|
||||
// insert back to cache?? to update it??
|
||||
this.keyToBoxEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime?: number | undefined,
|
||||
ctime?: number | undefined
|
||||
): Promise<Entity> {
|
||||
if (!key.endsWith("/")) {
|
||||
throw Error(`you should not mkdir on key=${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const cachedEntity = this.keyToBoxEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity !== undefined && fileID !== undefined) {
|
||||
return cachedEntity;
|
||||
}
|
||||
|
||||
// xxx/ => ["xxx"]
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
let parentID: string | undefined = undefined;
|
||||
if (folderLevels.length === 0) {
|
||||
throw Error(`cannot getFolderLevels of ${key}`);
|
||||
} else if (folderLevels.length === 1) {
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = ""; // ignore base dir
|
||||
} else {
|
||||
// length > 1
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
|
||||
if (!(parentFolderPath in this.keyToBoxEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToBoxEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
|
||||
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
|
||||
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
|
||||
|
||||
const access = await this._getAccessToken();
|
||||
const auth = new BoxDeveloperTokenAuth({ token: access });
|
||||
const client = new BoxClient({ auth });
|
||||
const f = await client.folders.createFolder({
|
||||
name: folderItselfWithoutSlash,
|
||||
parent: { id: parentID },
|
||||
});
|
||||
|
||||
const entity = fromBoxItemToEntity(f, parentID, parentFolderPath);
|
||||
// insert into cache
|
||||
this.keyToBoxEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`should not call writeFile on ${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const prevCachedEntity: BoxEntity | undefined = this.keyToBoxEntity[key];
|
||||
const prevFileID: string | undefined = prevCachedEntity?.id;
|
||||
|
||||
const contentType =
|
||||
mime.contentType(mime.lookup(key) || DEFAULT_CONTENT_TYPE) ||
|
||||
DEFAULT_CONTENT_TYPE;
|
||||
|
||||
let parentID: string | undefined = undefined;
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
|
||||
// "xxx" => []
|
||||
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
if (folderLevels.length === 0) {
|
||||
// root
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = "";
|
||||
} else {
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
|
||||
if (!(parentFolderPath in this.keyToBoxEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToBoxEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
const fileItself = key.split("/").pop()!;
|
||||
|
||||
const BIG_FILE_THRESHOLD = 20000000; // box api hard coded...
|
||||
if (content.byteLength <= BIG_FILE_THRESHOLD) {
|
||||
const formData = new FormData();
|
||||
const attributes = {
|
||||
name: fileItself,
|
||||
parent: { id: parentID },
|
||||
content_created_at: unixTimeToStr(ctime),
|
||||
content_modified_at: unixTimeToStr(mtime),
|
||||
};
|
||||
formData.append("attributes", JSON.stringify(attributes));
|
||||
formData.append("file", new Blob([content], { type: contentType }));
|
||||
|
||||
let url = "";
|
||||
if (prevFileID === undefined) {
|
||||
// create new file
|
||||
// https://developer.box.com/reference/post-files-content/
|
||||
url = `https://upload.box.com/api/2.0/files/content`;
|
||||
} else {
|
||||
// update new file
|
||||
// https://developer.box.com/reference/post-files-id-content/
|
||||
url = `https://upload.box.com/api/2.0/files/${prevFileID}/content`;
|
||||
}
|
||||
|
||||
const res = await fetch(url, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
body: formData,
|
||||
});
|
||||
|
||||
if (res.status !== 200 && res.status !== 201) {
|
||||
throw Error(
|
||||
`create file ${key} failed! attributes=${JSON.stringify(attributes)}`
|
||||
);
|
||||
}
|
||||
|
||||
const res2 = await res.json();
|
||||
if (res2.entries === undefined) {
|
||||
throw Error(`upload small file ${key} failed!`);
|
||||
}
|
||||
const entity = fromRawResponseToEntity(
|
||||
res2.entries[0],
|
||||
parentID,
|
||||
parentFolderPath
|
||||
);
|
||||
this.keyToBoxEntity[key] = entity;
|
||||
// console.debug(`entity after upload=${JSON.stringify(entity, null, 2)}`);
|
||||
return entity;
|
||||
} else {
|
||||
// create session
|
||||
|
||||
let url = "";
|
||||
if (prevFileID === undefined) {
|
||||
// https://developer.box.com/reference/post-files-upload-sessions/
|
||||
url = "https://upload.box.com/api/2.0/files/upload_sessions";
|
||||
} else {
|
||||
// https://developer.box.com/reference/post-files-id-upload-sessions/
|
||||
url = `https://upload.box.com/api/2.0/files/${prevFileID}/upload_sessions`;
|
||||
}
|
||||
|
||||
const sessionRes1 = await fetch(url, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
body: JSON.stringify({
|
||||
file_name: fileItself,
|
||||
file_size: content.byteLength,
|
||||
folder_id: parentID,
|
||||
}),
|
||||
});
|
||||
if (sessionRes1.status !== 200 && sessionRes1.status !== 201) {
|
||||
throw Error(
|
||||
`Create upload session for ${key} failed! Response header=${JSON.stringify(
|
||||
sessionRes1.headers
|
||||
)}`
|
||||
);
|
||||
}
|
||||
const sessionRes2: CreateUploadSessionRawResponse =
|
||||
await sessionRes1.json();
|
||||
// console.debug(sessionRes2);
|
||||
|
||||
// upload by chunks
|
||||
const sizePerChunk = sessionRes2.part_size;
|
||||
const chunkRanges = splitFileSizeToChunkRanges(
|
||||
content.byteLength,
|
||||
sizePerChunk
|
||||
);
|
||||
// TODO: parallel
|
||||
const partsResult: UploadChunkRawResponse[] = [];
|
||||
for (const { start, end } of chunkRanges) {
|
||||
const subContent = content.slice(start, end + 1);
|
||||
const sha1 = await getSha1(subContent, "base64");
|
||||
const res = await fetch(sessionRes2.session_endpoints.upload_part, {
|
||||
method: "PUT",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
// "Content-Length": `${end - start + 1}`, // the number of bytes in the current chunk
|
||||
"Content-Range": `bytes ${start}-${end}/${content.byteLength}`,
|
||||
"Content-Type": "application/octet-stream",
|
||||
digest: `sha=${sha1}`,
|
||||
},
|
||||
body: subContent,
|
||||
});
|
||||
if (res.status !== 200 && res.status !== 201) {
|
||||
throw Error(
|
||||
`Upload chunk for ${key}, ${start}-${end} failed! Response header=${JSON.stringify(
|
||||
res.headers
|
||||
)}`
|
||||
);
|
||||
}
|
||||
|
||||
partsResult.push((await res.json()) as UploadChunkRawResponse);
|
||||
}
|
||||
// commit?
|
||||
const sha1 = await getSha1(content, "base64");
|
||||
let status = 202;
|
||||
let tries = 0;
|
||||
do {
|
||||
// console.debug(`begin commit key=${key} for tries=${tries}`)
|
||||
const commitRes1 = await fetch(sessionRes2.session_endpoints.commit, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
|
||||
"Content-Type": "application/json",
|
||||
digest: `sha=${sha1}`,
|
||||
},
|
||||
body: JSON.stringify({
|
||||
parts: partsResult.map((p) => p.part),
|
||||
attributes: {
|
||||
content_modified_at: unixTimeToStr(mtime, false),
|
||||
content_created_at: unixTimeToStr(ctime, false),
|
||||
},
|
||||
}),
|
||||
});
|
||||
status = commitRes1.status;
|
||||
// console.debug(`status===${status} for tries=${tries},key=${key}`)
|
||||
if (status === 200 || status === 201) {
|
||||
const commitRes2 = await commitRes1.json();
|
||||
if (commitRes2.entries === undefined) {
|
||||
throw Error(`Upload big file ${key} failed!`);
|
||||
}
|
||||
const entity = fromRawResponseToEntity(
|
||||
commitRes2.entries[0],
|
||||
parentID,
|
||||
parentFolderPath
|
||||
);
|
||||
this.keyToBoxEntity[key] = entity;
|
||||
// console.debug(
|
||||
// `entity after upload=${JSON.stringify(entity, null, 2)}`
|
||||
// );
|
||||
return entity;
|
||||
} else if (status === 202) {
|
||||
await delay(500);
|
||||
tries += 1;
|
||||
} else {
|
||||
throw Error(
|
||||
`Commit all chunks for ${key} failed! Response header=${JSON.stringify(
|
||||
commitRes1.headers
|
||||
)}`
|
||||
);
|
||||
}
|
||||
// console.debug(`end commit key=${key}, currently status===${status}, tries===${tries} for next loop`)
|
||||
} while (status === 202 && tries < 4);
|
||||
throw Error(`Commit all chunks for ${key} failed! No idea what happened`);
|
||||
}
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
await this._init();
|
||||
|
||||
const cachedEntity = this.keyToBoxEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const res1 = await fetch(
|
||||
`https://api.box.com/2.0/files/${fileID}/content`,
|
||||
{
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
}
|
||||
);
|
||||
if (res1.status !== 200) {
|
||||
throw Error(
|
||||
`Cannot download file ${key} with id ${fileID}. Response header=${JSON.stringify(
|
||||
res1.headers
|
||||
)}`
|
||||
);
|
||||
}
|
||||
const res2 = await res1.arrayBuffer();
|
||||
return res2;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
await this._init();
|
||||
|
||||
const cachedEntity = this.keyToBoxEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const access = await this._getAccessToken();
|
||||
const auth = new BoxDeveloperTokenAuth({ token: access });
|
||||
const client = new BoxClient({ auth });
|
||||
|
||||
if (cachedEntity.isFolder) {
|
||||
await client.folders.deleteFolderById(fileID, {
|
||||
queryParams: { recursive: true },
|
||||
});
|
||||
} else {
|
||||
await client.files.deleteFileById(fileID);
|
||||
}
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developer.box.com/guides/authentication/tokens/revoke/
|
||||
*/
|
||||
async revokeAuth(): Promise<any> {
|
||||
await fetch(`https://api.box.com/oauth2/revoke`, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: BOX_CLIENT_ID ?? "",
|
||||
client_secret: BOX_CLIENT_SECRET ?? "",
|
||||
token: this.boxConfig.refreshToken,
|
||||
}).toString(),
|
||||
});
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,766 @@
|
||||
// https://developers.google.com/identity/protocols/oauth2/native-app
|
||||
// https://developers.google.com/identity/protocols/oauth2/javascript-implicit-flow
|
||||
// https://developers.google.com/identity/protocols/oauth2/web-server
|
||||
|
||||
import { entries } from "lodash";
|
||||
import * as mime from "mime-types";
|
||||
import { requestUrl } from "obsidian";
|
||||
import PQueue from "p-queue";
|
||||
import { DEFAULT_CONTENT_TYPE, type Entity } from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import {
|
||||
getFolderLevels,
|
||||
splitFileSizeToChunkRanges,
|
||||
unixTimeToStr,
|
||||
} from "../../src/misc";
|
||||
import {
|
||||
GOOGLEDRIVE_CLIENT_ID,
|
||||
GOOGLEDRIVE_CLIENT_SECRET,
|
||||
type GoogleDriveConfig,
|
||||
} from "./baseTypesPro";
|
||||
|
||||
export const DEFAULT_GOOGLEDRIVE_CONFIG: GoogleDriveConfig = {
|
||||
accessToken: "",
|
||||
refreshToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
credentialsShouldBeDeletedAtTimeMs: 0,
|
||||
scope: "https://www.googleapis.com/auth/drive.file",
|
||||
kind: "googledrive",
|
||||
};
|
||||
|
||||
const FOLDER_MIME_TYPE = "application/vnd.google-apps.folder";
|
||||
|
||||
/**
|
||||
* A simplified version of the type
|
||||
*
|
||||
*/
|
||||
interface File {
|
||||
kind?: string;
|
||||
driveId?: string;
|
||||
fileExtension?: string;
|
||||
copyRequiresWriterPermission?: boolean;
|
||||
md5Checksum?: string;
|
||||
writersCanShare?: boolean;
|
||||
viewedByMe?: boolean;
|
||||
mimeType?: string;
|
||||
parents?: string[];
|
||||
thumbnailLink?: string;
|
||||
iconLink?: string;
|
||||
shared?: boolean;
|
||||
headRevisionId?: string;
|
||||
webViewLink?: string;
|
||||
webContentLink?: string;
|
||||
size?: string;
|
||||
viewersCanCopyContent?: boolean;
|
||||
hasThumbnail?: boolean;
|
||||
spaces?: string[];
|
||||
folderColorRgb?: string;
|
||||
id?: string;
|
||||
name?: string;
|
||||
description?: string;
|
||||
starred?: boolean;
|
||||
trashed?: boolean;
|
||||
explicitlyTrashed?: boolean;
|
||||
createdTime?: string;
|
||||
modifiedTime?: string;
|
||||
modifiedByMeTime?: string;
|
||||
viewedByMeTime?: string;
|
||||
sharedWithMeTime?: string;
|
||||
quotaBytesUsed?: string;
|
||||
version?: string;
|
||||
originalFilename?: string;
|
||||
ownedByMe?: boolean;
|
||||
fullFileExtension?: string;
|
||||
isAppAuthorized?: boolean;
|
||||
teamDriveId?: string;
|
||||
hasAugmentedPermissions?: boolean;
|
||||
thumbnailVersion?: string;
|
||||
trashedTime?: string;
|
||||
modifiedByMe?: boolean;
|
||||
permissionIds?: string[];
|
||||
resourceKey?: string;
|
||||
sha1Checksum?: string;
|
||||
sha256Checksum?: string;
|
||||
}
|
||||
|
||||
interface GDEntity extends Entity {
|
||||
id: string;
|
||||
parentID: string | undefined;
|
||||
parentIDPath: string | undefined;
|
||||
isFolder: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/identity/protocols/oauth2/web-server#httprest_7
|
||||
* @param refreshToken
|
||||
*/
|
||||
export const sendRefreshTokenReq = async (refreshToken: string) => {
|
||||
console.debug(`refreshing token`);
|
||||
const x = await fetch("https://oauth2.googleapis.com/token", {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: GOOGLEDRIVE_CLIENT_ID ?? "",
|
||||
client_secret: GOOGLEDRIVE_CLIENT_SECRET ?? "",
|
||||
grant_type: "refresh_token",
|
||||
refresh_token: refreshToken,
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
if (x.status === 200) {
|
||||
const y = await x.json();
|
||||
console.debug(`new token obtained`);
|
||||
return y;
|
||||
} else {
|
||||
throw Error(`cannot refresh an access token`);
|
||||
}
|
||||
|
||||
// {
|
||||
// "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
|
||||
// "expires_in": 3920,
|
||||
// "scope": "https://www.googleapis.com/auth/drive.file",
|
||||
// "token_type": "Bearer"
|
||||
// }
|
||||
};
|
||||
|
||||
const fromFileToGDEntity = (
|
||||
file: File,
|
||||
parentID: string,
|
||||
parentFolderPath: string | undefined /* for bfs */
|
||||
) => {
|
||||
if (parentID === undefined || parentID === "" || parentID === "root") {
|
||||
throw Error(`parentID=${parentID} should not be in fromFileToGDEntity`);
|
||||
}
|
||||
|
||||
let keyRaw = file.name!;
|
||||
if (
|
||||
parentFolderPath !== undefined &&
|
||||
parentFolderPath !== "" &&
|
||||
parentFolderPath !== "/"
|
||||
) {
|
||||
if (!parentFolderPath.endsWith("/")) {
|
||||
throw Error(
|
||||
`parentFolderPath=${parentFolderPath} should not be in fromFileToGDEntity`
|
||||
);
|
||||
}
|
||||
keyRaw = `${parentFolderPath}${file.name}`;
|
||||
}
|
||||
const isFolder = file.mimeType === FOLDER_MIME_TYPE;
|
||||
if (isFolder) {
|
||||
keyRaw = `${keyRaw}/`;
|
||||
}
|
||||
|
||||
return {
|
||||
key: keyRaw,
|
||||
keyRaw: keyRaw,
|
||||
mtimeCli: Date.parse(file.modifiedTime!),
|
||||
mtimeSvr: Date.parse(file.modifiedTime!),
|
||||
size: isFolder ? 0 : Number.parseInt(file.size!),
|
||||
sizeRaw: isFolder ? 0 : Number.parseInt(file.size!),
|
||||
hash: isFolder ? undefined : file.md5Checksum!,
|
||||
id: file.id!,
|
||||
parentID: parentID,
|
||||
isFolder: isFolder,
|
||||
} as GDEntity;
|
||||
};
|
||||
|
||||
export class FakeFsGoogleDrive extends FakeFs {
|
||||
kind: string;
|
||||
googleDriveConfig: GoogleDriveConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
keyToGDEntity: Record<string, GDEntity>;
|
||||
|
||||
baseDirID: string;
|
||||
|
||||
constructor(
|
||||
googleDriveConfig: GoogleDriveConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "googledrive";
|
||||
this.googleDriveConfig = googleDriveConfig;
|
||||
this.remoteBaseDir =
|
||||
this.googleDriveConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
this.keyToGDEntity = {};
|
||||
this.baseDirID = "";
|
||||
}
|
||||
|
||||
async _init() {
|
||||
// get accessToken
|
||||
await this._getAccessToken();
|
||||
|
||||
// check vault folder exists
|
||||
if (this.vaultFolderExists) {
|
||||
// pass
|
||||
} else {
|
||||
const q = encodeURIComponent(
|
||||
`name='${this.remoteBaseDir}' and mimeType='application/vnd.google-apps.folder' and trashed=false`
|
||||
);
|
||||
const url: string = `https://www.googleapis.com/drive/v3/files?q=${q}&pageSize=1000&fields=kind,nextPageToken,files(kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum)`;
|
||||
const k = await fetch(url, {
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
|
||||
const k1: { files: File[] } = await k.json();
|
||||
// console.debug(k1);
|
||||
if (k1.files.length > 0) {
|
||||
// yeah we find it
|
||||
this.baseDirID = k1.files[0].id!;
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
// wait, we need to create the folder!
|
||||
console.debug(`we need to create the base dir ${this.remoteBaseDir}`);
|
||||
const meta: any = {
|
||||
mimeType: FOLDER_MIME_TYPE,
|
||||
name: this.remoteBaseDir,
|
||||
};
|
||||
const res = await fetch("https://www.googleapis.com/drive/v3/files", {
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
body: JSON.stringify(meta),
|
||||
});
|
||||
const res2: File = await res.json();
|
||||
if (res.status === 200) {
|
||||
console.debug(`succeed to create the base dir ${this.remoteBaseDir}`);
|
||||
this.baseDirID = res2.id!;
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
throw Error(
|
||||
`cannot create base dir ${this.remoteBaseDir} in init func.`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async _getAccessToken() {
|
||||
if (
|
||||
this.googleDriveConfig.accessToken === "" ||
|
||||
this.googleDriveConfig.refreshToken === ""
|
||||
) {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
const ts = Date.now();
|
||||
if (this.googleDriveConfig.accessTokenExpiresAtTimeMs > ts) {
|
||||
return this.googleDriveConfig.accessToken;
|
||||
}
|
||||
// refresh
|
||||
const k = await sendRefreshTokenReq(this.googleDriveConfig.refreshToken);
|
||||
this.googleDriveConfig.accessToken = k.access_token;
|
||||
this.googleDriveConfig.accessTokenExpiresInMs = k.expires_in * 1000;
|
||||
this.googleDriveConfig.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
await this.saveUpdatedConfigFunc();
|
||||
console.info("Google Drive accessToken updated");
|
||||
return this.googleDriveConfig.accessToken;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/reference/rest/v3/files/list
|
||||
*/
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const allFiles: GDEntity[] = [];
|
||||
|
||||
// bfs
|
||||
const queue = new PQueue({
|
||||
concurrency: 5, // TODO: make it configurable?
|
||||
autoStart: true,
|
||||
});
|
||||
queue.on("error", (error) => {
|
||||
queue.pause();
|
||||
queue.clear();
|
||||
throw error;
|
||||
});
|
||||
|
||||
let parents = [
|
||||
{
|
||||
id: this.baseDirID, // special init, from already created root folder ID
|
||||
folderPath: "",
|
||||
},
|
||||
];
|
||||
while (parents.length !== 0) {
|
||||
const children: typeof parents = [];
|
||||
for (const { id, folderPath } of parents) {
|
||||
queue.add(async () => {
|
||||
const filesUnderFolder = await this._walkFolder(id, folderPath);
|
||||
for (const f of filesUnderFolder) {
|
||||
allFiles.push(f);
|
||||
if (f.isFolder) {
|
||||
// keyRaw itself already has a tailing slash, no more slash here
|
||||
// keyRaw itself also already has full path
|
||||
const child = {
|
||||
id: f.id,
|
||||
folderPath: f.keyRaw,
|
||||
};
|
||||
// console.debug(
|
||||
// `looping result of _walkFolder(${id},${folderPath}), adding child=${JSON.stringify(
|
||||
// child
|
||||
// )}`
|
||||
// );
|
||||
children.push(child);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
await queue.onIdle();
|
||||
parents = children;
|
||||
}
|
||||
|
||||
// console.debug(`in the end of walk:`);
|
||||
// console.debug(allFiles);
|
||||
// console.debug(this.keyToGDEntity);
|
||||
return allFiles;
|
||||
}
|
||||
|
||||
async _walkFolder(parentID: string, parentFolderPath: string) {
|
||||
// console.debug(
|
||||
// `input of single level: parentID=${parentID}, parentFolderPath=${parentFolderPath}`
|
||||
// );
|
||||
const filesOneLevel: GDEntity[] = [];
|
||||
let nextPageToken: string | undefined = undefined;
|
||||
if (parentID === undefined || parentID === "" || parentID === "root") {
|
||||
// we should never start from root
|
||||
// because we encapsulate the vault inside a folder
|
||||
throw Error(`something goes wrong walking folder`);
|
||||
}
|
||||
do {
|
||||
const q = encodeURIComponent(
|
||||
`'${parentID}' in parents and trashed=false`
|
||||
);
|
||||
const pageToken =
|
||||
nextPageToken !== undefined ? `&pageToken=${nextPageToken}` : "";
|
||||
|
||||
const url: string = `https://www.googleapis.com/drive/v3/files?q=${q}&pageSize=1000&fields=kind,nextPageToken,files(kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum)${pageToken}`;
|
||||
|
||||
const k = await fetch(url, {
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
if (k.status !== 200) {
|
||||
throw Error(`cannot walk for parentID=${parentID}`);
|
||||
}
|
||||
|
||||
const k1 = await k.json();
|
||||
// console.debug(k1);
|
||||
for (const file of k1.files as File[]) {
|
||||
const entity = fromFileToGDEntity(file, parentID, parentFolderPath);
|
||||
this.keyToGDEntity[entity.keyRaw] = entity; // build cache
|
||||
filesOneLevel.push(entity);
|
||||
}
|
||||
|
||||
nextPageToken = k1.nextPageToken;
|
||||
} while (nextPageToken !== undefined);
|
||||
|
||||
// console.debug(filesOneLevel);
|
||||
|
||||
return filesOneLevel;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const filesInLevel = await this._walkFolder(this.baseDirID, "");
|
||||
return filesInLevel;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/reference/rest/v3/files/get
|
||||
* https://developers.google.com/drive/api/guides/fields-parameter
|
||||
*/
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
|
||||
// TODO: we already have a cache, should we call again?
|
||||
const cachedEntity = this.keyToGDEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const url: string = `https://www.googleapis.com/drive/v3/files/${fileID}?fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum`;
|
||||
|
||||
const k = await fetch(url, {
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
if (k.status !== 200) {
|
||||
throw Error(`cannot get file meta fileID=${fileID}, key=${key}`);
|
||||
}
|
||||
const k1: File = await k.json();
|
||||
const entity = fromFileToGDEntity(
|
||||
k1,
|
||||
cachedEntity.parentID!,
|
||||
cachedEntity.parentIDPath!
|
||||
);
|
||||
// insert back to cache?? to update it??
|
||||
this.keyToGDEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/guides/folder
|
||||
*/
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime: number | undefined,
|
||||
ctime: number | undefined
|
||||
): Promise<Entity> {
|
||||
if (!key.endsWith("/")) {
|
||||
throw Error(`you should not mkdir on key=${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
// xxx/ => ["xxx"]
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
let parentID: string | undefined = undefined;
|
||||
if (folderLevels.length === 0) {
|
||||
throw Error(`cannot getFolderLevels of ${key}`);
|
||||
} else if (folderLevels.length === 1) {
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = ""; // ignore base dir
|
||||
} else {
|
||||
// length > 1
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
|
||||
if (!(parentFolderPath in this.keyToGDEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToGDEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
|
||||
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
|
||||
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
|
||||
|
||||
const meta: any = {
|
||||
mimeType: FOLDER_MIME_TYPE,
|
||||
modifiedTime: unixTimeToStr(mtime, true),
|
||||
createdTime: unixTimeToStr(ctime, true),
|
||||
name: folderItselfWithoutSlash,
|
||||
parents: [parentID],
|
||||
};
|
||||
const res = await fetch("https://www.googleapis.com/drive/v3/files", {
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
body: JSON.stringify(meta),
|
||||
});
|
||||
if (res.status !== 200 && res.status !== 201) {
|
||||
throw Error(`create folder ${key} failed! meta=${JSON.stringify(meta)}`);
|
||||
}
|
||||
const res2: File = await res.json();
|
||||
// console.debug(res2);
|
||||
const entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
|
||||
// insert into cache
|
||||
this.keyToGDEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/guides/manage-uploads
|
||||
* https://stackoverflow.com/questions/65181932/how-i-can-upload-file-to-google-drive-with-google-drive-api
|
||||
*/
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`should not call writeFile on ${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const contentType =
|
||||
mime.contentType(mime.lookup(key) || DEFAULT_CONTENT_TYPE) ||
|
||||
DEFAULT_CONTENT_TYPE;
|
||||
|
||||
let parentID: string | undefined = undefined;
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
|
||||
// "xxx" => []
|
||||
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
if (folderLevels.length === 0) {
|
||||
// root
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = "";
|
||||
} else {
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
|
||||
if (!(parentFolderPath in this.keyToGDEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToGDEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
const fileItself = key.split("/").pop()!;
|
||||
|
||||
if (content.byteLength <= 5 * 1024 * 1024) {
|
||||
const formData = new FormData();
|
||||
const meta: any = {
|
||||
name: fileItself,
|
||||
modifiedTime: unixTimeToStr(mtime, true),
|
||||
createdTime: unixTimeToStr(ctime, true),
|
||||
parents: [parentID],
|
||||
};
|
||||
formData.append(
|
||||
"metadata",
|
||||
new Blob([JSON.stringify(meta)], {
|
||||
type: "application/json; charset=UTF-8",
|
||||
})
|
||||
);
|
||||
formData.append("media", new Blob([content], { type: contentType }));
|
||||
|
||||
const res = await fetch(
|
||||
"https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart&fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum",
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
body: formData,
|
||||
}
|
||||
);
|
||||
if (res.status !== 200 && res.status !== 201) {
|
||||
throw Error(`create file ${key} failed! meta=${JSON.stringify(meta)}`);
|
||||
}
|
||||
const res2: File = await res.json();
|
||||
console.debug(
|
||||
`upload ${key} with ${JSON.stringify(meta)}, res2=${JSON.stringify(
|
||||
res2
|
||||
)}`
|
||||
);
|
||||
const entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
|
||||
// insert into cache
|
||||
this.keyToGDEntity[key] = entity;
|
||||
return entity;
|
||||
} else {
|
||||
const meta: any = {
|
||||
name: fileItself,
|
||||
modifiedTime: unixTimeToStr(mtime, true),
|
||||
createdTime: unixTimeToStr(ctime, true),
|
||||
parents: [parentID],
|
||||
};
|
||||
const bodyStr = JSON.stringify(meta);
|
||||
const headers: HeadersInit = {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
"Content-Type": "application/json",
|
||||
"Content-Length": `${bodyStr.length}`,
|
||||
"X-Upload-Content-Type": contentType,
|
||||
"X-Upload-Content-Length": `${content.byteLength}`,
|
||||
};
|
||||
const res = await fetch(
|
||||
"https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&fields=kind,fileExtension,md5Checksum,mimeType,parents,size,spaces,id,name,trashed,createdTime,modifiedTime,quotaBytesUsed,originalFilename,fullFileExtension,sha1Checksum,sha256Checksum",
|
||||
{
|
||||
method: "POST",
|
||||
headers: headers,
|
||||
body: bodyStr,
|
||||
}
|
||||
);
|
||||
if (res.status !== 200) {
|
||||
throw Error(
|
||||
`create resumable file ${key} failed! meta=${JSON.stringify(
|
||||
meta
|
||||
)}, header=${JSON.stringify(headers)}`
|
||||
);
|
||||
}
|
||||
const uploadLocation = res.headers.get("Location");
|
||||
if (uploadLocation === null || !uploadLocation.startsWith("http")) {
|
||||
throw Error(
|
||||
`create resumable file ${key} failed! meta=${JSON.stringify(
|
||||
meta
|
||||
)}, header=${JSON.stringify(headers)}`
|
||||
);
|
||||
}
|
||||
console.debug(`key=${key}, uploadLocaltion=${uploadLocation}`);
|
||||
|
||||
// multiples of 256 KB (256 x 1024 bytes) in size
|
||||
const sizePerChunk = 5 * 4 * 256 * 1024; // 5.24 mb
|
||||
const chunkRanges = splitFileSizeToChunkRanges(
|
||||
content.byteLength,
|
||||
sizePerChunk
|
||||
);
|
||||
|
||||
let entity: GDEntity | undefined = undefined;
|
||||
|
||||
// TODO: deal with "Resume an interrupted upload"
|
||||
// currently (202405) only assume everything goes well...
|
||||
// TODO: parallel
|
||||
for (const { start, end } of chunkRanges) {
|
||||
console.debug(
|
||||
`key=${key}, start upload chunk ${start}-${end}/${content.byteLength}`
|
||||
);
|
||||
const res = await fetch(uploadLocation, {
|
||||
method: "PUT",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
"Content-Length": `${end - start + 1}`, // the number of bytes in the current chunk
|
||||
"Content-Range": `bytes ${start}-${end}/${content.byteLength}`,
|
||||
},
|
||||
body: content.slice(start, end + 1), // TODO: slice() is a copy, may be we can optimize it
|
||||
});
|
||||
if (res.status >= 400 && res.status <= 599) {
|
||||
throw Error(
|
||||
`create resumable file ${key} failed! meta=${JSON.stringify(
|
||||
meta
|
||||
)}, header=${JSON.stringify(headers)}`
|
||||
);
|
||||
}
|
||||
|
||||
if (res.status === 200 || res.status === 201) {
|
||||
const res2: File = await res.json();
|
||||
console.debug(
|
||||
`upload ${key} with ${JSON.stringify(meta)}, res2=${JSON.stringify(
|
||||
res2
|
||||
)}`
|
||||
);
|
||||
if (res2.id === undefined || res2.id === null || res2.id === "") {
|
||||
// TODO: what's this??
|
||||
} else {
|
||||
entity = fromFileToGDEntity(res2, parentID, parentFolderPath);
|
||||
// insert into cache
|
||||
this.keyToGDEntity[key] = entity;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (entity === undefined) {
|
||||
throw Error(`something goes wrong while uploading large file ${key}`);
|
||||
}
|
||||
return entity;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/reference/rest/v3/files/get
|
||||
*/
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`you should not call readFile on ${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const fileID = this.keyToGDEntity[key]?.id;
|
||||
if (fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const res1 = await fetch(
|
||||
`https://www.googleapis.com/drive/v3/files/${fileID}?alt=media`,
|
||||
{
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
}
|
||||
);
|
||||
if (res1.status !== 200) {
|
||||
throw Error(`cannot download ${key} using fileID=${fileID}`);
|
||||
}
|
||||
const res2 = await res1.arrayBuffer();
|
||||
return res2;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/drive/api/guides/delete
|
||||
* https://developers.google.com/drive/api/reference/rest/v3/files/update
|
||||
*/
|
||||
async rm(key: string): Promise<void> {
|
||||
await this._init();
|
||||
|
||||
const fileID = this.keyToGDEntity[key]?.id;
|
||||
if (fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const res1 = await fetch(
|
||||
`https://www.googleapis.com/drive/v3/files/${fileID}`,
|
||||
{
|
||||
method: "PATCH",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this._getAccessToken()}`,
|
||||
},
|
||||
body: JSON.stringify({
|
||||
trashed: true,
|
||||
}),
|
||||
}
|
||||
);
|
||||
if (res1.status !== 200) {
|
||||
throw Error(`cannot rm ${key} using fileID=${fileID}`);
|
||||
}
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
/**
|
||||
* https://developers.google.com/identity/protocols/oauth2/web-server#tokenrevoke
|
||||
*/
|
||||
async revokeAuth(): Promise<any> {
|
||||
const x = await fetch(
|
||||
`https://oauth2.googleapis.com/revoke?token=${this._getAccessToken()}`,
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
}
|
||||
);
|
||||
if (x.status === 200) {
|
||||
return true;
|
||||
} else {
|
||||
throw Error(`cannot revoke`);
|
||||
}
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,577 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import createClient, { type Middleware } from "openapi-fetch";
|
||||
import { base64 } from "rfc4648";
|
||||
import type { Entity } from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import { getParentFolder } from "../../src/misc";
|
||||
import {
|
||||
COMMAND_CALLBACK_KOOFR,
|
||||
KOOFR_CLIENT_ID,
|
||||
KOOFR_CLIENT_SECRET,
|
||||
type KoofrConfig,
|
||||
} from "./baseTypesPro";
|
||||
import type { paths } from "./koofrApi";
|
||||
import type { components } from "./koofrApi";
|
||||
|
||||
type FilesListRecursiveItem = components["schemas"]["FilesListRecursiveItem"];
|
||||
type FilesFile = components["schemas"]["FilesFile"];
|
||||
|
||||
export const DEFAULT_KOOFR_CONFIG: KoofrConfig = {
|
||||
accessToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
refreshToken: "",
|
||||
remoteBaseDir: "",
|
||||
credentialsShouldBeDeletedAtTimeMs: 0,
|
||||
scope: "",
|
||||
api: "https://app.koofr.net",
|
||||
mountID: "",
|
||||
kind: "koofr",
|
||||
};
|
||||
|
||||
/**
|
||||
* https://app.koofr.net/developers
|
||||
*/
|
||||
export const generateAuthUrl = (apiAddr: string, hasCallback: boolean) => {
|
||||
let callback = `urn:ietf:wg:oauth:2.0:oob`;
|
||||
if (hasCallback) {
|
||||
callback = `obsidian://${COMMAND_CALLBACK_KOOFR}`;
|
||||
}
|
||||
|
||||
const params = new URLSearchParams({
|
||||
response_type: "code",
|
||||
client_id: KOOFR_CLIENT_ID ?? "",
|
||||
redirect_uri: callback,
|
||||
scope: "public",
|
||||
state: nanoid(),
|
||||
});
|
||||
|
||||
const url = `${apiAddr}/oauth2/auth?${params}`;
|
||||
return url;
|
||||
};
|
||||
|
||||
interface AuthResSucc {
|
||||
token_type: "Bearer";
|
||||
access_token: string;
|
||||
expires_in: number;
|
||||
refresh_token: string;
|
||||
scope: string | undefined;
|
||||
}
|
||||
|
||||
interface AuthResFail {
|
||||
error: string;
|
||||
error_description: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://app.koofr.net/developers
|
||||
*/
|
||||
export const sendAuthReq = async (
|
||||
apiAddr: string,
|
||||
authCode: string,
|
||||
errorCallBack: any,
|
||||
hasCallback: boolean
|
||||
) => {
|
||||
let callback = `urn:ietf:wg:oauth:2.0:oob`;
|
||||
if (hasCallback) {
|
||||
callback = `obsidian://${COMMAND_CALLBACK_KOOFR}`;
|
||||
}
|
||||
try {
|
||||
const k = {
|
||||
code: authCode,
|
||||
grant_type: "authorization_code",
|
||||
client_id: KOOFR_CLIENT_ID ?? "",
|
||||
client_secret: KOOFR_CLIENT_SECRET ?? "",
|
||||
redirect_uri: callback,
|
||||
};
|
||||
// console.debug(k);
|
||||
const resp1 = await fetch(`${apiAddr}/oauth2/token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams(k),
|
||||
});
|
||||
|
||||
if (resp1.status !== 200) {
|
||||
const resp2: AuthResFail = await resp1.json();
|
||||
throw Error(JSON.stringify(resp2));
|
||||
}
|
||||
|
||||
const resp2: AuthResSucc = await resp1.json();
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
if (errorCallBack !== undefined) {
|
||||
await errorCallBack(e);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
export const sendRefreshTokenReq = async (
|
||||
apiAddr: string,
|
||||
refreshToken: string
|
||||
) => {
|
||||
console.debug(`refreshing token`);
|
||||
const x = await fetch(`${apiAddr}/oauth2/token`, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: KOOFR_CLIENT_ID ?? "",
|
||||
client_secret: KOOFR_CLIENT_SECRET ?? "",
|
||||
grant_type: "refresh_token",
|
||||
refresh_token: refreshToken,
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
if (x.status === 200) {
|
||||
const y: AuthResSucc = await x.json();
|
||||
console.debug(`new token obtained`);
|
||||
return y;
|
||||
} else {
|
||||
const y: AuthResFail = await x.json();
|
||||
throw Error(`cannot refresh an access token: ${JSON.stringify(y)}`);
|
||||
}
|
||||
};
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: KoofrConfig,
|
||||
authRes: AuthResSucc,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresAtTimeMs =
|
||||
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
|
||||
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
|
||||
config.refreshToken = authRes.refresh_token || config.refreshToken;
|
||||
|
||||
config.scope = authRes.scope || config.scope;
|
||||
|
||||
// manually set it expired after 60 days;
|
||||
config.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + 1000 * 60 * 60 * 24 * 59;
|
||||
|
||||
await saveUpdatedConfigFunc?.();
|
||||
|
||||
console.info("finish updating local info of Koofr token");
|
||||
};
|
||||
|
||||
const getNormPathFromBasedir = (x: string, type: "dir" | "file") => {
|
||||
if (x === "/" || x === "") {
|
||||
throw Error(`do not know how to deal with path: ${x}`);
|
||||
}
|
||||
|
||||
if (!x.startsWith("/")) {
|
||||
throw Error(`path returned by koofr should starts with slash: ${x}`);
|
||||
}
|
||||
|
||||
if (type === "file") {
|
||||
return x.slice(1);
|
||||
} else if (type === "dir") {
|
||||
return `${x.slice(1)}/`;
|
||||
} else {
|
||||
throw Error(`do not know how to deal with path and type: ${x}, ${type}`);
|
||||
}
|
||||
};
|
||||
|
||||
const getKoofrPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
let key = fileOrFolderPath;
|
||||
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||
// special
|
||||
key = `/${remoteBaseDir}`;
|
||||
} else if (fileOrFolderPath.startsWith("/")) {
|
||||
console.warn(
|
||||
`why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
|
||||
);
|
||||
key = `/${remoteBaseDir}${fileOrFolderPath}`;
|
||||
} else {
|
||||
key = `/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||
}
|
||||
if (key.endsWith("/")) {
|
||||
key = key.slice(0, key.length - 1);
|
||||
}
|
||||
return key;
|
||||
};
|
||||
|
||||
const fromItemToEntity = (x: FilesListRecursiveItem): Entity => {
|
||||
if (x.type === "error") {
|
||||
throw Error(`cannot understand ${JSON.stringify(x)}`);
|
||||
}
|
||||
|
||||
const key = getNormPathFromBasedir(x.path ?? "/", x.file?.type as any);
|
||||
|
||||
if (x.file?.type === "dir" || x.file?.type === "file") {
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeCli: x.file.modified,
|
||||
mtimeSvr: x.file.modified,
|
||||
size: x.file.size,
|
||||
sizeRaw: x.file.size,
|
||||
hash: x.file.hash,
|
||||
} as Entity;
|
||||
} else {
|
||||
throw Error(`cannot understand ${JSON.stringify(x)}`);
|
||||
}
|
||||
};
|
||||
|
||||
const fromFileToEntity = (x: FilesFile, parentPath: string): Entity => {
|
||||
const key = getNormPathFromBasedir(`${parentPath}/${x.name}`, x.type as any);
|
||||
if (x.type === "dir" || x.type === "file") {
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeCli: x.modified,
|
||||
mtimeSvr: x.modified,
|
||||
size: x.size,
|
||||
sizeRaw: x.size,
|
||||
hash: x.hash,
|
||||
} as Entity;
|
||||
} else {
|
||||
throw Error(`cannot understand ${JSON.stringify(x)}`);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* https://app.koofr.net/developers
|
||||
*
|
||||
*/
|
||||
// const getAuthHeader = (email: string, password: string) => {
|
||||
// const x = `${email}:${password}`;
|
||||
// const y = base64.stringify(new TextEncoder().encode(x));
|
||||
// const z = `Basic ${y}`;
|
||||
// return z;
|
||||
// };
|
||||
|
||||
// const getAuthMiddleware = (email: string, password: string) => {
|
||||
// const authMiddleware: Middleware = {
|
||||
// async onRequest(req) {
|
||||
// req.headers.set("Authorization", getAuthHeader(email, password));
|
||||
// return req;
|
||||
// },
|
||||
// };
|
||||
// return authMiddleware;
|
||||
// };
|
||||
|
||||
const getAuthMiddleware = (
|
||||
koofrConfig: KoofrConfig,
|
||||
saveUpdatedConfigFunc: any
|
||||
) => {
|
||||
const authMiddleware: Middleware = {
|
||||
async onRequest(req) {
|
||||
const getAccessToken = async () => {
|
||||
if (koofrConfig.refreshToken === "") {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
const ts = Date.now();
|
||||
const comp = koofrConfig.accessTokenExpiresAtTimeMs > ts;
|
||||
// console.debug(`koofrConfig.accessTokenExpiresAtTimeMs=${koofrConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
|
||||
if (comp) {
|
||||
return koofrConfig.accessToken;
|
||||
}
|
||||
|
||||
// refresh
|
||||
const k = await sendRefreshTokenReq(
|
||||
koofrConfig.api,
|
||||
koofrConfig.refreshToken
|
||||
);
|
||||
koofrConfig.accessToken = k.access_token;
|
||||
koofrConfig.accessTokenExpiresInMs = k.expires_in * 1000;
|
||||
koofrConfig.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
await saveUpdatedConfigFunc();
|
||||
console.info("Koofr accessToken updated");
|
||||
return koofrConfig.accessToken;
|
||||
};
|
||||
|
||||
const access = await getAccessToken();
|
||||
req.headers.set("Authorization", `Bearer ${access}`);
|
||||
return req;
|
||||
},
|
||||
};
|
||||
return authMiddleware;
|
||||
};
|
||||
|
||||
export class FakeFsKoofr extends FakeFs {
|
||||
kind: string;
|
||||
koofrConfig: KoofrConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
client: ReturnType<typeof createClient<paths>>;
|
||||
placeID: string;
|
||||
|
||||
constructor(
|
||||
koofrConfig: KoofrConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "koofr";
|
||||
this.koofrConfig = koofrConfig;
|
||||
this.remoteBaseDir = this.koofrConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
this.placeID = this.koofrConfig.mountID;
|
||||
const client = createClient<paths>({ baseUrl: this.koofrConfig.api });
|
||||
client.use(getAuthMiddleware(this.koofrConfig, saveUpdatedConfigFunc));
|
||||
this.client = client;
|
||||
}
|
||||
|
||||
async _init() {
|
||||
if (this.koofrConfig.refreshToken === "") {
|
||||
throw Error(`You have not auth yet!`);
|
||||
}
|
||||
|
||||
if (this.placeID === undefined || this.placeID === "") {
|
||||
const { data, error } = await this.client.GET("/api/v2.1/places");
|
||||
const primaryPlaceID = data?.places.filter((x) => x.isPrimary)[0].id;
|
||||
this.placeID = primaryPlaceID ?? "";
|
||||
|
||||
if (this.placeID === "") {
|
||||
throw Error(`cannot find primary placeID`);
|
||||
}
|
||||
}
|
||||
|
||||
if (this.vaultFolderExists) {
|
||||
// pass
|
||||
} else {
|
||||
const { data, error } = await this.client.GET(
|
||||
"/api/v2.1/mounts/{mountId}/files/list",
|
||||
{
|
||||
params: {
|
||||
query: {
|
||||
path: "/",
|
||||
},
|
||||
path: {
|
||||
mountId: this.placeID,
|
||||
},
|
||||
},
|
||||
}
|
||||
);
|
||||
const x = data?.files.filter((x) => x.name === this.remoteBaseDir);
|
||||
if ((x?.length ?? 0) > 0) {
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
const { data, error } = await this.client.POST(
|
||||
"/api/v2.1/mounts/{mountId}/files/folder",
|
||||
{
|
||||
params: {
|
||||
query: { path: "/" },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
body: {
|
||||
name: this.remoteBaseDir,
|
||||
},
|
||||
}
|
||||
);
|
||||
if (data !== undefined) {
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const { data, error } = await this.client.GET(
|
||||
"/content/api/v2.1/mounts/{mountId}/files/listrecursive",
|
||||
{
|
||||
params: {
|
||||
query: { path: this.remoteBaseDir },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
parseAs: "text",
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
const items = JSON.parse(
|
||||
`[${data.trim().split("\n").join(",")}]`
|
||||
) as FilesListRecursiveItem[];
|
||||
const entities = items.filter((x) => x.path !== "/").map(fromItemToEntity);
|
||||
return entities;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const { data, error } = await this.client.GET(
|
||||
"/api/v2.1/mounts/{mountId}/files/list",
|
||||
{
|
||||
params: {
|
||||
query: { path: this.remoteBaseDir },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
const entities = data.files.map((x) => fromFileToEntity(x, ""));
|
||||
// console.debug(entities);
|
||||
return entities;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
const { data, error } = await this.client.GET(
|
||||
"/api/v2.1/mounts/{mountId}/files/info",
|
||||
{
|
||||
params: {
|
||||
query: { path: getKoofrPath(key, this.remoteBaseDir) },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
const entity = fromFileToEntity(
|
||||
data,
|
||||
getKoofrPath(getParentFolder(key), this.remoteBaseDir)
|
||||
);
|
||||
// console.debug(entity);
|
||||
return entity;
|
||||
}
|
||||
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime?: number | undefined,
|
||||
ctime?: number | undefined
|
||||
): Promise<Entity> {
|
||||
await this._init();
|
||||
|
||||
// "abc/efg" -> "abc/"
|
||||
const parent = getParentFolder(key);
|
||||
const itself = key.slice(0, -1).split("/").pop()!;
|
||||
const { data, error } = await this.client.POST(
|
||||
"/api/v2.1/mounts/{mountId}/files/folder",
|
||||
{
|
||||
params: {
|
||||
query: { path: getKoofrPath(parent, this.remoteBaseDir) },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
body: {
|
||||
name: itself,
|
||||
},
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
return this.stat(key);
|
||||
}
|
||||
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
await this._init();
|
||||
const itself = key.split("/").pop()!;
|
||||
const { data, error } = await this.client.POST(
|
||||
"/content/api/v2.1/mounts/{mountId}/files/put",
|
||||
{
|
||||
params: {
|
||||
query: {
|
||||
path: getKoofrPath(getParentFolder(key), this.remoteBaseDir),
|
||||
filename: itself,
|
||||
info: true,
|
||||
overwrite: true,
|
||||
autorename: false,
|
||||
modified: mtime,
|
||||
},
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
|
||||
body: content as any,
|
||||
bodySerializer(body) {
|
||||
return body;
|
||||
},
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
const entity = fromFileToEntity(
|
||||
data,
|
||||
getKoofrPath(getParentFolder(key), this.remoteBaseDir)
|
||||
);
|
||||
// console.debug(entity);
|
||||
return entity;
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
await this._init();
|
||||
const { data, error } = await this.client.GET(
|
||||
"/content/api/v2.1/mounts/{mountId}/files/get",
|
||||
{
|
||||
params: {
|
||||
query: { path: getKoofrPath(key, this.remoteBaseDir), force: true },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
parseAs: "arrayBuffer",
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
await this._init();
|
||||
const { data, error } = await this.client.DELETE(
|
||||
"/api/v2.1/mounts/{mountId}/files/remove",
|
||||
{
|
||||
params: {
|
||||
query: { path: getKoofrPath(key, this.remoteBaseDir), force: true },
|
||||
path: { mountId: this.placeID },
|
||||
},
|
||||
}
|
||||
);
|
||||
if (error !== undefined) {
|
||||
throw Error(JSON.stringify(error));
|
||||
}
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async revokeAuth(): Promise<any> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,948 @@
|
||||
import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
|
||||
import type { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
|
||||
import type {
|
||||
DriveItem,
|
||||
FileSystemInfo,
|
||||
UploadSession,
|
||||
User,
|
||||
} from "@microsoft/microsoft-graph-types";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { request, requestUrl } from "obsidian";
|
||||
import {
|
||||
DEFAULT_CONTENT_TYPE,
|
||||
type Entity,
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
ONEDRIVE_AUTHORITY,
|
||||
ONEDRIVE_CLIENT_ID,
|
||||
} from "../../src/baseTypes";
|
||||
import { VALID_REQURL } from "../../src/baseTypesObs";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import { bufferToArrayBuffer } from "../../src/misc";
|
||||
import {
|
||||
COMMAND_CALLBACK_ONEDRIVEFULL,
|
||||
type OnedriveFullConfig,
|
||||
} from "./baseTypesPro";
|
||||
|
||||
const SCOPES = ["User.Read", "Files.ReadWrite", "offline_access"]; // not using Files.ReadWrite.All
|
||||
const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVEFULL}`; // diff from Onedrive (App Folder)
|
||||
|
||||
export const DEFAULT_ONEDRIVEFULL_CONFIG: OnedriveFullConfig = {
|
||||
accessToken: "",
|
||||
clientID: ONEDRIVE_CLIENT_ID ?? "",
|
||||
authority: ONEDRIVE_AUTHORITY ?? "",
|
||||
refreshToken: "",
|
||||
accessTokenExpiresInSeconds: 0,
|
||||
accessTokenExpiresAtTime: 0,
|
||||
deltaLink: "",
|
||||
username: "",
|
||||
credentialsShouldBeDeletedAtTime: 0,
|
||||
emptyFile: "skip",
|
||||
kind: "onedrivefull",
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// Onedrive authorization using PKCE
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
export async function getAuthUrlAndVerifier(
|
||||
clientID: string,
|
||||
authority: string
|
||||
) {
|
||||
const cryptoProvider = new CryptoProvider();
|
||||
const { verifier, challenge } = await cryptoProvider.generatePkceCodes();
|
||||
|
||||
const pkceCodes = {
|
||||
challengeMethod: "S256", // Use SHA256 Algorithm
|
||||
verifier: verifier,
|
||||
challenge: challenge,
|
||||
};
|
||||
|
||||
const authCodeUrlParams = {
|
||||
redirectUri: REDIRECT_URI,
|
||||
scopes: SCOPES,
|
||||
codeChallenge: pkceCodes.challenge, // PKCE Code Challenge
|
||||
codeChallengeMethod: pkceCodes.challengeMethod, // PKCE Code Challenge Method
|
||||
};
|
||||
|
||||
const pca = new PublicClientApplication({
|
||||
auth: {
|
||||
clientId: clientID,
|
||||
authority: authority,
|
||||
},
|
||||
});
|
||||
const authCodeUrl = await pca.getAuthCodeUrl(authCodeUrlParams);
|
||||
|
||||
return {
|
||||
authUrl: authCodeUrl,
|
||||
verifier: verifier,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Check doc from
|
||||
* https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
|
||||
* https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth?view=odsp-graph-online#code-flow
|
||||
*/
|
||||
export interface AccessCodeResponseSuccessfulType {
|
||||
token_type: "Bearer" | "bearer";
|
||||
expires_in: number;
|
||||
ext_expires_in?: number;
|
||||
scope: string;
|
||||
access_token: string;
|
||||
refresh_token?: string;
|
||||
id_token?: string;
|
||||
}
|
||||
export interface AccessCodeResponseFailedType {
|
||||
error: string;
|
||||
error_description: string;
|
||||
error_codes: number[];
|
||||
timestamp: string;
|
||||
trace_id: string;
|
||||
correlation_id: string;
|
||||
}
|
||||
|
||||
export const sendAuthReq = async (
|
||||
clientID: string,
|
||||
authority: string,
|
||||
authCode: string,
|
||||
verifier: string,
|
||||
errorCallBack: any
|
||||
) => {
|
||||
// // original code snippets for references
|
||||
// const authResponse = await pca.acquireTokenByCode({
|
||||
// redirectUri: REDIRECT_URI,
|
||||
// scopes: SCOPES,
|
||||
// code: authCode,
|
||||
// codeVerifier: verifier, // PKCE Code Verifier
|
||||
// });
|
||||
// console.info('authResponse')
|
||||
// console.info(authResponse)
|
||||
// return authResponse;
|
||||
|
||||
// Because of the CORS problem,
|
||||
// we need to construct raw request using Obsidian request,
|
||||
// instead of using msal
|
||||
// https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
|
||||
// https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth?view=odsp-graph-online#code-flow
|
||||
try {
|
||||
const rsp1 = await request({
|
||||
url: `${authority}/oauth2/v2.0/token`,
|
||||
method: "POST",
|
||||
contentType: "application/x-www-form-urlencoded",
|
||||
body: new URLSearchParams({
|
||||
tenant: "consumers",
|
||||
client_id: clientID,
|
||||
scope: SCOPES.join(" "),
|
||||
code: authCode,
|
||||
redirect_uri: REDIRECT_URI,
|
||||
grant_type: "authorization_code",
|
||||
code_verifier: verifier,
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
const rsp2 = JSON.parse(rsp1);
|
||||
// console.info(rsp2);
|
||||
|
||||
if (rsp2.error !== undefined) {
|
||||
return rsp2 as AccessCodeResponseFailedType;
|
||||
} else {
|
||||
return rsp2 as AccessCodeResponseSuccessfulType;
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
await errorCallBack(e);
|
||||
}
|
||||
};
|
||||
|
||||
export const sendRefreshTokenReq = async (
|
||||
clientID: string,
|
||||
authority: string,
|
||||
refreshToken: string
|
||||
) => {
|
||||
// also use Obsidian request to bypass CORS issue.
|
||||
try {
|
||||
const rsp1 = await request({
|
||||
url: `${authority}/oauth2/v2.0/token`,
|
||||
method: "POST",
|
||||
contentType: "application/x-www-form-urlencoded",
|
||||
body: new URLSearchParams({
|
||||
tenant: "consumers",
|
||||
client_id: clientID,
|
||||
scope: SCOPES.join(" "),
|
||||
refresh_token: refreshToken,
|
||||
grant_type: "refresh_token",
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
const rsp2 = JSON.parse(rsp1);
|
||||
// console.info(rsp2);
|
||||
|
||||
if (rsp2.error !== undefined) {
|
||||
return rsp2 as AccessCodeResponseFailedType;
|
||||
} else {
|
||||
return rsp2 as AccessCodeResponseSuccessfulType;
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
throw e;
|
||||
}
|
||||
};
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: OnedriveFullConfig,
|
||||
authRes: AccessCodeResponseSuccessfulType,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
console.info("start updating local info of OneDrive token");
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresAtTime =
|
||||
Date.now() + authRes.expires_in - 5 * 60 * 1000;
|
||||
config.accessTokenExpiresInSeconds = authRes.expires_in;
|
||||
config.refreshToken = authRes.refresh_token!;
|
||||
|
||||
// manually set it expired after 80 days;
|
||||
config.credentialsShouldBeDeletedAtTime =
|
||||
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
|
||||
|
||||
if (saveUpdatedConfigFunc !== undefined) {
|
||||
await saveUpdatedConfigFunc();
|
||||
}
|
||||
|
||||
console.info("finish updating local info of Onedrive token");
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// Other usual common methods
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* This is different from Onedrive (App Folder)
|
||||
*/
|
||||
const getOnedrivePath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
// https://learn.microsoft.com/en-us/onedrive/developer/rest-api/concepts/addressing-driveitems?view=odsp-graph-online
|
||||
const prefix = `/drive/root:/${remoteBaseDir}`;
|
||||
|
||||
let key = fileOrFolderPath;
|
||||
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||
// special
|
||||
return prefix;
|
||||
}
|
||||
if (key.endsWith("/")) {
|
||||
key = key.slice(0, key.length - 1);
|
||||
}
|
||||
|
||||
if (key.startsWith("/")) {
|
||||
console.warn(`why the path ${key} starts with '/'? but we just go on.`);
|
||||
key = `${prefix}${key}`;
|
||||
} else {
|
||||
key = `${prefix}/${key}`;
|
||||
}
|
||||
return key;
|
||||
};
|
||||
|
||||
const constructFromDriveItemToEntityError = (x: DriveItem) => {
|
||||
const fullPathOriginal = `${x.parentReference?.path}/${x.name}`;
|
||||
return `parentPath="${
|
||||
x.parentReference?.path ?? "(no parentReference or path)"
|
||||
}", selfName="${x.name}"`;
|
||||
};
|
||||
|
||||
const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
let key = "";
|
||||
|
||||
// possible prefix:
|
||||
// pure english: /drive/root:${remoteBaseDir}
|
||||
const FIRST_COMMON_PREFIX_RAW = `/drive/root:/${remoteBaseDir}`;
|
||||
const SECOND_COMMON_PREFIX_RAW = `/drive/root:/${encodeURIComponent(
|
||||
remoteBaseDir
|
||||
)}`;
|
||||
|
||||
if (
|
||||
x.parentReference === undefined ||
|
||||
x.parentReference === null ||
|
||||
x.parentReference.path === undefined ||
|
||||
x.parentReference.path === null
|
||||
) {
|
||||
throw Error("x.parentReference.path is undefinded or null");
|
||||
}
|
||||
const fullPathOriginal = `${x.parentReference?.path}/${x.name}`;
|
||||
const matchFirstPrefixRes = fullPathOriginal.startsWith(
|
||||
FIRST_COMMON_PREFIX_RAW
|
||||
);
|
||||
const matchSecondPrefixRes = fullPathOriginal.startsWith(
|
||||
SECOND_COMMON_PREFIX_RAW
|
||||
);
|
||||
|
||||
if (matchFirstPrefixRes) {
|
||||
key = fullPathOriginal.substring(FIRST_COMMON_PREFIX_RAW.length + 1);
|
||||
} else if (matchSecondPrefixRes) {
|
||||
key = fullPathOriginal.substring(SECOND_COMMON_PREFIX_RAW.length + 1);
|
||||
} else {
|
||||
throw Error(
|
||||
`we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToEntityError(
|
||||
x
|
||||
)}`
|
||||
);
|
||||
}
|
||||
|
||||
const isFolder = "folder" in x;
|
||||
if (isFolder) {
|
||||
key = `${key}/`;
|
||||
}
|
||||
|
||||
const mtimeSvr = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
const mtimeCli = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeSvr: mtimeSvr,
|
||||
mtimeCli: mtimeCli,
|
||||
size: isFolder ? 0 : x.size!,
|
||||
sizeRaw: isFolder ? 0 : x.size!,
|
||||
synthesizedFile: false,
|
||||
// hash: ?? // TODO
|
||||
};
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// The client.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// to adapt to the required interface
|
||||
class MyAuthProvider implements AuthenticationProvider {
|
||||
onedriveFullConfig: OnedriveFullConfig;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
constructor(
|
||||
onedriveFullConfig: OnedriveFullConfig,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
this.onedriveFullConfig = onedriveFullConfig;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
}
|
||||
|
||||
async getAccessToken() {
|
||||
if (
|
||||
this.onedriveFullConfig.accessToken === "" ||
|
||||
this.onedriveFullConfig.refreshToken === ""
|
||||
) {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
const currentTs = Date.now();
|
||||
if (this.onedriveFullConfig.accessTokenExpiresAtTime > currentTs) {
|
||||
return this.onedriveFullConfig.accessToken;
|
||||
} else {
|
||||
// use refreshToken to refresh
|
||||
const r = await sendRefreshTokenReq(
|
||||
this.onedriveFullConfig.clientID,
|
||||
this.onedriveFullConfig.authority,
|
||||
this.onedriveFullConfig.refreshToken
|
||||
);
|
||||
if ((r as any).error !== undefined) {
|
||||
const r2 = r as AccessCodeResponseFailedType;
|
||||
throw Error(
|
||||
`Error while refreshing accessToken: ${r2.error}, ${r2.error_codes}: ${r2.error_description}`
|
||||
);
|
||||
}
|
||||
const r2 = r as AccessCodeResponseSuccessfulType;
|
||||
this.onedriveFullConfig.accessToken = r2.access_token;
|
||||
this.onedriveFullConfig.refreshToken = r2.refresh_token!;
|
||||
this.onedriveFullConfig.accessTokenExpiresInSeconds = r2.expires_in;
|
||||
this.onedriveFullConfig.accessTokenExpiresAtTime =
|
||||
currentTs + r2.expires_in * 1000 - 60 * 2 * 1000;
|
||||
await this.saveUpdatedConfigFunc();
|
||||
console.info("Onedrive accessToken updated");
|
||||
return this.onedriveFullConfig.accessToken;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* to export the settings in qrcode,
|
||||
* we want to "trim" or "shrink" the settings
|
||||
* @param onedriveFullConfig
|
||||
*/
|
||||
export const getShrinkedSettings = (onedriveFullConfig: OnedriveFullConfig) => {
|
||||
const config = cloneDeep(onedriveFullConfig);
|
||||
config.accessToken = "x";
|
||||
config.accessTokenExpiresInSeconds = 1;
|
||||
config.accessTokenExpiresAtTime = 1;
|
||||
return config;
|
||||
};
|
||||
|
||||
export class FakeFsOnedriveFull extends FakeFs {
|
||||
kind: "onedrivefull";
|
||||
onedriveFullConfig: OnedriveFullConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
authGetter: MyAuthProvider;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
foldersCreatedBefore: Set<string>;
|
||||
|
||||
constructor(
|
||||
onedriveFullConfig: OnedriveFullConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "onedrivefull";
|
||||
this.onedriveFullConfig = onedriveFullConfig;
|
||||
this.remoteBaseDir =
|
||||
this.onedriveFullConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
this.authGetter = new MyAuthProvider(
|
||||
onedriveFullConfig,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
this.foldersCreatedBefore = new Set();
|
||||
}
|
||||
|
||||
async _init() {
|
||||
// check token
|
||||
if (
|
||||
this.onedriveFullConfig.accessToken === "" ||
|
||||
this.onedriveFullConfig.refreshToken === ""
|
||||
) {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
// check vault folder
|
||||
// console.info(`checking remote has folder /${this.remoteBaseDir}`);
|
||||
if (this.vaultFolderExists) {
|
||||
// console.info(`already checked, /${this.remoteBaseDir} exist before`)
|
||||
} else {
|
||||
const k = await this._getJson("/drive/root/children");
|
||||
// console.debug(k);
|
||||
this.vaultFolderExists =
|
||||
(k.value as DriveItem[]).filter((x) => x.name === this.remoteBaseDir)
|
||||
.length > 0;
|
||||
if (!this.vaultFolderExists) {
|
||||
console.info(`remote does not have folder /${this.remoteBaseDir}`);
|
||||
await this._postJson("/drive/root/children", {
|
||||
name: `${this.remoteBaseDir}`,
|
||||
folder: {},
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
});
|
||||
console.info(`remote folder /${this.remoteBaseDir} created`);
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
// console.info(`remote folder /${this.remoteBaseDir} exists`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_buildUrl(pathFragOrig: string) {
|
||||
const API_PREFIX = "https://graph.microsoft.com/v1.0";
|
||||
let theUrl = "";
|
||||
if (
|
||||
pathFragOrig.startsWith("http://") ||
|
||||
pathFragOrig.startsWith("https://")
|
||||
) {
|
||||
theUrl = pathFragOrig;
|
||||
} else {
|
||||
const pathFrag = encodeURI(pathFragOrig);
|
||||
theUrl = `${API_PREFIX}${pathFrag}`;
|
||||
}
|
||||
// we want to support file name with hash #
|
||||
// because every url we construct here do not contain the # symbol
|
||||
// thus it should be safe to directly replace the character
|
||||
theUrl = theUrl.replace(/#/g, "%23");
|
||||
// console.debug(`building url: [${pathFragOrig}] => [${theUrl}]`)
|
||||
return theUrl;
|
||||
}
|
||||
|
||||
async _getJson(pathFragOrig: string) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(`getJson, theUrl=${theUrl}`);
|
||||
return JSON.parse(
|
||||
await request({
|
||||
url: theUrl,
|
||||
method: "GET",
|
||||
contentType: "application/json",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
"Cache-Control": "no-cache",
|
||||
},
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
async _postJson(pathFragOrig: string, payload: any) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(`postJson, theUrl=${theUrl}`);
|
||||
return JSON.parse(
|
||||
await request({
|
||||
url: theUrl,
|
||||
method: "POST",
|
||||
contentType: "application/json",
|
||||
body: JSON.stringify(payload),
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
async _patchJson(pathFragOrig: string, payload: any) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(`patchJson, theUrl=${theUrl}`);
|
||||
return JSON.parse(
|
||||
await request({
|
||||
url: theUrl,
|
||||
method: "PATCH",
|
||||
contentType: "application/json",
|
||||
body: JSON.stringify(payload),
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
async _deleteJson(pathFragOrig: string) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(`deleteJson, theUrl=${theUrl}`);
|
||||
if (VALID_REQURL) {
|
||||
await requestUrl({
|
||||
url: theUrl,
|
||||
method: "DELETE",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
} else {
|
||||
await fetch(theUrl, {
|
||||
method: "DELETE",
|
||||
headers: {
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
async _putArrayBuffer(pathFragOrig: string, payload: ArrayBuffer) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(`putArrayBuffer, theUrl=${theUrl}`);
|
||||
// TODO:
|
||||
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||
// Use fetch everywhere instead!
|
||||
// biome-ignore lint/correctness/noConstantCondition: hard code
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const res = await requestUrl({
|
||||
url: theUrl,
|
||||
method: "PUT",
|
||||
body: payload,
|
||||
contentType: DEFAULT_CONTENT_TYPE,
|
||||
headers: {
|
||||
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
return res.json as DriveItem | UploadSession;
|
||||
} else {
|
||||
const res = await fetch(theUrl, {
|
||||
method: "PUT",
|
||||
body: payload,
|
||||
headers: {
|
||||
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||
Authorization: `Bearer ${await this.authGetter.getAccessToken()}`,
|
||||
},
|
||||
});
|
||||
return (await res.json()) as DriveItem | UploadSession;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A specialized function to upload large files by parts
|
||||
* @param pathFragOrig
|
||||
* @param payload
|
||||
* @param rangeMin
|
||||
* @param rangeEnd the end, exclusive
|
||||
* @param size
|
||||
*/
|
||||
async _putUint8ArrayByRange(
|
||||
pathFragOrig: string,
|
||||
payload: Uint8Array,
|
||||
rangeStart: number,
|
||||
rangeEnd: number,
|
||||
size: number
|
||||
) {
|
||||
const theUrl = this._buildUrl(pathFragOrig);
|
||||
console.debug(
|
||||
`putUint8ArrayByRange, theUrl=${theUrl}, range=${rangeStart}-${
|
||||
rangeEnd - 1
|
||||
}, len=${rangeEnd - rangeStart}, size=${size}`
|
||||
);
|
||||
// NO AUTH HEADER here!
|
||||
// TODO:
|
||||
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||
// Use fetch everywhere instead!
|
||||
// biome-ignore lint/correctness/noConstantCondition: hard code
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const res = await requestUrl({
|
||||
url: theUrl,
|
||||
method: "PUT",
|
||||
body: bufferToArrayBuffer(payload.subarray(rangeStart, rangeEnd)),
|
||||
contentType: DEFAULT_CONTENT_TYPE,
|
||||
headers: {
|
||||
// no "Content-Length" allowed here
|
||||
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
|
||||
/* "Cache-Control": "no-cache", not allowed here!!! */
|
||||
},
|
||||
});
|
||||
return res.json as DriveItem | UploadSession;
|
||||
} else {
|
||||
const res = await fetch(theUrl, {
|
||||
method: "PUT",
|
||||
body: payload.subarray(rangeStart, rangeEnd),
|
||||
headers: {
|
||||
"Content-Length": `${rangeEnd - rangeStart}`,
|
||||
"Content-Range": `bytes ${rangeStart}-${rangeEnd - 1}/${size}`,
|
||||
"Content-Type": DEFAULT_CONTENT_TYPE,
|
||||
/* "Cache-Control": "no-cache", not allowed here!!! */
|
||||
},
|
||||
});
|
||||
return (await res.json()) as DriveItem | UploadSession;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Use delta api to list all files and folders
|
||||
* https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_delta?view=odsp-graph-online
|
||||
*/
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const NEXT_LINK_KEY = "@odata.nextLink";
|
||||
const DELTA_LINK_KEY = "@odata.deltaLink";
|
||||
|
||||
let res = await this._getJson(`/drive/root:/${this.remoteBaseDir}:/delta`);
|
||||
const driveItems = res.value as DriveItem[];
|
||||
// console.debug(driveItems);
|
||||
|
||||
while (NEXT_LINK_KEY in res) {
|
||||
res = await this._getJson(res[NEXT_LINK_KEY]);
|
||||
driveItems.push(...cloneDeep(res.value as DriveItem[]));
|
||||
}
|
||||
|
||||
// lastly we should have delta link?
|
||||
if (DELTA_LINK_KEY in res) {
|
||||
this.onedriveFullConfig.deltaLink = res[DELTA_LINK_KEY];
|
||||
await this.saveUpdatedConfigFunc();
|
||||
}
|
||||
|
||||
// unify everything to Entity
|
||||
const unifiedContents = driveItems
|
||||
.map((x) => fromDriveItemToEntity(x, this.remoteBaseDir))
|
||||
.filter((x) => x.key !== "/");
|
||||
|
||||
return unifiedContents;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const DELTA_LINK_KEY = "@odata.deltaLink";
|
||||
|
||||
const res = await this._getJson(
|
||||
`/drive/root:/${this.remoteBaseDir}:/delta`
|
||||
);
|
||||
const driveItems = res.value as DriveItem[];
|
||||
// console.debug(driveItems);
|
||||
|
||||
// lastly we should have delta link?
|
||||
if (DELTA_LINK_KEY in res) {
|
||||
this.onedriveFullConfig.deltaLink = res[DELTA_LINK_KEY];
|
||||
await this.saveUpdatedConfigFunc();
|
||||
}
|
||||
|
||||
// unify everything to Entity
|
||||
const unifiedContents = driveItems
|
||||
.map((x) => fromDriveItemToEntity(x, this.remoteBaseDir))
|
||||
.filter((x) => x.key !== "/");
|
||||
|
||||
return unifiedContents;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
return await this._statFromRoot(getOnedrivePath(key, this.remoteBaseDir));
|
||||
}
|
||||
|
||||
async _statFromRoot(key: string): Promise<Entity> {
|
||||
// console.info(`remotePath=${remotePath}`);
|
||||
const rsp = await this._getJson(
|
||||
`${key}?$select=cTag,eTag,fileSystemInfo,folder,file,name,parentReference,size`
|
||||
);
|
||||
// console.info(rsp);
|
||||
const driveItem = rsp as DriveItem;
|
||||
const res = fromDriveItemToEntity(driveItem, this.remoteBaseDir);
|
||||
// console.info(res);
|
||||
return res;
|
||||
}
|
||||
|
||||
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 uploadFolder = getOnedrivePath(key, this.remoteBaseDir);
|
||||
console.debug(`mkdir uploadFolder=${uploadFolder}`);
|
||||
return await this._mkdirFromRoot(uploadFolder, mtime, ctime);
|
||||
}
|
||||
|
||||
async _mkdirFromRoot(
|
||||
key: string,
|
||||
mtime?: number,
|
||||
ctime?: number
|
||||
): Promise<Entity> {
|
||||
// console.debug(`foldersCreatedBefore=${Array.from(this.foldersCreatedBefore)}`);
|
||||
if (this.foldersCreatedBefore.has(key)) {
|
||||
// created, pass
|
||||
// console.debug(`folder ${key} created.`)
|
||||
} else {
|
||||
// https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
|
||||
// use PATCH to create folder recursively!!!
|
||||
const playload: any = {
|
||||
folder: {},
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
};
|
||||
const fileSystemInfo: Record<string, string> = {};
|
||||
if (mtime !== undefined && mtime !== 0) {
|
||||
const mtimeStr = new Date(mtime).toISOString();
|
||||
fileSystemInfo["lastModifiedDateTime"] = mtimeStr;
|
||||
}
|
||||
if (ctime !== undefined && ctime !== 0) {
|
||||
const ctimeStr = new Date(ctime).toISOString();
|
||||
fileSystemInfo["createdDateTime"] = ctimeStr;
|
||||
}
|
||||
if (Object.keys(fileSystemInfo).length > 0) {
|
||||
playload["fileSystemInfo"] = fileSystemInfo;
|
||||
}
|
||||
await this._patchJson(key, playload);
|
||||
}
|
||||
const res = await this._statFromRoot(key);
|
||||
return res;
|
||||
}
|
||||
|
||||
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 = getOnedrivePath(key, this.remoteBaseDir);
|
||||
console.debug(`uploadFile=${uploadFile}`);
|
||||
return await this._writeFileFromRoot(
|
||||
uploadFile,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
key,
|
||||
this.onedriveFullConfig.emptyFile
|
||||
);
|
||||
}
|
||||
|
||||
async _writeFileFromRoot(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number,
|
||||
origKey: string,
|
||||
emptyFile: "skip" | "error"
|
||||
): Promise<Entity> {
|
||||
if (content.byteLength === 0) {
|
||||
if (emptyFile === "error") {
|
||||
throw Error(
|
||||
`${origKey}: Empty file is not allowed in OneDrive, and please write something in it.`
|
||||
);
|
||||
} else {
|
||||
return {
|
||||
key: origKey,
|
||||
keyRaw: origKey,
|
||||
mtimeSvr: mtime,
|
||||
mtimeCli: mtime,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
synthesizedFile: true,
|
||||
// hash: ?? // TODO
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const ctimeStr = new Date(ctime).toISOString();
|
||||
const mtimeStr = new Date(mtime).toISOString();
|
||||
|
||||
// no need to create parent folders firstly, cool!
|
||||
|
||||
// hard code range size
|
||||
const MIN_UNIT = 327680; // bytes in msft doc, about 0.32768 MB
|
||||
const RANGE_SIZE = MIN_UNIT * 20; // about 6.5536 MB
|
||||
const DIRECT_UPLOAD_MAX_SIZE = 1000 * 1000 * 4; // 4 Megabyte
|
||||
|
||||
if (content.byteLength < DIRECT_UPLOAD_MAX_SIZE) {
|
||||
// directly using put!
|
||||
await this._putArrayBuffer(
|
||||
`${key}:/content?${new URLSearchParams({
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
})}`,
|
||||
content
|
||||
);
|
||||
if (mtime !== 0 && ctime !== 0) {
|
||||
await this._patchJson(key, {
|
||||
fileSystemInfo: {
|
||||
lastModifiedDateTime: mtimeStr,
|
||||
createdDateTime: ctimeStr,
|
||||
} as FileSystemInfo,
|
||||
});
|
||||
}
|
||||
} else {
|
||||
// upload large files!
|
||||
// ref: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_createuploadsession?view=odsp-graph-online
|
||||
|
||||
// 1. create uploadSession
|
||||
// uploadFile already starts with /drive/root:/${remoteBaseDir}
|
||||
let playload: any = {
|
||||
item: {
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
},
|
||||
};
|
||||
if (mtime !== 0 && ctime !== 0) {
|
||||
playload = {
|
||||
item: {
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
|
||||
// this is only possible using uploadSession
|
||||
fileSystemInfo: {
|
||||
lastModifiedDateTime: mtimeStr,
|
||||
createdDateTime: ctimeStr,
|
||||
} as FileSystemInfo,
|
||||
},
|
||||
};
|
||||
}
|
||||
const s: UploadSession = await this._postJson(
|
||||
`${key}:/createUploadSession`,
|
||||
playload
|
||||
);
|
||||
const uploadUrl = s.uploadUrl!;
|
||||
console.debug("uploadSession = ");
|
||||
console.debug(s);
|
||||
|
||||
// 2. upload by ranges
|
||||
// convert to uint8
|
||||
const uint8 = new Uint8Array(content);
|
||||
|
||||
// upload the ranges one by one
|
||||
let rangeStart = 0;
|
||||
while (rangeStart < uint8.byteLength) {
|
||||
await this._putUint8ArrayByRange(
|
||||
uploadUrl,
|
||||
uint8,
|
||||
rangeStart,
|
||||
Math.min(rangeStart + RANGE_SIZE, uint8.byteLength),
|
||||
uint8.byteLength
|
||||
);
|
||||
rangeStart += RANGE_SIZE;
|
||||
}
|
||||
}
|
||||
|
||||
const res = await this._statFromRoot(key);
|
||||
return res;
|
||||
}
|
||||
|
||||
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 = getOnedrivePath(key, this.remoteBaseDir);
|
||||
return await this._readFileFromRoot(downloadFile);
|
||||
}
|
||||
|
||||
async _readFileFromRoot(key: string): Promise<ArrayBuffer> {
|
||||
const rsp = await this._getJson(
|
||||
`${key}?$select=@microsoft.graph.downloadUrl`
|
||||
);
|
||||
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
|
||||
// biome-ignore lint/correctness/noConstantCondition: <explanation>
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const content = (
|
||||
await requestUrl({
|
||||
url: downloadUrl,
|
||||
headers: { "Cache-Control": "no-cache" },
|
||||
})
|
||||
).arrayBuffer;
|
||||
return content;
|
||||
} else {
|
||||
// cannot set no-cache here, will have cors error
|
||||
const content = await (
|
||||
await fetch(downloadUrl, { cache: "no-store" })
|
||||
).arrayBuffer();
|
||||
return content;
|
||||
}
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
if (key1 === "" || key1 === "/" || key2 === "" || key2 === "/") {
|
||||
return;
|
||||
}
|
||||
const remoteFileName1 = getOnedrivePath(key1, this.remoteBaseDir);
|
||||
const remoteFileName2 = getOnedrivePath(key2, this.remoteBaseDir);
|
||||
await this._init();
|
||||
await this._patchJson(remoteFileName1, {
|
||||
name: remoteFileName2,
|
||||
});
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
if (key === "" || key === "/") {
|
||||
return;
|
||||
}
|
||||
const remoteFileName = getOnedrivePath(key, this.remoteBaseDir);
|
||||
|
||||
await this._init();
|
||||
await this._deleteJson(remoteFileName);
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
try {
|
||||
const k = await this.getUserDisplayName();
|
||||
return k !== "<unknown display name>";
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName() {
|
||||
await this._init();
|
||||
const res: User = await this._getJson("/me?$select=displayName");
|
||||
return res.displayName || "<unknown display name>";
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc#send-a-sign-out-request
|
||||
* https://docs.microsoft.com/en-us/graph/api/user-revokesigninsessions
|
||||
* https://docs.microsoft.com/en-us/graph/api/user-invalidateallrefreshtokens
|
||||
*/
|
||||
async revokeAuth() {
|
||||
// await this._init();
|
||||
// await this._postJson("/me/revokeSignInSessions", {});
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async getRevokeAddr() {
|
||||
return "https://account.live.com/consent/Manage";
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,628 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import { requestUrl } from "obsidian";
|
||||
import pcloudSdk from "pcloud-sdk-js";
|
||||
import {
|
||||
type Entity,
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
} from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import { getFolderLevels } from "../../src/misc";
|
||||
import {
|
||||
COMMAND_CALLBACK_PCLOUD,
|
||||
PCLOUD_CLIENT_ID,
|
||||
PCLOUD_CLIENT_SECRET,
|
||||
type PCloudConfig,
|
||||
} from "./baseTypesPro";
|
||||
|
||||
export const DEFAULT_PCLOUD_CONFIG: PCloudConfig = {
|
||||
accessToken: "",
|
||||
hostname: "eapi.pcloud.com",
|
||||
locationid: 2,
|
||||
credentialsShouldBeDeletedAtTimeMs: 0,
|
||||
emptyFile: "skip",
|
||||
kind: "pcloud",
|
||||
};
|
||||
|
||||
export interface AuthAllowFirstRes {
|
||||
code: string;
|
||||
state?: string;
|
||||
locationid: 1 | 2;
|
||||
hostname: "api.pcloud.com" | "eapi.pcloud.com";
|
||||
}
|
||||
|
||||
/**
|
||||
* https://docs.pcloud.com/methods/oauth_2.0/authorize.html
|
||||
*/
|
||||
export const generateAuthUrl = async (hasCallback: boolean) => {
|
||||
const clientID = PCLOUD_CLIENT_ID;
|
||||
const state = nanoid();
|
||||
let authUrl = `https://my.pcloud.com/oauth2/authorize?response_type=code&client_id=${clientID}&state=${state}`;
|
||||
if (hasCallback) {
|
||||
authUrl += `&redirect_uri=obsidian://${COMMAND_CALLBACK_PCLOUD}`;
|
||||
}
|
||||
return {
|
||||
authUrl,
|
||||
state,
|
||||
};
|
||||
};
|
||||
|
||||
interface AuthResSucc {
|
||||
result: number;
|
||||
access_token: string;
|
||||
token_type: "bearer";
|
||||
uid: number;
|
||||
locationid: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://docs.pcloud.com/methods/oauth_2.0/oauth2_token.html
|
||||
*/
|
||||
export const sendAuthReq = async (
|
||||
hostname: string,
|
||||
authCode: string,
|
||||
errorCallBack: any
|
||||
) => {
|
||||
const clientID = PCLOUD_CLIENT_ID ?? "";
|
||||
const clientSecret = PCLOUD_CLIENT_SECRET ?? "";
|
||||
try {
|
||||
const k = {
|
||||
code: authCode,
|
||||
client_id: clientID,
|
||||
client_secret: clientSecret,
|
||||
};
|
||||
// console.debug(k);
|
||||
const resp1 = await fetch(`https://${hostname}/oauth2_token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams(k),
|
||||
});
|
||||
const resp2: AuthResSucc = await resp1.json();
|
||||
// console.debug(resp2);
|
||||
if (resp2?.result !== 0) {
|
||||
throw Error(`result is not 0 (success) in the end`);
|
||||
}
|
||||
if (!("access_token" in resp2)) {
|
||||
throw Error(`no access_token in the end`);
|
||||
}
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
if (errorCallBack !== undefined) {
|
||||
await errorCallBack(e);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: PCloudConfig,
|
||||
authAllowFirstRes: AuthAllowFirstRes,
|
||||
authRes: AuthResSucc | undefined,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes === undefined) {
|
||||
throw Error(`you should not save the setting for undefined result`);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.hostname = authAllowFirstRes.hostname;
|
||||
config.locationid = authAllowFirstRes.locationid;
|
||||
|
||||
// manually set it expired after 80 days;
|
||||
config.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
|
||||
|
||||
await saveUpdatedConfigFunc?.();
|
||||
|
||||
console.info("finish updating local info of pCloud token");
|
||||
};
|
||||
|
||||
interface PCloudEntity extends Entity {
|
||||
id: number;
|
||||
parentID: number | undefined;
|
||||
parentIDPath: string | undefined;
|
||||
isFolder: boolean;
|
||||
hashPCloud: number | undefined;
|
||||
}
|
||||
|
||||
interface File {
|
||||
contenttype: string;
|
||||
created: string;
|
||||
fileid: number;
|
||||
hash: number;
|
||||
id: string; // "f" + fileid
|
||||
isfolder: false;
|
||||
modified: string;
|
||||
name: string;
|
||||
parentfolderid: number;
|
||||
size: number;
|
||||
}
|
||||
|
||||
interface Folder {
|
||||
contents: (Folder | File)[] | undefined;
|
||||
id: string; // "d"+folderid
|
||||
folderid: number;
|
||||
isfolder: true;
|
||||
created: string;
|
||||
modified: string;
|
||||
name: string;
|
||||
parentfolderid: number;
|
||||
}
|
||||
|
||||
interface StatRawResponse {
|
||||
result: number;
|
||||
fileids: number[];
|
||||
metadata: (File | Folder)[];
|
||||
checksums: { sha1: string; sha256?: string; md5?: string }[] | undefined;
|
||||
}
|
||||
|
||||
const fromRawResponseToEntity = (
|
||||
item: Folder | File,
|
||||
parentFolderPath: string | undefined /* for bfs */
|
||||
): PCloudEntity => {
|
||||
if (item.parentfolderid === undefined || item.parentfolderid === 0) {
|
||||
throw Error(
|
||||
`parentfolderid=${item.parentfolderid} should not be in fromRawResponseToEntity`
|
||||
);
|
||||
}
|
||||
|
||||
let keyRaw = item.name;
|
||||
let size = 0;
|
||||
let hashPCloud: number | undefined = undefined;
|
||||
let hash: string | undefined = undefined;
|
||||
let id: number | undefined = undefined;
|
||||
if (
|
||||
parentFolderPath !== undefined &&
|
||||
parentFolderPath !== "" &&
|
||||
parentFolderPath !== "/"
|
||||
) {
|
||||
if (!parentFolderPath.endsWith("/")) {
|
||||
throw Error(
|
||||
`parentFolderPath=${parentFolderPath} should not be in fromRawResponseToEntity`
|
||||
);
|
||||
}
|
||||
keyRaw = `${parentFolderPath}${item.name}`;
|
||||
}
|
||||
|
||||
if (item.isfolder) {
|
||||
keyRaw = `${keyRaw}/`;
|
||||
id = item.folderid;
|
||||
} else {
|
||||
size = item.size;
|
||||
hashPCloud = item.hash;
|
||||
hash = `${item.hash}`;
|
||||
id = item.fileid;
|
||||
}
|
||||
|
||||
const mtime = new Date(item.modified).valueOf();
|
||||
|
||||
return {
|
||||
key: keyRaw,
|
||||
keyRaw: keyRaw,
|
||||
mtimeCli: mtime,
|
||||
mtimeSvr: mtime,
|
||||
id: id,
|
||||
parentID: item.parentfolderid,
|
||||
isFolder: item.isfolder,
|
||||
size: size,
|
||||
sizeRaw: size,
|
||||
hash: hash,
|
||||
hashPCloud: hashPCloud,
|
||||
parentIDPath: parentFolderPath,
|
||||
};
|
||||
};
|
||||
|
||||
const fromNestedFolderToEntityListAndCache = (
|
||||
root: Folder
|
||||
): { entities: PCloudEntity[]; key2Entity: Record<string, PCloudEntity> } => {
|
||||
// console.debug("root:");
|
||||
// console.debug(root);
|
||||
|
||||
const entities: PCloudEntity[] = [];
|
||||
const key2Entity: Record<string, PCloudEntity> = {};
|
||||
|
||||
if (root.contents === undefined || root.contents.length === 0) {
|
||||
// console.debug(`early return`);
|
||||
return {
|
||||
entities,
|
||||
key2Entity,
|
||||
};
|
||||
}
|
||||
|
||||
let parents: {
|
||||
folderPath: string;
|
||||
itself: Folder | File;
|
||||
}[] = [];
|
||||
for (const f of root.contents ?? []) {
|
||||
parents.push({
|
||||
folderPath: "",
|
||||
itself: f,
|
||||
});
|
||||
}
|
||||
|
||||
while (parents.length !== 0) {
|
||||
const children: typeof parents = [];
|
||||
for (const { folderPath, itself } of parents) {
|
||||
if (itself.isfolder && itself.folderid === root.folderid) {
|
||||
// special, ignore root folder itself
|
||||
} else {
|
||||
const entity = fromRawResponseToEntity(itself, folderPath);
|
||||
entities.push(entity);
|
||||
key2Entity[entity.keyRaw] = entity;
|
||||
}
|
||||
|
||||
if (
|
||||
itself.isfolder &&
|
||||
itself.contents !== undefined &&
|
||||
itself.contents.length > 0
|
||||
) {
|
||||
for (const f of itself.contents) {
|
||||
if (folderPath === "" || folderPath === "/") {
|
||||
const child = {
|
||||
itself: f,
|
||||
folderPath: `${itself.name}/`,
|
||||
};
|
||||
children.push(child);
|
||||
} else {
|
||||
const child = {
|
||||
itself: f,
|
||||
folderPath: `${folderPath}${itself.name}/`,
|
||||
};
|
||||
children.push(child);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
parents = children;
|
||||
}
|
||||
|
||||
// console.debug("entities:");
|
||||
// console.debug(entities);
|
||||
// console.debug("key2Entity:");
|
||||
// console.debug(key2Entity);
|
||||
|
||||
return {
|
||||
entities,
|
||||
key2Entity,
|
||||
};
|
||||
};
|
||||
|
||||
const getPCloudPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
return `/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||
};
|
||||
|
||||
export class FakeFsPCloud extends FakeFs {
|
||||
kind: string;
|
||||
|
||||
pCloudConfig: PCloudConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
keyToPCloudEntity: Record<string, PCloudEntity>;
|
||||
baseDirID: number;
|
||||
|
||||
client: pcloudSdk.Client;
|
||||
|
||||
constructor(
|
||||
pCloudConfig: PCloudConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "pcloud";
|
||||
this.pCloudConfig = pCloudConfig;
|
||||
this.remoteBaseDir = this.pCloudConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
this.keyToPCloudEntity = {};
|
||||
this.baseDirID = 0;
|
||||
|
||||
(global as any).locationid = pCloudConfig.locationid; // why?? pcloud, why??
|
||||
this.client = pcloudSdk.createClient(pCloudConfig.accessToken);
|
||||
}
|
||||
|
||||
async _init() {
|
||||
if (this.vaultFolderExists) {
|
||||
// pass
|
||||
} else {
|
||||
const root = (await this.client.listfolder(0, {
|
||||
recursive: false,
|
||||
})) as Folder;
|
||||
|
||||
// find?
|
||||
if (root.contents === undefined) {
|
||||
throw Error(`cannot listfolder of root!`);
|
||||
}
|
||||
const found = root.contents.filter(
|
||||
(x) => x.isfolder && x.name === this.remoteBaseDir
|
||||
);
|
||||
if (found.length > 0) {
|
||||
// we find it!
|
||||
const f = found[0] as Folder;
|
||||
this.baseDirID = f.folderid;
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
// not found, let's create it!
|
||||
const f: Folder = await this.client.createfolder(this.remoteBaseDir, 0);
|
||||
// console.debug(f);
|
||||
this.baseDirID = f.folderid;
|
||||
this.vaultFolderExists = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async _getAccessToken() {
|
||||
if (this.pCloudConfig.accessToken === "") {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
return this.pCloudConfig.accessToken;
|
||||
|
||||
// TODO: no expire date?
|
||||
// https://docs.pcloud.com/methods/intro/authentication.html
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const rsp = (await this.client.listfolder(this.baseDirID, {
|
||||
recursive: true,
|
||||
})) as Folder;
|
||||
|
||||
const { entities, key2Entity } = fromNestedFolderToEntityListAndCache(rsp);
|
||||
|
||||
this.keyToPCloudEntity = Object.assign(this.keyToPCloudEntity, key2Entity);
|
||||
|
||||
return entities;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const rsp = (await this.client.listfolder(this.baseDirID, {
|
||||
recursive: false,
|
||||
})) as Folder;
|
||||
const { entities, key2Entity } = fromNestedFolderToEntityListAndCache(rsp);
|
||||
|
||||
this.keyToPCloudEntity = Object.assign(this.keyToPCloudEntity, key2Entity);
|
||||
|
||||
return entities;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
|
||||
// TODO: we already have a cache, should we call again?
|
||||
const cachedEntity = this.keyToPCloudEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
// why? pcloud doesn't have stat api??
|
||||
return cachedEntity;
|
||||
}
|
||||
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime?: number | undefined,
|
||||
ctime?: number | undefined
|
||||
): Promise<Entity> {
|
||||
if (!key.endsWith("/")) {
|
||||
throw Error(`you should not mkdir on key=${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const cachedEntity = this.keyToPCloudEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity !== undefined && fileID !== undefined) {
|
||||
return cachedEntity;
|
||||
}
|
||||
|
||||
// xxx/ => ["xxx"]
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
let parentID: number | undefined = undefined;
|
||||
if (folderLevels.length === 0) {
|
||||
throw Error(`cannot getFolderLevels of ${key}`);
|
||||
} else if (folderLevels.length === 1) {
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = ""; // ignore base dir
|
||||
} else {
|
||||
// length > 1
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 2]}/`;
|
||||
if (!(parentFolderPath in this.keyToPCloudEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToPCloudEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
// xxx/yyy/zzz/ => ["xxx", "xxx/yyy", "xxx/yyy/zzz"] => "xxx/yyy/zzz" => "zzz"
|
||||
let folderItselfWithoutSlash = folderLevels[folderLevels.length - 1];
|
||||
folderItselfWithoutSlash = folderItselfWithoutSlash.split("/").pop()!;
|
||||
|
||||
const f = await this.client.createfolder(
|
||||
folderItselfWithoutSlash,
|
||||
parentID
|
||||
);
|
||||
|
||||
const entity = fromRawResponseToEntity(f, parentFolderPath);
|
||||
// insert into cache
|
||||
this.keyToPCloudEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://docs.pcloud.com/methods/file/uploadfile.html
|
||||
*/
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`should not call writeFile on ${key}`);
|
||||
}
|
||||
|
||||
await this._init();
|
||||
|
||||
const prevCachedEntity: PCloudEntity | undefined =
|
||||
this.keyToPCloudEntity[key];
|
||||
const prevFileID: number | undefined = prevCachedEntity?.id;
|
||||
|
||||
let parentID: number | undefined = undefined;
|
||||
let parentFolderPath: string | undefined = undefined;
|
||||
|
||||
// "xxx" => []
|
||||
// "xxx/yyy/zzz.md" => ["xxx", "xxx/yyy"]
|
||||
const folderLevels = getFolderLevels(key);
|
||||
if (folderLevels.length === 0) {
|
||||
// root
|
||||
parentID = this.baseDirID;
|
||||
parentFolderPath = "";
|
||||
} else {
|
||||
parentFolderPath = `${folderLevels[folderLevels.length - 1]}/`;
|
||||
if (!(parentFolderPath in this.keyToPCloudEntity)) {
|
||||
throw Error(
|
||||
`parent of ${key}: ${parentFolderPath} is not created before??`
|
||||
);
|
||||
}
|
||||
parentID = this.keyToPCloudEntity[parentFolderPath].id;
|
||||
}
|
||||
|
||||
const fileItself = key.split("/").pop()!;
|
||||
|
||||
// no idea how to use the sdk, let's use https here
|
||||
// https://docs.pcloud.com/methods/file/uploadfile.html
|
||||
const params = new URLSearchParams({
|
||||
access_token: await this._getAccessToken(),
|
||||
folderid: `${parentID}`,
|
||||
filename: fileItself,
|
||||
nopartial: `1`,
|
||||
renameifexists: `0`,
|
||||
mtime: `${Math.floor(mtime / 1000.0)}`,
|
||||
ctime: `${Math.floor(ctime / 1000.0)}`,
|
||||
});
|
||||
const apiUrl = `https://${this.pCloudConfig.hostname}/uploadfile?${params}`;
|
||||
|
||||
if (content.byteLength > 0) {
|
||||
const rsp = await fetch(apiUrl, {
|
||||
method: "PUT",
|
||||
body: content,
|
||||
});
|
||||
const f: StatRawResponse = await rsp.json();
|
||||
const entity = fromRawResponseToEntity(f.metadata[0], parentFolderPath);
|
||||
// console.debug(entity);
|
||||
this.keyToPCloudEntity[key] = entity;
|
||||
return entity;
|
||||
} else {
|
||||
// no idea why pcloud doesn't work for empty files
|
||||
// it can be uploaded successfully but the call doesn't end
|
||||
// we abort it and stat it manually.
|
||||
// console.warn(`uploading empty file ${key}`);
|
||||
const controller = new AbortController();
|
||||
const timeoutMs = 300; // just a random reasonable number
|
||||
const id = setTimeout(() => controller.abort(), timeoutMs);
|
||||
try {
|
||||
const rsp = await fetch(apiUrl, {
|
||||
method: "PUT",
|
||||
body: content,
|
||||
signal: controller.signal,
|
||||
});
|
||||
} catch (e) {
|
||||
// console.warn(`we abort the request of uploading empty file ${key}:`);
|
||||
// console.warn(e);
|
||||
} finally {
|
||||
clearTimeout(id);
|
||||
}
|
||||
|
||||
// raw stat here
|
||||
// https://docs.pcloud.com/methods/file/stat.html
|
||||
const params = new URLSearchParams({
|
||||
access_token: await this._getAccessToken(),
|
||||
path: getPCloudPath(key, this.remoteBaseDir),
|
||||
});
|
||||
const apiUrlStat = `https://${this.pCloudConfig.hostname}/stat?${params}`;
|
||||
const rsp2 = await fetch(apiUrlStat);
|
||||
const f = await rsp2.json();
|
||||
const entity = fromRawResponseToEntity(f.metadata, parentFolderPath);
|
||||
// console.warn(entity);
|
||||
this.keyToPCloudEntity[key] = entity;
|
||||
return entity;
|
||||
}
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
await this._init();
|
||||
const cachedEntity = this.keyToPCloudEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
const params = new URLSearchParams({
|
||||
access_token: await this._getAccessToken(),
|
||||
forcedownload: `1`,
|
||||
fileid: `${fileID}`,
|
||||
});
|
||||
const urlMeta = `https://${this.pCloudConfig.hostname}/getfilelink?${params}`;
|
||||
|
||||
// Referrer is restricted to pcloud.com.
|
||||
// we need to bypass it
|
||||
const meta = (await requestUrl(urlMeta)).json;
|
||||
// console.debug(meta);
|
||||
const link: string = `https://${meta.hosts[0]}${meta.path}`;
|
||||
const rsp = await requestUrl(link);
|
||||
const content = rsp.arrayBuffer;
|
||||
return content;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
await this._init();
|
||||
|
||||
const cachedEntity = this.keyToPCloudEntity[key];
|
||||
const fileID = cachedEntity?.id;
|
||||
if (cachedEntity === undefined || fileID === undefined) {
|
||||
throw Error(`no fileID found for key=${key}`);
|
||||
}
|
||||
|
||||
if (key.endsWith("/")) {
|
||||
await this.client.deletefolder(fileID);
|
||||
} else {
|
||||
await this.client.deletefile(fileID);
|
||||
}
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async revokeAuth(): Promise<any> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,516 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import PQueue from "p-queue";
|
||||
import type { Entity } from "../../src/baseTypes";
|
||||
import { FakeFs } from "../../src/fsAll";
|
||||
import { unixTimeToStr } from "../../src/misc";
|
||||
import {
|
||||
COMMAND_CALLBACK_YANDEXDISK,
|
||||
YANDEXDISK_CLIENT_ID,
|
||||
YANDEXDISK_CLIENT_SECRET,
|
||||
type YandexDiskConfig,
|
||||
} from "./baseTypesPro";
|
||||
import {
|
||||
type FilesResourceList,
|
||||
type Resource,
|
||||
type ResourceList,
|
||||
YandexApi,
|
||||
} from "./yandexApi";
|
||||
|
||||
export const DEFAULT_YANDEXDISK_CONFIG: YandexDiskConfig = {
|
||||
accessToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
refreshToken: "",
|
||||
scope: "",
|
||||
kind: "yandexdisk",
|
||||
};
|
||||
|
||||
/**
|
||||
* https://yandex.com/dev/id/doc/en/codes/code-url#code
|
||||
*/
|
||||
export const generateAuthUrl = (hasCallback: boolean) => {
|
||||
let callback = `https://oauth.yandex.com/verification_code`;
|
||||
if (hasCallback) {
|
||||
callback = `obsidian://${COMMAND_CALLBACK_YANDEXDISK}`;
|
||||
}
|
||||
|
||||
const params = new URLSearchParams({
|
||||
response_type: "code",
|
||||
client_id: YANDEXDISK_CLIENT_ID ?? "",
|
||||
redirect_uri: callback,
|
||||
force_confirm: "yes",
|
||||
state: nanoid(),
|
||||
});
|
||||
|
||||
const url = `https://oauth.yandex.com/authorize?${params}`;
|
||||
return url;
|
||||
};
|
||||
|
||||
interface AuthResSucc {
|
||||
token_type: "bearer";
|
||||
access_token: string;
|
||||
expires_in: number;
|
||||
refresh_token: string;
|
||||
scope: string | undefined;
|
||||
}
|
||||
|
||||
interface AuthResFail {
|
||||
error: string;
|
||||
error_description: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://yandex.com/dev/id/doc/en/codes/code-url#token
|
||||
*/
|
||||
export const sendAuthReq = async (authCode: string, errorCallBack: any) => {
|
||||
try {
|
||||
const k = {
|
||||
code: authCode,
|
||||
grant_type: "authorization_code",
|
||||
client_id: YANDEXDISK_CLIENT_ID ?? "",
|
||||
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
|
||||
// redirect_uri: `obsidian://${COMMAND_CALLBACK_BOX}`,
|
||||
};
|
||||
// console.debug(k);
|
||||
const resp1 = await fetch(`https://oauth.yandex.com/token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams(k),
|
||||
});
|
||||
|
||||
if (resp1.status !== 200) {
|
||||
const resp2: AuthResFail = await resp1.json();
|
||||
throw Error(JSON.stringify(resp2));
|
||||
}
|
||||
|
||||
const resp2: AuthResSucc = await resp1.json();
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
if (errorCallBack !== undefined) {
|
||||
await errorCallBack(e);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* https://yandex.com/dev/id/doc/en/tokens/refresh-client
|
||||
*/
|
||||
export const sendRefreshTokenReq = async (refreshToken: string) => {
|
||||
console.debug(`refreshing token`);
|
||||
const x = await fetch("https://oauth.yandex.com/token", {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: YANDEXDISK_CLIENT_ID ?? "",
|
||||
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
|
||||
grant_type: "refresh_token",
|
||||
refresh_token: refreshToken,
|
||||
}).toString(),
|
||||
});
|
||||
|
||||
if (x.status === 200) {
|
||||
const y: AuthResSucc = await x.json();
|
||||
console.debug(`new token obtained`);
|
||||
return y;
|
||||
} else {
|
||||
const y: AuthResFail = await x.json();
|
||||
throw Error(`cannot refresh an access token: ${JSON.stringify(y)}`);
|
||||
}
|
||||
};
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: YandexDiskConfig,
|
||||
authRes: any,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresAtTimeMs =
|
||||
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
|
||||
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
|
||||
config.refreshToken = authRes.refresh_token || config.refreshToken;
|
||||
|
||||
// manually set it expired after 60 days;
|
||||
config.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + 1000 * 60 * 60 * 24 * 59;
|
||||
|
||||
await saveUpdatedConfigFunc?.();
|
||||
|
||||
console.info("finish updating local info of Yandex Disk token");
|
||||
};
|
||||
|
||||
const getYandexDiskPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
let key = fileOrFolderPath;
|
||||
if (fileOrFolderPath === "/" || fileOrFolderPath === "") {
|
||||
// special
|
||||
key = `disk:/${remoteBaseDir}`;
|
||||
} else if (fileOrFolderPath.startsWith("/")) {
|
||||
console.warn(
|
||||
`why the path ${fileOrFolderPath} starts with '/'? but we just go on.`
|
||||
);
|
||||
key = `disk:/${remoteBaseDir}${fileOrFolderPath}`;
|
||||
} else {
|
||||
key = `disk:/${remoteBaseDir}/${fileOrFolderPath}`;
|
||||
}
|
||||
if (key.endsWith("/")) {
|
||||
key = key.slice(0, key.length - 1);
|
||||
}
|
||||
return key;
|
||||
};
|
||||
|
||||
const getNormPath = (
|
||||
fileOrFolderPath: string,
|
||||
remoteBaseDir: string,
|
||||
type: "dir" | "file"
|
||||
) => {
|
||||
if (
|
||||
!(
|
||||
fileOrFolderPath === `disk:/${remoteBaseDir}` ||
|
||||
fileOrFolderPath.startsWith(`disk:/${remoteBaseDir}/`)
|
||||
)
|
||||
) {
|
||||
throw Error(
|
||||
`"${fileOrFolderPath}" doesn't starts with "disk:/${remoteBaseDir}/"`
|
||||
);
|
||||
}
|
||||
let key = fileOrFolderPath.slice(`disk:/${remoteBaseDir}/`.length);
|
||||
if (type === "dir") {
|
||||
key = `${key}/`;
|
||||
}
|
||||
return key;
|
||||
};
|
||||
|
||||
const fromResourceToEntity = (x: Resource, remoteBaseDir: string): Entity => {
|
||||
const key = getNormPath(x.path!, remoteBaseDir, x.type!);
|
||||
if (x.type === "dir") {
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
} as Entity;
|
||||
} else {
|
||||
// file
|
||||
const mtimeCli = Date.parse(
|
||||
x?.custom_properties?.rclone_modified ?? x.modified!
|
||||
).valueOf();
|
||||
const mtimeSvr = Date.parse(x.modified!).valueOf();
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeCli: mtimeCli,
|
||||
mtimeSvr: mtimeSvr,
|
||||
size: x.size!,
|
||||
sizeRaw: x.size!,
|
||||
hash: x.sha256,
|
||||
} as Entity;
|
||||
}
|
||||
};
|
||||
|
||||
const FIELDS_FOR_RESOURCE = [
|
||||
"name",
|
||||
"created",
|
||||
"modified",
|
||||
"path",
|
||||
"type",
|
||||
"size",
|
||||
"sha256",
|
||||
"md5",
|
||||
"_embedded.limit",
|
||||
"_embedded.offset",
|
||||
"_embedded.total",
|
||||
"_embedded.items.created",
|
||||
"_embedded.items.modified",
|
||||
"_embedded.items.path",
|
||||
"_embedded.items.name",
|
||||
"_embedded.items.type",
|
||||
"_embedded.items.size",
|
||||
"_embedded.items.sha256",
|
||||
"_embedded.items.md5",
|
||||
"_embedded.items.mime_type",
|
||||
"_embedded.items.file",
|
||||
"_embedded.items.custom_properties",
|
||||
];
|
||||
|
||||
export class FakeFsYandexDisk extends FakeFs {
|
||||
kind: string;
|
||||
yandexDiskConfig: YandexDiskConfig;
|
||||
remoteBaseDir: string;
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
constructor(
|
||||
yandexDiskConfig: YandexDiskConfig,
|
||||
vaultName: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any>
|
||||
) {
|
||||
super();
|
||||
this.kind = "yandexdisk";
|
||||
this.yandexDiskConfig = yandexDiskConfig;
|
||||
this.remoteBaseDir = this.yandexDiskConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
}
|
||||
|
||||
async _init() {
|
||||
const access = await this._getAccessToken();
|
||||
const client = new YandexApi(access);
|
||||
|
||||
if (this.vaultFolderExists) {
|
||||
// pass
|
||||
} else {
|
||||
const res: Resource[] = [];
|
||||
let offset = 0;
|
||||
const limit = 100;
|
||||
let total = 100;
|
||||
do {
|
||||
const k = await client.diskResources(
|
||||
"disk:/",
|
||||
FIELDS_FOR_RESOURCE,
|
||||
limit,
|
||||
offset
|
||||
);
|
||||
res.push(...(k._embedded?.items ?? []));
|
||||
total = k._embedded?.total ?? 0;
|
||||
offset += limit;
|
||||
} while (offset < total);
|
||||
|
||||
if (res.filter((x) => x.name === this.remoteBaseDir).length > 0) {
|
||||
// found
|
||||
this.vaultFolderExists = true;
|
||||
} else {
|
||||
// need to create
|
||||
await client.diskResourcesPut(`disk:/${this.remoteBaseDir}`);
|
||||
this.vaultFolderExists = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async _getAccessToken() {
|
||||
if (this.yandexDiskConfig.refreshToken === "") {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
}
|
||||
|
||||
const ts = Date.now();
|
||||
const comp = this.yandexDiskConfig.accessTokenExpiresAtTimeMs > ts;
|
||||
// console.debug(`this.yandexDiskConfig.accessTokenExpiresAtTimeMs=${this.yandexDiskConfig.accessTokenExpiresAtTimeMs},ts=${ts},comp=${comp}`)
|
||||
if (comp) {
|
||||
return this.yandexDiskConfig.accessToken;
|
||||
}
|
||||
|
||||
// refresh
|
||||
const k = await sendRefreshTokenReq(this.yandexDiskConfig.refreshToken);
|
||||
this.yandexDiskConfig.accessToken = k.access_token;
|
||||
this.yandexDiskConfig.accessTokenExpiresInMs = k.expires_in * 1000;
|
||||
this.yandexDiskConfig.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
await this.saveUpdatedConfigFunc();
|
||||
console.info("Yandex Disk accessToken updated");
|
||||
return this.yandexDiskConfig.accessToken;
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
// bfs
|
||||
const queue = new PQueue({
|
||||
concurrency: 5, // TODO: make it configurable?
|
||||
autoStart: true,
|
||||
});
|
||||
queue.on("error", (error) => {
|
||||
queue.pause();
|
||||
queue.clear();
|
||||
throw error;
|
||||
});
|
||||
|
||||
const entities: Entity[] = [];
|
||||
|
||||
let parents = ["/"];
|
||||
while (parents.length !== 0) {
|
||||
const children: typeof parents = [];
|
||||
for (const p of parents) {
|
||||
queue.add(async () => {
|
||||
const entitiesOfALevel = await this._walkFolder(p);
|
||||
for (const entity of entitiesOfALevel) {
|
||||
entities.push(entity);
|
||||
if (entity.keyRaw.endsWith("/")) {
|
||||
children.push(entity.keyRaw);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
await queue.onIdle();
|
||||
parents = children;
|
||||
}
|
||||
|
||||
// console.debug(entities);
|
||||
return entities;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
const entities = await this._walkFolder("/");
|
||||
return entities;
|
||||
}
|
||||
|
||||
async _walkFolder(key: string) {
|
||||
if (!key.endsWith("/")) {
|
||||
throw Error(`should not call _walkFolder on ${key}`);
|
||||
}
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
const entities: Entity[] = [];
|
||||
let offset = 0;
|
||||
const limit = 100;
|
||||
let total = 100;
|
||||
// TODO: once we know the total in the first loop, we can run the list in parallel
|
||||
do {
|
||||
const k = await client.diskResources(
|
||||
p,
|
||||
FIELDS_FOR_RESOURCE,
|
||||
limit,
|
||||
offset
|
||||
);
|
||||
entities.push(
|
||||
...(k._embedded?.items ?? []).map((x) =>
|
||||
fromResourceToEntity(x, this.remoteBaseDir)
|
||||
)
|
||||
);
|
||||
total = k._embedded?.total ?? 0;
|
||||
offset += limit;
|
||||
} while (offset < total);
|
||||
return entities;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
const r = await client.diskResources(p, FIELDS_FOR_RESOURCE);
|
||||
const entity = fromResourceToEntity(r, this.remoteBaseDir);
|
||||
return entity;
|
||||
}
|
||||
|
||||
async mkdir(
|
||||
key: string,
|
||||
mtime?: number | undefined,
|
||||
ctime?: number | undefined
|
||||
): Promise<Entity> {
|
||||
// console.debug(`mkdir ${key} begin`)
|
||||
await this._init();
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
// create
|
||||
await client.diskResourcesPut(p, FIELDS_FOR_RESOURCE);
|
||||
// patch?
|
||||
const custom: Record<string, string> = {};
|
||||
if (mtime !== undefined) {
|
||||
custom["rclone_modified"] = unixTimeToStr(mtime, true);
|
||||
}
|
||||
if (ctime !== undefined) {
|
||||
custom["rclone_created"] = unixTimeToStr(ctime, true);
|
||||
}
|
||||
if (Object.keys(custom).length > 0) {
|
||||
await client.diskResourcesPatch(p, custom);
|
||||
}
|
||||
const entity = await this.stat(key);
|
||||
// console.debug(`mkdir ${key} finish, ${JSON.stringify(entity)}`)
|
||||
return entity;
|
||||
}
|
||||
|
||||
async writeFile(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
): Promise<Entity> {
|
||||
// console.debug(`writeFile ${key} begin`)
|
||||
await this._init();
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
await client.diskResoucesUpload(p, content, true);
|
||||
// console.debug(`writeFile ${key} upload succ`)
|
||||
// patch?
|
||||
const custom: Record<string, string> = {};
|
||||
if (mtime !== undefined) {
|
||||
custom["rclone_modified"] = unixTimeToStr(mtime, true);
|
||||
}
|
||||
if (ctime !== undefined) {
|
||||
custom["rclone_created"] = unixTimeToStr(ctime, true);
|
||||
}
|
||||
if (Object.keys(custom).length > 0) {
|
||||
await client.diskResourcesPatch(p, custom);
|
||||
}
|
||||
// console.debug(`writeFile ${key} patch succ`)
|
||||
const entity = await this.stat(key);
|
||||
// console.debug(`writeFile ${key} finish, ${JSON.stringify(entity)}`)
|
||||
return entity;
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
// console.debug(`readFile ${key} begin`)
|
||||
await this._init();
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
const content = await client.diskResoucesDownload(p);
|
||||
// console.debug(`readFile ${key} finish, length=${content.byteLength}`)
|
||||
return content;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
await this._init();
|
||||
const client = new YandexApi(await this._getAccessToken());
|
||||
const p = getYandexDiskPath(key, this.remoteBaseDir);
|
||||
await client.diskResourcesDelete(p, false);
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
await this._init();
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
/**
|
||||
* https://yandex.com/dev/id/doc/en/tokens/token-invalidate
|
||||
*/
|
||||
async revokeAuth(): Promise<any> {
|
||||
await fetch(`https://oauth.yandex.com/revoke_token`, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
client_id: YANDEXDISK_CLIENT_ID ?? "",
|
||||
client_secret: YANDEXDISK_CLIENT_SECRET ?? "",
|
||||
access_token: this.yandexDiskConfig.refreshToken, // TODO: which token?
|
||||
}).toString(),
|
||||
});
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
Vendored
+9953
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,297 @@
|
||||
{
|
||||
"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.",
|
||||
|
||||
"protocol_onedrivefull_connecting": "Connecting to OneDrive...\nPlease DO NOT close this modal.",
|
||||
"protocol_onedrivefull_connect_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
|
||||
"protocol_onedrivefull_connect_fail": "Something went wrong from response from OneDrive. Maybe you rejected the auth?",
|
||||
"protocol_onedrivefull_connect_unknown": "Do not know how to deal with the callback: {{params}}",
|
||||
|
||||
"protocol_box_connecting": "Connectting",
|
||||
"protocol_box_connect_manualinput_succ": "You've connected",
|
||||
"protocol_box_connect_fail": "Something went wrong from response from Box official website. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||
"protocol_box_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
|
||||
|
||||
"protocol_pcloud_connecting": "Connectting",
|
||||
"protocol_pcloud_connect_manualinput_succ": "You've connected",
|
||||
"protocol_pcloud_connect_fail": "Something went wrong from response from pCloud website. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||
"protocol_pcloud_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
|
||||
|
||||
"protocol_yandexdisk_connecting": "Connectting",
|
||||
"protocol_yandexdisk_connect_manualinput_succ": "You've connected",
|
||||
"protocol_yandexdisk_connect_fail": "Something went wrong from response from Yandex Disk website. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||
"protocol_yandexdisk_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
|
||||
|
||||
"protocol_koofr_connecting": "Connectting",
|
||||
"protocol_koofr_connect_manualinput_succ": "You've connected",
|
||||
"protocol_koofr_connect_fail": "Something went wrong from response from Koofr website. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||
"protocol_koofr_connect_succ_revoke": "You've connected. If you want to disconnect, click this button.",
|
||||
|
||||
"modal_onedrivefullauth_shortdesc": "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).\nVisit the address in a browser, and follow the steps.\nFinally you should be redirected to Obsidian.",
|
||||
"modal_onedrivefullauth_shortdesc_linux": "It seems that you are using Obsidian on Linux, and you might not be able to jump back here properly. Please consider <a href=\"https://github.com/remotely-save/remotely-save/issues/415\">using</a> the flatpack version of Obsidian, or creating an <a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/linux.md\"><code>obsidian.desktop</code> file</a>.",
|
||||
"modal_onedrivefullauth_copybutton": "Click to copy the auth url",
|
||||
"modal_onedrivefullauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_onedrivefullrevokeauth_step1": "Step 1: Go to the following address, click the \"Edit\" button for the plugin, then click \"Remove these permissions\" button on the page.",
|
||||
"modal_onedrivefullrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_onedrivefullrevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_onedrivefullrevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_onedrivefullrevokeauth_clean_button": "Clean",
|
||||
"modal_onedrivefullrevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_onedrivefullrevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_googledriveauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will see a code, please paste that code here and submit.</p>",
|
||||
"modal_googledriveauth_copybutton": "Click to copy the auth url",
|
||||
"modal_googledriveauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_googledrivce_maualinput": "The Code from the website",
|
||||
"modal_googledrivce_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.",
|
||||
"modal_googledrive_maualinput_notice": "We are trying to connect to Google and update the credentials...",
|
||||
"modal_googledrive_maualinput_succ_notice": "Great! The credentials are updated!",
|
||||
"modal_googledrive_maualinput_fail_notice": "Oops! Failed to update the credentials. Please try again later.",
|
||||
"modal_googledriverevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
|
||||
"modal_googledriverevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_googledriverevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_googledriverevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_googledriverevokeauth_clean_button": "Clean",
|
||||
"modal_googledriverevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_googledriverevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_boxauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
|
||||
"modal_boxauth_copybutton": "Click to copy the auth url",
|
||||
"modal_boxauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_box_maualinput": "The Code from the website",
|
||||
"modal_box_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.",
|
||||
"modal_box_maualinput_notice": "We are trying to connect to Box and update the credentials...",
|
||||
"modal_box_maualinput_succ_notice": "Great! The credentials are updated!",
|
||||
"modal_box_maualinput_fail_notice": "Oops! Failed to update the credentials. Please try again later.",
|
||||
"modal_boxrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
|
||||
"modal_boxrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_boxrevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_boxrevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_boxrevokeauth_clean_button": "Clean",
|
||||
"modal_boxrevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_boxrevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_pcloudauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
|
||||
"modal_pcloudauth_copybutton": "Click to copy the auth url",
|
||||
"modal_pcloudauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_pcloudrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
|
||||
"modal_pcloudrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_pcloudrevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_pcloudrevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_pcloudrevokeauth_clean_button": "Clean",
|
||||
"modal_pcloudrevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_pcloudrevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_yandexdiskauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
|
||||
"modal_yandexdiskauth_copybutton": "Click to copy the auth url",
|
||||
"modal_yandexdiskauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_yandexdiskrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
|
||||
"modal_yandexdiskrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_yandexdiskrevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_yandexdiskrevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_yandexdiskrevokeauth_clean_button": "Clean",
|
||||
"modal_yandexdiskrevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_yandexdiskrevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_koofrauth_tutorial": "<p>Please firstly go to the address, then go on the auth flow. In the end, you will be redirected to here.</p>",
|
||||
"modal_koofrauth_copybutton": "Click to copy the auth url",
|
||||
"modal_koofrauth_copynotice": "The auth url is copied to the clipboard!",
|
||||
"modal_koofrrevokeauth_step1": "Step 1: Go to the following address, you can remove the connection there.",
|
||||
"modal_koofrrevokeauth_step2": "Step 2: Click the button below, to clean the locally-saved login credentials.",
|
||||
"modal_koofrrevokeauth_clean": "Clean Locally-Saved Login Credentials",
|
||||
"modal_koofrrevokeauth_clean_desc": "You need to click the button.",
|
||||
"modal_koofrrevokeauth_clean_button": "Clean",
|
||||
"modal_koofrrevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_koofrrevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
|
||||
"modal_remoteprefix_azureblobstorage_title": "You are changing the remote prefix config",
|
||||
"modal_remoteprefix_azureblobstorage_shortdesc": "1. The plugin would NOT automatically move the content from the old directory to the new one directly on the remote. Everything syncs from the beginning again.\n2. If you set the string to the empty, the prefix will be the vault name.\n3. The remote directory name itself would not be encrypted even you've set an E2E password.\n4. Some special char like '?', '/', '\\' are not allowed. Spaces in the beginning or in the end are also trimmed.",
|
||||
"modal_remoteprefix_azureblobstorage_invaliddirhint": "Your input contains special characters like '?', '/', '\\' which are not allowed.",
|
||||
"modal_remoteprefix_azureblobstorage_tosave": "The prefix to save is \"{{{prefix}}}\"",
|
||||
"modal_remoteprefix_azureblobstorage_secondconfirm_change": "Confirm To Change",
|
||||
"modal_remoteprefix_azureblobstorage_notice": "New remote prefix config saved!",
|
||||
|
||||
"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_onedrivefull": "Remote For Onedrive (for personal) (Full)",
|
||||
"settings_chooseservice_onedrivefull": "OneDrive for personal (Full) (PRO)",
|
||||
"settings_onedrivefull_disclaimer1": "Disclaimer: This app is NOT an official Microsoft / OneDrive product.",
|
||||
"settings_onedrivefull_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Onedrive, please immediately disconnect this app on https://microsoft.com/consent .",
|
||||
"settings_onedrivefull_folder": "We will create and sync inside the folder /{{remoteBaseDir}} on your OneDrive.",
|
||||
"settings_onedrivefull_nobiz": "Currently only OneDrive for personal is supported. OneDrive for Business is NOT supported (yet).",
|
||||
"settings_onedrivefull_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_onedrivefull_notshowuphint": "OneDrive for personal (Full) Settings Not Available",
|
||||
"settings_onedrivefull_notshowuphint_desc": "OneDrive for personal (Full) settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_onedrivefull_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_onedrivefull_revoke": "Revoke Auth",
|
||||
"settings_onedrivefull_revoke_desc": "You've connected as user {{username}}. If you want to disconnect, click this button.",
|
||||
"settings_onedrivefull_revoke_button": "Revoke Auth",
|
||||
"settings_onedrivefull_auth": "Auth",
|
||||
"settings_onedrivefull_auth_desc": "Auth.",
|
||||
"settings_onedrivefull_auth_button": "Auth",
|
||||
"settings_onedrivefull_connect_succ": "Great! We can connect to OneDrive!",
|
||||
"settings_onedrivefull_connect_fail": "We cannot connect to OneDrive.",
|
||||
"settings_onedrivefull_emptyfile": "Empty File Handling",
|
||||
"settings_onedrivefull_emptyfile_desc": "OneDrive doesn't allow uploading empty file (even in its official website). Do you want to show up errors or silently skip the empty files?",
|
||||
"settings_onedrivefull_emptyfile_skip": "Skip",
|
||||
"settings_onedrivefull_emptyfile_error": "Error and abort",
|
||||
|
||||
"settings_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_googledrive_disclaimer1": "Disclaimer: This app is NOT an official Google product. The app just uses Google Drive's public api.",
|
||||
"settings_googledrive_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Google Drive, please immediately disconnect this app on https://myaccount.google.com/permissions .",
|
||||
"settings_googledrive_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_googledrive_notshowuphint": "Google Drive Settings Not Available",
|
||||
"settings_googledrive_notshowuphint_desc": "Google Drive settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_googledrive_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_googledrive_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Google Drive. DO NOT create this folder by yourself manually.",
|
||||
"settings_googledrive_revoke": "Revoke Auth",
|
||||
"settings_googledrive_revoke_desc": "You've connected. If you want to disconnect, click this button.",
|
||||
"settings_googledrive_revoke_button": "Revoke Auth",
|
||||
"settings_googledrive_auth": "Auth",
|
||||
"settings_googledrive_auth_desc": "Auth.",
|
||||
"settings_googledrive_auth_button": "Auth",
|
||||
"settings_googledrive_connect_succ": "Great! We can connect to Google Drive!",
|
||||
"settings_googledrive_connect_fail": "We cannot connect to Google Drive.",
|
||||
|
||||
"settings_box": "Box (PRO) (beta)",
|
||||
"settings_chooseservice_box": "Box (PRO) (beta)",
|
||||
"settings_box_disclaimer1": "Disclaimer: This app is NOT an official Box product. The app just uses Box's public api.",
|
||||
"settings_box_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Box, please immediately disconnect this app on https://app.box.com/account/security .",
|
||||
"settings_box_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_box_notshowuphint": "Box Settings Not Available",
|
||||
"settings_box_notshowuphint_desc": "Box settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_box_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_box_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Box. DO NOT create this folder by yourself manually.",
|
||||
"settings_box_revoke": "Revoke Auth",
|
||||
"settings_box_revoke_desc": "You've connected. If you want to disconnect, click this button.",
|
||||
"settings_box_revoke_button": "Revoke Auth",
|
||||
"settings_box_auth": "Auth",
|
||||
"settings_box_auth_desc": "Auth.",
|
||||
"settings_box_auth_button": "Auth",
|
||||
"settings_box_connect_succ": "Great! We can connect to Box!",
|
||||
"settings_box_connect_fail": "We cannot connect to Box.",
|
||||
|
||||
"settings_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_pcloud_disclaimer1": "Disclaimer: This app is NOT an official pCloud product. The app just uses pCloud's public api.",
|
||||
"settings_pcloud_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your pCloud, please immediately disconnect this app on https://my.pcloud.com/#page=settings&settings=tab-apps .",
|
||||
"settings_pcloud_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_pcloud_notshowuphint": "pCloud Settings Not Available",
|
||||
"settings_pcloud_notshowuphint_desc": "pCloud settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_pcloud_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_pcloud_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your pCloud. DO NOT create this folder by yourself manually.",
|
||||
"settings_pcloud_revoke": "Revoke Auth",
|
||||
"settings_pcloud_revoke_desc": "You've connected. If you want to disconnect, click this button.",
|
||||
"settings_pcloud_revoke_button": "Revoke Auth",
|
||||
"settings_pcloud_auth": "Auth",
|
||||
"settings_pcloud_auth_desc": "Auth.",
|
||||
"settings_pcloud_auth_button": "Auth",
|
||||
"settings_pcloud_emptyfile": "Empty File",
|
||||
"settings_pcloud_emptyfile_desc": "pCloud API doesn't work with empty file. How to deal with it?",
|
||||
"settings_pcloud_emptyfile_skip": "Skip",
|
||||
"settings_pcloud_emptyfile_error": "Error",
|
||||
"settings_pcloud_connect_succ": "Great! We can connect to pCloud!",
|
||||
"settings_pcloud_connect_fail": "We cannot connect to pCloud.",
|
||||
|
||||
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_yandexdisk_disclaimer1": "Disclaimer: This app is NOT an official Yandex Disk product. The app just uses Yandex Disk's public api.",
|
||||
"settings_yandexdisk_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Yandex Disk, please immediately disconnect this app on https://app.yandexdisk.com/account/security .",
|
||||
"settings_yandexdisk_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_yandexdisk_notshowuphint": "Yandex Disk Settings Not Available",
|
||||
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_yandexdisk_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_yandexdisk_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Yandex Disk. DO NOT create this folder by yourself manually.",
|
||||
"settings_yandexdisk_revoke": "Revoke Auth",
|
||||
"settings_yandexdisk_revoke_desc": "You've connected. If you want to disconnect, click this button.",
|
||||
"settings_yandexdisk_revoke_button": "Revoke Auth",
|
||||
"settings_yandexdisk_auth": "Auth",
|
||||
"settings_yandexdisk_auth_desc": "Auth.",
|
||||
"settings_yandexdisk_auth_button": "Auth",
|
||||
"settings_yandexdisk_connect_succ": "Great! We can connect to Yandex Disk!",
|
||||
"settings_yandexdisk_connect_fail": "We cannot connect to Yandex Disk.",
|
||||
|
||||
"settings_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_koofr_disclaimer1": "Disclaimer: This app is NOT an official Koofr product. The app just uses Koofr's public api.",
|
||||
"settings_koofr_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Koofr, please immediately disconnect this app on https://app.koofr.net/app/admin/preferences/security .",
|
||||
"settings_koofr_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_koofr_notshowuphint": "Koofr Settings Not Available",
|
||||
"settings_koofr_notshowuphint_desc": "Koofr settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_koofr_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_koofr_folder": "We will create and sync inside the folder {{remoteBaseDir}} on your Koofr. DO NOT create this folder by yourself manually.",
|
||||
"settings_koofr_revoke": "Revoke Auth",
|
||||
"settings_koofr_revoke_desc": "You've connected. If you want to disconnect, click this button.",
|
||||
"settings_koofr_revoke_button": "Revoke Auth",
|
||||
"settings_koofr_auth": "Auth",
|
||||
"settings_koofr_auth_desc": "Auth.",
|
||||
"settings_koofr_auth_button": "Auth",
|
||||
"settings_koofr_connect_succ": "Great! We can connect to Koofr!",
|
||||
"settings_koofr_connect_fail": "We cannot connect to Koofr.",
|
||||
|
||||
"settings_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_chooseservice_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_azureblobstorage_disclaimer1": "Disclaimer: This app is NOT an official Microsoft / Azure product. The app just uses Azure Blob Storage's public api.",
|
||||
"settings_azureblobstorage_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins could read the info. If you see any unintentional access to your Azure Blob Storage, please immediately delete the SAS Url and <a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">try to change your policy</a> or account info.",
|
||||
"settings_azureblobstorage_pro_desc": "<p><strong>!!It's a PRO feature of Remotely Save! You need a Remotely Save online account for this feature!!</strong>(<a href=\"#settings-pro\">scroll down</a> for more info about PRO account.)</p>",
|
||||
"settings_azureblobstorage_notshowuphint": "Azure Blob Storage Settings Not Available",
|
||||
"settings_azureblobstorage_notshowuphint_desc": "Azure Blob Storage settings are not available, because you haven't subscribed to the PRO feature in your Remotely Save account.",
|
||||
"settings_azureblobstorage_notshowuphint_view_pro": "View PRO Settings",
|
||||
"settings_azureblobstorage_folder": "We will create and sync inside the prefix {{remoteBaseDir}} on your Azure Blob Storage.",
|
||||
"settings_azureblobstorage_containersasurl": "Container SAS Url",
|
||||
"settings_azureblobstorage_containersasurl_desc": "The only connction method is providing the Container SAS Url. Remember to configure CORS as well. Please read the <a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">doc</a> for details.",
|
||||
"settings_azureblobstorage_containername": "Container Name",
|
||||
"settings_azureblobstorage_containername_desc": "Input your container name here.",
|
||||
"settings_azureblobstorage_remoteprefix": "Remote Prefix",
|
||||
"settings_azureblobstorage_remoteprefix_desc": "Input your remote prefix of blobs for this vault. If you set this value to empty, the <strong>vault name</strong> will be used as prefix. <strong>Empty prefix is not allowed and not settable here.</strong>",
|
||||
"settings_azureblobstorage_parts": "Parts Concurrency",
|
||||
"settings_azureblobstorage_parts_desc": "Large files are split into small parts to upload. How many parts do you want to upload in parallel at most?",
|
||||
"settings_azureblobstorage_generatefolderobject": "Generate Folder Object Or Not",
|
||||
"settings_azureblobstorage_generatefolderobject_desc": "Azure Blob Storage doesn't have \"real\" folder. If you set \"Generate\" here, the plugin will upload a zero-byte object endding with \"/\" to represent the folder. By default, the plugin skips generating folder object.",
|
||||
"settings_azureblobstorage_generatefolderobject_notgenerate": "Not generate (default)",
|
||||
"settings_azureblobstorage_generatefolderobject_generate": "Generate",
|
||||
"settings_azureblobstorage_connect_succ": "Great! We can connect to Azure Blob Storage!",
|
||||
"settings_azureblobstorage_connect_fail": "We cannot connect to Azure Blob Storage.",
|
||||
|
||||
"settings_export_onedrivefull_button": "Export Onedrive (Full) Part",
|
||||
"settings_export_googledrive_button": "Export Google Drive Part",
|
||||
"settings_export_box_button": "Export Box Part",
|
||||
"settings_export_pcloud_button": "Export pCloud Part",
|
||||
"settings_export_yandexdisk_button": "Export Yandex Disk Part",
|
||||
"settings_export_koofr_button": "Export Koofr Part",
|
||||
"settings_export_azureblobstorage_button": "Export Azure Blob Storage Part",
|
||||
|
||||
"settings_pro": "Account (for PRO features)",
|
||||
"settings_pro_tutorial": "<p>Using <stong>basic</strong> features of Remotely Save is <strong>FREE</strong> and do <strong>NOT</strong> need an account.</p><p>However, you will <strong>need</strong> an online account and <strong>PAY</strong> for the <strong>PRO</strong> features such as smart conflict.</p><p>Firstly please click the button to sign up and sign in to the website: <a href=\"https://remotelysave.com\">https://remotelysave.com</a>. Notice: It's different from, and NOT affiliated with Obsidian account.</p><p>Secondly please \"connect\" your local device to your online account.",
|
||||
"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,304 @@
|
||||
{
|
||||
"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}}。如果要取消连接,请点击此按钮。",
|
||||
|
||||
"protocol_onedrivefull_connecting": "正在连接 OneDrive……\n请不要关闭此弹窗。",
|
||||
"protocol_onedrivefull_connect_succ_revoke": "您已作为用户 {{username}} 连接上了。如果您想取消连接,请点击此按钮。",
|
||||
"protocol_onedrivefull_connect_fail": "OneDrive 的回调请求有点异常。您是否拒绝了鉴权?",
|
||||
"protocol_onedrivefull_connect_unknown": "不知道如何处理此 callback:{{params}}",
|
||||
|
||||
"protocol_box_connecting": "正在连接",
|
||||
"protocol_box_connect_manualinput_succ": "连接成功",
|
||||
"protocol_box_connect_fail": "Box 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
|
||||
"protocol_box_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
|
||||
|
||||
"protocol_pcloud_connecting": "正在连接",
|
||||
"protocol_pcloud_connect_manualinput_succ": "连接成功",
|
||||
"protocol_pcloud_connect_fail": "pCloud 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
|
||||
"protocol_pcloud_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
|
||||
|
||||
"protocol_yandexdisk_connecting": "正在连接",
|
||||
"protocol_yandexdisk_connect_manualinput_succ": "连接成功",
|
||||
"protocol_yandexdisk_connect_fail": "Yandex Disk 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
|
||||
"protocol_yandexdisk_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
|
||||
|
||||
"protocol_koofr_connecting": "正在连接",
|
||||
"protocol_koofr_connect_manualinput_succ": "连接成功",
|
||||
"protocol_koofr_connect_fail": "Yandex Disk 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权?",
|
||||
"protocol_koofr_connect_succ_revoke": "您已连接上账号。如果要取消连接,请点击此按钮。",
|
||||
|
||||
"modal_onedrivefullauth_shortdesc": "现在只支持个人版 OneDrive,(暂)不支持企业版。\n在浏览器中访问以下地址,然后按照网页提示操作。\n到了最后,您应该会被自动重定向回来 Obsidian。",
|
||||
"modal_onedrivefullauth_shortdesc_linux": "您正在用 Linux,有可能无法跳转回来。请考虑<a href=\"https://github.com/remotely-save/remotely-save/issues/415\">使用</a> flatpack 版本的 Obsidian,或创建 <a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/linux.md\"><code>obsidian.desktop</code> 文件</a>。",
|
||||
"modal_onedrivefullauth_copybutton": "点击此按钮从而复制鉴权 url",
|
||||
"modal_onedrivefullauth_copynotice": "鉴权 url 已复制到剪贴板!",
|
||||
"modal_onedrivefullrevokeauth_step1": "第 1 步:用浏览器打开以下地址,点击本插件对应的“Edit”按钮,点击“Remove these permissions”按钮。",
|
||||
"modal_onedrivefullrevokeauth_step2": "第 2 步:点击以下按钮,清理本地保存的登录信息。",
|
||||
"modal_onedrivefullrevokeauth_clean": "清理本地保存的登录信息",
|
||||
"modal_onedrivefullrevokeauth_clean_desc": "您需要点击“清理”按钮。",
|
||||
"modal_onedrivefullrevokeauth_clean_button": "清理",
|
||||
"modal_onedrivefullrevokeauth_clean_notice": "已清理!",
|
||||
"modal_onedrivefullrevokeauth_clean_fail": "鉴权途中出错了。",
|
||||
|
||||
"modal_googledriveauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会看到一个码,请复制粘贴到这里然后提交。</p>",
|
||||
"modal_googledriveauth_copybutton": "点击以复制网址",
|
||||
"modal_googledriveauth_copynotice": "网址已复制!",
|
||||
"modal_googledrivce_maualinput": "网站上的码",
|
||||
"modal_googledrivce_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
|
||||
"modal_googledrive_maualinput_notice": "正在尝试连接 Google 并更新授权信息......",
|
||||
"modal_googledrive_maualinput_succ_notice": "很好!授权信息已更新!",
|
||||
"modal_googledrive_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
|
||||
"modal_googledriverevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
|
||||
"modal_googledriverevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
|
||||
"modal_googledriverevokeauth_clean": "清理本地登录信息",
|
||||
"modal_googledriverevokeauth_clean_desc": "您需要点击此按钮。",
|
||||
"modal_googledriverevokeauth_clean_button": "清理",
|
||||
"modal_googledriverevokeauth_clean_notice": "已清理!",
|
||||
"modal_googledriverevokeauth_clean_fail": "清理授权时候发生了错误。",
|
||||
|
||||
"modal_boxauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
|
||||
"modal_boxauth_copybutton": "点击以复制网址",
|
||||
"modal_boxauth_copynotice": "网址已复制!",
|
||||
"modal_box_maualinput": "网站上的码",
|
||||
"modal_box_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
|
||||
"modal_box_maualinput_notice": "正在尝试连接 Box 并更新授权信息......",
|
||||
"modal_box_maualinput_succ_notice": "很好!授权信息已更新!",
|
||||
"modal_box_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
|
||||
"modal_boxrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
|
||||
"modal_boxrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
|
||||
"modal_boxrevokeauth_clean": "清理本地登录信息",
|
||||
"modal_boxrevokeauth_clean_desc": "您需要点击此按钮。",
|
||||
"modal_boxrevokeauth_clean_button": "清理",
|
||||
"modal_boxrevokeauth_clean_notice": "已清理!",
|
||||
"modal_boxrevokeauth_clean_fail": "清理授权时候发生了错误。",
|
||||
|
||||
"modal_pcloudauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
|
||||
"modal_pcloudauth_copybutton": "点击以复制网址",
|
||||
"modal_pcloudauth_copynotice": "网址已复制!",
|
||||
"modal_pcloudrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
|
||||
"modal_pcloudrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
|
||||
"modal_pcloudrevokeauth_clean": "清理本地登录信息",
|
||||
"modal_pcloudrevokeauth_clean_desc": "您需要点击此按钮。",
|
||||
"modal_pcloudrevokeauth_clean_button": "清理",
|
||||
"modal_pcloudrevokeauth_clean_notice": "已清理!",
|
||||
"modal_pcloudrevokeauth_clean_fail": "清理授权时候发生了错误。",
|
||||
|
||||
"modal_yandexdiskauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
|
||||
"modal_yandexdiskauth_copybutton": "点击以复制网址",
|
||||
"modal_yandexdiskauth_copynotice": "网址已复制!",
|
||||
"modal_yandexdisk_maualinput": "网站上的码",
|
||||
"modal_yandexdisk_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
|
||||
"modal_yandexdisk_maualinput_notice": "正在尝试连接 Yandex Disk 并更新授权信息......",
|
||||
"modal_yandexdisk_maualinput_succ_notice": "很好!授权信息已更新!",
|
||||
"modal_yandexdisk_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
|
||||
"modal_yandexdiskrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
|
||||
"modal_yandexdiskrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
|
||||
"modal_yandexdiskrevokeauth_clean": "清理本地登录信息",
|
||||
"modal_yandexdiskrevokeauth_clean_desc": "您需要点击此按钮。",
|
||||
"modal_yandexdiskrevokeauth_clean_button": "清理",
|
||||
"modal_yandexdiskrevokeauth_clean_notice": "已清理!",
|
||||
"modal_yandexdiskrevokeauth_clean_fail": "清理授权时候发生了错误。",
|
||||
|
||||
"modal_koofrauth_tutorial": "<p>请访问此网址,然后会进入授权流程。最后,您会被重定向回来。</p>",
|
||||
"modal_koofrauth_copybutton": "点击以复制网址",
|
||||
"modal_koofrauth_copynotice": "网址已复制!",
|
||||
"modal_koofr_maualinput": "网站上的码",
|
||||
"modal_koofr_maualinput_desc": "请粘贴授权流程最后的那个码,然后点击确认。",
|
||||
"modal_koofr_maualinput_notice": "正在尝试连接 Yandex Disk 并更新授权信息......",
|
||||
"modal_koofr_maualinput_succ_notice": "很好!授权信息已更新!",
|
||||
"modal_koofr_maualinput_fail_notice": "更新授权信息失败。请稍后重试。",
|
||||
"modal_koofrrevokeauth_step1": "第 1 步:访问以下网址,可以删除连接。",
|
||||
"modal_koofrrevokeauth_step2": "第 2 步:点击以下按钮,从而清理本地的登录信息。",
|
||||
"modal_koofrrevokeauth_clean": "清理本地登录信息",
|
||||
"modal_koofrrevokeauth_clean_desc": "您需要点击此按钮。",
|
||||
"modal_koofrrevokeauth_clean_button": "清理",
|
||||
"modal_koofrrevokeauth_clean_notice": "已清理!",
|
||||
"modal_koofrrevokeauth_clean_fail": "清理授权时候发生了错误。",
|
||||
|
||||
"modal_remoteprefix_azureblobstorage_title": "您正在修改远端路径前缀设置",
|
||||
"modal_remoteprefix_azureblobstorage_shortdesc": "1. 本插件并不会自动在远端把内容从旧文件夹移动到新文件夹。所有内容都会重新同步。\n2. 如果你使得文本输入框为空,那么本设置为保存为空,文件将会使用 Vault 名字作为前缀。\n3. 即使您设置了端对端加密的密码,远端文件夹名称本身也不会被加密。\n4. 某些特殊字符,如“?”、“/”、“\\”是不允许的。文本前后的空格也会被自动删去。",
|
||||
"modal_remoteprefix_azureblobstorage_invaliddirhint": "您所输入的内容含有某些特殊字符,如“?”、“/”、“\\”,它们是不允许的。",
|
||||
"modal_remoteprefix_azureblobstorage_tosave": "您设定的新前缀为:“{{{prefix}}}”",
|
||||
"modal_remoteprefix_azureblobstorage_secondconfirm_empty": "前缀为空,文件会保存在根目录",
|
||||
"modal_remoteprefix_azureblobstorage_secondconfirm_change": "确认修改",
|
||||
"modal_remoteprefix_azureblobstorage_notice": "新的远端路径前缀设置已保存!",
|
||||
|
||||
"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_onedrivefull": "Onedrive(个人版)(Full)设置",
|
||||
"settings_chooseservice_onedrivefull": "OneDrive(个人版)(Full)(PRO)",
|
||||
"settings_onedrivefull_disclaimer1": "声明:此插件不是微软或 OneDrive 的官方产品。",
|
||||
"settings_onedrivefull_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现了 OneDrive 有不符合预期的访问,请立刻从 https://microsoft.com/consent 删除记录于此插件的连接鉴权。",
|
||||
"settings_onedrivefull_folder": "我们会在您的 OneDrive 上创建此文件夹并在里面同步:/{{remoteBaseDir}}。",
|
||||
"settings_onedrivefull_nobiz": "现在只支持个人版 OneDrive。(暂时)并不支持企业版 OneDrive。",
|
||||
"settings_onedrivefull_revoke": "撤回鉴权",
|
||||
"settings_onedrivefull_revoke_desc": "您现在使用了用户名 {{username}} 来连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_onedrivefull_revoke_button": "撤回鉴权",
|
||||
"settings_onedrivefull_auth": "鉴权",
|
||||
"settings_onedrivefull_auth_desc": "鉴权。",
|
||||
"settings_onedrivefull_auth_button": "鉴权",
|
||||
"settings_onedrivefull_connect_succ": "很好!我们可连接上 OneDrive!",
|
||||
"settings_onedrivefull_connect_fail": "我们未能连接上 OneDrive。",
|
||||
"settings_onedrivefull_emptyfile": "空文件处理",
|
||||
"settings_onedrivefull_emptyfile_desc": "OneDrive 不允许上传空文件(即使官网也是不允许的)。那么你想跳过空文件还是返回错误?",
|
||||
"settings_onedrivefull_emptyfile_skip": "跳过",
|
||||
"settings_onedrivefull_emptyfile_error": "返回错误和中断",
|
||||
|
||||
"settings_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_googledrive_disclaimer1": "声明:本插件不是 Google 的官方产品。只是用到了它的公开 API。",
|
||||
"settings_googledrive_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Google Drive 访问,请立刻在以下网站操作断开连接: https://myaccount.google.com/permissions 。",
|
||||
"settings_googledrive_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_googledrive_notshowuphint": "Google Drive 设置不可用",
|
||||
"settings_googledrive_notshowuphint_desc": "Google Drive 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_googledrive_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_googledrive_folder": "我们会在 Google Drive 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
|
||||
"settings_googledrive_revoke": "撤回鉴权",
|
||||
"settings_googledrive_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_googledrive_revoke_button": "撤回鉴权",
|
||||
"settings_googledrive_auth": "鉴权",
|
||||
"settings_googledrive_auth_desc": "鉴权.",
|
||||
"settings_googledrive_auth_button": "鉴权",
|
||||
"settings_googledrive_connect_succ": "很好!我们可连接上 Google Drive!",
|
||||
"settings_googledrive_connect_fail": "我们未能连接上 Google Drive。",
|
||||
|
||||
"settings_box": "Box (PRO) (beta)",
|
||||
"settings_chooseservice_box": "Box (PRO) (beta)",
|
||||
"settings_box_disclaimer1": "声明:本插件不是 Box 的官方产品。只是用到了它的公开 API。",
|
||||
"settings_box_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Box 访问,请立刻在以下网站操作断开连接: https://app.box.com/account/security 。",
|
||||
"settings_box_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_box_notshowuphint": "Box 设置不可用",
|
||||
"settings_box_notshowuphint_desc": "Box 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_box_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_box_folder": "我们会在 Box 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
|
||||
"settings_box_revoke": "撤回鉴权",
|
||||
"settings_box_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_box_revoke_button": "撤回鉴权",
|
||||
"settings_box_auth": "鉴权",
|
||||
"settings_box_auth_desc": "鉴权.",
|
||||
"settings_box_auth_button": "鉴权",
|
||||
"settings_box_connect_succ": "很好!我们可连接上 Box!",
|
||||
"settings_box_connect_fail": "我们未能连接上 Box。",
|
||||
|
||||
"settings_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_pcloud_disclaimer1": "声明:本插件不是 pCloud 的官方产品。只是用到了它的公开 API。",
|
||||
"settings_pcloud_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 pCloud 访问,请立刻在以下网站操作断开连接: https://my.pcloud.com/#page=settings&settings=tab-apps 。",
|
||||
"settings_pcloud_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_pcloud_notshowuphint": "pCloud 设置不可用",
|
||||
"settings_pcloud_notshowuphint_desc": "pCloud 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_pcloud_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_pcloud_folder": "我们会在 pCloud 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
|
||||
"settings_pcloud_revoke": "撤回鉴权",
|
||||
"settings_pcloud_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_pcloud_revoke_button": "撤回鉴权",
|
||||
"settings_pcloud_auth": "鉴权",
|
||||
"settings_pcloud_auth_desc": "鉴权.",
|
||||
"settings_pcloud_auth_button": "鉴权",
|
||||
"settings_pcloud_emptyfile": "空文件",
|
||||
"settings_pcloud_emptyfile_desc": "pCloud API 不支持上传空文件,怎么处理?",
|
||||
"settings_pcloud_emptyfile_skip": "跳过",
|
||||
"settings_pcloud_emptyfile_error": "提示错误",
|
||||
"settings_pcloud_connect_succ": "很好!我们可连接上 pCloud!",
|
||||
"settings_pcloud_connect_fail": "我们未能连接上 pCloud。",
|
||||
|
||||
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_yandexdisk_disclaimer1": "声明:本插件不是 Yandex Disk 的官方产品。只是用到了它的公开 API。",
|
||||
"settings_yandexdisk_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Yandex Disk 访问,请立刻在以下网站操作断开连接: https://id.yandex.com/profile/devices 。",
|
||||
"settings_yandexdisk_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_yandexdisk_notshowuphint": "Yandex Disk 设置不可用",
|
||||
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_yandexdisk_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_yandexdisk_folder": "我们会在 Yandex Disk 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
|
||||
"settings_yandexdisk_revoke": "撤回鉴权",
|
||||
"settings_yandexdisk_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_yandexdisk_revoke_button": "撤回鉴权",
|
||||
"settings_yandexdisk_auth": "鉴权",
|
||||
"settings_yandexdisk_auth_desc": "鉴权.",
|
||||
"settings_yandexdisk_auth_button": "鉴权",
|
||||
"settings_yandexdisk_connect_succ": "很好!我们可连接上 Yandex Disk!",
|
||||
"settings_yandexdisk_connect_fail": "我们未能连接上 Yandex Disk。",
|
||||
|
||||
"settings_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_koofr_disclaimer1": "声明:本插件不是 Koofr 的官方产品。只是用到了它的公开 API。",
|
||||
"settings_koofr_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Koofr 访问,请立刻在以下网站操作断开连接: https://app.koofr.net/app/admin/preferences/security 。",
|
||||
"settings_koofr_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_koofr_notshowuphint": "Koofr 设置不可用",
|
||||
"settings_koofr_notshowuphint_desc": "Koofr 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_koofr_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_koofr_folder": "我们会在 Koofr 创建此文件夹并同步内容进去: {{remoteBaseDir}} 。请不要手动在网站上创建。",
|
||||
"settings_koofr_revoke": "撤回鉴权",
|
||||
"settings_koofr_revoke_desc": "您现在已连接。如果想取消连接,请点击此按钮。",
|
||||
"settings_koofr_revoke_button": "撤回鉴权",
|
||||
"settings_koofr_auth": "鉴权",
|
||||
"settings_koofr_auth_desc": "鉴权.",
|
||||
"settings_koofr_auth_button": "鉴权",
|
||||
"settings_koofr_connect_succ": "很好!我们可连接上 Koofr!",
|
||||
"settings_koofr_connect_fail": "我们未能连接上 Koofr。",
|
||||
|
||||
"settings_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_chooseservice_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_azureblobstorage_disclaimer1": "声明:本插件不是微软或 Azure 的官方产品。只是用到了 Azure 的公开 API。",
|
||||
"settings_azureblobstorage_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现任何不符合预期的 Azure Blob Storage 访问,请立刻删除 SAS Url 然后<a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">修改预设的 policy</a> 或账号信息。",
|
||||
"settings_azureblobstorage_pro_desc": "<p><strong>!!这是 PRO(付费)功能! 您需要在线账号来使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 账号的更多信息。)</p>",
|
||||
"settings_azureblobstorage_notshowuphint": "Azure Blob Storage 设置不可用",
|
||||
"settings_azureblobstorage_notshowuphint_desc": "Azure Blob Storage 设置不可用,因为您没有在 Remotely Save 账号里开启这个 PRO 功能。",
|
||||
"settings_azureblobstorage_notshowuphint_view_pro": "查看 PRO 相关设置",
|
||||
"settings_azureblobstorage_folder": "Azure Blob Storage 里,我们会用这个前缀保存你的文件: {{remoteBaseDir}} 。",
|
||||
"settings_azureblobstorage_containersasurl": "Container SAS Url",
|
||||
"settings_azureblobstorage_containersasurl_desc": "目前只支持通过 Container SAS Url 进行连接。请记得同时设置 CORS。可阅读<a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">文档</a>获取更多说明。",
|
||||
"settings_azureblobstorage_containername": "Container 名字",
|
||||
"settings_azureblobstorage_containername_desc": "输入 Container 名字。",
|
||||
"settings_azureblobstorage_remoteprefix": "修改远端前缀路径",
|
||||
"settings_azureblobstorage_remoteprefix_desc": "您可以在这里修改路径前缀。如果设置为空,那么<strong>库(vault)名字</strong>会作为前缀。<strong>不允许设置空前缀。</strong>您需要点击“确认”。",
|
||||
"settings_azureblobstorage_parts": "分块并行度",
|
||||
"settings_azureblobstorage_parts_desc": "大文件会被分块上传。您希望同一时间最多有多少个分块被上传?",
|
||||
"settings_azureblobstorage_generatefolderobject": "是否生成文件夹 Object",
|
||||
"settings_azureblobstorage_generatefolderobject_desc": "Azure Blob Storage 不存在“真正”的文件夹。如果您设置了“生成”,那么插件会上传 0 字节的以“/”结尾的 Object 来代表文件夹。默认跳过生成这种文件夹 Object。",
|
||||
"settings_azureblobstorage_generatefolderobject_notgenerate": "不生成(默认)",
|
||||
"settings_azureblobstorage_generatefolderobject_generate": "生成",
|
||||
"settings_azureblobstorage_connect_succ": "很好!我们可连接上 Azure Blob Storage!",
|
||||
"settings_azureblobstorage_connect_fail": "我们未能连接上 Azure Blob Storage。",
|
||||
|
||||
"settings_export_onedrivefull_button": "导出 OneDrive (Full) 部分",
|
||||
"settings_export_googledrive_button": "导出 Google Drive 部分",
|
||||
"settings_export_box_button": "导出 Box 部分",
|
||||
"settings_export_pcloud_button": "导出 pCloud 部分",
|
||||
"settings_export_yandexdisk_button": "导出 Yandex Disk 部分",
|
||||
"settings_export_koofr_button": "导出 Koofr 部分",
|
||||
"settings_export_azureblobstorage_button": "导出 Azure Blob Storage 部分",
|
||||
|
||||
"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,304 @@
|
||||
{
|
||||
"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}}。如果要取消連線,請點選此按鈕。",
|
||||
|
||||
"protocol_onedrivefull_connecting": "正在連線 OneDrive……\n請不要關閉此彈窗。",
|
||||
"protocol_onedrivefull_connect_succ_revoke": "您已作為使用者 {{username}} 連線上了。如果您想取消連線,請點選此按鈕。",
|
||||
"protocol_onedrivefull_connect_fail": "OneDrive 的回撥請求有點異常。您是否拒絕了鑑權?",
|
||||
"protocol_onedrivefull_connect_unknown": "不知道如何處理此 callback:{{params}}",
|
||||
|
||||
"protocol_box_connecting": "正在連線",
|
||||
"protocol_box_connect_manualinput_succ": "連線成功",
|
||||
"protocol_box_connect_fail": "Box 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
|
||||
"protocol_box_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
|
||||
|
||||
"protocol_pcloud_connecting": "正在連線",
|
||||
"protocol_pcloud_connect_manualinput_succ": "連線成功",
|
||||
"protocol_pcloud_connect_fail": "pCloud 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
|
||||
"protocol_pcloud_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
|
||||
|
||||
"protocol_yandexdisk_connecting": "正在連線",
|
||||
"protocol_yandexdisk_connect_manualinput_succ": "連線成功",
|
||||
"protocol_yandexdisk_connect_fail": "Yandex Disk 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
|
||||
"protocol_yandexdisk_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
|
||||
|
||||
"protocol_koofr_connecting": "正在連線",
|
||||
"protocol_koofr_connect_manualinput_succ": "連線成功",
|
||||
"protocol_koofr_connect_fail": "Yandex Disk 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權?",
|
||||
"protocol_koofr_connect_succ_revoke": "您已連線上賬號。如果要取消連線,請點選此按鈕。",
|
||||
|
||||
"modal_onedrivefullauth_shortdesc": "現在只支援個人版 OneDrive,(暫)不支援企業版。\n在瀏覽器中訪問以下地址,然後按照網頁提示操作。\n到了最後,您應該會被自動重定向回來 Obsidian。",
|
||||
"modal_onedrivefullauth_shortdesc_linux": "您正在用 Linux,有可能無法跳轉回來。請考慮<a href=\"https://github.com/remotely-save/remotely-save/issues/415\">使用</a> flatpack 版本的 Obsidian,或建立 <a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/linux.md\"><code>obsidian.desktop</code> 檔案</a>。",
|
||||
"modal_onedrivefullauth_copybutton": "點選此按鈕從而複製鑑權 url",
|
||||
"modal_onedrivefullauth_copynotice": "鑑權 url 已複製到剪貼簿!",
|
||||
"modal_onedrivefullrevokeauth_step1": "第 1 步:用瀏覽器開啟以下地址,點選本外掛對應的“Edit”按鈕,點選“Remove these permissions”按鈕。",
|
||||
"modal_onedrivefullrevokeauth_step2": "第 2 步:點選以下按鈕,清理本地儲存的登入資訊。",
|
||||
"modal_onedrivefullrevokeauth_clean": "清理本地儲存的登入資訊",
|
||||
"modal_onedrivefullrevokeauth_clean_desc": "您需要點選“清理”按鈕。",
|
||||
"modal_onedrivefullrevokeauth_clean_button": "清理",
|
||||
"modal_onedrivefullrevokeauth_clean_notice": "已清理!",
|
||||
"modal_onedrivefullrevokeauth_clean_fail": "鑑權途中出錯了。",
|
||||
|
||||
"modal_googledriveauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會看到一個碼,請複製貼上到這裡然後提交。</p>",
|
||||
"modal_googledriveauth_copybutton": "點選以複製網址",
|
||||
"modal_googledriveauth_copynotice": "網址已複製!",
|
||||
"modal_googledrivce_maualinput": "網站上的碼",
|
||||
"modal_googledrivce_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
|
||||
"modal_googledrive_maualinput_notice": "正在嘗試連線 Google 並更新授權資訊......",
|
||||
"modal_googledrive_maualinput_succ_notice": "很好!授權資訊已更新!",
|
||||
"modal_googledrive_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
|
||||
"modal_googledriverevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
|
||||
"modal_googledriverevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
|
||||
"modal_googledriverevokeauth_clean": "清理本地登入資訊",
|
||||
"modal_googledriverevokeauth_clean_desc": "您需要點選此按鈕。",
|
||||
"modal_googledriverevokeauth_clean_button": "清理",
|
||||
"modal_googledriverevokeauth_clean_notice": "已清理!",
|
||||
"modal_googledriverevokeauth_clean_fail": "清理授權時候發生了錯誤。",
|
||||
|
||||
"modal_boxauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
|
||||
"modal_boxauth_copybutton": "點選以複製網址",
|
||||
"modal_boxauth_copynotice": "網址已複製!",
|
||||
"modal_box_maualinput": "網站上的碼",
|
||||
"modal_box_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
|
||||
"modal_box_maualinput_notice": "正在嘗試連線 Box 並更新授權資訊......",
|
||||
"modal_box_maualinput_succ_notice": "很好!授權資訊已更新!",
|
||||
"modal_box_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
|
||||
"modal_boxrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
|
||||
"modal_boxrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
|
||||
"modal_boxrevokeauth_clean": "清理本地登入資訊",
|
||||
"modal_boxrevokeauth_clean_desc": "您需要點選此按鈕。",
|
||||
"modal_boxrevokeauth_clean_button": "清理",
|
||||
"modal_boxrevokeauth_clean_notice": "已清理!",
|
||||
"modal_boxrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
|
||||
|
||||
"modal_pcloudauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
|
||||
"modal_pcloudauth_copybutton": "點選以複製網址",
|
||||
"modal_pcloudauth_copynotice": "網址已複製!",
|
||||
"modal_pcloudrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
|
||||
"modal_pcloudrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
|
||||
"modal_pcloudrevokeauth_clean": "清理本地登入資訊",
|
||||
"modal_pcloudrevokeauth_clean_desc": "您需要點選此按鈕。",
|
||||
"modal_pcloudrevokeauth_clean_button": "清理",
|
||||
"modal_pcloudrevokeauth_clean_notice": "已清理!",
|
||||
"modal_pcloudrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
|
||||
|
||||
"modal_yandexdiskauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
|
||||
"modal_yandexdiskauth_copybutton": "點選以複製網址",
|
||||
"modal_yandexdiskauth_copynotice": "網址已複製!",
|
||||
"modal_yandexdisk_maualinput": "網站上的碼",
|
||||
"modal_yandexdisk_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
|
||||
"modal_yandexdisk_maualinput_notice": "正在嘗試連線 Yandex Disk 並更新授權資訊......",
|
||||
"modal_yandexdisk_maualinput_succ_notice": "很好!授權資訊已更新!",
|
||||
"modal_yandexdisk_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
|
||||
"modal_yandexdiskrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
|
||||
"modal_yandexdiskrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
|
||||
"modal_yandexdiskrevokeauth_clean": "清理本地登入資訊",
|
||||
"modal_yandexdiskrevokeauth_clean_desc": "您需要點選此按鈕。",
|
||||
"modal_yandexdiskrevokeauth_clean_button": "清理",
|
||||
"modal_yandexdiskrevokeauth_clean_notice": "已清理!",
|
||||
"modal_yandexdiskrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
|
||||
|
||||
"modal_koofrauth_tutorial": "<p>請訪問此網址,然後會進入授權流程。最後,您會被重定向回來。</p>",
|
||||
"modal_koofrauth_copybutton": "點選以複製網址",
|
||||
"modal_koofrauth_copynotice": "網址已複製!",
|
||||
"modal_koofr_maualinput": "網站上的碼",
|
||||
"modal_koofr_maualinput_desc": "請貼上授權流程最後的那個碼,然後點選確認。",
|
||||
"modal_koofr_maualinput_notice": "正在嘗試連線 Yandex Disk 並更新授權資訊......",
|
||||
"modal_koofr_maualinput_succ_notice": "很好!授權資訊已更新!",
|
||||
"modal_koofr_maualinput_fail_notice": "更新授權資訊失敗。請稍後重試。",
|
||||
"modal_koofrrevokeauth_step1": "第 1 步:訪問以下網址,可以刪除連線。",
|
||||
"modal_koofrrevokeauth_step2": "第 2 步:點選以下按鈕,從而清理本地的登入資訊。",
|
||||
"modal_koofrrevokeauth_clean": "清理本地登入資訊",
|
||||
"modal_koofrrevokeauth_clean_desc": "您需要點選此按鈕。",
|
||||
"modal_koofrrevokeauth_clean_button": "清理",
|
||||
"modal_koofrrevokeauth_clean_notice": "已清理!",
|
||||
"modal_koofrrevokeauth_clean_fail": "清理授權時候發生了錯誤。",
|
||||
|
||||
"modal_remoteprefix_azureblobstorage_title": "您正在修改遠端路徑字首設定",
|
||||
"modal_remoteprefix_azureblobstorage_shortdesc": "1. 本外掛並不會自動在遠端把內容從舊資料夾移動到新資料夾。所有內容都會重新同步。\n2. 如果你使得文字輸入框為空,那麼本設定為儲存為空,檔案將會使用 Vault 名字作為字首。\n3. 即使您設定了端對端加密的密碼,遠端資料夾名稱本身也不會被加密。\n4. 某些特殊字元,如“?”、“/”、“\\”是不允許的。文字前後的空格也會被自動刪去。",
|
||||
"modal_remoteprefix_azureblobstorage_invaliddirhint": "您所輸入的內容含有某些特殊字元,如“?”、“/”、“\\”,它們是不允許的。",
|
||||
"modal_remoteprefix_azureblobstorage_tosave": "您設定的新字首為:“{{{prefix}}}”",
|
||||
"modal_remoteprefix_azureblobstorage_secondconfirm_empty": "字首為空,檔案會儲存在根目錄",
|
||||
"modal_remoteprefix_azureblobstorage_secondconfirm_change": "確認修改",
|
||||
"modal_remoteprefix_azureblobstorage_notice": "新的遠端路徑字首設定已儲存!",
|
||||
|
||||
"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_onedrivefull": "Onedrive(個人版)(Full)設定",
|
||||
"settings_chooseservice_onedrivefull": "OneDrive(個人版)(Full)(PRO)",
|
||||
"settings_onedrivefull_disclaimer1": "宣告:此外掛不是微軟或 OneDrive 的官方產品。",
|
||||
"settings_onedrivefull_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現了 OneDrive 有不符合預期的訪問,請立刻從 https://microsoft.com/consent 刪除記錄於此外掛的連線鑑權。",
|
||||
"settings_onedrivefull_folder": "我們會在您的 OneDrive 上建立此資料夾並在裡面同步:/{{remoteBaseDir}}。",
|
||||
"settings_onedrivefull_nobiz": "現在只支援個人版 OneDrive。(暫時)並不支援企業版 OneDrive。",
|
||||
"settings_onedrivefull_revoke": "撤回鑑權",
|
||||
"settings_onedrivefull_revoke_desc": "您現在使用了使用者名稱 {{username}} 來連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_onedrivefull_revoke_button": "撤回鑑權",
|
||||
"settings_onedrivefull_auth": "鑑權",
|
||||
"settings_onedrivefull_auth_desc": "鑑權。",
|
||||
"settings_onedrivefull_auth_button": "鑑權",
|
||||
"settings_onedrivefull_connect_succ": "很好!我們可連線上 OneDrive!",
|
||||
"settings_onedrivefull_connect_fail": "我們未能連線上 OneDrive。",
|
||||
"settings_onedrivefull_emptyfile": "空檔案處理",
|
||||
"settings_onedrivefull_emptyfile_desc": "OneDrive 不允許上傳空檔案(即使官網也是不允許的)。那麼你想跳過空檔案還是返回錯誤?",
|
||||
"settings_onedrivefull_emptyfile_skip": "跳過",
|
||||
"settings_onedrivefull_emptyfile_error": "返回錯誤和中斷",
|
||||
|
||||
"settings_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_chooseservice_googledrive": "Google Drive (PRO) (beta)",
|
||||
"settings_googledrive_disclaimer1": "宣告:本外掛不是 Google 的官方產品。只是用到了它的公開 API。",
|
||||
"settings_googledrive_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Google Drive 訪問,請立刻在以下網站操作斷開連線: https://myaccount.google.com/permissions 。",
|
||||
"settings_googledrive_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_googledrive_notshowuphint": "Google Drive 設定不可用",
|
||||
"settings_googledrive_notshowuphint_desc": "Google Drive 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_googledrive_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_googledrive_folder": "我們會在 Google Drive 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
|
||||
"settings_googledrive_revoke": "撤回鑑權",
|
||||
"settings_googledrive_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_googledrive_revoke_button": "撤回鑑權",
|
||||
"settings_googledrive_auth": "鑑權",
|
||||
"settings_googledrive_auth_desc": "鑑權.",
|
||||
"settings_googledrive_auth_button": "鑑權",
|
||||
"settings_googledrive_connect_succ": "很好!我們可連線上 Google Drive!",
|
||||
"settings_googledrive_connect_fail": "我們未能連線上 Google Drive。",
|
||||
|
||||
"settings_box": "Box (PRO) (beta)",
|
||||
"settings_chooseservice_box": "Box (PRO) (beta)",
|
||||
"settings_box_disclaimer1": "宣告:本外掛不是 Box 的官方產品。只是用到了它的公開 API。",
|
||||
"settings_box_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Box 訪問,請立刻在以下網站操作斷開連線: https://app.box.com/account/security 。",
|
||||
"settings_box_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_box_notshowuphint": "Box 設定不可用",
|
||||
"settings_box_notshowuphint_desc": "Box 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_box_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_box_folder": "我們會在 Box 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
|
||||
"settings_box_revoke": "撤回鑑權",
|
||||
"settings_box_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_box_revoke_button": "撤回鑑權",
|
||||
"settings_box_auth": "鑑權",
|
||||
"settings_box_auth_desc": "鑑權.",
|
||||
"settings_box_auth_button": "鑑權",
|
||||
"settings_box_connect_succ": "很好!我們可連線上 Box!",
|
||||
"settings_box_connect_fail": "我們未能連線上 Box。",
|
||||
|
||||
"settings_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_chooseservice_pcloud": "pCloud (PRO) (beta)",
|
||||
"settings_pcloud_disclaimer1": "宣告:本外掛不是 pCloud 的官方產品。只是用到了它的公開 API。",
|
||||
"settings_pcloud_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 pCloud 訪問,請立刻在以下網站操作斷開連線: https://my.pcloud.com/#page=settings&settings=tab-apps 。",
|
||||
"settings_pcloud_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_pcloud_notshowuphint": "pCloud 設定不可用",
|
||||
"settings_pcloud_notshowuphint_desc": "pCloud 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_pcloud_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_pcloud_folder": "我們會在 pCloud 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
|
||||
"settings_pcloud_revoke": "撤回鑑權",
|
||||
"settings_pcloud_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_pcloud_revoke_button": "撤回鑑權",
|
||||
"settings_pcloud_auth": "鑑權",
|
||||
"settings_pcloud_auth_desc": "鑑權.",
|
||||
"settings_pcloud_auth_button": "鑑權",
|
||||
"settings_pcloud_emptyfile": "空檔案",
|
||||
"settings_pcloud_emptyfile_desc": "pCloud API 不支援上傳空檔案,怎麼處理?",
|
||||
"settings_pcloud_emptyfile_skip": "跳過",
|
||||
"settings_pcloud_emptyfile_error": "提示錯誤",
|
||||
"settings_pcloud_connect_succ": "很好!我們可連線上 pCloud!",
|
||||
"settings_pcloud_connect_fail": "我們未能連線上 pCloud。",
|
||||
|
||||
"settings_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_chooseservice_yandexdisk": "Yandex Disk (PRO) (beta)",
|
||||
"settings_yandexdisk_disclaimer1": "宣告:本外掛不是 Yandex Disk 的官方產品。只是用到了它的公開 API。",
|
||||
"settings_yandexdisk_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Yandex Disk 訪問,請立刻在以下網站操作斷開連線: https://id.yandex.com/profile/devices 。",
|
||||
"settings_yandexdisk_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_yandexdisk_notshowuphint": "Yandex Disk 設定不可用",
|
||||
"settings_yandexdisk_notshowuphint_desc": "Yandex Disk 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_yandexdisk_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_yandexdisk_folder": "我們會在 Yandex Disk 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
|
||||
"settings_yandexdisk_revoke": "撤回鑑權",
|
||||
"settings_yandexdisk_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_yandexdisk_revoke_button": "撤回鑑權",
|
||||
"settings_yandexdisk_auth": "鑑權",
|
||||
"settings_yandexdisk_auth_desc": "鑑權.",
|
||||
"settings_yandexdisk_auth_button": "鑑權",
|
||||
"settings_yandexdisk_connect_succ": "很好!我們可連線上 Yandex Disk!",
|
||||
"settings_yandexdisk_connect_fail": "我們未能連線上 Yandex Disk。",
|
||||
|
||||
"settings_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_chooseservice_koofr": "Koofr (PRO) (beta)",
|
||||
"settings_koofr_disclaimer1": "宣告:本外掛不是 Koofr 的官方產品。只是用到了它的公開 API。",
|
||||
"settings_koofr_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Koofr 訪問,請立刻在以下網站操作斷開連線: https://app.koofr.net/app/admin/preferences/security 。",
|
||||
"settings_koofr_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_koofr_notshowuphint": "Koofr 設定不可用",
|
||||
"settings_koofr_notshowuphint_desc": "Koofr 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_koofr_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_koofr_folder": "我們會在 Koofr 建立此資料夾並同步內容進去: {{remoteBaseDir}} 。請不要手動在網站上建立。",
|
||||
"settings_koofr_revoke": "撤回鑑權",
|
||||
"settings_koofr_revoke_desc": "您現在已連線。如果想取消連線,請點選此按鈕。",
|
||||
"settings_koofr_revoke_button": "撤回鑑權",
|
||||
"settings_koofr_auth": "鑑權",
|
||||
"settings_koofr_auth_desc": "鑑權.",
|
||||
"settings_koofr_auth_button": "鑑權",
|
||||
"settings_koofr_connect_succ": "很好!我們可連線上 Koofr!",
|
||||
"settings_koofr_connect_fail": "我們未能連線上 Koofr。",
|
||||
|
||||
"settings_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_chooseservice_azureblobstorage": "Azure Blob Storage (PRO) (alpha)",
|
||||
"settings_azureblobstorage_disclaimer1": "宣告:本外掛不是微軟或 Azure 的官方產品。只是用到了 Azure 的公開 API。",
|
||||
"settings_azureblobstorage_disclaimer2": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現任何不符合預期的 Azure Blob Storage 訪問,請立刻刪除 SAS Url 然後<a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">修改預設的 policy</a> 或賬號資訊。",
|
||||
"settings_azureblobstorage_pro_desc": "<p><strong>!!這是 PRO(付費)功能! 您需要線上賬號來使用此功能!!</strong>(<a href=\"#settings-pro\">向下滑</a>可以看到 PRO 賬號的更多資訊。)</p>",
|
||||
"settings_azureblobstorage_notshowuphint": "Azure Blob Storage 設定不可用",
|
||||
"settings_azureblobstorage_notshowuphint_desc": "Azure Blob Storage 設定不可用,因為您沒有在 Remotely Save 賬號裡開啟這個 PRO 功能。",
|
||||
"settings_azureblobstorage_notshowuphint_view_pro": "檢視 PRO 相關設定",
|
||||
"settings_azureblobstorage_folder": "Azure Blob Storage 裡,我們會用這個字首儲存你的檔案: {{remoteBaseDir}} 。",
|
||||
"settings_azureblobstorage_containersasurl": "Container SAS Url",
|
||||
"settings_azureblobstorage_containersasurl_desc": "目前只支援透過 Container SAS Url 進行連線。請記得同時設定 CORS。可閱讀<a href=\"https://github.com/remotely-save/remotely-save/blob/master/docs/remote_services/azureblobstorage/README.md\">文件</a>獲取更多說明。",
|
||||
"settings_azureblobstorage_containername": "Container 名字",
|
||||
"settings_azureblobstorage_containername_desc": "輸入 Container 名字。",
|
||||
"settings_azureblobstorage_remoteprefix": "修改遠端字首路徑",
|
||||
"settings_azureblobstorage_remoteprefix_desc": "您可以在這裡修改路徑字首。如果設定為空,那麼<strong>庫(vault)名字</strong>會作為字首。<strong>不允許設定空字首。</strong>您需要點選“確認”。",
|
||||
"settings_azureblobstorage_parts": "分塊並行度",
|
||||
"settings_azureblobstorage_parts_desc": "大檔案會被分塊上傳。您希望同一時間最多有多少個分塊被上傳?",
|
||||
"settings_azureblobstorage_generatefolderobject": "是否生成資料夾 Object",
|
||||
"settings_azureblobstorage_generatefolderobject_desc": "Azure Blob Storage 不存在“真正”的資料夾。如果您設定了“生成”,那麼外掛會上傳 0 位元組的以“/”結尾的 Object 來代表資料夾。預設跳過生成這種資料夾 Object。",
|
||||
"settings_azureblobstorage_generatefolderobject_notgenerate": "不生成(預設)",
|
||||
"settings_azureblobstorage_generatefolderobject_generate": "生成",
|
||||
"settings_azureblobstorage_connect_succ": "很好!我們可連線上 Azure Blob Storage!",
|
||||
"settings_azureblobstorage_connect_fail": "我們未能連線上 Azure Blob Storage。",
|
||||
|
||||
"settings_export_onedrivefull_button": "匯出 OneDrive (Full) 部分",
|
||||
"settings_export_googledrive_button": "匯出 Google Drive 部分",
|
||||
"settings_export_box_button": "匯出 Box 部分",
|
||||
"settings_export_pcloud_button": "匯出 pCloud 部分",
|
||||
"settings_export_yandexdisk_button": "匯出 Yandex Disk 部分",
|
||||
"settings_export_koofr_button": "匯出 Koofr 部分",
|
||||
"settings_export_azureblobstorage_button": "匯出 Azure Blob Storage 部分",
|
||||
|
||||
"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,26 @@
|
||||
import { base64url } from "rfc4648";
|
||||
|
||||
/**
|
||||
* https://datatracker.ietf.org/doc/html/rfc7636
|
||||
* dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
|
||||
* => E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
|
||||
* @param x
|
||||
* @returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
|
||||
*/
|
||||
export async function codeVerifier2CodeChallenge(x: string) {
|
||||
if (x === undefined || x === "") {
|
||||
return "";
|
||||
}
|
||||
try {
|
||||
return base64url.stringify(
|
||||
new Uint8Array(
|
||||
await crypto.subtle.digest("SHA-256", new TextEncoder().encode(x))
|
||||
),
|
||||
{
|
||||
pad: false,
|
||||
}
|
||||
);
|
||||
} catch (e) {
|
||||
return "";
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,293 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { wrapTextWithPasswordHide } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_AZUREBLOBSTORAGE_CONFIG,
|
||||
simpleTransRemotePrefix,
|
||||
} from "./fsAzureBlobStorage";
|
||||
|
||||
class ChangeAzureBlobStorageRemotePrefixModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly newRemotePrefix: string;
|
||||
constructor(app: App, plugin: RemotelySavePlugin, newRemotePrefix: string) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.newRemotePrefix = newRemotePrefix;
|
||||
}
|
||||
|
||||
onOpen() {
|
||||
const { contentEl } = this;
|
||||
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.plugin.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
contentEl.createEl("h2", {
|
||||
text: t("modal_remoteprefix_azureblobstorage_title"),
|
||||
});
|
||||
t("modal_remoteprefix_azureblobstorage_shortdesc")
|
||||
.split("\n")
|
||||
.forEach((val, idx) => {
|
||||
contentEl.createEl("p", {
|
||||
text: val,
|
||||
});
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_remoteprefix_azureblobstorage_tosave", {
|
||||
prefix: this.newRemotePrefix,
|
||||
}),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(
|
||||
t("modal_remoteprefix_azureblobstorage_secondconfirm_change")
|
||||
);
|
||||
button.onClick(async () => {
|
||||
this.plugin.settings.azureblobstorage.remotePrefix =
|
||||
this.newRemotePrefix;
|
||||
await this.plugin.saveSettings();
|
||||
new Notice(t("modal_remoteprefix_azureblobstorage_notice"));
|
||||
this.close();
|
||||
});
|
||||
button.setClass("remoteprefix-azureblobstorage-second-confirm");
|
||||
})
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("goback"));
|
||||
button.onClick(() => {
|
||||
this.close();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateAzureBlobStorageSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const azureBlobStorageDiv = containerEl.createEl("div", {
|
||||
cls: "azureblobstorage-hide",
|
||||
});
|
||||
azureBlobStorageDiv.toggleClass(
|
||||
"azureblobstorage-hide",
|
||||
plugin.settings.serviceType !== "azureblobstorage"
|
||||
);
|
||||
azureBlobStorageDiv.createEl("h2", { text: t("settings_azureblobstorage") });
|
||||
|
||||
const azureBlobStorageLongDescDiv = azureBlobStorageDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_azureblobstorage_disclaimer1"),
|
||||
stringToFragment(t("settings_azureblobstorage_disclaimer2")),
|
||||
]) {
|
||||
azureBlobStorageLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "azureblobstorage-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
azureBlobStorageLongDescDiv.createEl("p", {
|
||||
text: t("settings_azureblobstorage_folder", {
|
||||
remotePrefix:
|
||||
plugin.settings.azureblobstorage.remotePrefix ||
|
||||
`${app.vault.getName()}/`,
|
||||
}),
|
||||
});
|
||||
|
||||
azureBlobStorageLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_azureblobstorage_pro_desc")),
|
||||
cls: "azureblobstorage-disclaimer",
|
||||
});
|
||||
|
||||
const azureBlobStorageNotShowUpHintSetting = new Setting(azureBlobStorageDiv)
|
||||
.setName(t("settings_azureblobstorage_notshowuphint"))
|
||||
.setDesc(t("settings_azureblobstorage_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(
|
||||
t("settings_azureblobstorage_notshowuphint_view_pro")
|
||||
);
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const azureBlobStorageAllowedToUsedDiv = azureBlobStorageDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowAzureBlobStorage =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-azure_blob_storage"
|
||||
).length === 1;
|
||||
console.debug(
|
||||
`allow to show up azureBlobStorage settings? ${allowAzureBlobStorage}`
|
||||
);
|
||||
if (allowAzureBlobStorage) {
|
||||
azureBlobStorageAllowedToUsedDiv.removeClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
azureBlobStorageNotShowUpHintSetting.settingEl.addClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
azureBlobStorageAllowedToUsedDiv.addClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
azureBlobStorageNotShowUpHintSetting.settingEl.removeClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_azureblobstorage_containersasurl"))
|
||||
.setDesc(
|
||||
stringToFragment(t("settings_azureblobstorage_containersasurl_desc"))
|
||||
)
|
||||
.addText((text) => {
|
||||
wrapTextWithPasswordHide(text);
|
||||
text
|
||||
.setPlaceholder("")
|
||||
.setValue(`${plugin.settings.azureblobstorage.containerSasUrl}`)
|
||||
.onChange(async (value) => {
|
||||
plugin.settings.azureblobstorage.containerSasUrl = value.trim();
|
||||
await plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_azureblobstorage_containername"))
|
||||
.setDesc(t("settings_azureblobstorage_containername_desc"))
|
||||
.addText((text) => {
|
||||
wrapTextWithPasswordHide(text);
|
||||
text
|
||||
.setPlaceholder("")
|
||||
.setValue(`${plugin.settings.azureblobstorage.containerName}`)
|
||||
.onChange(async (value) => {
|
||||
plugin.settings.azureblobstorage.containerName = value.trim();
|
||||
await plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
let newAzureBlobStorageRemotePrefix =
|
||||
plugin.settings.azureblobstorage.remotePrefix || "";
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_azureblobstorage_remoteprefix"))
|
||||
.setDesc(t("settings_azureblobstorage_remoteprefix_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(`${app.vault.getName()}/`)
|
||||
.setValue(newAzureBlobStorageRemotePrefix)
|
||||
.onChange((value) => {
|
||||
const k = simpleTransRemotePrefix(value);
|
||||
if (k === "") {
|
||||
newAzureBlobStorageRemotePrefix = `${app.vault.getName()}/`;
|
||||
} else {
|
||||
newAzureBlobStorageRemotePrefix = k;
|
||||
}
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeAzureBlobStorageRemotePrefixModal(
|
||||
app,
|
||||
plugin,
|
||||
newAzureBlobStorageRemotePrefix
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_azureblobstorage_parts"))
|
||||
.setDesc(t("settings_azureblobstorage_parts_desc"))
|
||||
.addDropdown((dropdown) => {
|
||||
dropdown.addOption("1", "1");
|
||||
dropdown.addOption("2", "2");
|
||||
dropdown.addOption("3", "3");
|
||||
dropdown.addOption("5", "5");
|
||||
dropdown.addOption("10", "10");
|
||||
dropdown.addOption("15", "15");
|
||||
dropdown.addOption("20", "20 (default)");
|
||||
|
||||
dropdown
|
||||
.setValue(`${plugin.settings.azureblobstorage.partsConcurrency}`)
|
||||
.onChange(async (val) => {
|
||||
const realVal = Number.parseInt(val);
|
||||
plugin.settings.azureblobstorage.partsConcurrency = realVal;
|
||||
await plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_azureblobstorage_generatefolderobject"))
|
||||
.setDesc(t("settings_azureblobstorage_generatefolderobject_desc"))
|
||||
.addDropdown((dropdown) => {
|
||||
dropdown
|
||||
.addOption(
|
||||
"notgenerate",
|
||||
t("settings_azureblobstorage_generatefolderobject_notgenerate")
|
||||
)
|
||||
.addOption(
|
||||
"generate",
|
||||
t("settings_azureblobstorage_generatefolderobject_generate")
|
||||
);
|
||||
|
||||
dropdown
|
||||
.setValue(
|
||||
`${
|
||||
plugin.settings.azureblobstorage.generateFolderObject
|
||||
? "generate"
|
||||
: "notgenerate"
|
||||
}`
|
||||
)
|
||||
.onChange(async (val) => {
|
||||
if (val === "generate") {
|
||||
plugin.settings.azureblobstorage.generateFolderObject = true;
|
||||
} else {
|
||||
plugin.settings.azureblobstorage.generateFolderObject = false;
|
||||
}
|
||||
await plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(azureBlobStorageAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_azureblobstorage_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_azureblobstorage_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
azureBlobStorageDiv: azureBlobStorageDiv,
|
||||
azureBlobStorageAllowedToUsedDiv: azureBlobStorageAllowedToUsedDiv,
|
||||
azureBlobStorageNotShowUpHintSetting: azureBlobStorageNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,367 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_BOX_CONFIG,
|
||||
generateAuthUrl,
|
||||
sendRefreshTokenReq,
|
||||
} from "./fsBox";
|
||||
|
||||
class BoxAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = this.t;
|
||||
|
||||
const authUrl = generateAuthUrl();
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createDiv({
|
||||
text: stringToFragment(t("modal_boxauth_tutorial")),
|
||||
});
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_boxauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_boxauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
|
||||
// let refreshToken = "";
|
||||
// new Setting(contentEl)
|
||||
// .setName(t("modal_box_maualinput"))
|
||||
// .setDesc(t("modal_box_maualinput_desc"))
|
||||
// .addText((text) =>
|
||||
// text
|
||||
// .setPlaceholder("")
|
||||
// .setValue("")
|
||||
// .onChange((val) => {
|
||||
// refreshToken = val.trim();
|
||||
// })
|
||||
// )
|
||||
// .addButton(async (button) => {
|
||||
// button.setButtonText(t("submit"));
|
||||
// button.onClick(async () => {
|
||||
// new Notice(t("modal_box_maualinput_notice"));
|
||||
|
||||
// try {
|
||||
// if (this.plugin.settings.box === undefined) {
|
||||
// this.plugin.settings.box = cloneDeep(
|
||||
// DEFAULT_BOX_CONFIG
|
||||
// );
|
||||
// }
|
||||
// this.plugin.settings.box.refreshToken = refreshToken;
|
||||
// this.plugin.settings.box.accessToken = "access";
|
||||
// this.plugin.settings.box.accessTokenExpiresAtTimeMs = 1;
|
||||
// this.plugin.settings.box.accessTokenExpiresInMs = 1;
|
||||
|
||||
// // TODO: abstraction leaking now, how to fix?
|
||||
// const k = await sendRefreshTokenReq(refreshToken);
|
||||
// const ts = Date.now();
|
||||
// this.plugin.settings.box.accessToken = k.access_token;
|
||||
// this.plugin.settings.box.accessTokenExpiresInMs =
|
||||
// k.expires_in * 1000;
|
||||
// this.plugin.settings.box.accessTokenExpiresAtTimeMs =
|
||||
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
// await this.plugin.saveSettings();
|
||||
|
||||
// // try to remove data in clipboard
|
||||
// await navigator.clipboard.writeText("");
|
||||
|
||||
// new Notice(t("modal_box_maualinput_succ_notice"));
|
||||
// } catch (e) {
|
||||
// console.error(e);
|
||||
// new Notice(t("modal_box_maualinput_fail_notice"));
|
||||
// } finally {
|
||||
// this.authDiv.toggleClass(
|
||||
// "box-auth-button-hide",
|
||||
// this.plugin.settings.box.refreshToken !== ""
|
||||
// );
|
||||
// this.revokeAuthDiv.toggleClass(
|
||||
// "box-revoke-auth-button-hide",
|
||||
// this.plugin.settings.box.refreshToken === ""
|
||||
// );
|
||||
// this.close();
|
||||
// }
|
||||
// });
|
||||
// });
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
class BoxRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const t = this.t;
|
||||
const { contentEl } = this;
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_boxrevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://app.box.com/account/security";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_boxrevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_boxrevokeauth_clean"))
|
||||
.setDesc(t("modal_boxrevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_boxrevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.box = cloneDeep(DEFAULT_BOX_CONFIG);
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"box-auth-button-hide",
|
||||
this.plugin.settings.box.refreshToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"box-revoke-auth-button-hide",
|
||||
this.plugin.settings.box.refreshToken === ""
|
||||
);
|
||||
new Notice(t("modal_boxrevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_boxrevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateBoxSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const boxDiv = containerEl.createEl("div", {
|
||||
cls: "box-hide",
|
||||
});
|
||||
boxDiv.toggleClass("box-hide", plugin.settings.serviceType !== "box");
|
||||
boxDiv.createEl("h2", { text: t("settings_box") });
|
||||
|
||||
const boxLongDescDiv = boxDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_box_disclaimer1"),
|
||||
t("settings_box_disclaimer2"),
|
||||
]) {
|
||||
boxLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "box-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
boxLongDescDiv.createEl("p", {
|
||||
text: t("settings_box_folder", {
|
||||
remoteBaseDir: plugin.settings.box.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
boxLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_box_pro_desc")),
|
||||
cls: "box-disclaimer",
|
||||
});
|
||||
|
||||
const boxNotShowUpHintSetting = new Setting(boxDiv)
|
||||
.setName(t("settings_box_notshowuphint"))
|
||||
.setDesc(t("settings_box_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_box_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const boxAllowedToUsedDiv = boxDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowBox =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-box"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up box settings? ${allowBox}`);
|
||||
if (allowBox) {
|
||||
boxAllowedToUsedDiv.removeClass("box-allow-to-use-hide");
|
||||
boxNotShowUpHintSetting.settingEl.addClass("box-allow-to-use-hide");
|
||||
} else {
|
||||
boxAllowedToUsedDiv.addClass("box-allow-to-use-hide");
|
||||
boxNotShowUpHintSetting.settingEl.removeClass("box-allow-to-use-hide");
|
||||
}
|
||||
|
||||
const boxSelectAuthDiv = boxAllowedToUsedDiv.createDiv();
|
||||
const boxAuthDiv = boxSelectAuthDiv.createDiv({
|
||||
cls: "box-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const boxRevokeAuthDiv = boxSelectAuthDiv.createDiv({
|
||||
cls: "box-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const boxRevokeAuthSetting = new Setting(boxRevokeAuthDiv)
|
||||
.setName(t("settings_box_revoke"))
|
||||
.setDesc(t("settings_box_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_box_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new BoxRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
boxAuthDiv,
|
||||
boxRevokeAuthDiv,
|
||||
t
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(boxAuthDiv)
|
||||
.setName(t("settings_box_auth"))
|
||||
.setDesc(t("settings_box_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_box_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new BoxAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
boxAuthDiv,
|
||||
boxRevokeAuthDiv,
|
||||
boxRevokeAuthSetting,
|
||||
t
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = boxAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = boxRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = boxRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
boxAuthDiv.toggleClass(
|
||||
"box-auth-button-hide",
|
||||
plugin.settings.box.refreshToken !== ""
|
||||
);
|
||||
boxRevokeAuthDiv.toggleClass(
|
||||
"box-revoke-auth-button-hide",
|
||||
plugin.settings.box.refreshToken === ""
|
||||
);
|
||||
|
||||
let newboxRemoteBaseDir = plugin.settings.box.remoteBaseDir || "";
|
||||
new Setting(boxAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newboxRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newboxRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newboxRemoteBaseDir,
|
||||
"box"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
new Setting(boxAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_box_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_box_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
boxDiv: boxDiv,
|
||||
boxAllowedToUsedDiv: boxAllowedToUsedDiv,
|
||||
boxNotShowUpHintSetting: boxNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,377 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_GOOGLEDRIVE_CONFIG,
|
||||
sendRefreshTokenReq,
|
||||
} from "./fsGoogleDrive";
|
||||
|
||||
class GoogleDriveAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = this.t;
|
||||
|
||||
const authUrl = "https://remotelysave.com/auth/googledrive/start";
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createDiv({
|
||||
text: stringToFragment(t("modal_googledriveauth_tutorial")),
|
||||
});
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_googledriveauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_googledriveauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
|
||||
let refreshToken = "";
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_googledrivce_maualinput"))
|
||||
.setDesc(t("modal_googledrivce_maualinput_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder("")
|
||||
.setValue("")
|
||||
.onChange((val) => {
|
||||
refreshToken = val.trim();
|
||||
})
|
||||
)
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("submit"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("modal_googledrive_maualinput_notice"));
|
||||
|
||||
try {
|
||||
if (this.plugin.settings.googledrive === undefined) {
|
||||
this.plugin.settings.googledrive = cloneDeep(
|
||||
DEFAULT_GOOGLEDRIVE_CONFIG
|
||||
);
|
||||
}
|
||||
this.plugin.settings.googledrive.refreshToken = refreshToken;
|
||||
this.plugin.settings.googledrive.accessToken = "access";
|
||||
this.plugin.settings.googledrive.accessTokenExpiresAtTimeMs = 1;
|
||||
this.plugin.settings.googledrive.accessTokenExpiresInMs = 1;
|
||||
|
||||
// TODO: abstraction leaking now, how to fix?
|
||||
const k = await sendRefreshTokenReq(refreshToken);
|
||||
const ts = Date.now();
|
||||
this.plugin.settings.googledrive.accessToken = k.access_token;
|
||||
this.plugin.settings.googledrive.accessTokenExpiresInMs =
|
||||
k.expires_in * 1000;
|
||||
this.plugin.settings.googledrive.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
await this.plugin.saveSettings();
|
||||
|
||||
// try to remove data in clipboard
|
||||
await navigator.clipboard.writeText("");
|
||||
|
||||
new Notice(t("modal_googledrive_maualinput_succ_notice"));
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
new Notice(t("modal_googledrive_maualinput_fail_notice"));
|
||||
} finally {
|
||||
this.authDiv.toggleClass(
|
||||
"googledrive-auth-button-hide",
|
||||
this.plugin.settings.googledrive.refreshToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"googledrive-revoke-auth-button-hide",
|
||||
this.plugin.settings.googledrive.refreshToken === ""
|
||||
);
|
||||
this.close();
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
class GoogleDriveRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const t = this.t;
|
||||
const { contentEl } = this;
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_googledriverevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://myaccount.google.com/permissions";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_googledriverevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_googledriverevokeauth_clean"))
|
||||
.setDesc(t("modal_googledriverevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_googledriverevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.googledrive = cloneDeep(
|
||||
DEFAULT_GOOGLEDRIVE_CONFIG
|
||||
);
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"googledrive-auth-button-hide",
|
||||
this.plugin.settings.googledrive.refreshToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"googledrive-revoke-auth-button-hide",
|
||||
this.plugin.settings.googledrive.refreshToken === ""
|
||||
);
|
||||
new Notice(t("modal_googledriverevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_googledriverevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateGoogleDriveSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const googleDriveDiv = containerEl.createEl("div", {
|
||||
cls: "googledrive-hide",
|
||||
});
|
||||
googleDriveDiv.toggleClass(
|
||||
"googledrive-hide",
|
||||
plugin.settings.serviceType !== "googledrive"
|
||||
);
|
||||
googleDriveDiv.createEl("h2", { text: t("settings_googledrive") });
|
||||
|
||||
const googleDriveLongDescDiv = googleDriveDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_googledrive_disclaimer1"),
|
||||
t("settings_googledrive_disclaimer2"),
|
||||
]) {
|
||||
googleDriveLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "googledrive-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
googleDriveLongDescDiv.createEl("p", {
|
||||
text: t("settings_googledrive_folder", {
|
||||
remoteBaseDir:
|
||||
plugin.settings.googledrive.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
googleDriveLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_googledrive_pro_desc")),
|
||||
cls: "googledrive-disclaimer",
|
||||
});
|
||||
|
||||
const googleDriveNotShowUpHintSetting = new Setting(googleDriveDiv)
|
||||
.setName(t("settings_googledrive_notshowuphint"))
|
||||
.setDesc(t("settings_googledrive_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_googledrive_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const googleDriveAllowedToUsedDiv = googleDriveDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowGoogleDrive =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-google_drive"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up google drive settings? ${allowGoogleDrive}`);
|
||||
if (allowGoogleDrive) {
|
||||
googleDriveAllowedToUsedDiv.removeClass("googledrive-allow-to-use-hide");
|
||||
googleDriveNotShowUpHintSetting.settingEl.addClass(
|
||||
"googledrive-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
googleDriveAllowedToUsedDiv.addClass("googledrive-allow-to-use-hide");
|
||||
googleDriveNotShowUpHintSetting.settingEl.removeClass(
|
||||
"googledrive-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const googleDriveSelectAuthDiv = googleDriveAllowedToUsedDiv.createDiv();
|
||||
const googleDriveAuthDiv = googleDriveSelectAuthDiv.createDiv({
|
||||
cls: "googledrive-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const googleDriveRevokeAuthDiv = googleDriveSelectAuthDiv.createDiv({
|
||||
cls: "googledrive-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const googleDriveRevokeAuthSetting = new Setting(googleDriveRevokeAuthDiv)
|
||||
.setName(t("settings_googledrive_revoke"))
|
||||
.setDesc(t("settings_googledrive_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_googledrive_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new GoogleDriveRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
googleDriveAuthDiv,
|
||||
googleDriveRevokeAuthDiv,
|
||||
t
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(googleDriveAuthDiv)
|
||||
.setName(t("settings_googledrive_auth"))
|
||||
.setDesc(t("settings_googledrive_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_googledrive_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new GoogleDriveAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
googleDriveAuthDiv,
|
||||
googleDriveRevokeAuthDiv,
|
||||
googleDriveRevokeAuthSetting,
|
||||
t
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = googleDriveAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = googleDriveRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = googleDriveRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
googleDriveAuthDiv.toggleClass(
|
||||
"googledrive-auth-button-hide",
|
||||
plugin.settings.googledrive.refreshToken !== ""
|
||||
);
|
||||
googleDriveRevokeAuthDiv.toggleClass(
|
||||
"googledrive-revoke-auth-button-hide",
|
||||
plugin.settings.googledrive.refreshToken === ""
|
||||
);
|
||||
|
||||
let newgoogleDriveRemoteBaseDir =
|
||||
plugin.settings.googledrive.remoteBaseDir || "";
|
||||
new Setting(googleDriveAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newgoogleDriveRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newgoogleDriveRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newgoogleDriveRemoteBaseDir,
|
||||
"googledrive"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
new Setting(googleDriveAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_googledrive_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_googledrive_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
googleDriveDiv: googleDriveDiv,
|
||||
googleDriveAllowedToUsedDiv: googleDriveAllowedToUsedDiv,
|
||||
googleDriveNotShowUpHintSetting: googleDriveNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,367 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_KOOFR_CONFIG,
|
||||
generateAuthUrl,
|
||||
sendRefreshTokenReq,
|
||||
} from "./fsKoofr";
|
||||
|
||||
class KoofrAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = this.t;
|
||||
|
||||
const authUrl = generateAuthUrl(this.plugin.settings.koofr.api, true);
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createDiv({
|
||||
text: stringToFragment(t("modal_koofrauth_tutorial")),
|
||||
});
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_koofrauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_koofrauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
|
||||
// let refreshToken = "";
|
||||
// new Setting(contentEl)
|
||||
// .setName(t("modal_koofr_maualinput"))
|
||||
// .setDesc(t("modal_koofr_maualinput_desc"))
|
||||
// .addText((text) =>
|
||||
// text
|
||||
// .setPlaceholder("")
|
||||
// .setValue("")
|
||||
// .onChange((val) => {
|
||||
// refreshToken = val.trim();
|
||||
// })
|
||||
// )
|
||||
// .addButton(async (button) => {
|
||||
// button.setButtonText(t("submit"));
|
||||
// button.onClick(async () => {
|
||||
// new Notice(t("modal_koofr_maualinput_notice"));
|
||||
|
||||
// try {
|
||||
// if (this.plugin.settings.koofr === undefined) {
|
||||
// this.plugin.settings.koofr = cloneDeep(
|
||||
// DEFAULT_KOOFR_CONFIG
|
||||
// );
|
||||
// }
|
||||
// this.plugin.settings.koofr.refreshToken = refreshToken;
|
||||
// this.plugin.settings.koofr.accessToken = "access";
|
||||
// this.plugin.settings.koofr.accessTokenExpiresAtTimeMs = 1;
|
||||
// this.plugin.settings.koofr.accessTokenExpiresInMs = 1;
|
||||
|
||||
// // TODO: abstraction leaking now, how to fix?
|
||||
// const k = await sendRefreshTokenReq(refreshToken);
|
||||
// const ts = Date.now();
|
||||
// this.plugin.settings.koofr.accessToken = k.access_token;
|
||||
// this.plugin.settings.koofr.accessTokenExpiresInMs =
|
||||
// k.expires_in * 1000;
|
||||
// this.plugin.settings.koofr.accessTokenExpiresAtTimeMs =
|
||||
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
// await this.plugin.saveSettings();
|
||||
|
||||
// // try to remove data in clipboard
|
||||
// await navigator.clipboard.writeText("");
|
||||
|
||||
// new Notice(t("modal_koofr_maualinput_succ_notice"));
|
||||
// } catch (e) {
|
||||
// console.error(e);
|
||||
// new Notice(t("modal_koofr_maualinput_fail_notice"));
|
||||
// } finally {
|
||||
// this.authDiv.toggleClass(
|
||||
// "koofr-auth-button-hide",
|
||||
// this.plugin.settings.koofr.refreshToken !== ""
|
||||
// );
|
||||
// this.revokeAuthDiv.toggleClass(
|
||||
// "koofr-revoke-auth-button-hide",
|
||||
// this.plugin.settings.koofr.refreshToken === ""
|
||||
// );
|
||||
// this.close();
|
||||
// }
|
||||
// });
|
||||
// });
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
class KoofrRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const t = this.t;
|
||||
const { contentEl } = this;
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_koofrrevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://app.koofr.net/app/admin/preferences/security";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_koofrrevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_koofrrevokeauth_clean"))
|
||||
.setDesc(t("modal_koofrrevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_koofrrevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.koofr = cloneDeep(DEFAULT_KOOFR_CONFIG);
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"koofr-auth-button-hide",
|
||||
this.plugin.settings.koofr.refreshToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"koofr-revoke-auth-button-hide",
|
||||
this.plugin.settings.koofr.refreshToken === ""
|
||||
);
|
||||
new Notice(t("modal_koofrrevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_koofrrevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateKoofrSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const koofrDiv = containerEl.createEl("div", {
|
||||
cls: "koofr-hide",
|
||||
});
|
||||
koofrDiv.toggleClass("koofr-hide", plugin.settings.serviceType !== "koofr");
|
||||
koofrDiv.createEl("h2", { text: t("settings_koofr") });
|
||||
|
||||
const koofrLongDescDiv = koofrDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_koofr_disclaimer1"),
|
||||
t("settings_koofr_disclaimer2"),
|
||||
]) {
|
||||
koofrLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "koofr-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
koofrLongDescDiv.createEl("p", {
|
||||
text: t("settings_koofr_folder", {
|
||||
remoteBaseDir: plugin.settings.koofr.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
koofrLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_koofr_pro_desc")),
|
||||
cls: "koofr-disclaimer",
|
||||
});
|
||||
|
||||
const koofrNotShowUpHintSetting = new Setting(koofrDiv)
|
||||
.setName(t("settings_koofr_notshowuphint"))
|
||||
.setDesc(t("settings_koofr_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_koofr_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const koofrAllowedToUsedDiv = koofrDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowKoofr =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-koofr"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up koofr settings? ${allowKoofr}`);
|
||||
if (allowKoofr) {
|
||||
koofrAllowedToUsedDiv.removeClass("koofr-allow-to-use-hide");
|
||||
koofrNotShowUpHintSetting.settingEl.addClass("koofr-allow-to-use-hide");
|
||||
} else {
|
||||
koofrAllowedToUsedDiv.addClass("koofr-allow-to-use-hide");
|
||||
koofrNotShowUpHintSetting.settingEl.removeClass("koofr-allow-to-use-hide");
|
||||
}
|
||||
|
||||
const koofrSelectAuthDiv = koofrAllowedToUsedDiv.createDiv();
|
||||
const koofrAuthDiv = koofrSelectAuthDiv.createDiv({
|
||||
cls: "koofr-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const koofrRevokeAuthDiv = koofrSelectAuthDiv.createDiv({
|
||||
cls: "koofr-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const koofrRevokeAuthSetting = new Setting(koofrRevokeAuthDiv)
|
||||
.setName(t("settings_koofr_revoke"))
|
||||
.setDesc(t("settings_koofr_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_koofr_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new KoofrRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
koofrAuthDiv,
|
||||
koofrRevokeAuthDiv,
|
||||
t
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(koofrAuthDiv)
|
||||
.setName(t("settings_koofr_auth"))
|
||||
.setDesc(t("settings_koofr_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_koofr_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new KoofrAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
koofrAuthDiv,
|
||||
koofrRevokeAuthDiv,
|
||||
koofrRevokeAuthSetting,
|
||||
t
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = koofrAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = koofrRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = koofrRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
koofrAuthDiv.toggleClass(
|
||||
"koofr-auth-button-hide",
|
||||
plugin.settings.koofr.refreshToken !== ""
|
||||
);
|
||||
koofrRevokeAuthDiv.toggleClass(
|
||||
"koofr-revoke-auth-button-hide",
|
||||
plugin.settings.koofr.refreshToken === ""
|
||||
);
|
||||
|
||||
let newkoofrRemoteBaseDir = plugin.settings.koofr.remoteBaseDir || "";
|
||||
new Setting(koofrAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newkoofrRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newkoofrRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newkoofrRemoteBaseDir,
|
||||
"koofr"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
new Setting(koofrAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_koofr_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_koofr_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
koofrDiv: koofrDiv,
|
||||
koofrAllowedToUsedDiv: koofrAllowedToUsedDiv,
|
||||
koofrNotShowUpHintSetting: koofrNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,337 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Platform, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_ONEDRIVEFULL_CONFIG,
|
||||
getAuthUrlAndVerifier as getAuthUrlAndVerifierOnedriveFull,
|
||||
sendRefreshTokenReq as sendRefreshTokenReqOnedriveFull,
|
||||
} from "./fsOnedriveFull";
|
||||
|
||||
export class OnedriveFullAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
|
||||
const { authUrl, verifier } = await getAuthUrlAndVerifierOnedriveFull(
|
||||
this.plugin.settings.onedrivefull.clientID,
|
||||
this.plugin.settings.onedrivefull.authority
|
||||
);
|
||||
this.plugin.oauth2Info.verifier = verifier;
|
||||
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.plugin.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
t("modal_onedrivefullauth_shortdesc")
|
||||
.split("\n")
|
||||
.forEach((val) => {
|
||||
contentEl.createEl("p", {
|
||||
text: val,
|
||||
});
|
||||
});
|
||||
if (Platform.isLinux) {
|
||||
t("modal_onedrivefullauth_shortdesc_linux")
|
||||
.split("\n")
|
||||
.forEach((val) => {
|
||||
contentEl.createEl("p", {
|
||||
text: stringToFragment(val),
|
||||
});
|
||||
});
|
||||
}
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_onedrivefullauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_onedrivefullauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export class OnedriveFullRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.plugin.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_onedrivefullrevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://microsoft.com/consent";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_onedrivefullrevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_onedrivefullrevokeauth_clean"))
|
||||
.setDesc(t("modal_onedrivefullrevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_onedrivefullrevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.onedrivefull = JSON.parse(
|
||||
JSON.stringify(DEFAULT_ONEDRIVEFULL_CONFIG)
|
||||
);
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"onedrivefull-auth-button-hide",
|
||||
this.plugin.settings.onedrivefull.username !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"onedrivefull-revoke-auth-button-hide",
|
||||
this.plugin.settings.onedrivefull.username === ""
|
||||
);
|
||||
new Notice(t("modal_onedrivefullrevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_onedrivefullrevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateOnedriveFullSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const onedriveFullDiv = containerEl.createEl("div", {
|
||||
cls: "onedrivefull-hide",
|
||||
});
|
||||
onedriveFullDiv.toggleClass(
|
||||
"onedrivefull-hide",
|
||||
plugin.settings.serviceType !== "onedrivefull"
|
||||
);
|
||||
onedriveFullDiv.createEl("h2", { text: t("settings_onedrivefull") });
|
||||
|
||||
const onedriveFullLongDescDiv = onedriveFullDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_onedrivefull_disclaimer1"),
|
||||
t("settings_onedrivefull_disclaimer2"),
|
||||
]) {
|
||||
onedriveFullLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "onedrivefull-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
onedriveFullLongDescDiv.createEl("p", {
|
||||
text: t("settings_onedrivefull_folder", {
|
||||
remoteBaseDir:
|
||||
plugin.settings.onedrivefull.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
onedriveFullLongDescDiv.createEl("p", {
|
||||
text: t("settings_onedrivefull_nobiz"),
|
||||
});
|
||||
|
||||
onedriveFullLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_onedrivefull_pro_desc")),
|
||||
cls: "onedrivefull-disclaimer",
|
||||
});
|
||||
|
||||
const onedriveFullNotShowUpHintSetting = new Setting(onedriveFullDiv)
|
||||
.setName(t("settings_onedrivefull_notshowuphint"))
|
||||
.setDesc(t("settings_onedrivefull_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_onedrivefull_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const onedriveFullAllowedToUsedDiv = onedriveFullDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowOnedriveFull =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-onedrive_full"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up onedriveFull settings? ${allowOnedriveFull}`);
|
||||
if (allowOnedriveFull) {
|
||||
onedriveFullAllowedToUsedDiv.removeClass("onedrivefull-allow-to-use-hide");
|
||||
onedriveFullNotShowUpHintSetting.settingEl.addClass(
|
||||
"onedrivefull-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
onedriveFullAllowedToUsedDiv.addClass("onedrivefull-allow-to-use-hide");
|
||||
onedriveFullNotShowUpHintSetting.settingEl.removeClass(
|
||||
"onedrivefull-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const onedriveFullSelectAuthDiv = onedriveFullAllowedToUsedDiv.createDiv();
|
||||
const onedriveFullAuthDiv = onedriveFullSelectAuthDiv.createDiv({
|
||||
cls: "onedrivefull-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const onedriveFullRevokeAuthDiv = onedriveFullSelectAuthDiv.createDiv({
|
||||
cls: "onedrivefull-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const onedriveFullRevokeAuthSetting = new Setting(onedriveFullRevokeAuthDiv)
|
||||
.setName(t("settings_onedrivefull_revoke"))
|
||||
.setDesc(t("settings_onedrivefull_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_onedrivefull_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new OnedriveFullRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
onedriveFullAuthDiv,
|
||||
onedriveFullRevokeAuthDiv
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(onedriveFullAuthDiv)
|
||||
.setName(t("settings_onedrivefull_auth"))
|
||||
.setDesc(t("settings_onedrivefull_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_onedrivefull_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new OnedriveFullAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
onedriveFullAuthDiv,
|
||||
onedriveFullRevokeAuthDiv,
|
||||
onedriveFullRevokeAuthSetting
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = onedriveFullAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = onedriveFullRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = onedriveFullRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
onedriveFullAuthDiv.toggleClass(
|
||||
"onedrivefull-auth-button-hide",
|
||||
plugin.settings.onedrivefull.refreshToken !== ""
|
||||
);
|
||||
onedriveFullRevokeAuthDiv.toggleClass(
|
||||
"onedrivefull-revoke-auth-button-hide",
|
||||
plugin.settings.onedrivefull.refreshToken === ""
|
||||
);
|
||||
|
||||
let newonedriveFullRemoteBaseDir =
|
||||
plugin.settings.onedrivefull.remoteBaseDir || "";
|
||||
new Setting(onedriveFullAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newonedriveFullRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newonedriveFullRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newonedriveFullRemoteBaseDir,
|
||||
"onedrivefull"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
new Setting(onedriveFullAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_onedrivefull_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_onedrivefull_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
onedriveFullDiv: onedriveFullDiv,
|
||||
onedriveFullAllowedToUsedDiv: onedriveFullAllowedToUsedDiv,
|
||||
onedriveFullNotShowUpHintSetting: onedriveFullNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,311 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import { DEFAULT_PCLOUD_CONFIG, generateAuthUrl } from "./fsPCloud";
|
||||
|
||||
class PCloudAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = this.t;
|
||||
|
||||
const { authUrl } = await generateAuthUrl(true);
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createDiv({
|
||||
text: stringToFragment(t("modal_pcloudauth_tutorial")),
|
||||
});
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_pcloudauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_pcloudauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
class PCloudRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const t = this.t;
|
||||
const { contentEl } = this;
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_pcloudrevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://my.pcloud.com/#page=settings&settings=tab-apps";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_pcloudrevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_pcloudrevokeauth_clean"))
|
||||
.setDesc(t("modal_pcloudrevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_pcloudrevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.pcloud = cloneDeep(DEFAULT_PCLOUD_CONFIG);
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"pcloud-auth-button-hide",
|
||||
this.plugin.settings.pcloud.accessToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"pcloud-revoke-auth-button-hide",
|
||||
this.plugin.settings.pcloud.accessToken === ""
|
||||
);
|
||||
new Notice(t("modal_pcloudrevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_pcloudrevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generatePCloudSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const pCloudDiv = containerEl.createEl("div", {
|
||||
cls: "pcloud-hide",
|
||||
});
|
||||
pCloudDiv.toggleClass(
|
||||
"pcloud-hide",
|
||||
plugin.settings.serviceType !== "pcloud"
|
||||
);
|
||||
pCloudDiv.createEl("h2", { text: t("settings_pcloud") });
|
||||
|
||||
const pcloudLongDescDiv = pCloudDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_pcloud_disclaimer1"),
|
||||
t("settings_pcloud_disclaimer2"),
|
||||
]) {
|
||||
pcloudLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "pcloud-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
pcloudLongDescDiv.createEl("p", {
|
||||
text: t("settings_pcloud_folder", {
|
||||
remoteBaseDir:
|
||||
plugin.settings.pcloud.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
pcloudLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_pcloud_pro_desc")),
|
||||
cls: "pcloud-disclaimer",
|
||||
});
|
||||
|
||||
const pCloudNotShowUpHintSetting = new Setting(pCloudDiv)
|
||||
.setName(t("settings_pcloud_notshowuphint"))
|
||||
.setDesc(t("settings_pcloud_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_pcloud_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const pCloudAllowedToUsedDiv = pCloudDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowPCloud =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-pcloud"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up pcloud settings? ${allowPCloud}`);
|
||||
if (allowPCloud) {
|
||||
pCloudAllowedToUsedDiv.removeClass("pcloud-allow-to-use-hide");
|
||||
pCloudNotShowUpHintSetting.settingEl.addClass("pcloud-allow-to-use-hide");
|
||||
} else {
|
||||
pCloudAllowedToUsedDiv.addClass("pcloud-allow-to-use-hide");
|
||||
pCloudNotShowUpHintSetting.settingEl.removeClass(
|
||||
"pcloud-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const pcloudSelectAuthDiv = pCloudAllowedToUsedDiv.createDiv();
|
||||
const pcloudAuthDiv = pcloudSelectAuthDiv.createDiv({
|
||||
cls: "pcloud-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const pcloudRevokeAuthDiv = pcloudSelectAuthDiv.createDiv({
|
||||
cls: "pcloud-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const pcloudRevokeAuthSetting = new Setting(pcloudRevokeAuthDiv)
|
||||
.setName(t("settings_pcloud_revoke"))
|
||||
.setDesc(t("settings_pcloud_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_pcloud_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new PCloudRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
pcloudAuthDiv,
|
||||
pcloudRevokeAuthDiv,
|
||||
t
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(pcloudAuthDiv)
|
||||
.setName(t("settings_pcloud_auth"))
|
||||
.setDesc(t("settings_pcloud_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_pcloud_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new PCloudAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
pcloudAuthDiv,
|
||||
pcloudRevokeAuthDiv,
|
||||
pcloudRevokeAuthSetting,
|
||||
t
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = pcloudAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = pcloudRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = pcloudRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
pcloudAuthDiv.toggleClass(
|
||||
"pcloud-auth-button-hide",
|
||||
plugin.settings.pcloud.accessToken !== ""
|
||||
);
|
||||
pcloudRevokeAuthDiv.toggleClass(
|
||||
"pcloud-revoke-auth-button-hide",
|
||||
plugin.settings.pcloud.accessToken === ""
|
||||
);
|
||||
|
||||
let newpcloudRemoteBaseDir = plugin.settings.pcloud.remoteBaseDir || "";
|
||||
new Setting(pCloudAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newpcloudRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newpcloudRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newpcloudRemoteBaseDir,
|
||||
"pcloud"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(pCloudAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_pcloud_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_pcloud_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
pCloudDiv: pCloudDiv,
|
||||
pCloudAllowedToUsedDiv: pCloudAllowedToUsedDiv,
|
||||
pCloudNotShowUpHintSetting: pCloudNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
@@ -0,0 +1,506 @@
|
||||
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;
|
||||
|
||||
// try to remove data in clipboard
|
||||
await navigator.clipboard.writeText("");
|
||||
|
||||
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,
|
||||
onedriveFullAllowedToUsedDiv: HTMLDivElement,
|
||||
onedriveFullNotShowUpHintSetting: Setting,
|
||||
googleDriveAllowedToUsedDiv: HTMLDivElement,
|
||||
googleDriveNotShowUpHintSetting: Setting,
|
||||
boxAllowedToUsedDiv: HTMLDivElement,
|
||||
boxNotShowUpHintSetting: Setting,
|
||||
pCloudAllowedToUsedDiv: HTMLDivElement,
|
||||
pCloudNotShowUpHintSetting: Setting,
|
||||
yandexDiskAllowedToUsedDiv: HTMLDivElement,
|
||||
yandexDiskNotShowUpHintSetting: Setting,
|
||||
koofrAllowedToUsedDiv: HTMLDivElement,
|
||||
koofrNotShowUpHintSetting: Setting,
|
||||
azureBlobStorageAllowedToUsedDiv: HTMLDivElement,
|
||||
azureBlobStorageNotShowUpHintSetting: Setting
|
||||
) => {
|
||||
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
|
||||
),
|
||||
})
|
||||
)
|
||||
);
|
||||
|
||||
const allowOnedriveFull =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-box"
|
||||
).length === 1;
|
||||
console.debug(
|
||||
`allow to show up OnedriveFull settings? ${allowOnedriveFull}`
|
||||
);
|
||||
if (allowOnedriveFull) {
|
||||
onedriveFullAllowedToUsedDiv.removeClass(
|
||||
"onedrivefull-allow-to-use-hide"
|
||||
);
|
||||
onedriveFullNotShowUpHintSetting.settingEl.addClass(
|
||||
"onedrivefull-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
onedriveFullAllowedToUsedDiv.addClass("onedrivefull-allow-to-use-hide");
|
||||
onedriveFullNotShowUpHintSetting.settingEl.removeClass(
|
||||
"onedrivefull-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const allowGoogleDrive =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-google_drive"
|
||||
).length === 1;
|
||||
console.debug(
|
||||
`allow to show up google drive settings? ${allowGoogleDrive}`
|
||||
);
|
||||
if (allowGoogleDrive) {
|
||||
googleDriveAllowedToUsedDiv.removeClass(
|
||||
"googledrive-allow-to-use-hide"
|
||||
);
|
||||
googleDriveNotShowUpHintSetting.settingEl.addClass(
|
||||
"googledrive-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
googleDriveAllowedToUsedDiv.addClass("googledrive-allow-to-use-hide");
|
||||
googleDriveNotShowUpHintSetting.settingEl.removeClass(
|
||||
"googledrive-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const allowBox =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-box"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up Box settings? ${allowBox}`);
|
||||
if (allowBox) {
|
||||
boxAllowedToUsedDiv.removeClass("box-allow-to-use-hide");
|
||||
boxNotShowUpHintSetting.settingEl.addClass("box-allow-to-use-hide");
|
||||
} else {
|
||||
boxAllowedToUsedDiv.addClass("box-allow-to-use-hide");
|
||||
boxNotShowUpHintSetting.settingEl.removeClass("box-allow-to-use-hide");
|
||||
}
|
||||
|
||||
const allowPCloud =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-pcloud"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up pCloud settings? ${allowPCloud}`);
|
||||
if (allowPCloud) {
|
||||
pCloudAllowedToUsedDiv.removeClass("pcloud-allow-to-use-hide");
|
||||
pCloudNotShowUpHintSetting.settingEl.addClass(
|
||||
"pcloud-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
pCloudAllowedToUsedDiv.addClass("pcloud-allow-to-use-hide");
|
||||
pCloudNotShowUpHintSetting.settingEl.removeClass(
|
||||
"pcloud-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const allowYandexDisk =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-yandex_disk"
|
||||
).length === 1;
|
||||
console.debug(
|
||||
`allow to show up Yandex Disk settings? ${allowYandexDisk}`
|
||||
);
|
||||
if (allowYandexDisk) {
|
||||
yandexDiskAllowedToUsedDiv.removeClass("yandexdisk-allow-to-use-hide");
|
||||
yandexDiskNotShowUpHintSetting.settingEl.addClass(
|
||||
"yandexdisk-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
yandexDiskAllowedToUsedDiv.addClass("yandexdisk-allow-to-use-hide");
|
||||
yandexDiskNotShowUpHintSetting.settingEl.removeClass(
|
||||
"yandexdisk-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const allowKoofr =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-koofr"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up Koofr settings? ${allowKoofr}`);
|
||||
if (allowKoofr) {
|
||||
koofrAllowedToUsedDiv.removeClass("koofr-allow-to-use-hide");
|
||||
koofrNotShowUpHintSetting.settingEl.addClass("koofr-allow-to-use-hide");
|
||||
} else {
|
||||
koofrAllowedToUsedDiv.addClass("koofr-allow-to-use-hide");
|
||||
koofrNotShowUpHintSetting.settingEl.removeClass(
|
||||
"koofr-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const allowAzureBlobStorage =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-azure_blob_storage"
|
||||
).length === 1;
|
||||
console.debug(
|
||||
`allow to show up AzureBlobStorage settings? ${allowAzureBlobStorage}`
|
||||
);
|
||||
if (allowAzureBlobStorage) {
|
||||
azureBlobStorageAllowedToUsedDiv.removeClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
azureBlobStorageNotShowUpHintSetting.settingEl.addClass(
|
||||
"azureBlobStorage-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
azureBlobStorageAllowedToUsedDiv.addClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
azureBlobStorageNotShowUpHintSetting.settingEl.removeClass(
|
||||
"azureblobstorage-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
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,378 @@
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { type App, Modal, Notice, Setting } from "obsidian";
|
||||
import { getClient } from "../../src/fsGetter";
|
||||
import type { TransItemType } from "../../src/i18n";
|
||||
import type RemotelySavePlugin from "../../src/main";
|
||||
import { stringToFragment } from "../../src/misc";
|
||||
import { ChangeRemoteBaseDirModal } from "../../src/settings";
|
||||
import {
|
||||
DEFAULT_YANDEXDISK_CONFIG,
|
||||
generateAuthUrl,
|
||||
sendRefreshTokenReq,
|
||||
} from "./fsYandexDisk";
|
||||
|
||||
class YandexDiskAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly revokeAuthSetting: Setting;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
revokeAuthSetting: Setting,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.revokeAuthSetting = revokeAuthSetting;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const { contentEl } = this;
|
||||
const t = this.t;
|
||||
|
||||
const authUrl = generateAuthUrl(true);
|
||||
const div2 = contentEl.createDiv();
|
||||
div2.createDiv({
|
||||
text: stringToFragment(t("modal_yandexdiskauth_tutorial")),
|
||||
});
|
||||
div2.createEl(
|
||||
"button",
|
||||
{
|
||||
text: t("modal_yandexdiskauth_copybutton"),
|
||||
},
|
||||
(el) => {
|
||||
el.onclick = async () => {
|
||||
await navigator.clipboard.writeText(authUrl);
|
||||
new Notice(t("modal_yandexdiskauth_copynotice"));
|
||||
};
|
||||
}
|
||||
);
|
||||
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: authUrl,
|
||||
text: authUrl,
|
||||
});
|
||||
|
||||
// let refreshToken = "";
|
||||
// new Setting(contentEl)
|
||||
// .setName(t("modal_yandexdisk_maualinput"))
|
||||
// .setDesc(t("modal_yandexdisk_maualinput_desc"))
|
||||
// .addText((text) =>
|
||||
// text
|
||||
// .setPlaceholder("")
|
||||
// .setValue("")
|
||||
// .onChange((val) => {
|
||||
// refreshToken = val.trim();
|
||||
// })
|
||||
// )
|
||||
// .addButton(async (button) => {
|
||||
// button.setButtonText(t("submit"));
|
||||
// button.onClick(async () => {
|
||||
// new Notice(t("modal_yandexdisk_maualinput_notice"));
|
||||
|
||||
// try {
|
||||
// if (this.plugin.settings.yandexdisk === undefined) {
|
||||
// this.plugin.settings.yandexdisk = cloneDeep(
|
||||
// DEFAULT_YANDEXDISK_CONFIG
|
||||
// );
|
||||
// }
|
||||
// this.plugin.settings.yandexdisk.refreshToken = refreshToken;
|
||||
// this.plugin.settings.yandexdisk.accessToken = "access";
|
||||
// this.plugin.settings.yandexdisk.accessTokenExpiresAtTimeMs = 1;
|
||||
// this.plugin.settings.yandexdisk.accessTokenExpiresInMs = 1;
|
||||
|
||||
// // TODO: abstraction leaking now, how to fix?
|
||||
// const k = await sendRefreshTokenReq(refreshToken);
|
||||
// const ts = Date.now();
|
||||
// this.plugin.settings.yandexdisk.accessToken = k.access_token;
|
||||
// this.plugin.settings.yandexdisk.accessTokenExpiresInMs =
|
||||
// k.expires_in * 1000;
|
||||
// this.plugin.settings.yandexdisk.accessTokenExpiresAtTimeMs =
|
||||
// ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
// await this.plugin.saveSettings();
|
||||
|
||||
// // try to remove data in clipboard
|
||||
// await navigator.clipboard.writeText("");
|
||||
|
||||
// new Notice(t("modal_yandexdisk_maualinput_succ_notice"));
|
||||
// } catch (e) {
|
||||
// console.error(e);
|
||||
// new Notice(t("modal_yandexdisk_maualinput_fail_notice"));
|
||||
// } finally {
|
||||
// this.authDiv.toggleClass(
|
||||
// "yandexdisk-auth-button-hide",
|
||||
// this.plugin.settings.yandexdisk.refreshToken !== ""
|
||||
// );
|
||||
// this.revokeAuthDiv.toggleClass(
|
||||
// "yandexdisk-revoke-auth-button-hide",
|
||||
// this.plugin.settings.yandexdisk.refreshToken === ""
|
||||
// );
|
||||
// this.close();
|
||||
// }
|
||||
// });
|
||||
// });
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
class YandexDiskRevokeAuthModal extends Modal {
|
||||
readonly plugin: RemotelySavePlugin;
|
||||
readonly authDiv: HTMLDivElement;
|
||||
readonly revokeAuthDiv: HTMLDivElement;
|
||||
readonly t: (x: TransItemType, vars?: any) => string;
|
||||
constructor(
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
authDiv: HTMLDivElement,
|
||||
revokeAuthDiv: HTMLDivElement,
|
||||
t: (x: TransItemType, vars?: any) => string
|
||||
) {
|
||||
super(app);
|
||||
this.plugin = plugin;
|
||||
this.authDiv = authDiv;
|
||||
this.revokeAuthDiv = revokeAuthDiv;
|
||||
this.t = t;
|
||||
}
|
||||
|
||||
async onOpen() {
|
||||
const t = this.t;
|
||||
const { contentEl } = this;
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_yandexdiskrevokeauth_step1"),
|
||||
});
|
||||
const consentUrl = "https://app.yandexDisk.com/account/security";
|
||||
contentEl.createEl("p").createEl("a", {
|
||||
href: consentUrl,
|
||||
text: consentUrl,
|
||||
});
|
||||
|
||||
contentEl.createEl("p", {
|
||||
text: t("modal_yandexdiskrevokeauth_step2"),
|
||||
});
|
||||
|
||||
new Setting(contentEl)
|
||||
.setName(t("modal_yandexdiskrevokeauth_clean"))
|
||||
.setDesc(t("modal_yandexdiskrevokeauth_clean_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("modal_yandexdiskrevokeauth_clean_button"));
|
||||
button.onClick(async () => {
|
||||
try {
|
||||
this.plugin.settings.yandexdisk = cloneDeep(
|
||||
DEFAULT_YANDEXDISK_CONFIG
|
||||
);
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
this.authDiv.toggleClass(
|
||||
"yandexdisk-auth-button-hide",
|
||||
this.plugin.settings.yandexdisk.refreshToken !== ""
|
||||
);
|
||||
this.revokeAuthDiv.toggleClass(
|
||||
"yandexdisk-revoke-auth-button-hide",
|
||||
this.plugin.settings.yandexdisk.refreshToken === ""
|
||||
);
|
||||
new Notice(t("modal_yandexdiskrevokeauth_clean_notice"));
|
||||
this.close();
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
new Notice(t("modal_yandexdiskrevokeauth_clean_fail"));
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
const { contentEl } = this;
|
||||
contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
export const generateYandexDiskSettingsPart = (
|
||||
containerEl: HTMLElement,
|
||||
t: (x: TransItemType, vars?: any) => string,
|
||||
app: App,
|
||||
plugin: RemotelySavePlugin,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const yandexDiskDiv = containerEl.createEl("div", {
|
||||
cls: "yandexdisk-hide",
|
||||
});
|
||||
yandexDiskDiv.toggleClass(
|
||||
"yandexdisk-hide",
|
||||
plugin.settings.serviceType !== "yandexdisk"
|
||||
);
|
||||
yandexDiskDiv.createEl("h2", { text: t("settings_yandexdisk") });
|
||||
|
||||
const yandexDiskLongDescDiv = yandexDiskDiv.createEl("div", {
|
||||
cls: "settings-long-desc",
|
||||
});
|
||||
for (const c of [
|
||||
t("settings_yandexdisk_disclaimer1"),
|
||||
t("settings_yandexdisk_disclaimer2"),
|
||||
]) {
|
||||
yandexDiskLongDescDiv.createEl("p", {
|
||||
text: c,
|
||||
cls: "yandexdisk-disclaimer",
|
||||
});
|
||||
}
|
||||
|
||||
yandexDiskLongDescDiv.createEl("p", {
|
||||
text: t("settings_yandexdisk_folder", {
|
||||
remoteBaseDir:
|
||||
plugin.settings.yandexdisk.remoteBaseDir || app.vault.getName(),
|
||||
}),
|
||||
});
|
||||
|
||||
yandexDiskLongDescDiv.createDiv({
|
||||
text: stringToFragment(t("settings_yandexdisk_pro_desc")),
|
||||
cls: "yandexdisk-disclaimer",
|
||||
});
|
||||
|
||||
const yandexDiskNotShowUpHintSetting = new Setting(yandexDiskDiv)
|
||||
.setName(t("settings_yandexdisk_notshowuphint"))
|
||||
.setDesc(t("settings_yandexdisk_notshowuphint_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_yandexdisk_notshowuphint_view_pro"));
|
||||
button.onClick(async () => {
|
||||
window.location.href = "#settings-pro";
|
||||
});
|
||||
});
|
||||
|
||||
const yandexDiskAllowedToUsedDiv = yandexDiskDiv.createDiv();
|
||||
// if pro enabled, show up; otherwise hide.
|
||||
const allowYandexDisk =
|
||||
plugin.settings.pro?.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-yandex_disk"
|
||||
).length === 1;
|
||||
console.debug(`allow to show up yandexDisk settings? ${allowYandexDisk}`);
|
||||
if (allowYandexDisk) {
|
||||
yandexDiskAllowedToUsedDiv.removeClass("yandexdisk-allow-to-use-hide");
|
||||
yandexDiskNotShowUpHintSetting.settingEl.addClass(
|
||||
"yandexdisk-allow-to-use-hide"
|
||||
);
|
||||
} else {
|
||||
yandexDiskAllowedToUsedDiv.addClass("yandexdisk-allow-to-use-hide");
|
||||
yandexDiskNotShowUpHintSetting.settingEl.removeClass(
|
||||
"yandexdisk-allow-to-use-hide"
|
||||
);
|
||||
}
|
||||
|
||||
const yandexDiskSelectAuthDiv = yandexDiskAllowedToUsedDiv.createDiv();
|
||||
const yandexDiskAuthDiv = yandexDiskSelectAuthDiv.createDiv({
|
||||
cls: "yandexdisk-auth-button-hide settings-auth-related",
|
||||
});
|
||||
const yandexDiskRevokeAuthDiv = yandexDiskSelectAuthDiv.createDiv({
|
||||
cls: "yandexdisk-revoke-auth-button-hide settings-auth-related",
|
||||
});
|
||||
|
||||
const yandexDiskRevokeAuthSetting = new Setting(yandexDiskRevokeAuthDiv)
|
||||
.setName(t("settings_yandexdisk_revoke"))
|
||||
.setDesc(t("settings_yandexdisk_revoke_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_yandexdisk_revoke_button"));
|
||||
button.onClick(async () => {
|
||||
new YandexDiskRevokeAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
yandexDiskAuthDiv,
|
||||
yandexDiskRevokeAuthDiv,
|
||||
t
|
||||
).open();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(yandexDiskAuthDiv)
|
||||
.setName(t("settings_yandexdisk_auth"))
|
||||
.setDesc(t("settings_yandexdisk_auth_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_yandexdisk_auth_button"));
|
||||
button.onClick(async () => {
|
||||
const modal = new YandexDiskAuthModal(
|
||||
app,
|
||||
plugin,
|
||||
yandexDiskAuthDiv,
|
||||
yandexDiskRevokeAuthDiv,
|
||||
yandexDiskRevokeAuthSetting,
|
||||
t
|
||||
);
|
||||
plugin.oauth2Info.helperModal = modal;
|
||||
plugin.oauth2Info.authDiv = yandexDiskAuthDiv;
|
||||
plugin.oauth2Info.revokeDiv = yandexDiskRevokeAuthDiv;
|
||||
plugin.oauth2Info.revokeAuthSetting = yandexDiskRevokeAuthSetting;
|
||||
modal.open();
|
||||
});
|
||||
});
|
||||
|
||||
yandexDiskAuthDiv.toggleClass(
|
||||
"yandexdisk-auth-button-hide",
|
||||
plugin.settings.yandexdisk.refreshToken !== ""
|
||||
);
|
||||
yandexDiskRevokeAuthDiv.toggleClass(
|
||||
"yandexdisk-revoke-auth-button-hide",
|
||||
plugin.settings.yandexdisk.refreshToken === ""
|
||||
);
|
||||
|
||||
let newyandexDiskRemoteBaseDir =
|
||||
plugin.settings.yandexdisk.remoteBaseDir || "";
|
||||
new Setting(yandexDiskAllowedToUsedDiv)
|
||||
.setName(t("settings_remotebasedir"))
|
||||
.setDesc(t("settings_remotebasedir_desc"))
|
||||
.addText((text) =>
|
||||
text
|
||||
.setPlaceholder(app.vault.getName())
|
||||
.setValue(newyandexDiskRemoteBaseDir)
|
||||
.onChange((value) => {
|
||||
newyandexDiskRemoteBaseDir = value.trim();
|
||||
})
|
||||
)
|
||||
.addButton((button) => {
|
||||
button.setButtonText(t("confirm"));
|
||||
button.onClick(() => {
|
||||
new ChangeRemoteBaseDirModal(
|
||||
app,
|
||||
plugin,
|
||||
newyandexDiskRemoteBaseDir,
|
||||
"yandexdisk"
|
||||
).open();
|
||||
});
|
||||
});
|
||||
new Setting(yandexDiskAllowedToUsedDiv)
|
||||
.setName(t("settings_checkonnectivity"))
|
||||
.setDesc(t("settings_checkonnectivity_desc"))
|
||||
.addButton(async (button) => {
|
||||
button.setButtonText(t("settings_checkonnectivity_button"));
|
||||
button.onClick(async () => {
|
||||
new Notice(t("settings_checkonnectivity_checking"));
|
||||
const client = getClient(plugin.settings, app.vault.getName(), () =>
|
||||
plugin.saveSettings()
|
||||
);
|
||||
const errors = { msg: "" };
|
||||
const res = await client.checkConnect((err: any) => {
|
||||
errors.msg = `${err}`;
|
||||
});
|
||||
if (res) {
|
||||
new Notice(t("settings_yandexdisk_connect_succ"));
|
||||
} else {
|
||||
new Notice(t("settings_yandexdisk_connect_fail"));
|
||||
new Notice(errors.msg);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
yandexDiskDiv: yandexDiskDiv,
|
||||
yandexDiskAllowedToUsedDiv: yandexDiskAllowedToUsedDiv,
|
||||
yandexDiskNotShowUpHintSetting: yandexDiskNotShowUpHintSetting,
|
||||
};
|
||||
};
|
||||
+571
-210
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,307 @@
|
||||
//////////////////////////////////////////////
|
||||
// all types
|
||||
// https://yandex.com/dev/disk-api/doc/en/reference/response-objects
|
||||
//////////////////////////////////////////////
|
||||
|
||||
export interface Link {
|
||||
href: string;
|
||||
method: string;
|
||||
templated: boolean;
|
||||
}
|
||||
|
||||
export interface Resource {
|
||||
antivirus_status?: string;
|
||||
public_key?: string;
|
||||
_embedded?: ResourceList;
|
||||
name?: string;
|
||||
created?: string;
|
||||
custom_properties?: Record<string, string>;
|
||||
public_url?: string;
|
||||
origin_path?: string;
|
||||
modified?: string;
|
||||
path?: string;
|
||||
md5?: string;
|
||||
sha256?: string;
|
||||
file?: string;
|
||||
type?: "dir" | "file";
|
||||
mime_type?: string;
|
||||
size?: number;
|
||||
exif?: Record<any, any>;
|
||||
}
|
||||
|
||||
type SortType = string;
|
||||
|
||||
export interface ResourceList {
|
||||
sort?: SortType;
|
||||
public_key?: string;
|
||||
items?: Resource[];
|
||||
path?: string;
|
||||
limit?: number;
|
||||
offset?: number;
|
||||
total?: number;
|
||||
}
|
||||
|
||||
export interface FilesResourceList {
|
||||
items: Resource[];
|
||||
limit: number;
|
||||
offset: number;
|
||||
}
|
||||
|
||||
export interface LastUploadedResourceList {
|
||||
items: Resource[];
|
||||
limit: number;
|
||||
}
|
||||
|
||||
export interface PublicResourcesList {
|
||||
items: Resource[];
|
||||
type: "dir" | "file";
|
||||
limit: number;
|
||||
offset: number;
|
||||
}
|
||||
|
||||
export interface Disk {
|
||||
trash_size: number;
|
||||
total_space: number;
|
||||
used_space: number;
|
||||
system_folders: {
|
||||
applications: string;
|
||||
downloads: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface Operation {
|
||||
status: "success" | "failed" | "in-progress";
|
||||
}
|
||||
|
||||
export interface ErrorResponse {
|
||||
error: string;
|
||||
description: string;
|
||||
message?: string;
|
||||
}
|
||||
|
||||
//////////////////////////////////////////////
|
||||
// api
|
||||
// https://yandex.com/dev/disk-api/doc/en/
|
||||
//////////////////////////////////////////////
|
||||
|
||||
export class YandexApi {
|
||||
accessToken: string;
|
||||
apiVersion: number;
|
||||
host: string;
|
||||
constructor(accessToken: string) {
|
||||
this.accessToken = accessToken;
|
||||
this.apiVersion = 1;
|
||||
this.host = `https://cloud-api.yandex.net`;
|
||||
}
|
||||
|
||||
async _api(
|
||||
method: string,
|
||||
endPoint: string,
|
||||
returnType: "json" | "arrayBuffer" | "raw",
|
||||
queryParams?: Record<string, string>,
|
||||
body?: any,
|
||||
requestContentType?: string
|
||||
) {
|
||||
let p = "";
|
||||
if (queryParams !== undefined) {
|
||||
p = `?${new URLSearchParams(queryParams)}`;
|
||||
}
|
||||
|
||||
const fullUrl = `${this.host}/v${this.apiVersion}/${endPoint}${p}`;
|
||||
// console.debug(`method: ${method}, fullUrl: ${fullUrl}`)
|
||||
const headers: HeadersInit = {
|
||||
Authorization: `OAuth ${this.accessToken}`,
|
||||
};
|
||||
if (requestContentType !== undefined) {
|
||||
headers["Content-Type"] = requestContentType;
|
||||
}
|
||||
const r = await fetch(fullUrl, {
|
||||
method: method,
|
||||
headers: headers,
|
||||
body: body,
|
||||
});
|
||||
// console.debug(r)
|
||||
|
||||
if (r.status >= 200 && r.status < 300) {
|
||||
if (returnType === "json") {
|
||||
return await r.json();
|
||||
}
|
||||
if (returnType === "arrayBuffer") {
|
||||
return await r.arrayBuffer();
|
||||
}
|
||||
if (returnType === "raw") {
|
||||
return r;
|
||||
}
|
||||
} else {
|
||||
throw Error(JSON.stringify((await r.json()) as ErrorResponse));
|
||||
}
|
||||
}
|
||||
|
||||
async disk() {
|
||||
return (await this._api("GET", "disk/", "json")) as Disk;
|
||||
}
|
||||
|
||||
async diskResources(
|
||||
path: string,
|
||||
fields?: string[],
|
||||
limit?: number,
|
||||
offset?: number
|
||||
) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
};
|
||||
if (fields !== undefined) {
|
||||
params["fields"] = fields.join(",");
|
||||
}
|
||||
if (limit !== undefined) {
|
||||
params["limit"] = `${limit}`;
|
||||
}
|
||||
if (offset !== undefined) {
|
||||
params["offset"] = `${offset}`;
|
||||
}
|
||||
|
||||
return (await this._api(
|
||||
"GET",
|
||||
"disk/resources",
|
||||
"json",
|
||||
params
|
||||
)) as Resource;
|
||||
}
|
||||
|
||||
async diskResourcesFiles(fields?: string[], limit?: number, offset?: number) {
|
||||
const params: Record<string, string> = {};
|
||||
if (fields !== undefined) {
|
||||
params["fields"] = fields.join(",");
|
||||
}
|
||||
if (limit !== undefined) {
|
||||
params["limit"] = `${limit}`;
|
||||
}
|
||||
if (offset !== undefined) {
|
||||
params["offset"] = `${offset}`;
|
||||
}
|
||||
return (await this._api(
|
||||
"GET",
|
||||
"disk/resources/files",
|
||||
"json",
|
||||
params
|
||||
)) as FilesResourceList;
|
||||
}
|
||||
|
||||
async diskResourcesPatch(
|
||||
path: string,
|
||||
custom_properties: Record<string, string | null>,
|
||||
fields?: string[]
|
||||
) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
};
|
||||
if (fields !== undefined) {
|
||||
params["fields"] = fields.join(",");
|
||||
}
|
||||
return (await this._api(
|
||||
"PATCH",
|
||||
"disk/resources",
|
||||
"json",
|
||||
params,
|
||||
JSON.stringify({
|
||||
custom_properties: custom_properties,
|
||||
}),
|
||||
"application/json"
|
||||
)) as Resource;
|
||||
}
|
||||
|
||||
async diskResoucesUpload(
|
||||
path: string,
|
||||
content: ArrayBuffer,
|
||||
overwrite?: boolean
|
||||
) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
overwrite: `${overwrite ?? false}`,
|
||||
};
|
||||
const link = (await this._api(
|
||||
"GET",
|
||||
"disk/resources/upload",
|
||||
"json",
|
||||
params
|
||||
)) as Link;
|
||||
|
||||
if (link.templated) {
|
||||
throw Error(
|
||||
`do not know how to deal with upload link with templated: ${JSON.stringify(
|
||||
link
|
||||
)}`
|
||||
);
|
||||
}
|
||||
|
||||
const rsp = await fetch(link.href, {
|
||||
method: link.method,
|
||||
body: content,
|
||||
});
|
||||
if (rsp.status === 200 || rsp.status === 201 || rsp.status === 202) {
|
||||
return true;
|
||||
} else {
|
||||
throw Error(`upload failed. status=${rsp.status}, link=${link.href}`);
|
||||
}
|
||||
}
|
||||
|
||||
async diskResoucesDownload(path: string) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
};
|
||||
const link = (await this._api(
|
||||
"GET",
|
||||
"disk/resources/download",
|
||||
"json",
|
||||
params
|
||||
)) as Link;
|
||||
|
||||
if (link.templated) {
|
||||
throw Error(
|
||||
`do not know how to deal with download link with templated: ${JSON.stringify(
|
||||
link
|
||||
)}`
|
||||
);
|
||||
}
|
||||
|
||||
const rsp = await fetch(link.href, {
|
||||
method: link.method,
|
||||
});
|
||||
if (rsp.status === 200 || rsp.status === 201 || rsp.status === 202) {
|
||||
return await rsp.arrayBuffer();
|
||||
} else {
|
||||
throw Error(`download failed. status=${rsp.status}, link=${link.href}`);
|
||||
}
|
||||
}
|
||||
|
||||
async diskResourcesDelete(path: string, permanently?: boolean) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
permanently: `${permanently ?? false}`,
|
||||
};
|
||||
const rsp = (await this._api(
|
||||
"DELETE",
|
||||
"disk/resources",
|
||||
"raw",
|
||||
params
|
||||
)) as Response;
|
||||
|
||||
if (rsp.status === 204) {
|
||||
return;
|
||||
}
|
||||
if (rsp.status === 202) {
|
||||
return (await rsp.json()) as Link;
|
||||
}
|
||||
throw Error(`do not know how to deal with delete response ${rsp}`);
|
||||
}
|
||||
|
||||
async diskResourcesPut(path: string, fields?: string[]) {
|
||||
const params: Record<string, string> = {
|
||||
path: path,
|
||||
};
|
||||
if (fields !== undefined) {
|
||||
params["fields"] = fields.join(",");
|
||||
}
|
||||
return (await this._api("PUT", "disk/resources", "json", params)) as Link;
|
||||
}
|
||||
}
|
||||
@@ -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".
|
||||
+70
-13
@@ -3,7 +3,27 @@
|
||||
* To avoid circular dependency.
|
||||
*/
|
||||
|
||||
import type { LangType, LangTypeAndAuto } from "./i18n";
|
||||
import type {
|
||||
AzureBlobStorageConfig,
|
||||
BoxConfig,
|
||||
GoogleDriveConfig,
|
||||
KoofrConfig,
|
||||
OnedriveFullConfig,
|
||||
PCloudConfig,
|
||||
ProConfig,
|
||||
YandexDiskConfig,
|
||||
} from "../pro/src/baseTypesPro";
|
||||
import type { LangTypeAndAuto } from "./i18n";
|
||||
|
||||
declare global {
|
||||
var DEFAULT_DROPBOX_APP_KEY: string;
|
||||
var DEFAULT_ONEDRIVE_CLIENT_ID: string;
|
||||
var DEFAULT_ONEDRIVE_AUTHORITY: string;
|
||||
}
|
||||
|
||||
export const DROPBOX_APP_KEY = global.DEFAULT_DROPBOX_APP_KEY;
|
||||
export const ONEDRIVE_CLIENT_ID = global.DEFAULT_ONEDRIVE_CLIENT_ID;
|
||||
export const ONEDRIVE_AUTHORITY = global.DEFAULT_ONEDRIVE_AUTHORITY;
|
||||
|
||||
export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
|
||||
|
||||
@@ -12,13 +32,19 @@ export type SUPPORTED_SERVICES_TYPE =
|
||||
| "webdav"
|
||||
| "dropbox"
|
||||
| "onedrive"
|
||||
| "webdis";
|
||||
| "onedrivefull"
|
||||
| "webdis"
|
||||
| "googledrive"
|
||||
| "box"
|
||||
| "pcloud"
|
||||
| "yandexdisk"
|
||||
| "koofr"
|
||||
| "azureblobstorage";
|
||||
|
||||
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
|
||||
| "webdav"
|
||||
| "dropbox"
|
||||
| "onedrive"
|
||||
| "webdis";
|
||||
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR = Exclude<
|
||||
SUPPORTED_SERVICES_TYPE,
|
||||
"s3" | "azureblobstorage"
|
||||
>;
|
||||
|
||||
export interface S3Config {
|
||||
s3Endpoint: string;
|
||||
@@ -89,6 +115,8 @@ export interface OnedriveConfig {
|
||||
username: string;
|
||||
credentialsShouldBeDeletedAtTime?: number;
|
||||
remoteBaseDir?: string;
|
||||
emptyFile: "skip" | "error";
|
||||
kind: "onedrive";
|
||||
}
|
||||
|
||||
export interface WebdisConfig {
|
||||
@@ -101,18 +129,33 @@ export interface WebdisConfig {
|
||||
export type SyncDirectionType =
|
||||
| "bidirectional"
|
||||
| "incremental_pull_only"
|
||||
| "incremental_push_only";
|
||||
| "incremental_push_only"
|
||||
| "incremental_pull_and_delete_only"
|
||||
| "incremental_push_and_delete_only";
|
||||
|
||||
export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
|
||||
|
||||
export type QRExportType = "all_but_oauth2" | "dropbox" | "onedrive";
|
||||
export type QRExportType = "basic_and_advanced" | SUPPORTED_SERVICES_TYPE;
|
||||
|
||||
export interface ProfilerConfig {
|
||||
enablePrinting?: boolean;
|
||||
recordSize?: boolean;
|
||||
}
|
||||
|
||||
export interface RemotelySavePluginSettings {
|
||||
s3: S3Config;
|
||||
webdav: WebdavConfig;
|
||||
dropbox: DropboxConfig;
|
||||
onedrive: OnedriveConfig;
|
||||
onedrivefull: OnedriveFullConfig;
|
||||
webdis: WebdisConfig;
|
||||
googledrive: GoogleDriveConfig;
|
||||
box: BoxConfig;
|
||||
pcloud: PCloudConfig;
|
||||
yandexdisk: YandexDiskConfig;
|
||||
koofr: KoofrConfig;
|
||||
azureblobstorage: AzureBlobStorageConfig;
|
||||
|
||||
password: string;
|
||||
serviceType: SUPPORTED_SERVICES_TYPE;
|
||||
currLogLevel?: string;
|
||||
@@ -130,7 +173,6 @@ export interface RemotelySavePluginSettings {
|
||||
enableStatusBarInfo?: boolean;
|
||||
deleteToWhere?: "system" | "obsidian";
|
||||
conflictAction?: ConflictActionType;
|
||||
howToCleanEmptyFolder?: EmptyFolderCleanType;
|
||||
|
||||
protectModifyPercentage?: number;
|
||||
syncDirection?: SyncDirectionType;
|
||||
@@ -141,6 +183,10 @@ export interface RemotelySavePluginSettings {
|
||||
|
||||
encryptionMethod?: CipherMethodType;
|
||||
|
||||
profiler?: ProfilerConfig;
|
||||
|
||||
pro?: ProConfig;
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
@@ -155,6 +201,11 @@ export interface RemotelySavePluginSettings {
|
||||
* @deprecated
|
||||
*/
|
||||
logToDB?: boolean;
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
howToCleanEmptyFolder?: EmptyFolderCleanType;
|
||||
}
|
||||
|
||||
export const COMMAND_URI = "remotely-save";
|
||||
@@ -174,7 +225,10 @@ export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
|
||||
|
||||
export type EmptyFolderCleanType = "skip" | "clean_both";
|
||||
|
||||
export type ConflictActionType = "keep_newer" | "keep_larger" | "rename_both";
|
||||
export type ConflictActionType =
|
||||
| "keep_newer"
|
||||
| "keep_larger"
|
||||
| "smart_conflict";
|
||||
|
||||
export type DecisionTypeForMixedEntity =
|
||||
| "only_history"
|
||||
@@ -189,11 +243,11 @@ export type DecisionTypeForMixedEntity =
|
||||
| "remote_is_deleted_thus_also_delete_local"
|
||||
| "conflict_created_then_keep_local"
|
||||
| "conflict_created_then_keep_remote"
|
||||
| "conflict_created_then_keep_both"
|
||||
| "conflict_created_then_smart_conflict"
|
||||
| "conflict_created_then_do_nothing"
|
||||
| "conflict_modified_then_keep_local"
|
||||
| "conflict_modified_then_keep_remote"
|
||||
| "conflict_modified_then_keep_both"
|
||||
| "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"
|
||||
@@ -223,6 +277,7 @@ export interface Entity {
|
||||
hash?: string;
|
||||
etag?: string;
|
||||
synthesizedFolder?: boolean;
|
||||
synthesizedFile?: boolean;
|
||||
}
|
||||
|
||||
export interface UploadedType {
|
||||
@@ -243,6 +298,8 @@ export interface MixedEntity {
|
||||
decision?: DecisionTypeForMixedEntity;
|
||||
conflictAction?: ConflictActionType;
|
||||
|
||||
change?: boolean;
|
||||
|
||||
sideNotes?: any;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { base64, base64url } from "rfc4648";
|
||||
import { base64url } from "rfc4648";
|
||||
import { reverseString } from "./misc";
|
||||
|
||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
+34
-10
@@ -1,22 +1,40 @@
|
||||
import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
|
||||
import type { Vault } from "obsidian";
|
||||
|
||||
import {
|
||||
readAllProfilerResultsByVault,
|
||||
readAllSyncPlanRecordTextsByVault,
|
||||
} from "./localdb";
|
||||
import type { InternalDBs } from "./localdb";
|
||||
import { mkdirpInVault, unixTimeToStr } from "./misc";
|
||||
import type { SyncPlanType } from "../pro/src/sync";
|
||||
import {
|
||||
DEFAULT_DEBUG_FOLDER,
|
||||
DEFAULT_PROFILER_RESULT_FILE_PREFIX,
|
||||
DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
|
||||
} from "./baseTypes";
|
||||
import {
|
||||
readAllProfilerResultsByVault,
|
||||
readAllSyncPlanRecordTextsByVault,
|
||||
} from "./localdb";
|
||||
import type { InternalDBs } from "./localdb";
|
||||
import { mkdirpInVault } from "./misc";
|
||||
|
||||
const getSubsetOfSyncPlan = (x: string, onlyChange: boolean) => {
|
||||
if (!onlyChange) {
|
||||
return x;
|
||||
}
|
||||
const y: SyncPlanType = JSON.parse(x);
|
||||
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 (
|
||||
db: InternalDBs,
|
||||
vault: Vault,
|
||||
vaultRandomID: string,
|
||||
howMany: number
|
||||
howMany: number,
|
||||
onlyChange: boolean
|
||||
) => {
|
||||
console.info("exporting sync plans");
|
||||
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
|
||||
@@ -28,12 +46,18 @@ export const exportVaultSyncPlansToFiles = async (
|
||||
if (howMany <= 0) {
|
||||
md =
|
||||
"Sync plans found:\n\n" +
|
||||
records.map((x) => "```json\n" + x + "\n```\n").join("\n");
|
||||
records
|
||||
.map(
|
||||
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
|
||||
)
|
||||
.join("\n");
|
||||
} else {
|
||||
md =
|
||||
"Sync plans found:\n\n" +
|
||||
records
|
||||
.map((x) => "```json\n" + x + "\n```\n")
|
||||
.map(
|
||||
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
|
||||
)
|
||||
.slice(0, howMany)
|
||||
.join("\n");
|
||||
}
|
||||
|
||||
@@ -39,7 +39,7 @@ export const encryptArrayBuffer = async (
|
||||
arrBuf: ArrayBuffer,
|
||||
password: string,
|
||||
rounds: number = DEFAULT_ITER,
|
||||
saltHex: string = ""
|
||||
saltHex = ""
|
||||
) => {
|
||||
let salt: Uint8Array;
|
||||
if (saltHex !== "") {
|
||||
@@ -109,7 +109,7 @@ export const encryptStringToBase32 = async (
|
||||
text: string,
|
||||
password: string,
|
||||
rounds: number = DEFAULT_ITER,
|
||||
saltHex: string = ""
|
||||
saltHex = ""
|
||||
) => {
|
||||
const enc = await encryptArrayBuffer(
|
||||
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
||||
@@ -138,7 +138,7 @@ export const encryptStringToBase64url = async (
|
||||
text: string,
|
||||
password: string,
|
||||
rounds: number = DEFAULT_ITER,
|
||||
saltHex: string = ""
|
||||
saltHex = ""
|
||||
) => {
|
||||
const enc = await encryptArrayBuffer(
|
||||
bufferToArrayBuffer(new TextEncoder().encode(text)),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import { Cipher as CipherRCloneCryptPack } from "@fyears/rclone-crypt";
|
||||
import { nanoid } from "nanoid";
|
||||
|
||||
const ctx: WorkerGlobalScope = self as any;
|
||||
|
||||
|
||||
+4
-1
@@ -1,8 +1,9 @@
|
||||
import { Entity } from "./baseTypes";
|
||||
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(
|
||||
@@ -12,8 +13,10 @@ export abstract class FakeFs {
|
||||
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;
|
||||
}
|
||||
|
||||
+65
-31
@@ -1,13 +1,14 @@
|
||||
import { FakeFs } from "./fsAll";
|
||||
import { Dropbox, DropboxAuth } from "dropbox";
|
||||
import type { files, DropboxResponseError, DropboxResponse } from "dropbox";
|
||||
import {
|
||||
DropboxConfig,
|
||||
COMMAND_CALLBACK_DROPBOX,
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
Entity,
|
||||
} from "./baseTypes";
|
||||
import type { DropboxResponse, DropboxResponseError, files } from "dropbox";
|
||||
import random from "lodash/random";
|
||||
import {
|
||||
COMMAND_CALLBACK_DROPBOX,
|
||||
DROPBOX_APP_KEY,
|
||||
type DropboxConfig,
|
||||
type Entity,
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
} from "./baseTypes";
|
||||
import { FakeFs } from "./fsAll";
|
||||
import {
|
||||
bufferToArrayBuffer,
|
||||
delay,
|
||||
@@ -21,7 +22,7 @@ export { Dropbox } from "dropbox";
|
||||
|
||||
export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
|
||||
accessToken: "",
|
||||
clientID: process.env.DEFAULT_DROPBOX_APP_KEY ?? "",
|
||||
clientID: DROPBOX_APP_KEY ?? "",
|
||||
refreshToken: "",
|
||||
accessTokenExpiresInSeconds: 0,
|
||||
accessTokenExpiresAtTime: 0,
|
||||
@@ -134,7 +135,7 @@ export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
|
||||
caseMapping[newKey.toLocaleLowerCase()] = newKey;
|
||||
e.key = newKey;
|
||||
// console.log(JSON.stringify(caseMapping,null,2));
|
||||
continue;
|
||||
// continue;
|
||||
} else {
|
||||
throw Error(`${parentFolder} doesn't have cases record??`);
|
||||
}
|
||||
@@ -145,7 +146,7 @@ export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
|
||||
.slice(-1)
|
||||
.join("/")}`;
|
||||
e.key = newKey;
|
||||
continue;
|
||||
// continue;
|
||||
} else {
|
||||
throw Error(`${parentFolder} doesn't have cases record??`);
|
||||
}
|
||||
@@ -167,7 +168,7 @@ interface ErrSubType {
|
||||
|
||||
async function retryReq<T>(
|
||||
reqFunc: () => Promise<DropboxResponse<T>>,
|
||||
extraHint: string = ""
|
||||
extraHint = ""
|
||||
): Promise<DropboxResponse<T> | undefined> {
|
||||
const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
|
||||
for (let idx = 0; idx < waitSeconds.length; ++idx) {
|
||||
@@ -205,7 +206,7 @@ async function retryReq<T>(
|
||||
const headers = headersToRecord(err.headers);
|
||||
const svrSec =
|
||||
err.error.error.retry_after ||
|
||||
parseInt(headers["retry-after"] || "1") ||
|
||||
Number.parseInt(headers["retry-after"] || "1") ||
|
||||
1;
|
||||
const fallbackSec = waitSeconds[idx];
|
||||
const secMin = Math.max(svrSec, fallbackSec);
|
||||
@@ -233,7 +234,7 @@ async function retryReq<T>(
|
||||
|
||||
export const getAuthUrlAndVerifier = async (
|
||||
appKey: string,
|
||||
needManualPatse: boolean = false
|
||||
needManualPatse = false
|
||||
) => {
|
||||
const auth = new DropboxAuth({
|
||||
clientId: appKey,
|
||||
@@ -328,9 +329,9 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
console.info("start updating local info of Dropbox token");
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresInSeconds = parseInt(authRes.expires_in);
|
||||
config.accessTokenExpiresInSeconds = Number.parseInt(authRes.expires_in);
|
||||
config.accessTokenExpiresAtTime =
|
||||
Date.now() + parseInt(authRes.expires_in) * 1000 - 10 * 1000;
|
||||
Date.now() + Number.parseInt(authRes.expires_in) * 1000 - 10 * 1000;
|
||||
|
||||
// manually set it expired after 80 days;
|
||||
config.credentialsShouldBeDeletedAtTime =
|
||||
@@ -452,13 +453,21 @@ export class FakeFsDropbox extends FakeFs {
|
||||
}
|
||||
|
||||
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: true,
|
||||
recursive: !partial,
|
||||
include_deleted: false,
|
||||
limit: 1000,
|
||||
limit: partial ? 10 : 1000,
|
||||
});
|
||||
if (res.status !== 200) {
|
||||
throw Error(JSON.stringify(res));
|
||||
@@ -471,20 +480,22 @@ export class FakeFsDropbox extends FakeFs {
|
||||
.filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
|
||||
.map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
|
||||
|
||||
while (res.result.has_more) {
|
||||
res = await this.dropbox.filesListFolderContinue({
|
||||
cursor: res.result.cursor,
|
||||
});
|
||||
if (res.status !== 200) {
|
||||
throw Error(JSON.stringify(res));
|
||||
}
|
||||
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);
|
||||
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);
|
||||
@@ -685,6 +696,25 @@ export class FakeFsDropbox extends FakeFs {
|
||||
}
|
||||
}
|
||||
|
||||
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;
|
||||
@@ -736,4 +766,8 @@ export class FakeFsDropbox extends FakeFs {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
+58
-28
@@ -1,10 +1,10 @@
|
||||
import { CipherMethodType, Entity } from "./baseTypes";
|
||||
import type { CipherMethodType, Entity } from "./baseTypes";
|
||||
import * as openssl from "./encryptOpenSSL";
|
||||
import * as rclone from "./encryptRClone";
|
||||
import { isVaildText } from "./misc";
|
||||
import { isSpecialFolderNameToSkip, isVaildText } from "./misc";
|
||||
|
||||
import { FakeFs } from "./fsAll";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { FakeFs } from "./fsAll";
|
||||
|
||||
/**
|
||||
* quick guess, no actual decryption here
|
||||
@@ -78,8 +78,6 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
cacheMapOrigToEnc: Record<string, string>;
|
||||
hasCacheMap: boolean;
|
||||
kind: string;
|
||||
innerWalkResultCache?: Entity[];
|
||||
innerWalkResultCacheTime?: number;
|
||||
|
||||
constructor(innerFs: FakeFs, password: string, method: CipherMethodType) {
|
||||
super();
|
||||
@@ -89,9 +87,12 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
this.cacheMapOrigToEnc = {};
|
||||
this.hasCacheMap = false;
|
||||
|
||||
this.kind = `encrypt(${this.innerFs.kind},${method})`;
|
||||
this.kind = `encrypt(${this.innerFs.kind},${
|
||||
this.password !== "" ? method : "no password"
|
||||
})`;
|
||||
|
||||
if (method === "rclone-base64") {
|
||||
if (this.password !== "" && method === "rclone-base64") {
|
||||
// no need to init if no password or not rclone
|
||||
this.cipherRClone = new rclone.CipherRclone(password, 5);
|
||||
}
|
||||
}
|
||||
@@ -110,26 +111,8 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
throw Error(`no idea about isFolderAware for method=${this.method}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* we want a little caching here.
|
||||
*/
|
||||
async _getInnerWalkResult(): Promise<Entity[]> {
|
||||
let innerWalkResult: Entity[] | undefined = undefined;
|
||||
if (
|
||||
this.innerWalkResultCacheTime !== undefined &&
|
||||
this.innerWalkResultCacheTime >= Date.now() - 1000
|
||||
) {
|
||||
innerWalkResult = this.innerWalkResultCache!;
|
||||
} else {
|
||||
innerWalkResult = await this.innerFs.walk();
|
||||
this.innerWalkResultCache = innerWalkResult;
|
||||
this.innerWalkResultCacheTime = Date.now();
|
||||
}
|
||||
return innerWalkResult;
|
||||
}
|
||||
|
||||
async isPasswordOk(): Promise<PasswordCheckType> {
|
||||
const innerWalkResult = await this._getInnerWalkResult();
|
||||
const innerWalkResult = await this.walkPartial();
|
||||
|
||||
if (innerWalkResult === undefined || innerWalkResult.length === 0) {
|
||||
// remote empty
|
||||
@@ -155,6 +138,8 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
};
|
||||
}
|
||||
} else {
|
||||
// the config has a password
|
||||
|
||||
if (this.method === "unknown") {
|
||||
return {
|
||||
ok: false,
|
||||
@@ -186,8 +171,16 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
const innerWalkResult = await this._getInnerWalkResult();
|
||||
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()) {
|
||||
@@ -199,6 +192,10 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
return res;
|
||||
} else {
|
||||
for (const innerEntity of innerWalkResult) {
|
||||
if (isSpecialFolderNameToSkip(innerEntity.keyRaw, [])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const key = await this._decryptName(innerEntity.keyRaw);
|
||||
const size = key.endsWith("/") ? 0 : undefined;
|
||||
res.push({
|
||||
@@ -273,9 +270,13 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
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,
|
||||
new ArrayBuffer(0),
|
||||
content,
|
||||
mtime ?? now,
|
||||
ctime ?? now
|
||||
);
|
||||
@@ -362,6 +363,31 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
}
|
||||
}
|
||||
|
||||
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");
|
||||
@@ -554,4 +580,8 @@ export class FakeFsEncrypt extends FakeFs {
|
||||
async revokeAuth(): Promise<any> {
|
||||
return await this.innerFs.revokeAuth();
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
+39
-8
@@ -1,5 +1,12 @@
|
||||
import { RemotelySavePluginSettings } from "./baseTypes";
|
||||
import { FakeFs } from "./fsAll";
|
||||
import { FakeFsAzureBlobStorage } from "../pro/src/fsAzureBlobStorage";
|
||||
import { FakeFsBox } from "../pro/src/fsBox";
|
||||
import { FakeFsGoogleDrive } from "../pro/src/fsGoogleDrive";
|
||||
import { FakeFsKoofr } from "../pro/src/fsKoofr";
|
||||
import { FakeFsOnedriveFull } from "../pro/src/fsOnedriveFull";
|
||||
import { FakeFsPCloud } from "../pro/src/fsPCloud";
|
||||
import { FakeFsYandexDisk } from "../pro/src/fsYandexDisk";
|
||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||
import type { FakeFs } from "./fsAll";
|
||||
import { FakeFsDropbox } from "./fsDropbox";
|
||||
import { FakeFsOnedrive } from "./fsOnedrive";
|
||||
import { FakeFsS3 } from "./fsS3";
|
||||
@@ -17,37 +24,61 @@ export function getClient(
|
||||
switch (settings.serviceType) {
|
||||
case "s3":
|
||||
return new FakeFsS3(settings.s3);
|
||||
break;
|
||||
case "webdav":
|
||||
return new FakeFsWebdav(
|
||||
settings.webdav,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
break;
|
||||
case "dropbox":
|
||||
return new FakeFsDropbox(
|
||||
settings.dropbox,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
break;
|
||||
case "onedrive":
|
||||
return new FakeFsOnedrive(
|
||||
settings.onedrive,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
break;
|
||||
case "onedrivefull":
|
||||
return new FakeFsOnedriveFull(
|
||||
settings.onedrivefull,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
case "webdis":
|
||||
return new FakeFsWebdis(
|
||||
settings.webdis,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
break;
|
||||
case "googledrive":
|
||||
return new FakeFsGoogleDrive(
|
||||
settings.googledrive,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
case "box":
|
||||
return new FakeFsBox(settings.box, vaultName, saveUpdatedConfigFunc);
|
||||
case "pcloud":
|
||||
return new FakeFsPCloud(
|
||||
settings.pcloud,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
case "yandexdisk":
|
||||
return new FakeFsYandexDisk(
|
||||
settings.yandexdisk,
|
||||
vaultName,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
case "koofr":
|
||||
return new FakeFsKoofr(settings.koofr, vaultName, saveUpdatedConfigFunc);
|
||||
case "azureblobstorage":
|
||||
return new FakeFsAzureBlobStorage(settings.azureblobstorage, vaultName);
|
||||
default:
|
||||
throw Error(`cannot init client for serviceType=${settings.serviceType}`);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
+38
-18
@@ -1,17 +1,17 @@
|
||||
import { DEFAULT_DEBUG_FOLDER, Entity } from "./baseTypes";
|
||||
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 { Profiler } from "./profiler";
|
||||
import { getFolderLevels, mkdirpInVault, statFix } from "./misc";
|
||||
import type { Profiler } from "./profiler";
|
||||
|
||||
export class FakeFsLocal extends FakeFs {
|
||||
vault: Vault;
|
||||
syncConfigDir: boolean;
|
||||
configDir: string;
|
||||
pluginID: string;
|
||||
profiler: Profiler;
|
||||
profiler: Profiler | undefined;
|
||||
deleteToWhere: "obsidian" | "system";
|
||||
kind: "local";
|
||||
constructor(
|
||||
@@ -19,7 +19,7 @@ export class FakeFsLocal extends FakeFs {
|
||||
syncConfigDir: boolean,
|
||||
configDir: string,
|
||||
pluginID: string,
|
||||
profiler: Profiler,
|
||||
profiler: Profiler | undefined,
|
||||
deleteToWhere: "obsidian" | "system"
|
||||
) {
|
||||
super();
|
||||
@@ -34,17 +34,22 @@ export class FakeFsLocal extends FakeFs {
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
this.profiler.addIndent();
|
||||
this.profiler.insert("enter walk for local");
|
||||
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");
|
||||
this.profiler?.insert("finish getting walk for local");
|
||||
for (const entry of localTAbstractFiles) {
|
||||
let r: Entity | undefined = undefined;
|
||||
let key = entry.path;
|
||||
if (key.startsWith("/")) {
|
||||
// why?
|
||||
// just remove leading slash /
|
||||
key = key.slice(1);
|
||||
}
|
||||
|
||||
if (entry.path === "/") {
|
||||
if (entry.path === "/" || entry.path === "") {
|
||||
// ignore
|
||||
continue;
|
||||
} else if (entry instanceof TFile) {
|
||||
@@ -61,15 +66,15 @@ export class FakeFsLocal extends FakeFs {
|
||||
);
|
||||
}
|
||||
r = {
|
||||
key: entry.path, // local always unencrypted
|
||||
keyRaw: entry.path,
|
||||
key: key, // local always unencrypted
|
||||
keyRaw: key,
|
||||
mtimeCli: mtimeLocal,
|
||||
mtimeSvr: mtimeLocal,
|
||||
size: entry.stat.size, // local always unencrypted
|
||||
sizeRaw: entry.stat.size,
|
||||
};
|
||||
} else if (entry instanceof TFolder) {
|
||||
key = `${entry.path}/`;
|
||||
key = `${key}/`;
|
||||
r = {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
@@ -83,16 +88,16 @@ export class FakeFsLocal extends FakeFs {
|
||||
if (r.keyRaw.startsWith(DEFAULT_DEBUG_FOLDER)) {
|
||||
// skip listing the debug folder,
|
||||
// which should always not involved in sync
|
||||
continue;
|
||||
// continue;
|
||||
} else {
|
||||
local.push(r);
|
||||
}
|
||||
}
|
||||
|
||||
this.profiler.insert("finish transforming walk for local");
|
||||
this.profiler?.insert("finish transforming walk for local");
|
||||
|
||||
if (this.syncConfigDir) {
|
||||
this.profiler.insert("into syncConfigDir");
|
||||
this.profiler?.insert("into syncConfigDir");
|
||||
const syncFiles = await listFilesInObsFolder(
|
||||
this.configDir,
|
||||
this.vault,
|
||||
@@ -101,14 +106,18 @@ export class FakeFsLocal extends FakeFs {
|
||||
for (const f of syncFiles) {
|
||||
local.push(f);
|
||||
}
|
||||
this.profiler.insert("finish syncConfigDir");
|
||||
this.profiler?.insert("finish syncConfigDir");
|
||||
}
|
||||
|
||||
this.profiler.insert("finish walk for local");
|
||||
this.profiler.removeIndent();
|
||||
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) {
|
||||
@@ -120,6 +129,8 @@ export class FakeFsLocal extends FakeFs {
|
||||
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,
|
||||
};
|
||||
@@ -139,6 +150,7 @@ export class FakeFsLocal extends FakeFs {
|
||||
): Promise<Entity> {
|
||||
await this.vault.adapter.writeBinary(key, content, {
|
||||
mtime: mtime,
|
||||
ctime: ctime,
|
||||
});
|
||||
return await this.stat(key);
|
||||
}
|
||||
@@ -147,6 +159,10 @@ export class FakeFsLocal extends FakeFs {
|
||||
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);
|
||||
@@ -168,4 +184,8 @@ export class FakeFsLocal extends FakeFs {
|
||||
async revokeAuth(): Promise<any> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
+13
-1
@@ -1,4 +1,4 @@
|
||||
import { Entity } from "./baseTypes";
|
||||
import type { Entity } from "./baseTypes";
|
||||
import { FakeFs } from "./fsAll";
|
||||
|
||||
export class FakeFsMock extends FakeFs {
|
||||
@@ -13,6 +13,10 @@ export class FakeFsMock extends FakeFs {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
return await this.walk();
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
@@ -34,6 +38,10 @@ export class FakeFsMock extends FakeFs {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
@@ -49,4 +57,8 @@ export class FakeFsMock extends FakeFs {
|
||||
async revokeAuth(): Promise<any> {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
}
|
||||
|
||||
+164
-25
@@ -1,19 +1,21 @@
|
||||
import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
|
||||
import type { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
|
||||
import type {
|
||||
DriveItem,
|
||||
FileSystemInfo,
|
||||
UploadSession,
|
||||
User,
|
||||
} from "@microsoft/microsoft-graph-types";
|
||||
import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
|
||||
import { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { request, requestUrl } from "obsidian";
|
||||
import {
|
||||
COMMAND_CALLBACK_ONEDRIVE,
|
||||
DEFAULT_CONTENT_TYPE,
|
||||
Entity,
|
||||
type Entity,
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
OnedriveConfig,
|
||||
ONEDRIVE_AUTHORITY,
|
||||
ONEDRIVE_CLIENT_ID,
|
||||
type OnedriveConfig,
|
||||
} from "./baseTypes";
|
||||
import { VALID_REQURL } from "./baseTypesObs";
|
||||
import { FakeFs } from "./fsAll";
|
||||
@@ -24,14 +26,16 @@ const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;
|
||||
|
||||
export const DEFAULT_ONEDRIVE_CONFIG: OnedriveConfig = {
|
||||
accessToken: "",
|
||||
clientID: process.env.DEFAULT_ONEDRIVE_CLIENT_ID ?? "",
|
||||
authority: process.env.DEFAULT_ONEDRIVE_AUTHORITY ?? "",
|
||||
clientID: ONEDRIVE_CLIENT_ID ?? "",
|
||||
authority: ONEDRIVE_AUTHORITY ?? "",
|
||||
refreshToken: "",
|
||||
accessTokenExpiresInSeconds: 0,
|
||||
accessTokenExpiresAtTime: 0,
|
||||
deltaLink: "",
|
||||
username: "",
|
||||
credentialsShouldBeDeletedAtTime: 0,
|
||||
emptyFile: "skip",
|
||||
kind: "onedrive",
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
@@ -260,6 +264,9 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
// another possibile prefix
|
||||
const FOURTH_COMMON_PREFIX_RAW = `/drive/items/`;
|
||||
|
||||
// when to use decode?
|
||||
const remoteBaseDirEncoded = encodeURIComponent(remoteBaseDir);
|
||||
|
||||
if (
|
||||
x.parentReference === undefined ||
|
||||
x.parentReference === null ||
|
||||
@@ -275,6 +282,8 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
SECOND_COMMON_PREFIX_REGEX
|
||||
);
|
||||
const matchThirdPrefixRes = fullPathOriginal.match(THIRD_COMMON_PREFIX_REGEX);
|
||||
|
||||
// first
|
||||
if (
|
||||
matchFirstPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchFirstPrefixRes[0]}${remoteBaseDir}`)
|
||||
@@ -282,24 +291,68 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (
|
||||
matchFirstPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchFirstPrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchFirstPrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// fifth
|
||||
else if (
|
||||
matchFifthPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchFifthPrefixRes[0]}${remoteBaseDir}`)
|
||||
) {
|
||||
const foundPrefix = `${matchFifthPrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (
|
||||
matchFifthPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchFifthPrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchFifthPrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// second
|
||||
else if (
|
||||
matchSecondPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchSecondPrefixRes[0]}${remoteBaseDir}`)
|
||||
) {
|
||||
const foundPrefix = `${matchSecondPrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (
|
||||
matchSecondPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchSecondPrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchSecondPrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// third
|
||||
else if (
|
||||
matchThirdPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchThirdPrefixRes[0]}${remoteBaseDir}`)
|
||||
) {
|
||||
const foundPrefix = `${matchThirdPrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (x.parentReference.path.startsWith(FOURTH_COMMON_PREFIX_RAW)) {
|
||||
} else if (
|
||||
matchThirdPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchThirdPrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchThirdPrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// fourth
|
||||
else if (x.parentReference.path.startsWith(FOURTH_COMMON_PREFIX_RAW)) {
|
||||
// it's something like
|
||||
// /drive/items/<some_id>!<another_id>:/${remoteBaseDir}/<subfolder>
|
||||
// with uri encoded!
|
||||
@@ -317,16 +370,27 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
key = x.name;
|
||||
} else {
|
||||
throw Error(
|
||||
`we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToEntityError(
|
||||
x
|
||||
)}`
|
||||
`file/folder with /drive/items/, no idea how to deal with it:
|
||||
fullPathOriginal=${fullPathOriginal}
|
||||
matchFirstPrefixRes=${matchFirstPrefixRes}
|
||||
matchFifthPrefixRes=${matchFifthPrefixRes}
|
||||
matchSecondPrefixRes=${matchSecondPrefixRes}
|
||||
matchThirdPrefixRes=${matchThirdPrefixRes}
|
||||
${constructFromDriveItemToEntityError(x)}`
|
||||
);
|
||||
}
|
||||
} else {
|
||||
}
|
||||
|
||||
// others
|
||||
else {
|
||||
throw Error(
|
||||
`we meet file/folder and do not know how to deal with it:\n${constructFromDriveItemToEntityError(
|
||||
x
|
||||
)}`
|
||||
`file/folder, no idea how to deal with it without known prefix:
|
||||
fullPathOriginal=${fullPathOriginal}
|
||||
matchFirstPrefixRes=${matchFirstPrefixRes}
|
||||
matchFifthPrefixRes=${matchFifthPrefixRes}
|
||||
matchSecondPrefixRes=${matchSecondPrefixRes}
|
||||
matchThirdPrefixRes=${matchThirdPrefixRes}
|
||||
${constructFromDriveItemToEntityError(x)}`
|
||||
);
|
||||
}
|
||||
|
||||
@@ -344,6 +408,7 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
mtimeCli: mtimeCli,
|
||||
size: isFolder ? 0 : x.size!,
|
||||
sizeRaw: isFolder ? 0 : x.size!,
|
||||
synthesizedFile: false,
|
||||
// hash: ?? // TODO
|
||||
};
|
||||
};
|
||||
@@ -567,6 +632,7 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
// TODO:
|
||||
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||
// Use fetch everywhere instead!
|
||||
// biome-ignore lint/correctness/noConstantCondition: hard code
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const res = await requestUrl({
|
||||
url: theUrl,
|
||||
@@ -617,6 +683,7 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
// TODO:
|
||||
// 20220401: On Android, requestUrl has issue that text becomes base64.
|
||||
// Use fetch everywhere instead!
|
||||
// biome-ignore lint/correctness/noConstantCondition: hard code
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const res = await requestUrl({
|
||||
url: theUrl,
|
||||
@@ -658,7 +725,7 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
let res = await this._getJson(
|
||||
`/drive/special/approot:/${this.remoteBaseDir}:/delta`
|
||||
);
|
||||
let driveItems = res.value as DriveItem[];
|
||||
const driveItems = res.value as DriveItem[];
|
||||
// console.debug(driveItems);
|
||||
|
||||
while (NEXT_LINK_KEY in res) {
|
||||
@@ -680,6 +747,31 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
return unifiedContents;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const DELTA_LINK_KEY = "@odata.deltaLink";
|
||||
|
||||
const res = await this._getJson(
|
||||
`/drive/special/approot:/${this.remoteBaseDir}:/delta`
|
||||
);
|
||||
const driveItems = res.value as DriveItem[];
|
||||
// console.debug(driveItems);
|
||||
|
||||
// lastly we should have delta link?
|
||||
if (DELTA_LINK_KEY in res) {
|
||||
this.onedriveConfig.deltaLink = res[DELTA_LINK_KEY];
|
||||
await this.saveUpdatedConfigFunc();
|
||||
}
|
||||
|
||||
// unify everything to Entity
|
||||
const unifiedContents = driveItems
|
||||
.map((x) => fromDriveItemToEntity(x, this.remoteBaseDir))
|
||||
.filter((x) => x.key !== "/");
|
||||
|
||||
return unifiedContents;
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
return await this._statFromRoot(getOnedrivePath(key, this.remoteBaseDir));
|
||||
@@ -719,7 +811,7 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
} else {
|
||||
// https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
|
||||
// use PATCH to create folder recursively!!!
|
||||
let playload: any = {
|
||||
const playload: any = {
|
||||
folder: {},
|
||||
"@microsoft.graph.conflictBehavior": "replace",
|
||||
};
|
||||
@@ -758,7 +850,8 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
key
|
||||
key,
|
||||
this.onedriveConfig.emptyFile
|
||||
);
|
||||
}
|
||||
|
||||
@@ -767,12 +860,26 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number,
|
||||
origKey: string
|
||||
origKey: string,
|
||||
emptyFile: "skip" | "error"
|
||||
): Promise<Entity> {
|
||||
if (content.byteLength === 0) {
|
||||
throw Error(
|
||||
`${origKey}: Empty file is not allowed in OneDrive, and please write something in it.`
|
||||
);
|
||||
if (emptyFile === "error") {
|
||||
throw Error(
|
||||
`${origKey}: Empty file is not allowed in OneDrive, and please write something in it.`
|
||||
);
|
||||
} else {
|
||||
return {
|
||||
key: origKey,
|
||||
keyRaw: origKey,
|
||||
mtimeSvr: mtime,
|
||||
mtimeCli: mtime,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
synthesizedFile: true,
|
||||
// hash: ?? // TODO
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const ctimeStr = new Date(ctime).toISOString();
|
||||
@@ -869,7 +976,8 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
`${key}?$select=@microsoft.graph.downloadUrl`
|
||||
);
|
||||
const downloadUrl: string = rsp["@microsoft.graph.downloadUrl"];
|
||||
if (VALID_REQURL) {
|
||||
// biome-ignore lint/correctness/noConstantCondition: <explanation>
|
||||
if (false /*VALID_REQURL*/) {
|
||||
const content = (
|
||||
await requestUrl({
|
||||
url: downloadUrl,
|
||||
@@ -878,12 +986,39 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
).arrayBuffer;
|
||||
return content;
|
||||
} else {
|
||||
// cannot set no-cache here, will have cors error
|
||||
const content = await (await fetch(downloadUrl)).arrayBuffer();
|
||||
return content;
|
||||
// so strange, sometimes (!!!)
|
||||
// we cannot download the file because of CORS
|
||||
try {
|
||||
// cannot set no-cache here, will have cors error
|
||||
const content = await (
|
||||
await fetch(downloadUrl, { cache: "no-store" })
|
||||
).arrayBuffer();
|
||||
return content;
|
||||
} catch (e) {
|
||||
// let's try again to bypass the CORS
|
||||
const content = (
|
||||
await requestUrl({
|
||||
url: downloadUrl,
|
||||
headers: { "Cache-Control": "no-cache" },
|
||||
})
|
||||
).arrayBuffer;
|
||||
return content;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
if (key1 === "" || key1 === "/" || key2 === "" || key2 === "/") {
|
||||
return;
|
||||
}
|
||||
const remoteFileName1 = getOnedrivePath(key1, this.remoteBaseDir);
|
||||
const remoteFileName2 = getOnedrivePath(key2, this.remoteBaseDir);
|
||||
await this._init();
|
||||
await this._patchJson(remoteFileName1, {
|
||||
name: remoteFileName2,
|
||||
});
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
if (key === "" || key === "/") {
|
||||
return;
|
||||
@@ -926,4 +1061,8 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
async getRevokeAddr() {
|
||||
return "https://account.live.com/consent/Manage";
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
+117
-57
@@ -1,36 +1,37 @@
|
||||
import type { _Object, PutObjectCommandInput } from "@aws-sdk/client-s3";
|
||||
import { Buffer } from "buffer";
|
||||
import * as path from "path";
|
||||
import { Readable } from "stream";
|
||||
import type { PutObjectCommandInput, _Object } from "@aws-sdk/client-s3";
|
||||
import {
|
||||
DeleteObjectCommand,
|
||||
GetObjectCommand,
|
||||
HeadObjectCommand,
|
||||
HeadObjectCommandOutput,
|
||||
type HeadObjectCommandOutput,
|
||||
ListObjectsV2Command,
|
||||
ListObjectsV2CommandInput,
|
||||
type ListObjectsV2CommandInput,
|
||||
PutObjectCommand,
|
||||
S3Client,
|
||||
} from "@aws-sdk/client-s3";
|
||||
import { Upload } from "@aws-sdk/lib-storage";
|
||||
import { HttpRequest, HttpResponse } from "@smithy/protocol-http";
|
||||
import type { HttpHandlerOptions } from "@aws-sdk/types";
|
||||
import {
|
||||
FetchHttpHandler,
|
||||
FetchHttpHandlerOptions,
|
||||
type FetchHttpHandlerOptions,
|
||||
} from "@smithy/fetch-http-handler";
|
||||
// @ts-ignore
|
||||
import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout";
|
||||
import { type HttpRequest, HttpResponse } from "@smithy/protocol-http";
|
||||
import { buildQueryString } from "@smithy/querystring-builder";
|
||||
import { HttpHandlerOptions } from "@aws-sdk/types";
|
||||
import { Buffer } from "buffer";
|
||||
import * as mime from "mime-types";
|
||||
import { Platform, requestUrl, RequestUrlParam } from "obsidian";
|
||||
import { Readable } from "stream";
|
||||
import * as path from "path";
|
||||
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
|
||||
import AggregateError from "aggregate-error";
|
||||
import { DEFAULT_CONTENT_TYPE, S3Config } from "./baseTypes";
|
||||
import * as mime from "mime-types";
|
||||
import { Platform, type RequestUrlParam, requestUrl } from "obsidian";
|
||||
import PQueue from "p-queue";
|
||||
import { DEFAULT_CONTENT_TYPE, type S3Config } from "./baseTypes";
|
||||
import { VALID_REQURL } from "./baseTypesObs";
|
||||
import { bufferToArrayBuffer, getFolderLevels } from "./misc";
|
||||
import PQueue from "p-queue";
|
||||
|
||||
import { Entity } from "./baseTypes";
|
||||
import type { Entity } from "./baseTypes";
|
||||
import { FakeFs } from "./fsAll";
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
@@ -308,7 +309,14 @@ const fromS3ObjectToEntity = (
|
||||
) => {
|
||||
// console.debug(`fromS3ObjectToEntity: ${x.Key!}, ${JSON.stringify(x,null,2)}`);
|
||||
// S3 officially only supports seconds precision!!!!!
|
||||
const mtimeSvr = Math.floor(x.LastModified!.valueOf() / 1000.0) * 1000;
|
||||
if (x.LastModified === undefined) {
|
||||
throw Error(
|
||||
`s3 object ${x.Key!} doesn't have LastModified value: ${JSON.stringify(
|
||||
x
|
||||
)}`
|
||||
);
|
||||
}
|
||||
const mtimeSvr = Math.floor(x.LastModified.valueOf() / 1000.0) * 1000;
|
||||
let mtimeCli = mtimeSvr;
|
||||
if (x.Key! in mtimeRecords) {
|
||||
const m2 = mtimeRecords[x.Key!];
|
||||
@@ -340,15 +348,23 @@ const fromS3ObjectToEntity = (
|
||||
const fromS3HeadObjectToEntity = (
|
||||
fileOrFolderPathWithRemotePrefix: string,
|
||||
x: HeadObjectCommandOutput,
|
||||
remotePrefix: string
|
||||
remotePrefix: string,
|
||||
useAccurateMTime: boolean
|
||||
) => {
|
||||
// console.debug(`fromS3HeadObjectToEntity: ${fileOrFolderPathWithRemotePrefix}: ${JSON.stringify(x,null,2)}`);
|
||||
// S3 officially only supports seconds precision!!!!!
|
||||
const mtimeSvr = Math.floor(x.LastModified!.valueOf() / 1000.0) * 1000;
|
||||
if (x.LastModified === undefined) {
|
||||
throw Error(
|
||||
`s3 object ${fileOrFolderPathWithRemotePrefix} doesn't have LastModified value: ${JSON.stringify(
|
||||
x
|
||||
)}`
|
||||
);
|
||||
}
|
||||
const mtimeSvr = Math.floor(x.LastModified.valueOf() / 1000.0) * 1000;
|
||||
let mtimeCli = mtimeSvr;
|
||||
if (x.Metadata !== undefined) {
|
||||
if (useAccurateMTime && x.Metadata !== undefined) {
|
||||
const m2 = Math.floor(
|
||||
parseFloat(x.Metadata.mtime || x.Metadata.MTime || "0")
|
||||
Number.parseFloat(x.Metadata.mtime || x.Metadata.MTime || "0")
|
||||
);
|
||||
if (m2 !== 0) {
|
||||
// to be compatible with RClone, we read and store the time in seconds in new version!
|
||||
@@ -397,9 +413,16 @@ export class FakeFsS3 extends FakeFs {
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
const res = (await this._walkFromRoot(this.s3Config.remotePrefix)).filter(
|
||||
(x) => x.key !== "" && x.key !== "/"
|
||||
);
|
||||
const res = (
|
||||
await this._walkFromRoot(this.s3Config.remotePrefix, false)
|
||||
).filter((x) => x.key !== "" && x.key !== "/");
|
||||
return res;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
const res = (
|
||||
await this._walkFromRoot(this.s3Config.remotePrefix, true)
|
||||
).filter((x) => x.key !== "" && x.key !== "/");
|
||||
return res;
|
||||
}
|
||||
|
||||
@@ -407,19 +430,23 @@ export class FakeFsS3 extends FakeFs {
|
||||
* the input key contains basedir (prefix),
|
||||
* but the result doesn't contain it.
|
||||
*/
|
||||
async _walkFromRoot(prefixOfRawKeys: string | undefined) {
|
||||
async _walkFromRoot(prefixOfRawKeys: string | undefined, partial: boolean) {
|
||||
const confCmd = {
|
||||
Bucket: this.s3Config.s3BucketName,
|
||||
} as ListObjectsV2CommandInput;
|
||||
if (prefixOfRawKeys !== undefined && prefixOfRawKeys !== "") {
|
||||
confCmd.Prefix = prefixOfRawKeys;
|
||||
}
|
||||
if (partial) {
|
||||
confCmd.MaxKeys = 10; // no need to list more!
|
||||
}
|
||||
|
||||
const contents = [] as _Object[];
|
||||
const mtimeRecords: Record<string, number> = {};
|
||||
const ctimeRecords: Record<string, number> = {};
|
||||
const partsConcurrency = partial ? 1 : this.s3Config.partsConcurrency;
|
||||
const queueHead = new PQueue({
|
||||
concurrency: this.s3Config.partsConcurrency,
|
||||
concurrency: partsConcurrency,
|
||||
autoStart: true,
|
||||
});
|
||||
queueHead.on("error", (error) => {
|
||||
@@ -457,12 +484,12 @@ export class FakeFsS3 extends FakeFs {
|
||||
// pass
|
||||
} else {
|
||||
mtimeRecords[content.Key!] = Math.floor(
|
||||
parseFloat(
|
||||
Number.parseFloat(
|
||||
rspHead.Metadata.mtime || rspHead.Metadata.MTime || "0"
|
||||
)
|
||||
);
|
||||
ctimeRecords[content.Key!] = Math.floor(
|
||||
parseFloat(
|
||||
Number.parseFloat(
|
||||
rspHead.Metadata.ctime || rspHead.Metadata.CTime || "0"
|
||||
)
|
||||
);
|
||||
@@ -471,14 +498,20 @@ export class FakeFsS3 extends FakeFs {
|
||||
}
|
||||
}
|
||||
|
||||
isTruncated = rsp.IsTruncated ?? false;
|
||||
confCmd.ContinuationToken = rsp.NextContinuationToken;
|
||||
if (
|
||||
isTruncated &&
|
||||
(confCmd.ContinuationToken === undefined ||
|
||||
confCmd.ContinuationToken === "")
|
||||
) {
|
||||
throw Error("isTruncated is true but no continuationToken provided");
|
||||
if (partial) {
|
||||
// do not loop over
|
||||
isTruncated = false;
|
||||
} else {
|
||||
// loop over
|
||||
isTruncated = rsp.IsTruncated ?? false;
|
||||
confCmd.ContinuationToken = rsp.NextContinuationToken;
|
||||
if (
|
||||
isTruncated &&
|
||||
(confCmd.ContinuationToken === undefined ||
|
||||
confCmd.ContinuationToken === "")
|
||||
) {
|
||||
throw Error("isTruncated is true but no continuationToken provided");
|
||||
}
|
||||
}
|
||||
} while (isTruncated);
|
||||
|
||||
@@ -561,7 +594,12 @@ export class FakeFsS3 extends FakeFs {
|
||||
})
|
||||
);
|
||||
|
||||
return fromS3HeadObjectToEntity(key, res, this.s3Config.remotePrefix ?? "");
|
||||
return fromS3HeadObjectToEntity(
|
||||
key,
|
||||
res,
|
||||
this.s3Config.remotePrefix ?? "",
|
||||
this.s3Config.useAccurateMTime ?? false
|
||||
);
|
||||
}
|
||||
|
||||
async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
|
||||
@@ -722,28 +760,53 @@ export class FakeFsS3 extends FakeFs {
|
||||
return bodyContents;
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
throw Error(`rename not implemented for s3`);
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
if (key === "/") {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.synthFoldersCache.hasOwnProperty(key)) {
|
||||
delete this.synthFoldersCache[key];
|
||||
return;
|
||||
if (key.endsWith("/")) {
|
||||
if (this.synthFoldersCache.hasOwnProperty(key)) {
|
||||
delete this.synthFoldersCache[key];
|
||||
return;
|
||||
}
|
||||
|
||||
// in s3 the folder may not exist, so we make our best effort.
|
||||
// do NOT read this.s3Config.generateFolderObject
|
||||
// because the folder might be generated by previous setting
|
||||
try {
|
||||
const remoteFileName = getRemoteWithPrefixPath(
|
||||
key,
|
||||
this.s3Config.remotePrefix ?? ""
|
||||
);
|
||||
|
||||
await this.s3Client.send(
|
||||
new DeleteObjectCommand({
|
||||
Bucket: this.s3Config.s3BucketName,
|
||||
Key: remoteFileName,
|
||||
})
|
||||
);
|
||||
} catch (e) {
|
||||
// pass
|
||||
}
|
||||
} else {
|
||||
const remoteFileName = getRemoteWithPrefixPath(
|
||||
key,
|
||||
this.s3Config.remotePrefix ?? ""
|
||||
);
|
||||
|
||||
await this.s3Client.send(
|
||||
new DeleteObjectCommand({
|
||||
Bucket: this.s3Config.s3BucketName,
|
||||
Key: remoteFileName,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
const remoteFileName = getRemoteWithPrefixPath(
|
||||
key,
|
||||
this.s3Config.remotePrefix ?? ""
|
||||
);
|
||||
|
||||
await this.s3Client.send(
|
||||
new DeleteObjectCommand({
|
||||
Bucket: this.s3Config.s3BucketName,
|
||||
Key: remoteFileName,
|
||||
})
|
||||
);
|
||||
|
||||
// TODO: do we need to delete folder recursively?
|
||||
// maybe we should not
|
||||
// because the outer sync algorithm should do that
|
||||
@@ -752,13 +815,6 @@ export class FakeFsS3 extends FakeFs {
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
try {
|
||||
// TODO: no universal way now, just check this in connectivity
|
||||
if (Platform.isIosApp && this.s3Config.s3Endpoint.startsWith("http://")) {
|
||||
throw Error(
|
||||
`Your s3 endpoint could only be https, not http, because of the iOS restriction.`
|
||||
);
|
||||
}
|
||||
|
||||
// const results = await this.s3Client.send(
|
||||
// new HeadBucketCommand({ Bucket: this.s3Config.s3BucketName })
|
||||
// );
|
||||
@@ -810,4 +866,8 @@ export class FakeFsS3 extends FakeFs {
|
||||
async revokeAuth() {
|
||||
throw new Error("Method not implemented.");
|
||||
}
|
||||
|
||||
allowEmptyFile(): boolean {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
+395
-40
@@ -1,21 +1,23 @@
|
||||
import { getReasonPhrase } from "http-status-codes/build/cjs/utils-functions";
|
||||
import { Buffer } from "buffer";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { Queue } from "@fyears/tsqueue";
|
||||
import { getReasonPhrase } from "http-status-codes/build/cjs/utils-functions";
|
||||
import chunk from "lodash/chunk";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import flatten from "lodash/flatten";
|
||||
import { Platform, requestUrl } from "obsidian";
|
||||
import { FakeFs } from "./fsAll";
|
||||
import { bufferToArrayBuffer } from "./misc";
|
||||
import { Entity, WebdavConfig } from "./baseTypes";
|
||||
import { VALID_REQURL } from "./baseTypesObs";
|
||||
import isString from "lodash/isString";
|
||||
import { nanoid } from "nanoid";
|
||||
import { Platform, type RequestUrlParam, requestUrl } from "obsidian";
|
||||
import type {
|
||||
FileStat,
|
||||
WebDAVClient,
|
||||
RequestOptionsWithState,
|
||||
WebDAVClient,
|
||||
// Response,
|
||||
// ResponseDataDetailed,
|
||||
} from "webdav";
|
||||
import type { Entity, WebdavConfig } from "./baseTypes";
|
||||
import { VALID_REQURL } from "./baseTypesObs";
|
||||
import { FakeFs } from "./fsAll";
|
||||
import { bufferToArrayBuffer, delay, splitFileSizeToChunkRanges } from "./misc";
|
||||
|
||||
/**
|
||||
* https://stackoverflow.com/questions/32850898/how-to-check-if-a-string-has-any-non-iso-8859-1-characters-with-javascript
|
||||
@@ -55,20 +57,22 @@ if (VALID_REQURL) {
|
||||
retractedHeaders["authorization"] = "<retracted>";
|
||||
}
|
||||
|
||||
console.debug(`before request:`);
|
||||
console.debug(`url: ${options.url}`);
|
||||
console.debug(`method: ${options.method}`);
|
||||
console.debug(`headers: ${JSON.stringify(retractedHeaders, null, 2)}`);
|
||||
console.debug(`reqContentType: ${reqContentType}`);
|
||||
// console.debug(`before request:`);
|
||||
// console.debug(`url: ${options.url}`);
|
||||
// console.debug(`method: ${options.method}`);
|
||||
// console.debug(`headers: ${JSON.stringify(retractedHeaders, null, 2)}`);
|
||||
// console.debug(`reqContentType: ${reqContentType}`);
|
||||
|
||||
let r = await requestUrl({
|
||||
const p: RequestUrlParam = {
|
||||
url: options.url,
|
||||
method: options.method,
|
||||
body: options.data as string | ArrayBuffer,
|
||||
headers: transformedHeaders,
|
||||
contentType: reqContentType,
|
||||
throw: false,
|
||||
});
|
||||
};
|
||||
|
||||
let r = await requestUrl(p);
|
||||
|
||||
if (
|
||||
r.status === 401 &&
|
||||
@@ -82,20 +86,14 @@ if (VALID_REQURL) {
|
||||
// if a folder doesn't exist without slash, the servers return 401 instead of 404
|
||||
// here is a dirty hack that works
|
||||
console.debug(`so we have 401, try appending request url with slash`);
|
||||
r = await requestUrl({
|
||||
url: `${options.url}/`,
|
||||
method: options.method,
|
||||
body: options.data as string | ArrayBuffer,
|
||||
headers: transformedHeaders,
|
||||
contentType: reqContentType,
|
||||
throw: false,
|
||||
});
|
||||
p.url = `${options.url}/`;
|
||||
r = await requestUrl(p);
|
||||
}
|
||||
|
||||
console.debug(`after request:`);
|
||||
// console.debug(`after request:`);
|
||||
const rspHeaders = objKeyToLower({ ...r.headers });
|
||||
console.debug(`rspHeaders: ${JSON.stringify(rspHeaders, null, 2)}`);
|
||||
for (let key in rspHeaders) {
|
||||
// console.debug(`rspHeaders: ${JSON.stringify(rspHeaders, null, 2)}`);
|
||||
for (const key in rspHeaders) {
|
||||
if (rspHeaders.hasOwnProperty(key)) {
|
||||
// avoid the error:
|
||||
// Failed to read the 'headers' property from 'ResponseInit': String contains non ISO-8859-1 code point.
|
||||
@@ -111,7 +109,7 @@ if (VALID_REQURL) {
|
||||
// }
|
||||
// }
|
||||
if (!onlyAscii(rspHeaders[key])) {
|
||||
console.debug(`rspHeaders[key] needs encode: ${key}`);
|
||||
// console.debug(`rspHeaders[key] needs encode: ${key}`);
|
||||
rspHeaders[key] = encodeURIComponent(rspHeaders[key]);
|
||||
}
|
||||
}
|
||||
@@ -119,7 +117,7 @@ if (VALID_REQURL) {
|
||||
|
||||
let r2: Response | undefined = undefined;
|
||||
const statusText = getReasonPhrase(r.status);
|
||||
console.debug(`statusText: ${statusText}`);
|
||||
// console.debug(`statusText: ${statusText}`);
|
||||
if ([101, 103, 204, 205, 304].includes(r.status)) {
|
||||
// A null body status is a status that is 101, 103, 204, 205, or 304.
|
||||
// https://fetch.spec.whatwg.org/#statuses
|
||||
@@ -143,6 +141,7 @@ if (VALID_REQURL) {
|
||||
}
|
||||
|
||||
// @ts-ignore
|
||||
// biome-ignore lint: we want to ts-ignore the next line
|
||||
import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
|
||||
|
||||
export const DEFAULT_WEBDAV_CONFIG = {
|
||||
@@ -202,6 +201,14 @@ const fromWebdavItemToEntity = (x: FileStat, remoteBaseDir: string): Entity => {
|
||||
};
|
||||
};
|
||||
|
||||
const tryEncodeURI = (x: string) => {
|
||||
if (x.includes("%")) {
|
||||
// likely encoded before!
|
||||
return x;
|
||||
}
|
||||
return encodeURI(x);
|
||||
};
|
||||
|
||||
export class FakeFsWebdav extends FakeFs {
|
||||
kind: "webdav";
|
||||
|
||||
@@ -211,6 +218,10 @@ export class FakeFsWebdav extends FakeFs {
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
supportNativePartial: boolean;
|
||||
isNextcloud: boolean;
|
||||
nextcloudUploadServerAddress: string;
|
||||
|
||||
constructor(
|
||||
webdavConfig: WebdavConfig,
|
||||
vaultName: string,
|
||||
@@ -219,10 +230,14 @@ export class FakeFsWebdav extends FakeFs {
|
||||
super();
|
||||
this.kind = "webdav";
|
||||
this.webdavConfig = cloneDeep(webdavConfig);
|
||||
this.webdavConfig.address = encodeURI(this.webdavConfig.address);
|
||||
this.webdavConfig.address = tryEncodeURI(this.webdavConfig.address);
|
||||
this.remoteBaseDir = this.webdavConfig.remoteBaseDir || vaultName || "";
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
|
||||
this.supportNativePartial = false;
|
||||
this.isNextcloud = false;
|
||||
this.nextcloudUploadServerAddress = "";
|
||||
}
|
||||
|
||||
async _init() {
|
||||
@@ -231,12 +246,6 @@ export class FakeFsWebdav extends FakeFs {
|
||||
return;
|
||||
}
|
||||
|
||||
if (Platform.isIosApp && !this.webdavConfig.address.startsWith("https")) {
|
||||
throw Error(
|
||||
`Your webdav address could only be https, not http, because of the iOS restriction.`
|
||||
);
|
||||
}
|
||||
|
||||
const headers = {
|
||||
"Cache-Control": "no-cache",
|
||||
};
|
||||
@@ -292,6 +301,81 @@ export class FakeFsWebdav extends FakeFs {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
await this._checkPartialSupport();
|
||||
}
|
||||
|
||||
/**
|
||||
* <server>/remote.php/dav/files/<userid>
|
||||
* => <server>/remote.php/dav/uploads/<userid>
|
||||
*/
|
||||
_getnextcloudUploadServerAddress = () => {
|
||||
let k = this.webdavConfig.address;
|
||||
if (k.endsWith("/")) {
|
||||
// no tailing slash
|
||||
k = k.substring(0, k.length - 1);
|
||||
}
|
||||
const s = k.split("/");
|
||||
if (
|
||||
s.length > 3 &&
|
||||
s[s.length - 3] === "dav" &&
|
||||
s[s.length - 2] === "files" &&
|
||||
s[s.length - 1] !== ""
|
||||
) {
|
||||
s[s.length - 2] = "uploads";
|
||||
return s.join("/");
|
||||
}
|
||||
throw Error(`cannot construct upload address for ${s}`);
|
||||
};
|
||||
|
||||
async _checkPartialSupport() {
|
||||
const compliance = await this.client.getDAVCompliance(
|
||||
`/${this.remoteBaseDir}/`
|
||||
);
|
||||
|
||||
for (const c of compliance.compliance) {
|
||||
// nextcloud AND with an account
|
||||
if (
|
||||
c.toLocaleLowerCase().includes("nextcloud") &&
|
||||
this.webdavConfig.username !== "" &&
|
||||
this.webdavConfig.password !== ""
|
||||
) {
|
||||
// the address is parsable
|
||||
const s = this.webdavConfig.address.split("/");
|
||||
if (
|
||||
s.length > 3 &&
|
||||
s[s.length - 3] === "dav" &&
|
||||
s[s.length - 2] === "files" &&
|
||||
s[s.length - 1] !== ""
|
||||
) {
|
||||
this.isNextcloud = true;
|
||||
this.nextcloudUploadServerAddress =
|
||||
this._getnextcloudUploadServerAddress();
|
||||
console.debug(
|
||||
`isNextcloud=${this.isNextcloud}, uploadFolder=${this.nextcloudUploadServerAddress}`
|
||||
);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// taken from https://github.com/perry-mitchell/webdav-client/blob/master/source/operations/partialUpdateFileContents.ts
|
||||
// which is under MIT license
|
||||
if (
|
||||
(compliance.server.includes("Apache") &&
|
||||
compliance.compliance.includes(
|
||||
"<http://apache.org/dav/propset/fs/1>"
|
||||
)) ||
|
||||
compliance.compliance.includes("sabredav-partialupdate")
|
||||
) {
|
||||
this.supportNativePartial = true;
|
||||
console.debug(`supportNativePartial=true`);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
async walk(): Promise<Entity[]> {
|
||||
@@ -328,7 +412,20 @@ export class FakeFsWebdav extends FakeFs {
|
||||
// glob: "/**" /* avoid dot files by using glob */,
|
||||
}) as Promise<FileStat[]>;
|
||||
});
|
||||
const r2 = flatten(await Promise.all(r));
|
||||
const r3 = await Promise.all(r);
|
||||
for (const r4 of r3) {
|
||||
if (
|
||||
this.webdavConfig.address.includes("jianguoyun.com") &&
|
||||
r4.length >= 749
|
||||
) {
|
||||
// https://help.jianguoyun.com/?p=2064
|
||||
// no more than 750 per request
|
||||
throw Error(
|
||||
`出错:坚果云 api 有限制,文件列表加载不全。终止同步!`
|
||||
);
|
||||
}
|
||||
}
|
||||
const r2 = flatten(r3);
|
||||
subContents.push(...r2);
|
||||
}
|
||||
for (let i = 0; i < subContents.length; ++i) {
|
||||
@@ -356,6 +453,19 @@ export class FakeFsWebdav extends FakeFs {
|
||||
return contents.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir));
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
await this._init();
|
||||
|
||||
const contents = (await this.client.getDirectoryContents(
|
||||
`/${this.remoteBaseDir}`,
|
||||
{
|
||||
deep: false, // partial, no need to recursive here
|
||||
details: false /* no need for verbose details here */,
|
||||
}
|
||||
)) as FileStat[];
|
||||
return contents.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir));
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
await this._init();
|
||||
const fullPath = getWebdavPath(key, this.remoteBaseDir);
|
||||
@@ -383,8 +493,10 @@ export class FakeFsWebdav extends FakeFs {
|
||||
mtime?: number,
|
||||
ctime?: number
|
||||
): Promise<Entity> {
|
||||
// the sync algorithm should do recursive manually already.
|
||||
// if we set recursive: true here, Digest auth will return some error inside the PROPFIND
|
||||
await this.client.createDirectory(key, {
|
||||
recursive: true,
|
||||
recursive: false,
|
||||
});
|
||||
return await this._statFromRoot(key);
|
||||
}
|
||||
@@ -400,22 +512,251 @@ export class FakeFsWebdav extends FakeFs {
|
||||
}
|
||||
await this._init();
|
||||
const uploadFile = getWebdavPath(key, this.remoteBaseDir);
|
||||
return await this._writeFileFromRoot(uploadFile, content, mtime, ctime);
|
||||
return await this._writeFileFromRoot(
|
||||
uploadFile,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
key
|
||||
);
|
||||
}
|
||||
|
||||
async _writeFileFromRoot(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number
|
||||
ctime: number,
|
||||
origKey: string
|
||||
): Promise<Entity> {
|
||||
// less than 10 MB
|
||||
if (content.byteLength <= 10 * 1024 * 1024) {
|
||||
return await this._writeFileFromRootFull(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
}
|
||||
|
||||
// larger than 10 MB
|
||||
if (!this.isNextcloud && !this.supportNativePartial) {
|
||||
// give up and upload by whole, and directly return
|
||||
return await this._writeFileFromRootFull(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
}
|
||||
|
||||
// try to upload by chunks
|
||||
try {
|
||||
if (this.isNextcloud) {
|
||||
return await this._writeFileFromRootNextcloud(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
} else if (this.supportNativePartial) {
|
||||
return await this._writeFileFromRootNativePartial(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
}
|
||||
throw Error(`Error: partial upload / update method is not implemented??`);
|
||||
} catch (e) {
|
||||
console.error(
|
||||
`we fail to write file partially for nextcloud or apache or sabre/dav, stop!`
|
||||
);
|
||||
console.error(e);
|
||||
throw e;
|
||||
// this.isNextcloud = false;
|
||||
// this.supportNativePartial = false;
|
||||
// return await this._writeFileFromRootFull(
|
||||
// key,
|
||||
// content,
|
||||
// mtime,
|
||||
// ctime,
|
||||
// origKey
|
||||
// );
|
||||
}
|
||||
}
|
||||
|
||||
async _writeFileFromRootFull(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number,
|
||||
origKey: string
|
||||
): Promise<Entity> {
|
||||
// console.debug(`start _writeFileFromRootFull`);
|
||||
await this.client.putFileContents(key, content, {
|
||||
overwrite: true,
|
||||
onUploadProgress: (progress: any) => {
|
||||
console.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`);
|
||||
},
|
||||
});
|
||||
return await this._statFromRoot(key);
|
||||
const k = await this._statFromRoot(key);
|
||||
// console.debug(`end _writeFileFromRootFull`);
|
||||
return k;
|
||||
}
|
||||
|
||||
/**
|
||||
* https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/chunking.html
|
||||
* @param key
|
||||
* @param content
|
||||
* @param mtime
|
||||
* @param ctime
|
||||
* @returns
|
||||
*/
|
||||
async _writeFileFromRootNextcloud(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number,
|
||||
origKey: string
|
||||
): Promise<Entity> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(
|
||||
`key=${key} should not have tailing slash in _writeFileFromRootNextcloud`
|
||||
);
|
||||
}
|
||||
const destUrl = `${this.webdavConfig.address}/${encodeURI(key)}`;
|
||||
console.debug(`destUrl=${destUrl}`);
|
||||
|
||||
const getTmpFolder = (x: string) => {
|
||||
if (x.endsWith("/")) {
|
||||
throw Error(`file to upload by chunk should not ends with /`);
|
||||
}
|
||||
const y = x.split("/");
|
||||
const z = encodeURI(`${y[y.length - 1]}`);
|
||||
return z;
|
||||
};
|
||||
|
||||
const uploadServerAddress = this.nextcloudUploadServerAddress;
|
||||
console.debug(`uploadServerAddress=${uploadServerAddress}`);
|
||||
const tmpFolderName = getTmpFolder(key);
|
||||
console.debug(`tmpFolderName=${tmpFolderName}`);
|
||||
|
||||
const clientForUpload = createClient(uploadServerAddress, {
|
||||
username: this.webdavConfig.username,
|
||||
password: this.webdavConfig.password,
|
||||
headers: {
|
||||
"Cache-Control": "no-cache",
|
||||
},
|
||||
authType:
|
||||
this.webdavConfig.authType === "digest"
|
||||
? AuthType.Digest
|
||||
: AuthType.Password,
|
||||
});
|
||||
|
||||
// create folder
|
||||
await clientForUpload.createDirectory(tmpFolderName, {
|
||||
method: "MKCOL",
|
||||
headers: {
|
||||
Destination: destUrl,
|
||||
},
|
||||
});
|
||||
console.debug(`finish creating folder`);
|
||||
|
||||
// upload by chunks
|
||||
const sizePerChunk = 5 * 1024 * 1024; // 5 mb
|
||||
const chunkRanges = splitFileSizeToChunkRanges(
|
||||
content.byteLength,
|
||||
sizePerChunk
|
||||
);
|
||||
for (let i = 0; i < chunkRanges.length; ++i) {
|
||||
const { start, end } = chunkRanges[i];
|
||||
const tmpFileName = `${i + 1}`.padStart(5, "0");
|
||||
const tmpFileNameWithFolder = `${tmpFolderName}/${tmpFileName}`;
|
||||
console.debug(
|
||||
`start to upload chunk ${
|
||||
i + 1
|
||||
} to ${tmpFileNameWithFolder} with startInclusive=${start}, endInclusive=${end}`
|
||||
);
|
||||
await clientForUpload.putFileContents(
|
||||
tmpFileNameWithFolder,
|
||||
content.slice(start, end + 1),
|
||||
{
|
||||
headers: {
|
||||
Destination: destUrl,
|
||||
"OC-Total-Length": `${content.byteLength}`,
|
||||
},
|
||||
}
|
||||
);
|
||||
}
|
||||
console.debug(`finish upload all chunks`);
|
||||
|
||||
// move to assemble
|
||||
const fakeFileToMoveUrl = `${tmpFolderName}/.file`;
|
||||
console.debug(`fakeFileToMoveUrl=${fakeFileToMoveUrl}`);
|
||||
await clientForUpload.customRequest(fakeFileToMoveUrl, {
|
||||
method: "MOVE",
|
||||
headers: {
|
||||
Destination: destUrl,
|
||||
"OC-Total-Length": `${content.byteLength}`,
|
||||
},
|
||||
});
|
||||
console.debug(`finish moving file`);
|
||||
// TODO: setting X-OC-Mtime
|
||||
|
||||
// stat
|
||||
console.debug(`before stat origKey=${origKey}`);
|
||||
const k = await this.stat(origKey);
|
||||
console.debug(`after stat`);
|
||||
if (k.sizeRaw !== content.byteLength) {
|
||||
// we failed!
|
||||
this.isNextcloud = false; // give up next time!
|
||||
const err = `unable to upload file ${key} by chunks to nextcloud`;
|
||||
console.error(err);
|
||||
throw Error(err);
|
||||
}
|
||||
console.debug(`after stat, k=${JSON.stringify(k, null, 2)}`);
|
||||
|
||||
return k;
|
||||
}
|
||||
|
||||
async _writeFileFromRootNativePartial(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
ctime: number,
|
||||
origKey: string
|
||||
): Promise<Entity> {
|
||||
// firstly upload a 0-byte data
|
||||
await this._writeFileFromRootFull(
|
||||
key,
|
||||
new ArrayBuffer(0),
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
|
||||
// then "update" by chunks
|
||||
const sizePerChunk = 5 * 1024 * 1024; // 5 mb
|
||||
const chunkRanges = splitFileSizeToChunkRanges(
|
||||
content.byteLength,
|
||||
sizePerChunk
|
||||
);
|
||||
for (let i = 0; i < chunkRanges.length; ++i) {
|
||||
const { start, end } = chunkRanges[i];
|
||||
await this.client.partialUpdateFileContents(
|
||||
key,
|
||||
start,
|
||||
end,
|
||||
content.slice(start, end + 1)
|
||||
);
|
||||
}
|
||||
|
||||
// lastly return
|
||||
return await this.stat(origKey);
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
@@ -437,6 +778,16 @@ export class FakeFsWebdav extends FakeFs {
|
||||
throw Error(`unexpected file content result with type ${typeof buff}`);
|
||||
}
|
||||
|
||||
async rename(key1: string, key2: string): Promise<void> {
|
||||
if (key1 === "/" || key2 === "/") {
|
||||
return;
|
||||
}
|
||||
const remoteFileName1 = getWebdavPath(key1, this.remoteBaseDir);
|
||||
const remoteFileName2 = getWebdavPath(key2, this.remoteBaseDir);
|
||||
await this._init();
|
||||
await this.client.moveFile(remoteFileName1, remoteFileName2);
|
||||
}
|
||||
|
||||
async rm(key: string): Promise<void> {
|
||||
if (key === "/") {
|
||||
return;
|
||||
@@ -492,4 +843,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
async revokeAuth() {
|
||||
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