Compare commits

...
48 Commits
Author SHA1 Message Date
fyears b769becb97 bump to 0.4.22
Release A New Version / build (16.x) (push) Failing after 40s
2024-05-21 01:04:22 +08:00
fyears 7b3600a46f correct way for nextcloud 2024-05-20 09:56:09 +08:00
fyears 69e72eae1d correctly set range update 2024-05-19 21:41:01 +08:00
fyears b0acde0ba6 remove recursive to fix digest 2024-05-19 20:36:34 +08:00
fyears 11b7fee80b remove unnecessary get 2024-05-19 19:59:16 +08:00
fyears c4c39f6b79 make it more robust 2024-05-19 19:13:56 +08:00
fyears 45578a01dd chunk webdav upload to 5 mb 2024-05-19 18:10:32 +08:00
fyears 0391c42999 wrap settings 2024-05-19 18:09:41 +08:00
fyears 807eec928e optimize sync plan export 2024-05-19 17:51:44 +08:00
fyears 3d7c4d2a4a optimize webdav 2024-05-19 17:03:14 +08:00
fyears cb779fc7bf add upload by chunks for webdav 2024-05-19 15:58:49 +08:00
fyears 9d8e2af7b9 allow skipping empty file in onedrive 2024-05-18 12:03:53 +08:00
Jason a48440e60b Refine wording and grammar in some descriptions of settings. (#655)
* Refine wording and grammar in some descriptions of settings.

* Remove extra space in settings_encryptionmethod_desc.

* Add required ending comma syntax to settings_webdav_auth_desc.
2024-05-18 02:32:07 +08:00
fyears 2a84fae368 fix typo 2024-05-18 02:31:28 +08:00
fyears 3c3426a842 add more size range 2024-05-18 02:30:50 +08:00
fyears 74de7da89a fix timestamp to date using native js 2024-05-18 01:41:54 +08:00
fyears 1f33ac5d7a remove verbose webdav output 2024-05-18 01:34:46 +08:00
fyears 63c54d1956 check password using walkPartial instead of cache 2024-05-18 01:33:20 +08:00
fyears b584f89a95 profiler itself might impact performance 2024-05-18 00:03:21 +08:00
fyears fa17ea074b format 2024-05-17 22:59:44 +08:00
fyears cb98bae79a buck? localforage 2024-05-17 22:59:34 +08:00
fyears d1e30e3536 bump to 0.4.21
Release A New Version / build (16.x) (push) Failing after 38s
2024-05-09 00:02:07 +08:00
fyears 36079fc1d0 add profiler 2024-05-09 00:01:30 +08:00
fyears 67467a5034 fail statusbar 2024-05-08 22:50:18 +08:00
fyears 2a3df8ab53 fix onedrive issue in enc 2024-05-08 22:37:34 +08:00
fyears e66b0c71c4 fix format again 2024-05-08 22:04:21 +08:00
fyears a081d09212 safe lint from biome 2024-05-08 00:20:15 +08:00
fyears 6ed6122bb6 rm prettier 2024-05-07 23:51:26 +08:00
fyears 235e346d2f slightly format 2024-05-07 23:48:37 +08:00
fyears 084cbc8391 switch formater to biome for speed 2024-05-07 23:48:29 +08:00
fyears dc0c1db779 enable git lfs cache to avoid billing according to https://github.com/actions/checkout/issues/165 2024-05-07 23:22:51 +08:00
fyears 2645ff34e6 bump to 0.4.20
Release A New Version / build (16.x) (push) Failing after 46s
2024-05-07 00:05:41 +08:00
fyears f25a2c2992 shorten text 2024-05-07 00:02:34 +08:00
fyears 3d1269a9f2 add a little helper to see file stat 2024-05-07 00:01:21 +08:00
fyears ed52a8542f fix s3 mtime problem 2024-05-06 23:41:48 +08:00
fyears 757eb5c801 format 2024-04-30 00:57:22 +08:00
fyears 048e7b6251 update readme of s3 (#639) 2024-04-30 00:46:15 +08:00
fyears b762052da3 customize the welcome text 2024-04-30 00:37:52 +08:00
fyears c61efd1367 add steps for cla 2024-04-30 00:13:27 +08:00
fyears 605bffa471 add webdis (#638) 2024-04-30 00:04:00 +08:00
fyears 895e3db4c6 cla bot 2024-04-29 23:51:12 +08:00
fyears ce1990a35f change loglevel for verbose mixedEntityMappings 2024-04-28 00:55:56 +08:00
fyears 9ea7c8e858 bump to 0.4.19
Release A New Version / build (16.x) (push) Failing after 33s
2024-04-28 00:31:14 +08:00
fyears 61a3fab219 webdis 2024-04-27 23:10:36 +08:00
fyears 5340e38eac format of doc 2024-04-27 17:11:59 +08:00
fyears 8d5868b8d8 fix process counting 2024-04-27 17:11:48 +08:00
fyears 55175a6d06 bump to 0.4.18
Release A New Version / build (16.x) (push) Failing after 37s
2024-04-27 12:34:10 +08:00
fyears f60bd25490 add enc for upyun 2024-04-27 12:21:31 +08:00
52 changed files with 2203 additions and 554 deletions
+11 -3
View File
@@ -29,10 +29,18 @@ jobs:
- name: Checkout codes - name: Checkout codes
uses: actions/checkout@v2 uses: actions/checkout@v2
with: with:
lfs: true
submodules: recursive submodules: recursive
- name: Checkout LFS - name: Checkout LFS file list
run: git lfs checkout run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
- name: LFS Cache
uses: actions/cache@v3
with:
path: .git/lfs/objects
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
restore-keys: |
${{ runner.os }}-lfs-
- name: Git LFS Pull
run: git lfs pull
- name: Use Node.js ${{ matrix.node-version }} - name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v2
with: with:
+43
View File
@@ -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
+11 -3
View File
@@ -32,10 +32,18 @@ jobs:
- name: Checkout codes - name: Checkout codes
uses: actions/checkout@v2 uses: actions/checkout@v2
with: with:
lfs: true
submodules: recursive submodules: recursive
- name: Checkout LFS - name: Checkout LFS file list
run: git lfs checkout run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
- name: LFS Cache
uses: actions/cache@v3
with:
path: .git/lfs/objects
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
restore-keys: |
${{ runner.os }}-lfs-
- name: Git LFS Pull
run: git lfs pull
- name: Use Node.js ${{ matrix.node-version }} - name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v2
with: with:
-3
View File
@@ -1,3 +0,0 @@
node_modules/
main.js
data.json
+23
View File
@@ -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.
+22
View File
@@ -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.
![robot check](./assets/cla-process/cla-robot-alert.png)
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.
![robot recheck](./assets/cla-process/cla-sign-and-pass.png)
7. Your pr will be reviewed.
8. If you sign the CLA and submit some more PRs, the robot should pass the test automatically.
+10 -1
View File
@@ -21,6 +21,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
- Dropbox - Dropbox
- OneDrive for personal - OneDrive for personal
- Webdav - Webdav
- Webdis
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details. - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker". - **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password. - **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
@@ -67,11 +68,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) - [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
- [MinIO](./docs/remote_services/s3_minio/README.md) - [MinIO](./docs/remote_services/s3_minio/README.md)
- [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.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). - If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md). - Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
- Download and enable this plugin. - Download and enable this plugin.
- Enter your information to the settings of this plugin. - Enter your information to the settings of this plugin.
- If you do not set the prefix in the settings, the bucket should be empty and solely for syncing a vault. You can set the prefix in the settings so that the same bucket can store multiple vaults.
- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud. - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette. - Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
- **Be patient while syncing.** Especially in the first-time sync. - **Be patient while syncing.** Especially in the first-time sync.
@@ -108,6 +110,13 @@ 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**. - 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. - If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
### Webdis
- Tutorials:
- [Webdis](./docs/remote_services/webdis/README.md)
- Mostly experimental.
- You have to setup and protect your web server by yourself.
## Scheduled Auto Sync ## Scheduled Auto Sync
- You can configure auto syncing every N minutes in settings. - You can configure auto syncing every N minutes in settings.
+3
View File
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:07fd075d0f73c708d77fd97bb31d6f185f094031e8275e8fd582e3a0145f6be8
size 415757
+3
View File
@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:4c5754df8b5d6878a7fa58992fc7e37ddcce1ecf578a0fc2ec751b6f7bab6f13
size 284700
+55
View File
@@ -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 -1
View File
@@ -2,7 +2,7 @@
const http = require("http"); const http = require("http");
const requestHandler = (req, res) => { const requestHandler = (req, res) => {
let body = []; const body = [];
req req
.on("data", (chunk) => { .on("data", (chunk) => {
body.push(chunk); body.push(chunk);
+14 -9
View File
@@ -2,18 +2,23 @@
## 链接 ## 链接
* 官网 <https://www.upyun.com/> - 官网 <https://www.upyun.com/>
* 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/> - 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>
## 注意!!!!!
又拍云似乎(?)文件都是默认公开的,强烈建议注意隐私问题,强烈建议设置插件加密。
## 步骤 ## 步骤
1. 注册,新建对象存储。 1. 注册,新建对象存储。
2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>,创建操作员然后创建 S3 访问凭证。 2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>,创建操作员然后创建 S3 访问凭证。
3. 在 Remotely Save 设置以下: 3. 在 Remotely Save 设置以下:
* 服务地址(Endpoint):`s3.api.upyun.com` **一定是这个域名** - 服务地址(Endpoint):`s3.api.upyun.com` **一定是这个域名**
* 区域(Region):`us-east-1` - 区域(Region):`us-east-1`
* Acccess Key ID:您获取到的访问凭证的 AccessKey - Acccess Key ID:您获取到的访问凭证的 AccessKey
* Secret Access Key:您获取到的访问凭证的 SecretAccessKey - Secret Access Key:您获取到的访问凭证的 SecretAccessKey
* 存储桶(Bucket)的名字:您创建的“服务名” - 存储桶(Bucket)的名字:您创建的“服务名”
* 是否生成文件夹 Object:不生成(默认) **一定要选择不生成** - 是否生成文件夹 Object:不生成(默认) **一定要选择不生成**
4. 同步 4. 可以在插件设置里,加上密码
5. 同步。
+35
View File
@@ -0,0 +1,35 @@
# Webdis
## Links
- Webdis: <https://github.com/nicolasff/webdis>
- Redis®: <https://redis.io/>
## Explanation and Background
I like the Redis® software very much, and would like to experiment using it as a "file storage". It seems to be nature by using path as the key and the content as the value (Sort of..., see below).
However, Redis® works by using TCP connections, and browser js cannot establish raw TCP connections. We need a HTTP gateway, to provide the HTTP api. Wedis seems to be the most famous open source one.
And of course, this method should work for Redis® alternatives: Valkey, Redict, KeyDB, Dragonfly, Garnet, ...
## Disclaimer
This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.
**Never expose your Redis® or Webdis to public without security protection!!!** You are response for protecting your server.
## Usage
1. Install Redis®.
2. Install Webdis.
3. In `webdis.json`, configure the ACL for using password and username, and / or ip filters. **Never expose your Redis® or Webdis to public without security protection!!!**.
4. Install and configure reverse proxy, firewall, https, etc. (You have to configure HTTPS correctly if you want to use it on iOS)
5. In Remotely Save settings, enter your server address, username, password, and adjust the "base dir". Check connection.
6. Sync!
7. Serveral keys and values will be generated in your Redis® database:
```
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:meta # you can HGETALL it
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:content # you can GET it
```
+1 -2
View File
@@ -1,7 +1,6 @@
import dotenv from "dotenv/config";
import esbuild from "esbuild"; import esbuild from "esbuild";
import process from "process";
import inlineWorkerPlugin from "esbuild-plugin-inline-worker"; import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
import process from "process";
// import builtins from 'builtin-modules' // import builtins from 'builtin-modules'
const banner = `/* const banner = `/*
+2 -2
View File
@@ -1,2 +1,2 @@
export let Buffer = require("buffer").Buffer; export const Buffer = require("buffer").Buffer;
export let process = require("process/browser"); export const process = require("process/browser");
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"id": "remotely-save", "id": "remotely-save",
"name": "Remotely Save", "name": "Remotely Save",
"version": "0.4.16", "version": "0.4.22",
"minAppVersion": "0.13.21", "minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears", "author": "fyears",
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"id": "remotely-save", "id": "remotely-save",
"name": "Remotely Save", "name": "Remotely Save",
"version": "0.4.16", "version": "0.4.22",
"minAppVersion": "0.13.21", "minAppVersion": "0.13.21",
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
"author": "fyears", "author": "fyears",
+4 -3
View File
@@ -1,13 +1,13 @@
{ {
"name": "remotely-save", "name": "remotely-save",
"version": "0.4.16", "version": "0.4.22",
"description": "This is yet another sync plugin for Obsidian app.", "description": "This is yet another sync plugin for Obsidian app.",
"scripts": { "scripts": {
"dev2": "node esbuild.config.mjs --watch", "dev2": "node esbuild.config.mjs --watch",
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"build": "webpack --mode production", "build": "webpack --mode production",
"dev": "webpack --mode development --watch", "dev": "webpack --mode development --watch",
"format": "npx prettier --trailing-comma es5 --write .", "format": "npx @biomejs/biome check --apply .",
"clean": "npx rimraf main.js", "clean": "npx rimraf main.js",
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'" "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
}, },
@@ -25,6 +25,7 @@
"author": "", "author": "",
"license": "Apache-2.0", "license": "Apache-2.0",
"devDependencies": { "devDependencies": {
"@biomejs/biome": "1.7.3",
"@microsoft/microsoft-graph-types": "^2.40.0", "@microsoft/microsoft-graph-types": "^2.40.0",
"@types/chai": "^4.3.14", "@types/chai": "^4.3.14",
"@types/chai-as-promised": "^7.1.8", "@types/chai-as-promised": "^7.1.8",
@@ -44,7 +45,6 @@
"mocha": "^10.4.0", "mocha": "^10.4.0",
"npm-check-updates": "^16.14.20", "npm-check-updates": "^16.14.20",
"obsidian": "^1.5.7", "obsidian": "^1.5.7",
"prettier": "^3.2.5",
"ts-loader": "^9.5.1", "ts-loader": "^9.5.1",
"ts-node": "^10.9.2", "ts-node": "^10.9.2",
"tslib": "^2.6.2", "tslib": "^2.6.2",
@@ -77,6 +77,7 @@
"http-status-codes": "^2.3.0", "http-status-codes": "^2.3.0",
"localforage": "^1.10.0", "localforage": "^1.10.0",
"localforage-getitems": "^1.4.2", "localforage-getitems": "^1.4.2",
"localforage-removeitems": "^1.4.0",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"lucide": "^0.376.1", "lucide": "^0.376.1",
"mime-types": "^2.1.35", "mime-types": "^2.1.35",
+28 -13
View File
@@ -3,17 +3,22 @@
* To avoid circular dependency. * To avoid circular dependency.
*/ */
import { Platform, requireApiVersion } from "obsidian"; import type { LangTypeAndAuto } from "./i18n";
import type { LangType, LangTypeAndAuto } from "./i18n";
export const DEFAULT_CONTENT_TYPE = "application/octet-stream"; export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive"; export type SUPPORTED_SERVICES_TYPE =
| "s3"
| "webdav"
| "dropbox"
| "onedrive"
| "webdis";
export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR = export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
| "webdav" | "webdav"
| "dropbox" | "dropbox"
| "onedrive"; | "onedrive"
| "webdis";
export interface S3Config { export interface S3Config {
s3Endpoint: string; s3Endpoint: string;
@@ -84,6 +89,14 @@ export interface OnedriveConfig {
username: string; username: string;
credentialsShouldBeDeletedAtTime?: number; credentialsShouldBeDeletedAtTime?: number;
remoteBaseDir?: string; remoteBaseDir?: string;
emptyFile: "skip" | "error";
}
export interface WebdisConfig {
address: string;
username?: string;
password?: string;
remoteBaseDir?: string;
} }
export type SyncDirectionType = export type SyncDirectionType =
@@ -95,11 +108,17 @@ export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
export type QRExportType = "all_but_oauth2" | "dropbox" | "onedrive"; export type QRExportType = "all_but_oauth2" | "dropbox" | "onedrive";
export interface ProfilerConfig {
enablePrinting?: boolean;
recordSize?: boolean;
}
export interface RemotelySavePluginSettings { export interface RemotelySavePluginSettings {
s3: S3Config; s3: S3Config;
webdav: WebdavConfig; webdav: WebdavConfig;
dropbox: DropboxConfig; dropbox: DropboxConfig;
onedrive: OnedriveConfig; onedrive: OnedriveConfig;
webdis: WebdisConfig;
password: string; password: string;
serviceType: SUPPORTED_SERVICES_TYPE; serviceType: SUPPORTED_SERVICES_TYPE;
currLogLevel?: string; currLogLevel?: string;
@@ -128,6 +147,8 @@ export interface RemotelySavePluginSettings {
encryptionMethod?: CipherMethodType; encryptionMethod?: CipherMethodType;
profiler?: ProfilerConfig;
/** /**
* @deprecated * @deprecated
*/ */
@@ -210,6 +231,7 @@ export interface Entity {
hash?: string; hash?: string;
etag?: string; etag?: string;
synthesizedFolder?: boolean; synthesizedFolder?: boolean;
synthesizedFile?: boolean;
} }
export interface UploadedType { export interface UploadedType {
@@ -230,6 +252,8 @@ export interface MixedEntity {
decision?: DecisionTypeForMixedEntity; decision?: DecisionTypeForMixedEntity;
conflictAction?: ConflictActionType; conflictAction?: ConflictActionType;
change?: boolean;
sideNotes?: any; sideNotes?: any;
} }
@@ -261,15 +285,6 @@ export interface FileOrFolderMixedState {
deltimeRemoteFmt?: string; deltimeRemoteFmt?: string;
} }
export const API_VER_STAT_FOLDER = "0.13.27";
export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
export const API_VER_ENSURE_REQURL_OK = "1.0.0"; // always bypass CORS here
export const VALID_REQURL =
(!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
(Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/"; export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
"sync_plans_hist_exported_on_"; "sync_plans_hist_exported_on_";
+14
View File
@@ -0,0 +1,14 @@
/**
* Every utils requiring Obsidian is placed here.
*/
import { Platform, requireApiVersion } from "obsidian";
export const API_VER_STAT_FOLDER = "0.13.27";
export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
export const API_VER_ENSURE_REQURL_OK = "1.0.0"; // always bypass CORS here
export const VALID_REQURL =
(!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
(Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
+1 -1
View File
@@ -1,4 +1,4 @@
import { base64, base64url } from "rfc4648"; import { base64url } from "rfc4648";
import { reverseString } from "./misc"; import { reverseString } from "./misc";
import type { RemotelySavePluginSettings } from "./baseTypes"; import type { RemotelySavePluginSettings } from "./baseTypes";
+34 -10
View File
@@ -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 { import {
DEFAULT_DEBUG_FOLDER, DEFAULT_DEBUG_FOLDER,
DEFAULT_PROFILER_RESULT_FILE_PREFIX, DEFAULT_PROFILER_RESULT_FILE_PREFIX,
DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX, DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
} from "./baseTypes"; } from "./baseTypes";
import {
readAllProfilerResultsByVault,
readAllSyncPlanRecordTextsByVault,
} from "./localdb";
import type { InternalDBs } from "./localdb";
import { mkdirpInVault } from "./misc";
import type { SyncPlanType } from "./sync";
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 ( export const exportVaultSyncPlansToFiles = async (
db: InternalDBs, db: InternalDBs,
vault: Vault, vault: Vault,
vaultRandomID: string, vaultRandomID: string,
howMany: number howMany: number,
onlyChange: boolean
) => { ) => {
console.info("exporting sync plans"); console.info("exporting sync plans");
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault); await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
@@ -28,12 +46,18 @@ export const exportVaultSyncPlansToFiles = async (
if (howMany <= 0) { if (howMany <= 0) {
md = md =
"Sync plans found:\n\n" + "Sync plans found:\n\n" +
records.map((x) => "```json\n" + x + "\n```\n").join("\n"); records
.map(
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
)
.join("\n");
} else { } else {
md = md =
"Sync plans found:\n\n" + "Sync plans found:\n\n" +
records records
.map((x) => "```json\n" + x + "\n```\n") .map(
(x) => "```json\n" + getSubsetOfSyncPlan(x, onlyChange) + "\n```\n"
)
.slice(0, howMany) .slice(0, howMany)
.join("\n"); .join("\n");
} }
+3 -3
View File
@@ -39,7 +39,7 @@ export const encryptArrayBuffer = async (
arrBuf: ArrayBuffer, arrBuf: ArrayBuffer,
password: string, password: string,
rounds: number = DEFAULT_ITER, rounds: number = DEFAULT_ITER,
saltHex: string = "" saltHex = ""
) => { ) => {
let salt: Uint8Array; let salt: Uint8Array;
if (saltHex !== "") { if (saltHex !== "") {
@@ -109,7 +109,7 @@ export const encryptStringToBase32 = async (
text: string, text: string,
password: string, password: string,
rounds: number = DEFAULT_ITER, rounds: number = DEFAULT_ITER,
saltHex: string = "" saltHex = ""
) => { ) => {
const enc = await encryptArrayBuffer( const enc = await encryptArrayBuffer(
bufferToArrayBuffer(new TextEncoder().encode(text)), bufferToArrayBuffer(new TextEncoder().encode(text)),
@@ -138,7 +138,7 @@ export const encryptStringToBase64url = async (
text: string, text: string,
password: string, password: string,
rounds: number = DEFAULT_ITER, rounds: number = DEFAULT_ITER,
saltHex: string = "" saltHex = ""
) => { ) => {
const enc = await encryptArrayBuffer( const enc = await encryptArrayBuffer(
bufferToArrayBuffer(new TextEncoder().encode(text)), bufferToArrayBuffer(new TextEncoder().encode(text)),
+1 -1
View File
@@ -1,5 +1,5 @@
import { nanoid } from "nanoid";
import { Cipher as CipherRCloneCryptPack } from "@fyears/rclone-crypt"; import { Cipher as CipherRCloneCryptPack } from "@fyears/rclone-crypt";
import { nanoid } from "nanoid";
const ctx: WorkerGlobalScope = self as any; const ctx: WorkerGlobalScope = self as any;
+3 -1
View File
@@ -1,8 +1,9 @@
import { Entity } from "./baseTypes"; import type { Entity } from "./baseTypes";
export abstract class FakeFs { export abstract class FakeFs {
abstract kind: string; abstract kind: string;
abstract walk(): Promise<Entity[]>; abstract walk(): Promise<Entity[]>;
abstract walkPartial(): Promise<Entity[]>;
abstract stat(key: string): Promise<Entity>; abstract stat(key: string): Promise<Entity>;
abstract mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity>; abstract mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity>;
abstract writeFile( abstract writeFile(
@@ -16,4 +17,5 @@ export abstract class FakeFs {
abstract checkConnect(callbackFunc?: any): Promise<boolean>; abstract checkConnect(callbackFunc?: any): Promise<boolean>;
abstract getUserDisplayName(): Promise<string>; abstract getUserDisplayName(): Promise<string>;
abstract revokeAuth(): Promise<any>; abstract revokeAuth(): Promise<any>;
abstract allowEmptyFile(): boolean;
} }
+44 -30
View File
@@ -1,13 +1,13 @@
import { FakeFs } from "./fsAll";
import { Dropbox, DropboxAuth } from "dropbox"; import { Dropbox, DropboxAuth } from "dropbox";
import type { files, DropboxResponseError, DropboxResponse } from "dropbox"; import type { DropboxResponse, DropboxResponseError, files } from "dropbox";
import {
DropboxConfig,
COMMAND_CALLBACK_DROPBOX,
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
Entity,
} from "./baseTypes";
import random from "lodash/random"; import random from "lodash/random";
import {
COMMAND_CALLBACK_DROPBOX,
type DropboxConfig,
type Entity,
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
} from "./baseTypes";
import { FakeFs } from "./fsAll";
import { import {
bufferToArrayBuffer, bufferToArrayBuffer,
delay, delay,
@@ -134,7 +134,7 @@ export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
caseMapping[newKey.toLocaleLowerCase()] = newKey; caseMapping[newKey.toLocaleLowerCase()] = newKey;
e.key = newKey; e.key = newKey;
// console.log(JSON.stringify(caseMapping,null,2)); // console.log(JSON.stringify(caseMapping,null,2));
continue; // continue;
} else { } else {
throw Error(`${parentFolder} doesn't have cases record??`); throw Error(`${parentFolder} doesn't have cases record??`);
} }
@@ -145,7 +145,7 @@ export const fixEntityListCasesInplace = (entities: { key?: string }[]) => {
.slice(-1) .slice(-1)
.join("/")}`; .join("/")}`;
e.key = newKey; e.key = newKey;
continue; // continue;
} else { } else {
throw Error(`${parentFolder} doesn't have cases record??`); throw Error(`${parentFolder} doesn't have cases record??`);
} }
@@ -167,7 +167,7 @@ interface ErrSubType {
async function retryReq<T>( async function retryReq<T>(
reqFunc: () => Promise<DropboxResponse<T>>, reqFunc: () => Promise<DropboxResponse<T>>,
extraHint: string = "" extraHint = ""
): Promise<DropboxResponse<T> | undefined> { ): Promise<DropboxResponse<T> | undefined> {
const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff const waitSeconds = [1, 2, 4, 8]; // hard code exponential backoff
for (let idx = 0; idx < waitSeconds.length; ++idx) { for (let idx = 0; idx < waitSeconds.length; ++idx) {
@@ -205,7 +205,7 @@ async function retryReq<T>(
const headers = headersToRecord(err.headers); const headers = headersToRecord(err.headers);
const svrSec = const svrSec =
err.error.error.retry_after || err.error.error.retry_after ||
parseInt(headers["retry-after"] || "1") || Number.parseInt(headers["retry-after"] || "1") ||
1; 1;
const fallbackSec = waitSeconds[idx]; const fallbackSec = waitSeconds[idx];
const secMin = Math.max(svrSec, fallbackSec); const secMin = Math.max(svrSec, fallbackSec);
@@ -233,7 +233,7 @@ async function retryReq<T>(
export const getAuthUrlAndVerifier = async ( export const getAuthUrlAndVerifier = async (
appKey: string, appKey: string,
needManualPatse: boolean = false needManualPatse = false
) => { ) => {
const auth = new DropboxAuth({ const auth = new DropboxAuth({
clientId: appKey, clientId: appKey,
@@ -328,9 +328,9 @@ export const setConfigBySuccessfullAuthInplace = async (
console.info("start updating local info of Dropbox token"); console.info("start updating local info of Dropbox token");
config.accessToken = authRes.access_token; config.accessToken = authRes.access_token;
config.accessTokenExpiresInSeconds = parseInt(authRes.expires_in); config.accessTokenExpiresInSeconds = Number.parseInt(authRes.expires_in);
config.accessTokenExpiresAtTime = 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; // manually set it expired after 80 days;
config.credentialsShouldBeDeletedAtTime = config.credentialsShouldBeDeletedAtTime =
@@ -452,13 +452,21 @@ export class FakeFsDropbox extends FakeFs {
} }
async walk(): Promise<Entity[]> { 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(); await this._init();
let res = await this.dropbox.filesListFolder({ let res = await this.dropbox.filesListFolder({
path: `/${this.remoteBaseDir}`, path: `/${this.remoteBaseDir}`,
recursive: true, recursive: !partial,
include_deleted: false, include_deleted: false,
limit: 1000, limit: partial ? 10 : 1000,
}); });
if (res.status !== 200) { if (res.status !== 200) {
throw Error(JSON.stringify(res)); throw Error(JSON.stringify(res));
@@ -471,20 +479,22 @@ export class FakeFsDropbox extends FakeFs {
.filter((x) => x.path_display !== `/${this.remoteBaseDir}`) .filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
.map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir)); .map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
while (res.result.has_more) { if (!partial) {
res = await this.dropbox.filesListFolderContinue({ while (res.result.has_more) {
cursor: res.result.cursor, res = await this.dropbox.filesListFolderContinue({
}); cursor: res.result.cursor,
if (res.status !== 200) { });
throw Error(JSON.stringify(res)); if (res.status !== 200) {
} throw Error(JSON.stringify(res));
}
const contents2 = res.result.entries; const contents2 = res.result.entries;
const unifiedContents2 = contents2 const unifiedContents2 = contents2
.filter((x) => x[".tag"] !== "deleted") .filter((x) => x[".tag"] !== "deleted")
.filter((x) => x.path_display !== `/${this.remoteBaseDir}`) .filter((x) => x.path_display !== `/${this.remoteBaseDir}`)
.map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir)); .map((x) => fromDropboxItemToEntity(x, this.remoteBaseDir));
unifiedContents.push(...unifiedContents2); unifiedContents.push(...unifiedContents2);
}
} }
fixEntityListCasesInplace(unifiedContents); fixEntityListCasesInplace(unifiedContents);
@@ -736,4 +746,8 @@ export class FakeFsDropbox extends FakeFs {
return false; return false;
} }
} }
allowEmptyFile(): boolean {
return true;
}
} }
+21 -25
View File
@@ -1,10 +1,10 @@
import { CipherMethodType, Entity } from "./baseTypes"; import type { CipherMethodType, Entity } from "./baseTypes";
import * as openssl from "./encryptOpenSSL"; import * as openssl from "./encryptOpenSSL";
import * as rclone from "./encryptRClone"; import * as rclone from "./encryptRClone";
import { isVaildText } from "./misc"; import { isVaildText } from "./misc";
import { FakeFs } from "./fsAll";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import { FakeFs } from "./fsAll";
/** /**
* quick guess, no actual decryption here * quick guess, no actual decryption here
@@ -78,8 +78,6 @@ export class FakeFsEncrypt extends FakeFs {
cacheMapOrigToEnc: Record<string, string>; cacheMapOrigToEnc: Record<string, string>;
hasCacheMap: boolean; hasCacheMap: boolean;
kind: string; kind: string;
innerWalkResultCache?: Entity[];
innerWalkResultCacheTime?: number;
constructor(innerFs: FakeFs, password: string, method: CipherMethodType) { constructor(innerFs: FakeFs, password: string, method: CipherMethodType) {
super(); super();
@@ -110,26 +108,8 @@ export class FakeFsEncrypt extends FakeFs {
throw Error(`no idea about isFolderAware for method=${this.method}`); 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> { async isPasswordOk(): Promise<PasswordCheckType> {
const innerWalkResult = await this._getInnerWalkResult(); const innerWalkResult = await this.walkPartial();
if (innerWalkResult === undefined || innerWalkResult.length === 0) { if (innerWalkResult === undefined || innerWalkResult.length === 0) {
// remote empty // remote empty
@@ -186,8 +166,16 @@ export class FakeFsEncrypt extends FakeFs {
} }
async walk(): Promise<Entity[]> { 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[] = []; const res: Entity[] = [];
if (this.isPasswordEmpty()) { if (this.isPasswordEmpty()) {
@@ -273,9 +261,13 @@ export class FakeFsEncrypt extends FakeFs {
return copyEntityAndCopyKeyEncSizeEnc(innerEntity); return copyEntityAndCopyKeyEncSizeEnc(innerEntity);
} else { } else {
const now = Date.now(); const now = Date.now();
let content = new ArrayBuffer(0);
if (!this.innerFs.allowEmptyFile()) {
content = new ArrayBuffer(1);
}
const innerEntity = await this.innerFs.writeFile( const innerEntity = await this.innerFs.writeFile(
keyEnc, keyEnc,
new ArrayBuffer(0), content,
mtime ?? now, mtime ?? now,
ctime ?? now ctime ?? now
); );
@@ -554,4 +546,8 @@ export class FakeFsEncrypt extends FakeFs {
async revokeAuth(): Promise<any> { async revokeAuth(): Promise<any> {
return await this.innerFs.revokeAuth(); return await this.innerFs.revokeAuth();
} }
allowEmptyFile(): boolean {
return true;
}
} }
+9 -7
View File
@@ -1,9 +1,10 @@
import { RemotelySavePluginSettings } from "./baseTypes"; import type { RemotelySavePluginSettings } from "./baseTypes";
import { FakeFs } from "./fsAll"; import type { FakeFs } from "./fsAll";
import { FakeFsDropbox } from "./fsDropbox"; import { FakeFsDropbox } from "./fsDropbox";
import { FakeFsOnedrive } from "./fsOnedrive"; import { FakeFsOnedrive } from "./fsOnedrive";
import { FakeFsS3 } from "./fsS3"; import { FakeFsS3 } from "./fsS3";
import { FakeFsWebdav } from "./fsWebdav"; import { FakeFsWebdav } from "./fsWebdav";
import { FakeFsWebdis } from "./fsWebdis";
/** /**
* To avoid circular dependency, we need a new file here. * To avoid circular dependency, we need a new file here.
@@ -16,30 +17,31 @@ export function getClient(
switch (settings.serviceType) { switch (settings.serviceType) {
case "s3": case "s3":
return new FakeFsS3(settings.s3); return new FakeFsS3(settings.s3);
break;
case "webdav": case "webdav":
return new FakeFsWebdav( return new FakeFsWebdav(
settings.webdav, settings.webdav,
vaultName, vaultName,
saveUpdatedConfigFunc saveUpdatedConfigFunc
); );
break;
case "dropbox": case "dropbox":
return new FakeFsDropbox( return new FakeFsDropbox(
settings.dropbox, settings.dropbox,
vaultName, vaultName,
saveUpdatedConfigFunc saveUpdatedConfigFunc
); );
break;
case "onedrive": case "onedrive":
return new FakeFsOnedrive( return new FakeFsOnedrive(
settings.onedrive, settings.onedrive,
vaultName, vaultName,
saveUpdatedConfigFunc saveUpdatedConfigFunc
); );
break; case "webdis":
return new FakeFsWebdis(
settings.webdis,
vaultName,
saveUpdatedConfigFunc
);
default: default:
throw Error(`cannot init client for serviceType=${settings.serviceType}`); throw Error(`cannot init client for serviceType=${settings.serviceType}`);
break;
} }
} }
+24 -14
View File
@@ -1,17 +1,17 @@
import { DEFAULT_DEBUG_FOLDER, Entity } from "./baseTypes"; import { DEFAULT_DEBUG_FOLDER, type Entity } from "./baseTypes";
import { FakeFs } from "./fsAll"; import { FakeFs } from "./fsAll";
import { TFile, TFolder, type Vault } from "obsidian"; import { TFile, TFolder, type Vault } from "obsidian";
import { mkdirpInVault, statFix, unixTimeToStr } from "./misc";
import { listFilesInObsFolder } from "./obsFolderLister"; import { listFilesInObsFolder } from "./obsFolderLister";
import { Profiler } from "./profiler"; import type { Profiler } from "./profiler";
import { getFolderLevels, mkdirpInVault, statFix } from "./misc";
export class FakeFsLocal extends FakeFs { export class FakeFsLocal extends FakeFs {
vault: Vault; vault: Vault;
syncConfigDir: boolean; syncConfigDir: boolean;
configDir: string; configDir: string;
pluginID: string; pluginID: string;
profiler: Profiler; profiler: Profiler | undefined;
deleteToWhere: "obsidian" | "system"; deleteToWhere: "obsidian" | "system";
kind: "local"; kind: "local";
constructor( constructor(
@@ -19,7 +19,7 @@ export class FakeFsLocal extends FakeFs {
syncConfigDir: boolean, syncConfigDir: boolean,
configDir: string, configDir: string,
pluginID: string, pluginID: string,
profiler: Profiler, profiler: Profiler | undefined,
deleteToWhere: "obsidian" | "system" deleteToWhere: "obsidian" | "system"
) { ) {
super(); super();
@@ -34,12 +34,12 @@ export class FakeFsLocal extends FakeFs {
} }
async walk(): Promise<Entity[]> { async walk(): Promise<Entity[]> {
this.profiler.addIndent(); this.profiler?.addIndent();
this.profiler.insert("enter walk for local"); this.profiler?.insert("enter walk for local");
const local: Entity[] = []; const local: Entity[] = [];
const localTAbstractFiles = this.vault.getAllLoadedFiles(); 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) { for (const entry of localTAbstractFiles) {
let r: Entity | undefined = undefined; let r: Entity | undefined = undefined;
let key = entry.path; let key = entry.path;
@@ -83,16 +83,16 @@ export class FakeFsLocal extends FakeFs {
if (r.keyRaw.startsWith(DEFAULT_DEBUG_FOLDER)) { if (r.keyRaw.startsWith(DEFAULT_DEBUG_FOLDER)) {
// skip listing the debug folder, // skip listing the debug folder,
// which should always not involved in sync // which should always not involved in sync
continue; // continue;
} else { } else {
local.push(r); local.push(r);
} }
} }
this.profiler.insert("finish transforming walk for local"); this.profiler?.insert("finish transforming walk for local");
if (this.syncConfigDir) { if (this.syncConfigDir) {
this.profiler.insert("into syncConfigDir"); this.profiler?.insert("into syncConfigDir");
const syncFiles = await listFilesInObsFolder( const syncFiles = await listFilesInObsFolder(
this.configDir, this.configDir,
this.vault, this.vault,
@@ -101,14 +101,18 @@ export class FakeFsLocal extends FakeFs {
for (const f of syncFiles) { for (const f of syncFiles) {
local.push(f); local.push(f);
} }
this.profiler.insert("finish syncConfigDir"); this.profiler?.insert("finish syncConfigDir");
} }
this.profiler.insert("finish walk for local"); this.profiler?.insert("finish walk for local");
this.profiler.removeIndent(); this.profiler?.removeIndent();
return local; return local;
} }
async walkPartial(): Promise<Entity[]> {
return await this.walk();
}
async stat(key: string): Promise<Entity> { async stat(key: string): Promise<Entity> {
const statRes = await statFix(this.vault, key); const statRes = await statFix(this.vault, key);
if (statRes === undefined || statRes === null) { if (statRes === undefined || statRes === null) {
@@ -120,6 +124,8 @@ export class FakeFsLocal extends FakeFs {
keyRaw: isFolder ? `${key}/` : key, keyRaw: isFolder ? `${key}/` : key,
mtimeCli: statRes.mtime, mtimeCli: statRes.mtime,
mtimeSvr: statRes.mtime, mtimeSvr: statRes.mtime,
mtimeCliFmt: unixTimeToStr(statRes.mtime),
mtimeSvrFmt: unixTimeToStr(statRes.mtime),
size: statRes.size, // local always unencrypted size: statRes.size, // local always unencrypted
sizeRaw: statRes.size, sizeRaw: statRes.size,
}; };
@@ -168,4 +174,8 @@ export class FakeFsLocal extends FakeFs {
async revokeAuth(): Promise<any> { async revokeAuth(): Promise<any> {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
allowEmptyFile(): boolean {
return true;
}
} }
+9 -1
View File
@@ -1,4 +1,4 @@
import { Entity } from "./baseTypes"; import type { Entity } from "./baseTypes";
import { FakeFs } from "./fsAll"; import { FakeFs } from "./fsAll";
export class FakeFsMock extends FakeFs { export class FakeFsMock extends FakeFs {
@@ -13,6 +13,10 @@ export class FakeFsMock extends FakeFs {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
async walkPartial(): Promise<Entity[]> {
return await this.walk();
}
async stat(key: string): Promise<Entity> { async stat(key: string): Promise<Entity> {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
@@ -49,4 +53,8 @@ export class FakeFsMock extends FakeFs {
async revokeAuth(): Promise<any> { async revokeAuth(): Promise<any> {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
allowEmptyFile(): boolean {
throw new Error("Method not implemented.");
}
} }
+60 -12
View File
@@ -1,21 +1,21 @@
import { CryptoProvider, PublicClientApplication } from "@azure/msal-node";
import type { AuthenticationProvider } from "@microsoft/microsoft-graph-client";
import type { import type {
DriveItem, DriveItem,
FileSystemInfo, FileSystemInfo,
UploadSession, UploadSession,
User, User,
} from "@microsoft/microsoft-graph-types"; } 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 cloneDeep from "lodash/cloneDeep";
import { request, requestUrl } from "obsidian"; import { request, requestUrl } from "obsidian";
import { import {
COMMAND_CALLBACK_ONEDRIVE, COMMAND_CALLBACK_ONEDRIVE,
DEFAULT_CONTENT_TYPE, DEFAULT_CONTENT_TYPE,
Entity, type Entity,
OAUTH2_FORCE_EXPIRE_MILLISECONDS, OAUTH2_FORCE_EXPIRE_MILLISECONDS,
OnedriveConfig, type OnedriveConfig,
VALID_REQURL,
} from "./baseTypes"; } from "./baseTypes";
import { VALID_REQURL } from "./baseTypesObs";
import { FakeFs } from "./fsAll"; import { FakeFs } from "./fsAll";
import { bufferToArrayBuffer } from "./misc"; import { bufferToArrayBuffer } from "./misc";
@@ -32,6 +32,7 @@ export const DEFAULT_ONEDRIVE_CONFIG: OnedriveConfig = {
deltaLink: "", deltaLink: "",
username: "", username: "",
credentialsShouldBeDeletedAtTime: 0, credentialsShouldBeDeletedAtTime: 0,
emptyFile: "skip",
}; };
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@@ -344,6 +345,7 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
mtimeCli: mtimeCli, mtimeCli: mtimeCli,
size: isFolder ? 0 : x.size!, size: isFolder ? 0 : x.size!,
sizeRaw: isFolder ? 0 : x.size!, sizeRaw: isFolder ? 0 : x.size!,
synthesizedFile: false,
// hash: ?? // TODO // hash: ?? // TODO
}; };
}; };
@@ -567,6 +569,7 @@ export class FakeFsOnedrive extends FakeFs {
// TODO: // TODO:
// 20220401: On Android, requestUrl has issue that text becomes base64. // 20220401: On Android, requestUrl has issue that text becomes base64.
// Use fetch everywhere instead! // Use fetch everywhere instead!
// biome-ignore lint/correctness/noConstantCondition: hard code
if (false /*VALID_REQURL*/) { if (false /*VALID_REQURL*/) {
const res = await requestUrl({ const res = await requestUrl({
url: theUrl, url: theUrl,
@@ -617,6 +620,7 @@ export class FakeFsOnedrive extends FakeFs {
// TODO: // TODO:
// 20220401: On Android, requestUrl has issue that text becomes base64. // 20220401: On Android, requestUrl has issue that text becomes base64.
// Use fetch everywhere instead! // Use fetch everywhere instead!
// biome-ignore lint/correctness/noConstantCondition: hard code
if (false /*VALID_REQURL*/) { if (false /*VALID_REQURL*/) {
const res = await requestUrl({ const res = await requestUrl({
url: theUrl, url: theUrl,
@@ -658,7 +662,7 @@ export class FakeFsOnedrive extends FakeFs {
let res = await this._getJson( let res = await this._getJson(
`/drive/special/approot:/${this.remoteBaseDir}:/delta` `/drive/special/approot:/${this.remoteBaseDir}:/delta`
); );
let driveItems = res.value as DriveItem[]; const driveItems = res.value as DriveItem[];
// console.debug(driveItems); // console.debug(driveItems);
while (NEXT_LINK_KEY in res) { while (NEXT_LINK_KEY in res) {
@@ -680,6 +684,31 @@ export class FakeFsOnedrive extends FakeFs {
return unifiedContents; 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> { async stat(key: string): Promise<Entity> {
await this._init(); await this._init();
return await this._statFromRoot(getOnedrivePath(key, this.remoteBaseDir)); return await this._statFromRoot(getOnedrivePath(key, this.remoteBaseDir));
@@ -719,7 +748,7 @@ export class FakeFsOnedrive extends FakeFs {
} else { } else {
// https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api // https://stackoverflow.com/questions/56479865/creating-nested-folders-in-one-go-onedrive-api
// use PATCH to create folder recursively!!! // use PATCH to create folder recursively!!!
let playload: any = { const playload: any = {
folder: {}, folder: {},
"@microsoft.graph.conflictBehavior": "replace", "@microsoft.graph.conflictBehavior": "replace",
}; };
@@ -758,7 +787,8 @@ export class FakeFsOnedrive extends FakeFs {
content, content,
mtime, mtime,
ctime, ctime,
key key,
this.onedriveConfig.emptyFile
); );
} }
@@ -767,12 +797,26 @@ export class FakeFsOnedrive extends FakeFs {
content: ArrayBuffer, content: ArrayBuffer,
mtime: number, mtime: number,
ctime: number, ctime: number,
origKey: string origKey: string,
emptyFile: "skip" | "error"
): Promise<Entity> { ): Promise<Entity> {
if (content.byteLength === 0) { if (content.byteLength === 0) {
throw Error( if (emptyFile === "error") {
`${origKey}: Empty file is not allowed in OneDrive, and please write something in it.` 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 ctimeStr = new Date(ctime).toISOString();
@@ -926,4 +970,8 @@ export class FakeFsOnedrive extends FakeFs {
async getRevokeAddr() { async getRevokeAddr() {
return "https://account.live.com/consent/Manage"; return "https://account.live.com/consent/Manage";
} }
allowEmptyFile(): boolean {
return false;
}
} }
+62 -33
View File
@@ -1,35 +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 { import {
DeleteObjectCommand, DeleteObjectCommand,
GetObjectCommand, GetObjectCommand,
HeadObjectCommand, HeadObjectCommand,
HeadObjectCommandOutput, type HeadObjectCommandOutput,
ListObjectsV2Command, ListObjectsV2Command,
ListObjectsV2CommandInput, type ListObjectsV2CommandInput,
PutObjectCommand, PutObjectCommand,
S3Client, S3Client,
} from "@aws-sdk/client-s3"; } from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage"; import { Upload } from "@aws-sdk/lib-storage";
import { HttpRequest, HttpResponse } from "@smithy/protocol-http"; import type { HttpHandlerOptions } from "@aws-sdk/types";
import { import {
FetchHttpHandler, FetchHttpHandler,
FetchHttpHandlerOptions, type FetchHttpHandlerOptions,
} from "@smithy/fetch-http-handler"; } from "@smithy/fetch-http-handler";
// @ts-ignore // @ts-ignore
import { requestTimeout } from "@smithy/fetch-http-handler/dist-es/request-timeout"; 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 { buildQueryString } from "@smithy/querystring-builder";
import { HttpHandlerOptions } from "@aws-sdk/types"; // biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
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";
import AggregateError from "aggregate-error"; import AggregateError from "aggregate-error";
import { DEFAULT_CONTENT_TYPE, S3Config, VALID_REQURL } from "./baseTypes"; import * as mime from "mime-types";
import { bufferToArrayBuffer, getFolderLevels } from "./misc"; import { Platform, type RequestUrlParam, requestUrl } from "obsidian";
import PQueue from "p-queue"; import PQueue from "p-queue";
import { DEFAULT_CONTENT_TYPE, type S3Config } from "./baseTypes";
import { VALID_REQURL } from "./baseTypesObs";
import { bufferToArrayBuffer, getFolderLevels } from "./misc";
import { Entity } from "./baseTypes"; import type { Entity } from "./baseTypes";
import { FakeFs } from "./fsAll"; import { FakeFs } from "./fsAll";
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@@ -339,15 +341,16 @@ const fromS3ObjectToEntity = (
const fromS3HeadObjectToEntity = ( const fromS3HeadObjectToEntity = (
fileOrFolderPathWithRemotePrefix: string, fileOrFolderPathWithRemotePrefix: string,
x: HeadObjectCommandOutput, x: HeadObjectCommandOutput,
remotePrefix: string remotePrefix: string,
useAccurateMTime: boolean
) => { ) => {
// console.debug(`fromS3HeadObjectToEntity: ${fileOrFolderPathWithRemotePrefix}: ${JSON.stringify(x,null,2)}`); // console.debug(`fromS3HeadObjectToEntity: ${fileOrFolderPathWithRemotePrefix}: ${JSON.stringify(x,null,2)}`);
// S3 officially only supports seconds precision!!!!! // S3 officially only supports seconds precision!!!!!
const mtimeSvr = Math.floor(x.LastModified!.valueOf() / 1000.0) * 1000; const mtimeSvr = Math.floor(x.LastModified!.valueOf() / 1000.0) * 1000;
let mtimeCli = mtimeSvr; let mtimeCli = mtimeSvr;
if (x.Metadata !== undefined) { if (useAccurateMTime && x.Metadata !== undefined) {
const m2 = Math.floor( const m2 = Math.floor(
parseFloat(x.Metadata.mtime || x.Metadata.MTime || "0") Number.parseFloat(x.Metadata.mtime || x.Metadata.MTime || "0")
); );
if (m2 !== 0) { if (m2 !== 0) {
// to be compatible with RClone, we read and store the time in seconds in new version! // to be compatible with RClone, we read and store the time in seconds in new version!
@@ -396,9 +399,16 @@ export class FakeFsS3 extends FakeFs {
} }
async walk(): Promise<Entity[]> { async walk(): Promise<Entity[]> {
const res = (await this._walkFromRoot(this.s3Config.remotePrefix)).filter( const res = (
(x) => x.key !== "" && x.key !== "/" 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; return res;
} }
@@ -406,19 +416,23 @@ export class FakeFsS3 extends FakeFs {
* the input key contains basedir (prefix), * the input key contains basedir (prefix),
* but the result doesn't contain it. * but the result doesn't contain it.
*/ */
async _walkFromRoot(prefixOfRawKeys: string | undefined) { async _walkFromRoot(prefixOfRawKeys: string | undefined, partial: boolean) {
const confCmd = { const confCmd = {
Bucket: this.s3Config.s3BucketName, Bucket: this.s3Config.s3BucketName,
} as ListObjectsV2CommandInput; } as ListObjectsV2CommandInput;
if (prefixOfRawKeys !== undefined && prefixOfRawKeys !== "") { if (prefixOfRawKeys !== undefined && prefixOfRawKeys !== "") {
confCmd.Prefix = prefixOfRawKeys; confCmd.Prefix = prefixOfRawKeys;
} }
if (partial) {
confCmd.MaxKeys = 10; // no need to list more!
}
const contents = [] as _Object[]; const contents = [] as _Object[];
const mtimeRecords: Record<string, number> = {}; const mtimeRecords: Record<string, number> = {};
const ctimeRecords: Record<string, number> = {}; const ctimeRecords: Record<string, number> = {};
const partsConcurrency = partial ? 1 : this.s3Config.partsConcurrency;
const queueHead = new PQueue({ const queueHead = new PQueue({
concurrency: this.s3Config.partsConcurrency, concurrency: partsConcurrency,
autoStart: true, autoStart: true,
}); });
queueHead.on("error", (error) => { queueHead.on("error", (error) => {
@@ -456,12 +470,12 @@ export class FakeFsS3 extends FakeFs {
// pass // pass
} else { } else {
mtimeRecords[content.Key!] = Math.floor( mtimeRecords[content.Key!] = Math.floor(
parseFloat( Number.parseFloat(
rspHead.Metadata.mtime || rspHead.Metadata.MTime || "0" rspHead.Metadata.mtime || rspHead.Metadata.MTime || "0"
) )
); );
ctimeRecords[content.Key!] = Math.floor( ctimeRecords[content.Key!] = Math.floor(
parseFloat( Number.parseFloat(
rspHead.Metadata.ctime || rspHead.Metadata.CTime || "0" rspHead.Metadata.ctime || rspHead.Metadata.CTime || "0"
) )
); );
@@ -470,14 +484,20 @@ export class FakeFsS3 extends FakeFs {
} }
} }
isTruncated = rsp.IsTruncated ?? false; if (partial) {
confCmd.ContinuationToken = rsp.NextContinuationToken; // do not loop over
if ( isTruncated = false;
isTruncated && } else {
(confCmd.ContinuationToken === undefined || // loop over
confCmd.ContinuationToken === "") isTruncated = rsp.IsTruncated ?? false;
) { confCmd.ContinuationToken = rsp.NextContinuationToken;
throw Error("isTruncated is true but no continuationToken provided"); if (
isTruncated &&
(confCmd.ContinuationToken === undefined ||
confCmd.ContinuationToken === "")
) {
throw Error("isTruncated is true but no continuationToken provided");
}
} }
} while (isTruncated); } while (isTruncated);
@@ -560,7 +580,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> { async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
@@ -809,4 +834,8 @@ export class FakeFsS3 extends FakeFs {
async revokeAuth() { async revokeAuth() {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
allowEmptyFile(): boolean {
return true;
}
} }
+364 -33
View File
@@ -1,20 +1,23 @@
import { getReasonPhrase } from "http-status-codes/build/cjs/utils-functions";
import { Buffer } from "buffer"; import { Buffer } from "buffer";
import cloneDeep from "lodash/cloneDeep";
import { Queue } from "@fyears/tsqueue"; import { Queue } from "@fyears/tsqueue";
import { getReasonPhrase } from "http-status-codes/build/cjs/utils-functions";
import chunk from "lodash/chunk"; import chunk from "lodash/chunk";
import cloneDeep from "lodash/cloneDeep";
import flatten from "lodash/flatten"; import flatten from "lodash/flatten";
import { Platform, requestUrl } from "obsidian"; import isString from "lodash/isString";
import { FakeFs } from "./fsAll"; import { nanoid } from "nanoid";
import { bufferToArrayBuffer } from "./misc"; import { Platform, type RequestUrlParam, requestUrl } from "obsidian";
import { Entity, VALID_REQURL, WebdavConfig } from "./baseTypes";
import type { import type {
FileStat, FileStat,
WebDAVClient,
RequestOptionsWithState, RequestOptionsWithState,
WebDAVClient,
// Response, // Response,
// ResponseDataDetailed, // ResponseDataDetailed,
} from "webdav"; } 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 * https://stackoverflow.com/questions/32850898/how-to-check-if-a-string-has-any-non-iso-8859-1-characters-with-javascript
@@ -54,20 +57,35 @@ if (VALID_REQURL) {
retractedHeaders["authorization"] = "<retracted>"; retractedHeaders["authorization"] = "<retracted>";
} }
console.debug(`before request:`); // console.debug(`before request:`);
console.debug(`url: ${options.url}`); // console.debug(`url: ${options.url}`);
console.debug(`method: ${options.method}`); // console.debug(`method: ${options.method}`);
console.debug(`headers: ${JSON.stringify(retractedHeaders, null, 2)}`); // console.debug(`headers: ${JSON.stringify(retractedHeaders, null, 2)}`);
console.debug(`reqContentType: ${reqContentType}`); // console.debug(`reqContentType: ${reqContentType}`);
let r = await requestUrl({ const p: RequestUrlParam = {
url: options.url, url: options.url,
method: options.method, method: options.method,
body: options.data as string | ArrayBuffer, // body: options.data as string | ArrayBuffer,
headers: transformedHeaders, headers: transformedHeaders,
contentType: reqContentType, contentType: reqContentType,
throw: false, throw: false,
}); };
if (
options.data === undefined ||
options.data === null ||
isString(options.data)
) {
p.body = options.data;
} else {
if (typeof (options.data as any).transfer === "function") {
p.body = (options.data as any).transfer();
} else {
p.body = options.data as ArrayBuffer;
}
}
let r = await requestUrl(p);
if ( if (
r.status === 401 && r.status === 401 &&
@@ -81,20 +99,14 @@ if (VALID_REQURL) {
// if a folder doesn't exist without slash, the servers return 401 instead of 404 // if a folder doesn't exist without slash, the servers return 401 instead of 404
// here is a dirty hack that works // here is a dirty hack that works
console.debug(`so we have 401, try appending request url with slash`); console.debug(`so we have 401, try appending request url with slash`);
r = await requestUrl({ p.url = `${options.url}/`;
url: `${options.url}/`, r = await requestUrl(p);
method: options.method,
body: options.data as string | ArrayBuffer,
headers: transformedHeaders,
contentType: reqContentType,
throw: false,
});
} }
console.debug(`after request:`); // console.debug(`after request:`);
const rspHeaders = objKeyToLower({ ...r.headers }); const rspHeaders = objKeyToLower({ ...r.headers });
console.debug(`rspHeaders: ${JSON.stringify(rspHeaders, null, 2)}`); // console.debug(`rspHeaders: ${JSON.stringify(rspHeaders, null, 2)}`);
for (let key in rspHeaders) { for (const key in rspHeaders) {
if (rspHeaders.hasOwnProperty(key)) { if (rspHeaders.hasOwnProperty(key)) {
// avoid the error: // avoid the error:
// Failed to read the 'headers' property from 'ResponseInit': String contains non ISO-8859-1 code point. // Failed to read the 'headers' property from 'ResponseInit': String contains non ISO-8859-1 code point.
@@ -110,7 +122,7 @@ if (VALID_REQURL) {
// } // }
// } // }
if (!onlyAscii(rspHeaders[key])) { if (!onlyAscii(rspHeaders[key])) {
console.debug(`rspHeaders[key] needs encode: ${key}`); // console.debug(`rspHeaders[key] needs encode: ${key}`);
rspHeaders[key] = encodeURIComponent(rspHeaders[key]); rspHeaders[key] = encodeURIComponent(rspHeaders[key]);
} }
} }
@@ -118,7 +130,7 @@ if (VALID_REQURL) {
let r2: Response | undefined = undefined; let r2: Response | undefined = undefined;
const statusText = getReasonPhrase(r.status); const statusText = getReasonPhrase(r.status);
console.debug(`statusText: ${statusText}`); // console.debug(`statusText: ${statusText}`);
if ([101, 103, 204, 205, 304].includes(r.status)) { if ([101, 103, 204, 205, 304].includes(r.status)) {
// A null body status is a status that is 101, 103, 204, 205, or 304. // A null body status is a status that is 101, 103, 204, 205, or 304.
// https://fetch.spec.whatwg.org/#statuses // https://fetch.spec.whatwg.org/#statuses
@@ -142,6 +154,7 @@ if (VALID_REQURL) {
} }
// @ts-ignore // @ts-ignore
// biome-ignore lint: we want to ts-ignore the next line
import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js"; import { AuthType, BufferLike, createClient } from "webdav/dist/web/index.js";
export const DEFAULT_WEBDAV_CONFIG = { export const DEFAULT_WEBDAV_CONFIG = {
@@ -201,6 +214,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 { export class FakeFsWebdav extends FakeFs {
kind: "webdav"; kind: "webdav";
@@ -210,6 +231,10 @@ export class FakeFsWebdav extends FakeFs {
vaultFolderExists: boolean; vaultFolderExists: boolean;
saveUpdatedConfigFunc: () => Promise<any>; saveUpdatedConfigFunc: () => Promise<any>;
supportNativePartial: boolean;
isNextcloud: boolean;
nextcloudUploadServerAddress: string;
constructor( constructor(
webdavConfig: WebdavConfig, webdavConfig: WebdavConfig,
vaultName: string, vaultName: string,
@@ -218,10 +243,14 @@ export class FakeFsWebdav extends FakeFs {
super(); super();
this.kind = "webdav"; this.kind = "webdav";
this.webdavConfig = cloneDeep(webdavConfig); 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.remoteBaseDir = this.webdavConfig.remoteBaseDir || vaultName || "";
this.vaultFolderExists = false; this.vaultFolderExists = false;
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc; this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
this.supportNativePartial = false;
this.isNextcloud = false;
this.nextcloudUploadServerAddress = "";
} }
async _init() { async _init() {
@@ -291,6 +320,72 @@ export class FakeFsWebdav extends FakeFs {
); );
} }
} }
await this._checkPartialSupport();
}
_getnextcloudUploadServerAddress = () => {
const s = this.webdavConfig.address.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[]> { async walk(): Promise<Entity[]> {
@@ -355,6 +450,19 @@ export class FakeFsWebdav extends FakeFs {
return contents.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir)); 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> { async stat(key: string): Promise<Entity> {
await this._init(); await this._init();
const fullPath = getWebdavPath(key, this.remoteBaseDir); const fullPath = getWebdavPath(key, this.remoteBaseDir);
@@ -382,8 +490,10 @@ export class FakeFsWebdav extends FakeFs {
mtime?: number, mtime?: number,
ctime?: number ctime?: number
): Promise<Entity> { ): 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, { await this.client.createDirectory(key, {
recursive: true, recursive: false,
}); });
return await this._statFromRoot(key); return await this._statFromRoot(key);
} }
@@ -399,22 +509,239 @@ export class FakeFsWebdav extends FakeFs {
} }
await this._init(); await this._init();
const uploadFile = getWebdavPath(key, this.remoteBaseDir); 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( async _writeFileFromRoot(
key: string, key: string,
content: ArrayBuffer, content: ArrayBuffer,
mtime: number, mtime: number,
ctime: number ctime: number,
origKey: string
): Promise<Entity> { ): 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, 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(`no partial upload / update`);
} catch (e) {
console.error(
`we fail to write file partially, so downgrade to full and ignore the error:`
);
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, { await this.client.putFileContents(key, content, {
overwrite: true, overwrite: true,
onUploadProgress: (progress: any) => { onUploadProgress: (progress: any) => {
console.info(`Uploaded ${progress.loaded} bytes of ${progress.total}`); 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> { async readFile(key: string): Promise<ArrayBuffer> {
@@ -491,4 +818,8 @@ export class FakeFsWebdav extends FakeFs {
async revokeAuth() { async revokeAuth() {
throw new Error("Method not implemented."); throw new Error("Method not implemented.");
} }
allowEmptyFile(): boolean {
return true;
}
} }
+265
View File
@@ -0,0 +1,265 @@
import { isEqual } from "lodash";
import {
DEFAULT_CONTENT_TYPE,
type Entity,
type WebdisConfig,
} from "./baseTypes";
import { FakeFs } from "./fsAll";
export const DEFAULT_WEBDIS_CONFIG: WebdisConfig = {
address: "",
username: "",
password: "",
remoteBaseDir: "",
};
const getWebdisPath = (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}`;
}
return `rs:fs:v1:${encodeURIComponent(key)}`; // we should encode them!!!!
};
export const getOrigPath = (fullKey: string, remoteBaseDir: string) => {
const fullKeyDecoded = decodeURIComponent(fullKey);
const prefix = `rs:fs:v1:${remoteBaseDir}/`;
// console.debug(`prefix=${prefix}`);
const suffix1 = ":meta";
const suffix2 = ":content";
if (!fullKeyDecoded.startsWith(prefix)) {
throw Error(`you should not call getOrigEntity on ${fullKey}`);
}
let realKey = fullKeyDecoded.slice(prefix.length);
// console.debug(`realKey=${realKey}`);
if (realKey.endsWith(suffix1)) {
realKey = realKey.slice(0, -suffix1.length);
// console.debug(`realKey=${realKey}`);
} else if (realKey.endsWith(suffix2)) {
realKey = realKey.slice(0, -suffix2.length);
// console.debug(`realKey=${realKey}`);
}
// console.debug(`fullKey=${fullKey}, realKey=${realKey}`);
return realKey;
};
export class FakeFsWebdis extends FakeFs {
kind: "webdis";
webdisConfig: WebdisConfig;
remoteBaseDir: string;
saveUpdatedConfigFunc: () => Promise<any>;
constructor(
webdisConfig: WebdisConfig,
vaultName: string,
saveUpdatedConfigFunc: () => Promise<any>
) {
super();
this.kind = "webdis";
this.webdisConfig = webdisConfig;
this.remoteBaseDir = this.webdisConfig.remoteBaseDir || vaultName || "";
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
}
async _fetchCommand(
method: "GET" | "POST" | "PUT",
urlPath: string,
content?: ArrayBuffer
) {
const address = this.webdisConfig.address;
if (!address.startsWith(`https://`) && !address.startsWith(`http://`)) {
throw Error(
`your webdis server address should start with https:// or http://`
);
}
if (address.endsWith("/")) {
throw Error(`your webdis server should not ends with /`);
}
if (content !== undefined && method !== "PUT") {
throw Error(`you can only "POST" ArrayBuffer, not using other methods`);
}
const fullUrl = `${address}/${urlPath}`;
// console.debug(`fullUrl=${fullUrl}`)
const username = this.webdisConfig.username ?? "";
const password = this.webdisConfig.password ?? "";
if (username !== "" && password !== "") {
return await fetch(fullUrl, {
method: method,
headers: {
Authorization: "Basic " + btoa(username + ":" + password),
},
body: content,
});
} else if (username === "" && password === "") {
return await fetch(fullUrl, {
method: method,
body: content,
});
} else {
throw Error(
`your username and password should both be empty or not empty!`
);
}
}
async walk(): Promise<Entity[]> {
let cursor = "0";
const res: Entity[] = [];
do {
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:*:meta/COUNT/1000`;
const rsp = (await (await this._fetchCommand("GET", command)).json())[
"SCAN"
];
// console.debug(rsp);
cursor = rsp[0];
for (const fullKeyWithMeta of rsp[1]) {
const realKey = getOrigPath(fullKeyWithMeta, this.remoteBaseDir);
res.push(await this.stat(realKey));
}
} while (cursor !== "0");
// console.debug(`walk res:`);
// console.debug(res);
return res;
}
async walkPartial(): Promise<Entity[]> {
let cursor = "0";
const res: Entity[] = [];
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:*:meta/COUNT/10`; // fewer keys
const rsp = (await (await this._fetchCommand("GET", command)).json())[
"SCAN"
];
// console.debug(rsp);
cursor = rsp[0];
for (const fullKeyWithMeta of rsp[1]) {
const realKey = getOrigPath(fullKeyWithMeta, this.remoteBaseDir);
res.push(await this.stat(realKey));
}
// no need to loop over cursor
// console.debug(`walk res:`);
// console.debug(res);
return res;
}
async stat(key: string): Promise<Entity> {
const fullKey = getWebdisPath(key, this.remoteBaseDir);
return await this._statFromRaw(fullKey);
}
async _statFromRaw(key: string): Promise<Entity> {
// console.debug(`_statFromRaw on ${key}`);
const command = `HGETALL/${key}:meta`;
const rsp = (await (await this._fetchCommand("GET", command)).json())[
"HGETALL"
];
// console.debug(`rsp: ${JSON.stringify(rsp, null, 2)}`);
if (isEqual(rsp, {})) {
// empty!
throw Error(`key ${key} doesn't exist!`);
}
const realKey = getOrigPath(key, this.remoteBaseDir);
return {
key: realKey,
keyRaw: realKey,
mtimeCli: Number.parseInt(rsp["mtime"]),
mtimeSvr: Number.parseInt(rsp["mtime"]),
size: Number.parseInt(rsp["size"]),
sizeRaw: Number.parseInt(rsp["size"]),
};
}
async mkdir(key: string, mtime?: number, ctime?: number): Promise<Entity> {
let command = `HSET/${getWebdisPath(key, this.remoteBaseDir)}:meta/size/0`;
if (mtime !== undefined && mtime !== 0) {
command = `${command}/mtime/${mtime}`;
}
if (ctime !== undefined && ctime !== 0) {
command = `${command}/ctime/${ctime}`;
}
const rsp = (await (await this._fetchCommand("GET", command)).json())[
"HSET"
];
return await this.stat(key);
}
async writeFile(
key: string,
content: ArrayBuffer,
mtime: number,
ctime: number
): Promise<Entity> {
const fullKey = getWebdisPath(key, this.remoteBaseDir);
// meta
let command1 = `HSET/${fullKey}:meta/size/${content.byteLength}`;
if (mtime !== undefined && mtime !== 0) {
command1 = `${command1}/mtime/${mtime}`;
}
if (ctime !== undefined && ctime !== 0) {
command1 = `${command1}/ctime/${ctime}`;
}
const rsp1 = (await (await this._fetchCommand("GET", command1)).json())[
"HSET"
];
// content
const command2 = `SET/${fullKey}:content`;
const rsp2 = (
await (await this._fetchCommand("PUT", command2, content)).json()
)["SET"];
// fetch meta
return await this.stat(key);
}
async readFile(key: string): Promise<ArrayBuffer> {
const fullKey = getWebdisPath(key, this.remoteBaseDir);
const command = `GET/${fullKey}:content?type=${DEFAULT_CONTENT_TYPE}`;
const rsp = await (await this._fetchCommand("GET", command)).arrayBuffer();
return rsp;
}
async rm(key: string): Promise<void> {
const fullKey = getWebdisPath(key, this.remoteBaseDir);
const command = `DEL/${fullKey}:meta/${fullKey}:content`;
const rsp = (await (await this._fetchCommand("PUT", command)).json())[
"DEL"
];
}
async checkConnect(callbackFunc?: any): Promise<boolean> {
try {
const k = await (
await this._fetchCommand("GET", "PING/helloworld")
).json();
return isEqual(k, { PING: "helloworld" });
} catch (err: any) {
console.error(err);
callbackFunc?.(err);
return false;
}
}
async getUserDisplayName(): Promise<string> {
return this.webdisConfig.username || "<no usernme>";
}
async revokeAuth(): Promise<any> {
throw new Error("Method not implemented.");
}
allowEmptyFile(): boolean {
return true;
}
}
+5 -5
View File
@@ -1,11 +1,11 @@
import QRCode from "qrcode";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import QRCode from "qrcode";
import { import {
COMMAND_URI, COMMAND_URI,
UriParams, type QRExportType,
RemotelySavePluginSettings, type RemotelySavePluginSettings,
QRExportType, type UriParams,
} from "./baseTypes"; } from "./baseTypes";
import { getShrinkedSettings } from "./fsOnedrive"; import { getShrinkedSettings } from "./fsOnedrive";
@@ -64,7 +64,7 @@ export const importQrCodeUri = (
inputParams: any, inputParams: any,
currentVaultName: string currentVaultName: string
): ProcessQrCodeResultType => { ): ProcessQrCodeResultType => {
let params = inputParams as UriParams; const params = inputParams as UriParams;
if ( if (
params.func === undefined || params.func === undefined ||
params.func !== "settings" || params.func !== "settings" ||
+37 -11
View File
@@ -9,9 +9,9 @@
"syncrun_syncingribbon": "{{pluginName}}: syncing from {{triggerSource}}", "syncrun_syncingribbon": "{{pluginName}}: syncing from {{triggerSource}}",
"syncrun_step0": "0/8 Remotely Save is running in dry mode, thus not actual file changes would happen.", "syncrun_step0": "0/8 Remotely Save is running in dry mode, thus not actual file changes would happen.",
"syncrun_step1": "1/8 Remotely Save is preparing ({{serviceType}})", "syncrun_step1": "1/8 Remotely Save is preparing ({{serviceType}})",
"syncrun_step2": "2/8 Starting to fetch remote meta data.", "syncrun_step2": "2/8 Starting to fetch remote meta data and check password.",
"syncrun_step3": "3/8 Checking password correct or not.",
"syncrun_passworderr": "Something goes wrong while checking password.", "syncrun_passworderr": "Something goes wrong while checking password.",
"syncrun_step3": "3/8 Starting to process remote data.",
"syncrun_step4": "4/8 Starting to fetch local meta data.", "syncrun_step4": "4/8 Starting to fetch local meta data.",
"syncrun_step5": "5/8 Starting to fetch local prev sync data.", "syncrun_step5": "5/8 Starting to fetch local prev sync data.",
"syncrun_step6": "6/8 Starting to generate sync plan.", "syncrun_step6": "6/8 Starting to generate sync plan.",
@@ -38,6 +38,7 @@
"protocol_onedrive_connect_unknown": "Do not know how to deal with the callback: {{params}}", "protocol_onedrive_connect_unknown": "Do not know how to deal with the callback: {{params}}",
"command_startsync": "start sync", "command_startsync": "start sync",
"command_drynrun": "start sync (dry run only)", "command_drynrun": "start sync (dry run only)",
"command_exportsyncplans_1_only_change": "export sync plans (latest 1) (change part)",
"command_exportsyncplans_1": "export sync plans (latest 1)", "command_exportsyncplans_1": "export sync plans (latest 1)",
"command_exportsyncplans_5": "export sync plans (latest 5)", "command_exportsyncplans_5": "export sync plans (latest 5)",
"command_exportsyncplans_all": "export sync plans (all)", "command_exportsyncplans_all": "export sync plans (all)",
@@ -50,9 +51,10 @@
"statusbar_time_days": "Synced {{time}} days ago", "statusbar_time_days": "Synced {{time}} days ago",
"statusbar_time_hours": "Synced {{time}} hours ago", "statusbar_time_hours": "Synced {{time}} hours ago",
"statusbar_time_minutes": "Synced {{time}} minutes ago", "statusbar_time_minutes": "Synced {{time}} minutes ago",
"statusbar_time_lessminute": "Synced less than a minute ago", "statusbar_time_lessminute": "Synced last minute ago",
"statusbar_lastsync": "Synced {{time}} ago", "statusbar_lastsync": "Synced {{time}} ago",
"statusbar_syncing": "Syncing...", "statusbar_syncing": "Syncing...",
"statusbar_failed": "Last sync failed",
"statusbar_now": "Synced just now", "statusbar_now": "Synced just now",
"statusbar_lastsync_label": "Last successful Sync on {{date}}", "statusbar_lastsync_label": "Last successful Sync on {{date}}",
"statusbar_lastsync_never": "Never Synced", "statusbar_lastsync_never": "Never Synced",
@@ -114,9 +116,9 @@
"modal_sizesconflict_copynotice": "All the sizes conflicts info have been copied to the clipboard!", "modal_sizesconflict_copynotice": "All the sizes conflicts info have been copied to the clipboard!",
"settings_basic": "Basic Settings", "settings_basic": "Basic Settings",
"settings_password": "Encryption Password", "settings_password": "Encryption Password",
"settings_password_desc": "Password for E2E encryption. Empty for no password. You need to click \"Confirm\". Attention: The password and other info are saved locally. After changing the password, you need to manually delete every original files in the remote, and re-sync (so that upload) the encrypted files again.", "settings_password_desc": "Password for E2E encryption. Empty for no password. You need to click \"Confirm\". Attention: The password and other info are saved locally. After changing the password, you need to manually delete all files from the remote location and re-sync to upload the encrypted files again.",
"settings_encryptionmethod": "Encryption Method", "settings_encryptionmethod": "Encryption Method",
"settings_encryptionmethod_desc": "Encryption method for E2E encryption. RClone Crypt format is recommended but it doesn't encrypt path structure. OpenSSL enc is the legacy format of this plugin. <b>Both are not affliated with official RClone and OpenSSL product or community.</b> Attention: After switching the method, you need to manually delete every original files in the remote and re-sync (so that upload) the encrypted files again. More info in the <a href='https://github.com/remotely-save/remotely-save/tree/master/docs/encryption'>online doc</a>.", "settings_encryptionmethod_desc": "Encryption method for E2E encryption. The RClone Crypt format is recommended, although it does not encrypt the path structure. OpenSSL enc is the legacy format of this plugin. <b>Both are not affliated with the official RClone and OpenSSL products or communities.</b> Attention: After switching encryption methods, you need to manually delete all original files from the remote location and re-sync to upload the encrypted files again. More info is available in the <a href='https://github.com/remotely-save/remotely-save/tree/master/docs/encryption'>online doc</a>.",
"settings_encryptionmethod_rclone": "RClone Crypt (recommended)", "settings_encryptionmethod_rclone": "RClone Crypt (recommended)",
"settings_encryptionmethod_openssl": "OpenSSL enc (legacy)", "settings_encryptionmethod_openssl": "OpenSSL enc (legacy)",
@@ -128,7 +130,7 @@
"settings_autorun_10min": "every 10 minutes", "settings_autorun_10min": "every 10 minutes",
"settings_autorun_30min": "every 30 minutes", "settings_autorun_30min": "every 30 minutes",
"settings_runoncestartup": "Run Once On Start Up Automatically", "settings_runoncestartup": "Run Once On Start Up Automatically",
"settings_runoncestartup_desc": "This settings allows setting running ONCE on start up automatically. This will take effect on NEXT start up after changing. This setting, is different from \"schedule for auto run\" which starts syncing after EVERY interval.", "settings_runoncestartup_desc": "This setting causes the sync to run once automatically at startup. Changes will take effect on the NEXT startup. This setting is different from the \"schedule for auto run\" setting, which initiates syncing after every specified interval.",
"settings_runoncestartup_notset": "(not set)", "settings_runoncestartup_notset": "(not set)",
"settings_runoncestartup_1sec": "sync once after 1 second of start up", "settings_runoncestartup_1sec": "sync once after 1 second of start up",
"settings_runoncestartup_10sec": "sync once after 10 seconds of start up", "settings_runoncestartup_10sec": "sync once after 10 seconds of start up",
@@ -218,8 +220,12 @@
"settings_onedrive_auth": "Auth", "settings_onedrive_auth": "Auth",
"settings_onedrive_auth_desc": "Auth.", "settings_onedrive_auth_desc": "Auth.",
"settings_onedrive_auth_button": "Auth", "settings_onedrive_auth_button": "Auth",
"settings_onedrive_connect_succ": "Great! We can connect to Onedrive!", "settings_onedrive_connect_succ": "Great! We can connect to OneDrive!",
"settings_onedrive_connect_fail": "We cannot connect to Onedrive.", "settings_onedrive_connect_fail": "We cannot connect to OneDrive.",
"settings_onedrive_emptyfile": "Empty File Handling",
"settings_onedrive_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_onedrive_emptyfile_skip": "Skip",
"settings_onedrive_emptyfile_error": "Error and abort",
"settings_webdav": "Remote For Webdav", "settings_webdav": "Remote For Webdav",
"settings_webdav_disclaimer1": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your webdav server, please immediately change the username and password.", "settings_webdav_disclaimer1": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your webdav server, please immediately change the username and password.",
"settings_webdav_cors_os": "Obsidian desktop>=0.13.25 or iOS>=1.1.1 or Android>=1.2.1 supports bypassing CORS locally. But you are using an old version, and you're suggested to upgrade Obsidian.", "settings_webdav_cors_os": "Obsidian desktop>=0.13.25 or iOS>=1.1.1 or Android>=1.2.1 supports bypassing CORS locally. But you are using an old version, and you're suggested to upgrade Obsidian.",
@@ -232,7 +238,7 @@
"settings_webdav_password": "Password", "settings_webdav_password": "Password",
"settings_webdav_password_desc": "Password. Attention: the password and other info are saved locally.", "settings_webdav_password_desc": "Password. Attention: the password and other info are saved locally.",
"settings_webdav_auth": "Auth Type", "settings_webdav_auth": "Auth Type",
"settings_webdav_auth_desc": "If no password, this option would be ignored.", "settings_webdav_auth_desc": "If no password is provided, this option will be ignored.",
"settings_webdav_depth": "Depth Header Sent To Servers", "settings_webdav_depth": "Depth Header Sent To Servers",
"settings_webdav_depth_desc": "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. If you are not sure what's this, choose \"depth='1'\". If you are sure your server supports depth='infinity', please choose that to get way better performance.", "settings_webdav_depth_desc": "Webdav servers should be configured to allow requests with header Depth being '1' or 'Infinity'. If you are not sure what's this, choose \"depth='1'\". If you are sure your server supports depth='infinity', please choose that to get way better performance.",
"settings_webdav_depth_1": "only supports depth='1'", "settings_webdav_depth_1": "only supports depth='1'",
@@ -240,12 +246,25 @@
"settings_webdav_connect_succ": "Great! The webdav server can be accessed.", "settings_webdav_connect_succ": "Great! The webdav server can be accessed.",
"settings_webdav_connect_fail": "The webdav server cannot be reached (possible to be any of address/username/password/authtype errors).", "settings_webdav_connect_fail": "The webdav server cannot be reached (possible to be any of address/username/password/authtype errors).",
"settings_webdav_connect_fail_withcors": "The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors).", "settings_webdav_connect_fail_withcors": "The webdav server cannot be reached (possible to be any of address/username/password/authtype/CORS errors).",
"settings_webdis": "Remote For Webdis",
"settings_webdis_disclaimer1": "Disclaimer: This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.",
"settings_webdis_disclaimer2": "Disclaimer: The information is stored locally. Other malicious/harmful/faulty plugins may read the info. If you see any unintentional access to your Webdis server, please immediately change the username and password.",
"settings_webdis_folder": "We will store the value with keys prefixed by :{{remoteBaseDir}} on your server.",
"settings_webdis_addr": "Server Address",
"settings_webdis_addr_desc": "Server address.",
"settings_webdis_user": "Username",
"settings_webdis_user_desc": "Username. Attention: the username and other info are saved locally.",
"settings_webdis_password": "Password",
"settings_webdis_password_desc": "Password. Attention: the password and other info are saved locally.",
"settings_webdis_connect_succ": "Great! The Webdis server can be accessed.",
"settings_webdis_connect_fail": "The Webdis server cannot be reached (possible to be any of address/username/password errors).",
"settings_chooseservice": "Choose A Remote Service", "settings_chooseservice": "Choose A Remote Service",
"settings_chooseservice_desc": "Start here. What service are you connecting to? S3, Dropbox, Webdav, or OneDrive for personal?", "settings_chooseservice_desc": "Start here. What service are you connecting to? S3, Dropbox, Webdav, OneDrive for personal, or Webdis?",
"settings_chooseservice_s3": "S3 or compatible", "settings_chooseservice_s3": "S3 or compatible",
"settings_chooseservice_dropbox": "Dropbox", "settings_chooseservice_dropbox": "Dropbox",
"settings_chooseservice_webdav": "Webdav", "settings_chooseservice_webdav": "Webdav",
"settings_chooseservice_onedrive": "OneDrive for personal", "settings_chooseservice_onedrive": "OneDrive for personal",
"settings_chooseservice_webdis": "Webdis (HTTP for Redis®)",
"settings_adv": "Advanced Settings", "settings_adv": "Advanced Settings",
"settings_concurrency": "Concurrency", "settings_concurrency": "Concurrency",
"settings_concurrency_desc": "How many files do you want to download or upload in parallel at most? By default it's set to 5. If you meet any problems such as rate limit, you can reduce the concurrency to a lower value.", "settings_concurrency_desc": "How many files do you want to download or upload in parallel at most? By default it's set to 5. If you meet any problems such as rate limit, you can reduce the concurrency to a lower value.",
@@ -300,6 +319,7 @@
"settings_viewconsolelog_desc": "On desktop, please press \"ctrl+shift+i\" or \"cmd+shift+i\" to view the log. On mobile, please install the third-party plugin <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> to export the console log to a note.", "settings_viewconsolelog_desc": "On desktop, please press \"ctrl+shift+i\" or \"cmd+shift+i\" to view the log. On mobile, please install the third-party plugin <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> to export the console log to a note.",
"settings_syncplans": "Export Sync Plans", "settings_syncplans": "Export Sync Plans",
"settings_syncplans_desc": "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync. Click the button to export sync plans.", "settings_syncplans_desc": "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync. Click the button to export sync plans.",
"settings_syncplans_button_1_only_change": "Export latest 1 (change part)",
"settings_syncplans_button_1": "Export latest 1", "settings_syncplans_button_1": "Export latest 1",
"settings_syncplans_button_5": "Export latest 5", "settings_syncplans_button_5": "Export latest 5",
"settings_syncplans_button_all": "Export All", "settings_syncplans_button_all": "Export All",
@@ -316,6 +336,10 @@
"settings_profiler_results_desc": "The plugin records the time cost of each steps. Here you can export them to know which step is slow.", "settings_profiler_results_desc": "The plugin records the time cost of each steps. Here you can export them to know which step is slow.",
"settings_profiler_results_notice": "Profiler results exported.", "settings_profiler_results_notice": "Profiler results exported.",
"settings_profiler_results_button_all": "Export All", "settings_profiler_results_button_all": "Export All",
"settings_profiler_enabledebugprint": "Enable Profiler Printing",
"settings_profiler_enabledebugprint_desc": "Print profiler result in each insertion to console or not?",
"settings_profiler_recordsize": "Enable Profiler Recording Size",
"settings_profiler_recordsize_desc": "Let profiler record object sizes or not?",
"settings_outputbasepathvaultid": "Output Vault Base Path And Randomly Assigned ID", "settings_outputbasepathvaultid": "Output Vault Base Path And Randomly Assigned ID",
"settings_outputbasepathvaultid_desc": "For debugging purposes.", "settings_outputbasepathvaultid_desc": "For debugging purposes.",
"settings_outputbasepathvaultid_button": "Output", "settings_outputbasepathvaultid_button": "Output",
@@ -329,5 +353,7 @@
"syncalgov3_checkbox_manual_backup": "I will backup my vault manually firstly.", "syncalgov3_checkbox_manual_backup": "I will backup my vault manually firstly.",
"syncalgov3_checkbox_requiremultidevupdate": "I understand I need to update the plugin ACROSS ALL DEVICES to make them work properly.", "syncalgov3_checkbox_requiremultidevupdate": "I understand I need to update the plugin ACROSS ALL DEVICES to make them work properly.",
"syncalgov3_button_agree": "Agree", "syncalgov3_button_agree": "Agree",
"syncalgov3_button_disagree": "Do Not Agree" "syncalgov3_button_disagree": "Do Not Agree",
"menu_check_file_stat": "Check file stats"
} }
+26 -4
View File
@@ -9,9 +9,9 @@
"syncrun_syncingribbon": "{{pluginName}}:正在由 {{triggerSource}} 触发运行", "syncrun_syncingribbon": "{{pluginName}}:正在由 {{triggerSource}} 触发运行",
"syncrun_step0": "0/8 Remotely Save 在空跑(dry run)模式,不会发生实际的文件交换。", "syncrun_step0": "0/8 Remotely Save 在空跑(dry run)模式,不会发生实际的文件交换。",
"syncrun_step1": "1/8 Remotely Save 准备同步({{serviceType}}", "syncrun_step1": "1/8 Remotely Save 准备同步({{serviceType}}",
"syncrun_step2": "2/8 正在获取远端的元数据。", "syncrun_step2": "2/8 正在获取远端的元数据和检查密码。",
"syncrun_step3": "3/8 正在检查密码正确与否。",
"syncrun_passworderr": "检查密码时候出错。", "syncrun_passworderr": "检查密码时候出错。",
"syncrun_step3": "3/8 正在处理远端的元数据。",
"syncrun_step4": "4/8 正在获取本地的元数据。", "syncrun_step4": "4/8 正在获取本地的元数据。",
"syncrun_step5": "5/8 正在获取本地上一次同步的元数据。", "syncrun_step5": "5/8 正在获取本地上一次同步的元数据。",
"syncrun_step6": "6/8 正在生成同步计划。", "syncrun_step6": "6/8 正在生成同步计划。",
@@ -39,6 +39,7 @@
"command_startsync": "开始同步(start sync", "command_startsync": "开始同步(start sync",
"command_drynrun": "开始同步(空跑模式)(start sync (dry run only)", "command_drynrun": "开始同步(空跑模式)(start sync (dry run only)",
"command_exportsyncplans_json": "导出同步计划为 json 格式(export sync plans in json format", "command_exportsyncplans_json": "导出同步计划为 json 格式(export sync plans in json format",
"command_exportsyncplans_1_only_change": "导出同步计划(最近 1 次)(仅修改部分)(export sync plans (latest 1) (change part)",
"command_exportsyncplans_1": "导出同步计划(最近 1 次)(export sync plans (latest 1)", "command_exportsyncplans_1": "导出同步计划(最近 1 次)(export sync plans (latest 1)",
"command_exportsyncplans_5": "导出同步计划(最近 5 次)(export sync plans (latest 5)", "command_exportsyncplans_5": "导出同步计划(最近 5 次)(export sync plans (latest 5)",
"command_exportsyncplans_all": "导出同步计划(所有)(export sync plans (all)", "command_exportsyncplans_all": "导出同步计划(所有)(export sync plans (all)",
@@ -53,6 +54,7 @@
"statusbar_time_lessminute": "一分钟之内同步", "statusbar_time_lessminute": "一分钟之内同步",
"statusbar_lastsync": "上一次同步于:{{time}}", "statusbar_lastsync": "上一次同步于:{{time}}",
"statusbar_syncing": "正在同步", "statusbar_syncing": "正在同步",
"statusbar_failed": "上次同步失败了",
"statusbar_now": "刚同步完", "statusbar_now": "刚同步完",
"statusbar_lastsync_label": "上一次同步于:{{date}}", "statusbar_lastsync_label": "上一次同步于:{{date}}",
"statusbar_lastsync_never": "没触发过同步", "statusbar_lastsync_never": "没触发过同步",
@@ -219,6 +221,10 @@
"settings_onedrive_auth_button": "鉴权", "settings_onedrive_auth_button": "鉴权",
"settings_onedrive_connect_succ": "很好!我们可连接上 OneDrive", "settings_onedrive_connect_succ": "很好!我们可连接上 OneDrive",
"settings_onedrive_connect_fail": "我们未能连接上 OneDrive。", "settings_onedrive_connect_fail": "我们未能连接上 OneDrive。",
"settings_onedrive_emptyfile": "空文件处理",
"settings_onedrive_emptyfile_desc": "OneDrive 不允许上传空文件(即使官网也是不允许的)。那么你想跳过空文件还是返回错误?",
"settings_onedrive_emptyfile_skip": "跳过",
"settings_onedrive_emptyfile_error": "返回错误和中断",
"settings_webdav": "Webdav 设置", "settings_webdav": "Webdav 设置",
"settings_webdav_disclaimer1": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现了 Webdav 服务器有不符合预期的访问,请立刻修改用户名和密码。", "settings_webdav_disclaimer1": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现了 Webdav 服务器有不符合预期的访问,请立刻修改用户名和密码。",
"settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1 支持跳过 CORS 设置。但您正在使用旧版,建议升级。", "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.2.1 支持跳过 CORS 设置。但您正在使用旧版,建议升级。",
@@ -239,12 +245,25 @@
"settings_webdav_connect_succ": "很好!可以连接上 Webdav 服务器。", "settings_webdav_connect_succ": "很好!可以连接上 Webdav 服务器。",
"settings_webdav_connect_fail": "无法连接上 Webdav 服务器。(可能是地址/账号/密码/鉴权类型等错误。)", "settings_webdav_connect_fail": "无法连接上 Webdav 服务器。(可能是地址/账号/密码/鉴权类型等错误。)",
"settings_webdav_connect_fail_withcors": "无法连接上 Webdav 服务器。(可能是地址/账号/密码/鉴权类型/CORS 等错误。)", "settings_webdav_connect_fail_withcors": "无法连接上 Webdav 服务器。(可能是地址/账号/密码/鉴权类型/CORS 等错误。)",
"settings_webdis": "Webdis 设置",
"settings_webdis_disclaimer1": "声明:此插件不是 Redis® Ltd 或 Redis® 软件或 Wedis 的官方产品。Redis 是 Redis Ltd 的注册商标。",
"settings_webdis_disclaimer2": "声明:您所输入的信息存储于本地。其它有害的或者出错的插件,是有可能读取到这些信息的。如果您发现了 Webdis 服务器有不符合预期的访问,请立刻修改用户名和密码。",
"settings_webdis_folder": "我们会在您的服务器上创建带有此前缀的 key 并在里面同步::{{remoteBaseDir}}。",
"settings_webdis_addr": "服务器地址",
"settings_webdis_addr_desc": "服务器地址",
"settings_webdis_user": "用户名",
"settings_webdis_user_desc": "用户名。注意:用户名和其它信息都会保存在本地。",
"settings_webdis_password": "密码",
"settings_webdis_password_desc": "密码。注意:密码和其它信息都会保存在本地。",
"settings_webdis_connect_succ": "很好!可以连接上 Webdis 服务器。",
"settings_webdis_connect_fail": "无法连接上 Webdis 服务器。(可能是地址/账号/密码/鉴权类型等错误。)",
"settings_chooseservice": "选择远程服务", "settings_chooseservice": "选择远程服务",
"settings_chooseservice_desc": "从这里开始设置。您想连接到哪一个服务?S3、Dropbox、Webdav、OneDrive(个人版)?", "settings_chooseservice_desc": "从这里开始设置。您想连接到哪一个服务?S3、Dropbox、Webdav、OneDrive(个人版)、Webdis",
"settings_chooseservice_s3": "S3 或兼容 S3 的服务", "settings_chooseservice_s3": "S3 或兼容 S3 的服务",
"settings_chooseservice_dropbox": "Dropbox", "settings_chooseservice_dropbox": "Dropbox",
"settings_chooseservice_webdav": "Webdav", "settings_chooseservice_webdav": "Webdav",
"settings_chooseservice_onedrive": "OneDrive(个人版)", "settings_chooseservice_onedrive": "OneDrive(个人版)",
"settings_chooseservice_webdis": "Webdis (an HTTP interface for Redis)",
"settings_adv": "进阶设置", "settings_adv": "进阶设置",
"settings_concurrency": "并行度", "settings_concurrency": "并行度",
"settings_concurrency_desc": "您希望同时最多有多少个文件被上传和下载?默认值是 5。如果您遇到了一些问题(如访问频率限制),您可以减少并行度。", "settings_concurrency_desc": "您希望同时最多有多少个文件被上传和下载?默认值是 5。如果您遇到了一些问题(如访问频率限制),您可以减少并行度。",
@@ -299,6 +318,7 @@
"settings_viewconsolelog_desc": "电脑上,输入“ctrl+shift+i”或“cmd+shift+i”来查看终端输出。手机上,安装第三方插件 <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> 来导出终端输出到一篇笔记上。", "settings_viewconsolelog_desc": "电脑上,输入“ctrl+shift+i”或“cmd+shift+i”来查看终端输出。手机上,安装第三方插件 <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> 来导出终端输出到一篇笔记上。",
"settings_syncplans": "导出同步计划", "settings_syncplans": "导出同步计划",
"settings_syncplans_desc": "每次您启动同步,并在实际上传下载前,插件会生成同步计划。它可以使您知道每次同步发生了什么。点击按钮可以导出同步计划。", "settings_syncplans_desc": "每次您启动同步,并在实际上传下载前,插件会生成同步计划。它可以使您知道每次同步发生了什么。点击按钮可以导出同步计划。",
"settings_syncplans_button_1_only_change": "导出最近 1 次(仅修改部分)",
"settings_syncplans_button_1": "导出最近 1 次", "settings_syncplans_button_1": "导出最近 1 次",
"settings_syncplans_button_5": "导出最近 5 次", "settings_syncplans_button_5": "导出最近 5 次",
"settings_syncplans_button_all": "导出所有", "settings_syncplans_button_all": "导出所有",
@@ -328,5 +348,7 @@
"syncalgov3_checkbox_manual_backup": "我将会首先手动备份我的库(Vault)。", "syncalgov3_checkbox_manual_backup": "我将会首先手动备份我的库(Vault)。",
"syncalgov3_checkbox_requiremultidevupdate": "我理解,我需要在所有设备上都更新此插件使之正常运行。", "syncalgov3_checkbox_requiremultidevupdate": "我理解,我需要在所有设备上都更新此插件使之正常运行。",
"syncalgov3_button_agree": "同意", "syncalgov3_button_agree": "同意",
"syncalgov3_button_disagree": "不同意" "syncalgov3_button_disagree": "不同意",
"menu_check_file_stat": "查看文件属性"
} }
+26 -4
View File
@@ -9,9 +9,9 @@
"syncrun_syncingribbon": "{{pluginName}}:正在由 {{triggerSource}} 觸發執行", "syncrun_syncingribbon": "{{pluginName}}:正在由 {{triggerSource}} 觸發執行",
"syncrun_step0": "0/8 Remotely Save 在空跑(dry run)模式,不會發生實際的檔案交換。", "syncrun_step0": "0/8 Remotely Save 在空跑(dry run)模式,不會發生實際的檔案交換。",
"syncrun_step1": "1/8 Remotely Save 準備同步({{serviceType}}", "syncrun_step1": "1/8 Remotely Save 準備同步({{serviceType}}",
"syncrun_step2": "2/8 正在獲取遠端的元資料。", "syncrun_step2": "2/8 正在獲取遠端的元數據和檢查密碼。",
"syncrun_step3": "3/8 正在檢查密碼正確與否。",
"syncrun_passworderr": "檢查密碼時候出錯。", "syncrun_passworderr": "檢查密碼時候出錯。",
"syncrun_step3": "3/8 正在處理遠端的元數據。",
"syncrun_step4": "4/8 正在獲取本地的元資料。", "syncrun_step4": "4/8 正在獲取本地的元資料。",
"syncrun_step5": "5/8 正在獲取本地上一次同步的元資料。", "syncrun_step5": "5/8 正在獲取本地上一次同步的元資料。",
"syncrun_step6": "6/8 正在生成同步計劃。", "syncrun_step6": "6/8 正在生成同步計劃。",
@@ -38,6 +38,7 @@
"protocol_onedrive_connect_unknown": "不知道如何處理此 callback{{params}}", "protocol_onedrive_connect_unknown": "不知道如何處理此 callback{{params}}",
"command_startsync": "開始同步(start sync", "command_startsync": "開始同步(start sync",
"command_drynrun": "開始同步(空跑模式)(start sync (dry run only)", "command_drynrun": "開始同步(空跑模式)(start sync (dry run only)",
"command_exportsyncplans_1_only_change": "匯出同步計劃(最近 1 次)(僅修改部分)(export sync plans (latest 1) (change part)",
"command_exportsyncplans_1": "匯出同步計劃(最近 1 次)(export sync plans (latest 1)", "command_exportsyncplans_1": "匯出同步計劃(最近 1 次)(export sync plans (latest 1)",
"command_exportsyncplans_5": "匯出同步計劃(最近 5 次)(export sync plans (latest 5)", "command_exportsyncplans_5": "匯出同步計劃(最近 5 次)(export sync plans (latest 5)",
"command_exportsyncplans_all": "匯出同步計劃(所有)(export sync plans (all)", "command_exportsyncplans_all": "匯出同步計劃(所有)(export sync plans (all)",
@@ -52,6 +53,7 @@
"statusbar_time_lessminute": "一分鐘之內同步", "statusbar_time_lessminute": "一分鐘之內同步",
"statusbar_lastsync": "上一次同步於:{{time}}", "statusbar_lastsync": "上一次同步於:{{time}}",
"statusbar_syncing": "正在同步", "statusbar_syncing": "正在同步",
"statusbar_failed": "上次同步失敗了",
"statusbar_now": "剛同步完", "statusbar_now": "剛同步完",
"statusbar_lastsync_label": "上一次同步於:{{date}}", "statusbar_lastsync_label": "上一次同步於:{{date}}",
"statusbar_lastsync_never": "沒觸發過同步", "statusbar_lastsync_never": "沒觸發過同步",
@@ -218,6 +220,10 @@
"settings_onedrive_auth_button": "鑑權", "settings_onedrive_auth_button": "鑑權",
"settings_onedrive_connect_succ": "很好!我們可連線上 OneDrive", "settings_onedrive_connect_succ": "很好!我們可連線上 OneDrive",
"settings_onedrive_connect_fail": "我們未能連線上 OneDrive。", "settings_onedrive_connect_fail": "我們未能連線上 OneDrive。",
"settings_onedrive_emptyfile": "空檔案處理",
"settings_onedrive_emptyfile_desc": "OneDrive 不允許上傳空檔案(即使官網也是不允許的)。那麼你想跳過空檔案還是返回錯誤?",
"settings_onedrive_emptyfile_skip": "跳過",
"settings_onedrive_emptyfile_error": "返回錯誤和中斷",
"settings_webdav": "Webdav 設定", "settings_webdav": "Webdav 設定",
"settings_webdav_disclaimer1": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現了 Webdav 伺服器有不符合預期的訪問,請立刻修改使用者名稱和密碼。", "settings_webdav_disclaimer1": "宣告:您所輸入的資訊儲存於本地。其它有害的或者出錯的外掛,是有可能讀取到這些資訊的。如果您發現了 Webdav 伺服器有不符合預期的訪問,請立刻修改使用者名稱和密碼。",
"settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.1.1 支援跳過 CORS 設定。但您正在使用舊版,建議升級。", "settings_webdav_cors_os": "Obsidian 桌面版>=0.13.25 或 iOS>=1.1.1 或 Android>=1.1.1 支援跳過 CORS 設定。但您正在使用舊版,建議升級。",
@@ -238,12 +244,25 @@
"settings_webdav_connect_succ": "很好!可以連線上 Webdav 伺服器。", "settings_webdav_connect_succ": "很好!可以連線上 Webdav 伺服器。",
"settings_webdav_connect_fail": "無法連線上 Webdav 伺服器。(可能是地址/賬號/密碼/鑑權型別等錯誤。)", "settings_webdav_connect_fail": "無法連線上 Webdav 伺服器。(可能是地址/賬號/密碼/鑑權型別等錯誤。)",
"settings_webdav_connect_fail_withcors": "無法連線上 Webdav 伺服器。(可能是地址/賬號/密碼/鑑權型別/CORS 等錯誤。)", "settings_webdav_connect_fail_withcors": "無法連線上 Webdav 伺服器。(可能是地址/賬號/密碼/鑑權型別/CORS 等錯誤。)",
"settings_webdis": "Webdis 設置",
"settings_webdis_disclaimer1": "聲明:此插件不是 Redis® Ltd 或 Redis® 軟件或 Wedis 的官方產品。Redis 是 Redis Ltd 的註冊商標。",
"settings_webdis_disclaimer2": "聲明:您所輸入的信息存儲於本地。其它有害的或者出錯的插件,是有可能讀取到這些信息的。如果您發現了 Webdis 服務器有不符合預期的訪問,請立刻修改用戶名和密碼。",
"settings_webdis_folder": "我們會在您的服務器上創建帶有此前綴的 key 並在裡面同步::{{remoteBaseDir}}。",
"settings_webdis_addr": "服務器地址",
"settings_webdis_addr_desc": "服務器地址",
"settings_webdis_user": "用戶名",
"settings_webdis_user_desc": "用戶名。注意:用戶名和其它信息都會保存在本地。",
"settings_webdis_password": "密碼",
"settings_webdis_password_desc": "密碼。注意:密碼和其它信息都會保存在本地。",
"settings_webdis_connect_succ": "很好!可以連接上 Webdis 服務器。",
"settings_webdis_connect_fail": "無法連接上 Webdis 服務器。(可能是地址/賬號/密碼/鑑權類型等錯誤。)",
"settings_chooseservice": "選擇遠端服務", "settings_chooseservice": "選擇遠端服務",
"settings_chooseservice_desc": "從這裡開始設定。您想連線到哪一個服務?S3、Dropbox、Webdav、OneDrive(個人版)?", "settings_chooseservice_desc": "從這裡開始設定。您想連線到哪一個服務?S3、Dropbox、Webdav、OneDrive(個人版)、Webdis",
"settings_chooseservice_s3": "S3 或相容 S3 的服務", "settings_chooseservice_s3": "S3 或相容 S3 的服務",
"settings_chooseservice_dropbox": "Dropbox", "settings_chooseservice_dropbox": "Dropbox",
"settings_chooseservice_webdav": "Webdav", "settings_chooseservice_webdav": "Webdav",
"settings_chooseservice_onedrive": "OneDrive(個人版)", "settings_chooseservice_onedrive": "OneDrive(個人版)",
"settings_chooseservice_webdis": "Webdis (an HTTP interface for Redis®)",
"settings_adv": "進階設定", "settings_adv": "進階設定",
"settings_concurrency": "並行度", "settings_concurrency": "並行度",
"settings_concurrency_desc": "您希望同時最多有多少個檔案被上傳和下載?預設值是 5。如果您遇到了一些問題(如訪問頻率限制),您可以減少並行度。", "settings_concurrency_desc": "您希望同時最多有多少個檔案被上傳和下載?預設值是 5。如果您遇到了一些問題(如訪問頻率限制),您可以減少並行度。",
@@ -298,6 +317,7 @@
"settings_viewconsolelog_desc": "電腦上,輸入“ctrl+shift+i”或“cmd+shift+i”來檢視終端輸出。手機上,安裝第三方外掛 <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> 來匯出終端輸出到一篇筆記上。", "settings_viewconsolelog_desc": "電腦上,輸入“ctrl+shift+i”或“cmd+shift+i”來檢視終端輸出。手機上,安裝第三方外掛 <a href='https://obsidian.md/plugins?search=Logstravaganza'>Logstravaganza</a> 來匯出終端輸出到一篇筆記上。",
"settings_syncplans": "匯出同步計劃", "settings_syncplans": "匯出同步計劃",
"settings_syncplans_desc": "每次您啟動同步,並在實際上傳下載前,外掛會生成同步計劃。它可以使您知道每次同步發生了什麼。點選按鈕可以匯出同步計劃。", "settings_syncplans_desc": "每次您啟動同步,並在實際上傳下載前,外掛會生成同步計劃。它可以使您知道每次同步發生了什麼。點選按鈕可以匯出同步計劃。",
"settings_syncplans_button_1_only_change": "匯出最近 1 次(僅修改部分)",
"settings_syncplans_button_1": "匯出最近 1 次", "settings_syncplans_button_1": "匯出最近 1 次",
"settings_syncplans_button_5": "匯出最近 5 次", "settings_syncplans_button_5": "匯出最近 5 次",
"settings_syncplans_button_all": "匯出所有", "settings_syncplans_button_all": "匯出所有",
@@ -327,5 +347,7 @@
"syncalgov3_checkbox_manual_backup": "我將會首先手動備份我的庫(Vault)。", "syncalgov3_checkbox_manual_backup": "我將會首先手動備份我的庫(Vault)。",
"syncalgov3_checkbox_requiremultidevupdate": "我理解,我需要在所有裝置上都更新此外掛使之正常執行。", "syncalgov3_checkbox_requiremultidevupdate": "我理解,我需要在所有裝置上都更新此外掛使之正常執行。",
"syncalgov3_button_agree": "同意", "syncalgov3_button_agree": "同意",
"syncalgov3_button_disagree": "不同意" "syncalgov3_button_disagree": "不同意",
"menu_check_file_stat": "檢視檔案屬性"
} }
+37 -30
View File
@@ -1,12 +1,14 @@
import localforage from "localforage"; import localforage from "localforage";
import { extendPrototype } from "localforage-getitems"; import { extendPrototype as ep1 } from "localforage-getitems";
extendPrototype(localforage); import { extendPrototype as ep2 } from "localforage-removeitems";
ep1(localforage);
ep2(localforage);
export type LocalForage = typeof localforage; export type LocalForage = typeof localforage;
import { nanoid } from "nanoid"; import { nanoid } from "nanoid";
import type { Entity, MixedEntity, SUPPORTED_SERVICES_TYPE } from "./baseTypes"; import type { Entity, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
import type { SyncPlanType } from "./sync";
import { unixTimeToStr } from "./misc"; import { unixTimeToStr } from "./misc";
import type { SyncPlanType } from "./sync";
const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326, 20240220]; const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326, 20240220];
export const DEFAULT_DB_VERSION_NUMBER: number = 20240220; export const DEFAULT_DB_VERSION_NUMBER: number = 20240220;
@@ -307,12 +309,15 @@ export const clearFileHistoryOfEverythingByVault = async (
db: InternalDBs, db: InternalDBs,
vaultRandomID: string vaultRandomID: string
) => { ) => {
const keys = await db.fileHistoryTbl.keys(); const keys = (await db.fileHistoryTbl.keys()).filter((x) =>
for (const key of keys) { x.startsWith(`${vaultRandomID}\t`)
if (key.startsWith(`${vaultRandomID}\t`)) { );
await db.fileHistoryTbl.removeItem(key); await db.fileHistoryTbl.removeItems(keys);
} // for (const key of keys) {
} // if (key.startsWith(`${vaultRandomID}\t`)) {
// await db.fileHistoryTbl.removeItem(key);
// }
// }
}; };
/** /**
@@ -339,12 +344,15 @@ export const clearAllSyncMetaMappingByVault = async (
db: InternalDBs, db: InternalDBs,
vaultRandomID: string vaultRandomID: string
) => { ) => {
const keys = await db.syncMappingTbl.keys(); const keys = (await db.syncMappingTbl.keys()).filter((x) =>
for (const key of keys) { x.startsWith(`${vaultRandomID}\t`)
if (key.startsWith(`${vaultRandomID}\t`)) { );
await db.syncMappingTbl.removeItem(key); await db.syncMappingTbl.removeItems(keys);
} // for (const key of keys) {
} // if (key.startsWith(`${vaultRandomID}\t`)) {
// await db.syncMappingTbl.removeItem(key);
// }
// }
}; };
export const insertSyncPlanRecordByVault = async ( export const insertSyncPlanRecordByVault = async (
@@ -400,7 +408,7 @@ export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
const expiredTs = currTs - MILLISECONDS_OLD; const expiredTs = currTs - MILLISECONDS_OLD;
let records = (await db.syncPlansTbl.keys()).map((key) => { let records = (await db.syncPlansTbl.keys()).map((key) => {
const ts = parseInt(key.split("\t")[1]); const ts = Number.parseInt(key.split("\t")[1]);
const expired = ts <= expiredTs; const expired = ts <= expiredTs;
return { return {
ts: ts, ts: ts,
@@ -422,11 +430,12 @@ export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
}); });
} }
const ps = [] as Promise<void>[]; // const ps = [] as Promise<void>[];
keysToRemove.forEach((element) => { // keysToRemove.forEach((element) => {
ps.push(db.syncPlansTbl.removeItem(element)); // ps.push(db.syncPlansTbl.removeItem(element));
}); // });
await Promise.all(ps); // await Promise.all(ps);
await db.syncPlansTbl.removeItems(Array.from(keysToRemove));
}; };
export const getAllPrevSyncRecordsByVaultAndProfile = async ( export const getAllPrevSyncRecordsByVaultAndProfile = async (
@@ -475,12 +484,10 @@ export const clearAllPrevSyncRecordByVault = async (
db: InternalDBs, db: InternalDBs,
vaultRandomID: string vaultRandomID: string
) => { ) => {
const keys = await db.prevSyncRecordsTbl.keys(); const keys = (await db.prevSyncRecordsTbl.keys()).filter((x) =>
for (const key of keys) { x.startsWith(`${vaultRandomID}\t`)
if (key.startsWith(`${vaultRandomID}\t`)) { );
await db.prevSyncRecordsTbl.removeItem(key); await db.prevSyncRecordsTbl.removeItems(keys);
}
}
}; };
export const clearAllLoggerOutputRecords = async (db: InternalDBs) => { export const clearAllLoggerOutputRecords = async (db: InternalDBs) => {
@@ -542,7 +549,7 @@ export const insertProfilerResultByVault = async (
// clear older one while writing // clear older one while writing
const records = (await db.profilerResultsTbl.keys()) const records = (await db.profilerResultsTbl.keys())
.filter((x) => x.startsWith(`${vaultRandomID}\t`)) .filter((x) => x.startsWith(`${vaultRandomID}\t`))
.map((x) => parseInt(x.split("\t")[1])); .map((x) => Number.parseInt(x.split("\t")[1]));
records.sort((a, b) => -(a - b)); // descending records.sort((a, b) => -(a - b)); // descending
while (records.length > 5) { while (records.length > 5) {
const ts = records.pop()!; const ts = records.pop()!;
@@ -559,7 +566,7 @@ export const readAllProfilerResultsByVault = async (
if (key.startsWith(`${vaultRandomID}\t`)) { if (key.startsWith(`${vaultRandomID}\t`)) {
records.push({ records.push({
val: value as string, val: value as string,
ts: parseInt(key.split("\t")[1]), ts: Number.parseInt(key.split("\t")[1]),
}); });
} }
}); });
+137 -48
View File
@@ -1,72 +1,76 @@
import {
Modal,
Notice,
Plugin,
Setting,
addIcon,
setIcon,
FileSystemAdapter,
Platform,
requireApiVersion,
Events,
} from "obsidian";
import cloneDeep from "lodash/cloneDeep"; import cloneDeep from "lodash/cloneDeep";
import { createElement, RotateCcw, RefreshCcw, FileText } from "lucide"; import { FileText, RefreshCcw, RotateCcw, createElement } from "lucide";
import {
Events,
FileSystemAdapter,
type Modal,
Notice,
Platform,
Plugin,
type Setting,
TFolder,
addIcon,
requireApiVersion,
setIcon,
} from "obsidian";
import type { import type {
RemotelySavePluginSettings, RemotelySavePluginSettings,
SyncTriggerSourceType, SyncTriggerSourceType,
} from "./baseTypes"; } from "./baseTypes";
import { import {
COMMAND_CALLBACK, COMMAND_CALLBACK,
COMMAND_CALLBACK_ONEDRIVE,
COMMAND_CALLBACK_DROPBOX, COMMAND_CALLBACK_DROPBOX,
COMMAND_CALLBACK_ONEDRIVE,
COMMAND_URI, COMMAND_URI,
API_VER_ENSURE_REQURL_OK,
} from "./baseTypes"; } from "./baseTypes";
import { importQrCodeUri } from "./importExport"; import { API_VER_ENSURE_REQURL_OK } from "./baseTypesObs";
import { import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
prepareDBs,
InternalDBs,
clearExpiredSyncPlanRecords,
upsertPluginVersionByVault,
clearAllLoggerOutputRecords,
upsertLastSuccessSyncTimeByVault,
getLastSuccessSyncTimeByVault,
} from "./localdb";
import { import {
DEFAULT_DROPBOX_CONFIG, DEFAULT_DROPBOX_CONFIG,
sendAuthReq as sendAuthReqDropbox, sendAuthReq as sendAuthReqDropbox,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceDropbox, setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceDropbox,
} from "./fsDropbox"; } from "./fsDropbox";
import { import {
AccessCodeResponseSuccessfulType, type AccessCodeResponseSuccessfulType,
DEFAULT_ONEDRIVE_CONFIG, DEFAULT_ONEDRIVE_CONFIG,
sendAuthReq as sendAuthReqOnedrive, sendAuthReq as sendAuthReqOnedrive,
setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceOnedrive, setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplaceOnedrive,
} from "./fsOnedrive"; } from "./fsOnedrive";
import { DEFAULT_S3_CONFIG } from "./fsS3"; import { DEFAULT_S3_CONFIG } from "./fsS3";
import { DEFAULT_WEBDAV_CONFIG } from "./fsWebdav"; import { DEFAULT_WEBDAV_CONFIG } from "./fsWebdav";
import { RemotelySaveSettingTab } from "./settings";
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
import { I18n } from "./i18n"; import { I18n } from "./i18n";
import type { LangTypeAndAuto, TransItemType } from "./i18n"; import type { LangTypeAndAuto, TransItemType } from "./i18n";
import { importQrCodeUri } from "./importExport";
import {
type InternalDBs,
clearAllLoggerOutputRecords,
clearExpiredSyncPlanRecords,
getLastSuccessSyncTimeByVault,
prepareDBs,
upsertLastSuccessSyncTimeByVault,
upsertPluginVersionByVault,
} from "./localdb";
import { RemotelySaveSettingTab } from "./settings";
import { SyncAlgoV3Modal } from "./syncAlgoV3Notice"; import { SyncAlgoV3Modal } from "./syncAlgoV3Notice";
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
import AggregateError from "aggregate-error"; import AggregateError from "aggregate-error";
import { exportVaultSyncPlansToFiles } from "./debugMode";
import { changeMobileStatusBar } from "./misc";
import { Profiler } from "./profiler";
import { FakeFsLocal } from "./fsLocal";
import { FakeFsEncrypt } from "./fsEncrypt";
import { syncer } from "./sync";
import { getClient } from "./fsGetter";
import throttle from "lodash/throttle"; import throttle from "lodash/throttle";
import { exportVaultSyncPlansToFiles } from "./debugMode";
import { FakeFsEncrypt } from "./fsEncrypt";
import { getClient } from "./fsGetter";
import { FakeFsLocal } from "./fsLocal";
import { DEFAULT_WEBDIS_CONFIG } from "./fsWebdis";
import { changeMobileStatusBar } from "./misc";
import { DEFAULT_PROFILER_CONFIG, type Profiler } from "./profiler";
import { syncer } from "./sync";
const DEFAULT_SETTINGS: RemotelySavePluginSettings = { const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
s3: DEFAULT_S3_CONFIG, s3: DEFAULT_S3_CONFIG,
webdav: DEFAULT_WEBDAV_CONFIG, webdav: DEFAULT_WEBDAV_CONFIG,
dropbox: DEFAULT_DROPBOX_CONFIG, dropbox: DEFAULT_DROPBOX_CONFIG,
onedrive: DEFAULT_ONEDRIVE_CONFIG, onedrive: DEFAULT_ONEDRIVE_CONFIG,
webdis: DEFAULT_WEBDIS_CONFIG,
password: "", password: "",
serviceType: "s3", serviceType: "s3",
currLogLevel: "info", currLogLevel: "info",
@@ -92,6 +96,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
obfuscateSettingFile: true, obfuscateSettingFile: true,
enableMobileStatusBar: false, enableMobileStatusBar: false,
encryptionMethod: "unknown", encryptionMethod: "unknown",
profiler: DEFAULT_PROFILER_CONFIG,
}; };
interface OAuth2Info { interface OAuth2Info {
@@ -147,7 +152,12 @@ export default class RemotelySavePlugin extends Plugin {
appContainerObserver?: MutationObserver; appContainerObserver?: MutationObserver;
async syncRun(triggerSource: SyncTriggerSourceType = "manual") { async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
const profiler = new Profiler(); // const profiler = new Profiler(
// undefined,
// this.settings.profiler?.enablePrinting ?? false,
// this.settings.profiler?.recordSize ?? false
// );
const profiler: Profiler | undefined = undefined;
const fsLocal = new FakeFsLocal( const fsLocal = new FakeFsLocal(
this.app.vault, this.app.vault,
this.settings.syncConfigDir ?? false, this.settings.syncConfigDir ?? false,
@@ -297,7 +307,6 @@ export default class RemotelySavePlugin extends Plugin {
default: default:
throw Error(`unknown step=${step} for showing notice`); throw Error(`unknown step=${step} for showing notice`);
break;
} }
}; };
@@ -328,17 +337,21 @@ export default class RemotelySavePlugin extends Plugin {
// last step // last step
if (this.syncRibbon !== undefined) { if (this.syncRibbon !== undefined) {
setIcon(this.syncRibbon, iconNameSyncWait); setIcon(this.syncRibbon, iconNameSyncWait);
let originLabel = `${this.manifest.name}`; const originLabel = `${this.manifest.name}`;
this.syncRibbon.setAttribute("aria-label", originLabel); this.syncRibbon.setAttribute("aria-label", originLabel);
} }
} }
}; };
const statusBarFunc = async (s: SyncTriggerSourceType, step: number) => { const statusBarFunc = async (
s: SyncTriggerSourceType,
step: number,
everythingOk: boolean
) => {
if (step === 1) { if (step === 1) {
// change status to "syncing..." on statusbar // change status to "syncing..." on statusbar
this.updateLastSuccessSyncMsg(-1); this.updateLastSuccessSyncMsg(-1);
} else if (step === 8) { } else if (step === 8 && everythingOk) {
const lastSuccessSyncMillis = Date.now(); const lastSuccessSyncMillis = Date.now();
await upsertLastSuccessSyncTimeByVault( await upsertLastSuccessSyncTimeByVault(
this.db, this.db,
@@ -346,6 +359,8 @@ export default class RemotelySavePlugin extends Plugin {
lastSuccessSyncMillis lastSuccessSyncMillis
); );
this.updateLastSuccessSyncMsg(lastSuccessSyncMillis); this.updateLastSuccessSyncMsg(lastSuccessSyncMillis);
} else if (!everythingOk) {
this.updateLastSuccessSyncMsg(-2); // magic number
} }
}; };
@@ -405,7 +420,7 @@ export default class RemotelySavePlugin extends Plugin {
); );
fsEncrypt.closeResources(); fsEncrypt.closeResources();
profiler.clear(); (profiler as Profiler | undefined)?.clear();
this.syncEvent?.trigger("SYNC_DONE"); this.syncEvent?.trigger("SYNC_DONE");
} }
@@ -532,7 +547,7 @@ export default class RemotelySavePlugin extends Plugin {
return; return;
} }
let authRes = await sendAuthReqDropbox( const authRes = await sendAuthReqDropbox(
this.settings.dropbox.clientID, this.settings.dropbox.clientID,
this.oauth2Info.verifier, this.oauth2Info.verifier,
inputParams.code, inputParams.code,
@@ -617,7 +632,7 @@ export default class RemotelySavePlugin extends Plugin {
}); });
} }
let rsp = await sendAuthReqOnedrive( const rsp = await sendAuthReqOnedrive(
this.settings.onedrive.clientID, this.settings.onedrive.clientID,
this.settings.onedrive.authority, this.settings.onedrive.authority,
inputParams.code, inputParams.code,
@@ -730,6 +745,22 @@ export default class RemotelySavePlugin extends Plugin {
}, },
}); });
this.addCommand({
id: "export-sync-plans-1-only-change",
name: t("command_exportsyncplans_1_only_change"),
icon: iconNameLogs,
callback: async () => {
await exportVaultSyncPlansToFiles(
this.db,
this.app.vault,
this.vaultRandomID,
1,
true
);
new Notice(t("settings_syncplans_notice"));
},
});
this.addCommand({ this.addCommand({
id: "export-sync-plans-1", id: "export-sync-plans-1",
name: t("command_exportsyncplans_1"), name: t("command_exportsyncplans_1"),
@@ -739,7 +770,8 @@ export default class RemotelySavePlugin extends Plugin {
this.db, this.db,
this.app.vault, this.app.vault,
this.vaultRandomID, this.vaultRandomID,
1 1,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}, },
@@ -754,7 +786,8 @@ export default class RemotelySavePlugin extends Plugin {
this.db, this.db,
this.app.vault, this.app.vault,
this.vaultRandomID, this.vaultRandomID,
5 5,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}, },
@@ -769,7 +802,8 @@ export default class RemotelySavePlugin extends Plugin {
this.db, this.db,
this.app.vault, this.app.vault,
this.vaultRandomID, this.vaultRandomID,
-1 -1,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}, },
@@ -781,6 +815,8 @@ export default class RemotelySavePlugin extends Plugin {
// console.info("click", evt); // console.info("click", evt);
// }); // });
this.enableCheckingFileStat();
if (!this.settings.agreeToUseSyncV3) { if (!this.settings.agreeToUseSyncV3) {
const syncAlgoV3Modal = new SyncAlgoV3Modal(this.app, this); const syncAlgoV3Modal = new SyncAlgoV3Modal(this.app, this);
syncAlgoV3Modal.open(); syncAlgoV3Modal.open();
@@ -838,6 +874,9 @@ export default class RemotelySavePlugin extends Plugin {
if (this.settings.onedrive.remoteBaseDir === undefined) { if (this.settings.onedrive.remoteBaseDir === undefined) {
this.settings.onedrive.remoteBaseDir = ""; this.settings.onedrive.remoteBaseDir = "";
} }
if (this.settings.onedrive.emptyFile === undefined) {
this.settings.onedrive.emptyFile = "skip";
}
if (this.settings.webdav.manualRecursive === undefined) { if (this.settings.webdav.manualRecursive === undefined) {
this.settings.webdav.manualRecursive = true; this.settings.webdav.manualRecursive = true;
} }
@@ -929,6 +968,16 @@ export default class RemotelySavePlugin extends Plugin {
} }
} }
if (this.settings.profiler === undefined) {
this.settings.profiler = DEFAULT_PROFILER_CONFIG;
}
if (this.settings.profiler.enablePrinting === undefined) {
this.settings.profiler.enablePrinting = false;
}
if (this.settings.profiler.recordSize === undefined) {
this.settings.profiler.recordSize = false;
}
await this.saveSettings(); await this.saveSettings();
} }
@@ -952,7 +1001,7 @@ export default class RemotelySavePlugin extends Plugin {
} }
async checkIfOauthExpires() { async checkIfOauthExpires() {
let needSave: boolean = false; let needSave = false;
const current = Date.now(); const current = Date.now();
// fullfill old version settings // fullfill old version settings
@@ -1196,6 +1245,41 @@ export default class RemotelySavePlugin extends Plugin {
}); });
} }
enableCheckingFileStat() {
this.app.workspace.onLayoutReady(() => {
const t = (x: TransItemType, vars?: any) => {
return this.i18n.t(x, vars);
};
this.registerEvent(
this.app.workspace.on("file-menu", (menu, file) => {
if (file instanceof TFolder) {
// folder not supported yet
return;
}
menu.addItem((item) => {
item
.setTitle(t("menu_check_file_stat"))
.setIcon("file-cog")
.onClick(async () => {
const filePath = file.path;
const fsLocal = new FakeFsLocal(
this.app.vault,
this.settings.syncConfigDir ?? false,
this.app.vault.configDir,
this.manifest.id,
undefined,
this.settings.deleteToWhere ?? "system"
);
const s = await fsLocal.stat(filePath);
new Notice(JSON.stringify(s, null, 2), 10000);
});
});
})
);
});
}
async saveAgreeToUseNewSyncAlgorithm() { async saveAgreeToUseNewSyncAlgorithm() {
this.settings.agreeToUseSyncV3 = true; this.settings.agreeToUseSyncV3 = true;
await this.saveSettings(); await this.saveSettings();
@@ -1226,6 +1310,11 @@ export default class RemotelySavePlugin extends Plugin {
lastSyncMsg = t("statusbar_syncing"); lastSyncMsg = t("statusbar_syncing");
} }
if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis === -2) {
lastSyncMsg = t("statusbar_failed");
lastSyncLabelMsg = t("statusbar_failed");
}
if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis > 0) { if (lastSuccessSyncMillis !== undefined && lastSuccessSyncMillis > 0) {
const deltaTime = Date.now() - lastSuccessSyncMillis; const deltaTime = Date.now() - lastSuccessSyncMillis;
@@ -1258,7 +1347,7 @@ export default class RemotelySavePlugin extends Plugin {
timeText = t("statusbar_now"); timeText = t("statusbar_now");
} }
let dateText = new Date(lastSuccessSyncMillis).toLocaleTimeString( const dateText = new Date(lastSuccessSyncMillis).toLocaleTimeString(
navigator.language, navigator.language,
{ {
weekday: "long", weekday: "long",
+90 -31
View File
@@ -1,9 +1,9 @@
import { Platform, Vault } from "obsidian";
import * as path from "path"; import * as path from "path";
import type { Vault } from "obsidian";
import { base32, base64url } from "rfc4648";
import XRegExp from "xregexp";
import emojiRegex from "emoji-regex"; import emojiRegex from "emoji-regex";
import { base32 } from "rfc4648";
import XRegExp from "xregexp";
declare global { declare global {
interface Window { interface Window {
@@ -18,11 +18,7 @@ declare global {
* @param underscore * @param underscore
* @returns * @returns
*/ */
export const isHiddenPath = ( export const isHiddenPath = (item: string, dot = true, underscore = true) => {
item: string,
dot: boolean = true,
underscore: boolean = true
) => {
if (!(dot || underscore)) { if (!(dot || underscore)) {
throw Error("parameter error for isHiddenPath"); throw Error("parameter error for isHiddenPath");
} }
@@ -50,7 +46,7 @@ export const isHiddenPath = (
* @param x string * @param x string
* @returns string[] might be empty * @returns string[] might be empty
*/ */
export const getFolderLevels = (x: string, addEndingSlash: boolean = false) => { export const getFolderLevels = (x: string, addEndingSlash = false) => {
const res: string[] = []; const res: string[] = [];
if (x === "" || x === "/") { if (x === "" || x === "/") {
@@ -58,7 +54,7 @@ export const getFolderLevels = (x: string, addEndingSlash: boolean = false) => {
} }
const y1 = x.split("/"); const y1 = x.split("/");
let i = 0; const i = 0;
for (let index = 0; index + 1 < y1.length; index++) { for (let index = 0; index + 1 < y1.length; index++) {
let k = y1.slice(0, index + 1).join("/"); let k = y1.slice(0, index + 1).join("/");
if (k === "" || k === "/") { if (k === "" || k === "/") {
@@ -119,7 +115,7 @@ export const base64ToArrayBuffer = (b64text: string) => {
}; };
export const copyArrayBuffer = (src: ArrayBuffer) => { export const copyArrayBuffer = (src: ArrayBuffer) => {
var dst = new ArrayBuffer(src.byteLength); const dst = new ArrayBuffer(src.byteLength);
new Uint8Array(dst).set(new Uint8Array(src)); new Uint8Array(dst).set(new Uint8Array(src));
return dst; return dst;
}; };
@@ -134,18 +130,14 @@ export const hexStringToTypedArray = (hex: string) => {
if (f === null) { if (f === null) {
throw Error(`input ${hex} is not hex, no way to transform`); throw Error(`input ${hex} is not hex, no way to transform`);
} }
return new Uint8Array( return new Uint8Array(f.map((h) => Number.parseInt(h, 16)));
f.map(function (h) {
return parseInt(h, 16);
})
);
}; };
export const base64ToBase32 = (a: string) => { export const base64ToBase32 = (a: string) => {
return base32.stringify(Buffer.from(a, "base64")); return base32.stringify(Buffer.from(a, "base64"));
}; };
export const base64ToBase64url = (a: string, pad: boolean = false) => { export const base64ToBase64url = (a: string, pad = false) => {
let b = a.replace(/\+/g, "-").replace(/\//g, "_"); let b = a.replace(/\+/g, "-").replace(/\//g, "_");
if (!pad) { if (!pad) {
b = b.replace(/=/g, ""); b = b.replace(/=/g, "");
@@ -190,7 +182,7 @@ export const hasEmojiInText = (a: string) => {
* @param toLower * @param toLower
* @returns * @returns
*/ */
export const headersToRecord = (h: Headers, toLower: boolean = true) => { export const headersToRecord = (h: Headers, toLower = true) => {
const res: Record<string, string> = {}; const res: Record<string, string> = {};
h.forEach((v, k) => { h.forEach((v, k) => {
if (toLower) { if (toLower) {
@@ -240,11 +232,11 @@ export const getParentFolder = (a: string) => {
* @param delimiter * @param delimiter
* @returns * @returns
*/ */
export const setToString = (a: Set<string>, delimiter: string = ",") => { export const setToString = (a: Set<string>, delimiter = ",") => {
return [...a].join(delimiter); return [...a].join(delimiter);
}; };
export const extractSvgSub = (x: string, subEl: string = "rect") => { export const extractSvgSub = (x: string, subEl = "rect") => {
const parser = new window.DOMParser(); const parser = new window.DOMParser();
const dom = parser.parseFromString(x, "image/svg+xml"); const dom = parser.parseFromString(x, "image/svg+xml");
const svg = dom.querySelector("svg")!; const svg = dom.querySelector("svg")!;
@@ -261,10 +253,10 @@ export const extractSvgSub = (x: string, subEl: string = "rect") => {
export const getRandomIntInclusive = (min: number, max: number) => { export const getRandomIntInclusive = (min: number, max: number) => {
const randomBuffer = new Uint32Array(1); const randomBuffer = new Uint32Array(1);
window.crypto.getRandomValues(randomBuffer); window.crypto.getRandomValues(randomBuffer);
let randomNumber = randomBuffer[0] / (0xffffffff + 1); const randomNumber = randomBuffer[0] / (0xffffffff + 1);
min = Math.ceil(min); const min2 = Math.ceil(min);
max = Math.floor(max); const max2 = Math.floor(max);
return Math.floor(randomNumber * (max - min + 1)) + min; return Math.floor(randomNumber * (max2 - min2 + 1)) + min2;
}; };
/** /**
@@ -353,7 +345,7 @@ export const unixTimeToStr = (x: number | undefined | null) => {
if (x === undefined || x === null || Number.isNaN(x)) { if (x === undefined || x === null || Number.isNaN(x)) {
return undefined; return undefined;
} }
return window.moment(x).format() as string; return new Date(x).toISOString();
}; };
/** /**
@@ -397,9 +389,8 @@ export const toText = (x: any) => {
if ( if (
x instanceof Error || x instanceof Error ||
(x && (x?.stack &&
x.stack && x?.message &&
x.message &&
typeof x.stack === "string" && typeof x.stack === "string" &&
typeof x.message === "string") typeof x.message === "string")
) { ) {
@@ -446,7 +437,7 @@ export const isSpecialFolderNameToSkip = (
x: string, x: string,
more: string[] | undefined more: string[] | undefined
) => { ) => {
let specialFolders = [ const specialFolders = [
".git", ".git",
".github", ".github",
".gitlab", ".gitlab",
@@ -595,6 +586,7 @@ export const changeMobileStatusBar = (
if (oldAppContainerObserver !== undefined) { if (oldAppContainerObserver !== undefined) {
console.debug(`disconnect oldAppContainerObserver`); console.debug(`disconnect oldAppContainerObserver`);
oldAppContainerObserver.disconnect(); oldAppContainerObserver.disconnect();
// biome-ignore lint/style/noParameterAssign: we want gc
oldAppContainerObserver = undefined; oldAppContainerObserver = undefined;
} }
statusbar.style.removeProperty("display"); statusbar.style.removeProperty("display");
@@ -631,7 +623,6 @@ export const fixEntityListCasesInplace = (entities: { keyRaw: string }[]) => {
caseMapping[newKeyRaw.toLocaleLowerCase()] = newKeyRaw; caseMapping[newKeyRaw.toLocaleLowerCase()] = newKeyRaw;
e.keyRaw = newKeyRaw; e.keyRaw = newKeyRaw;
// console.log(JSON.stringify(caseMapping,null,2)); // console.log(JSON.stringify(caseMapping,null,2));
continue;
} else { } else {
throw Error(`${parentFolder} doesn't have cases record??`); throw Error(`${parentFolder} doesn't have cases record??`);
} }
@@ -642,7 +633,6 @@ export const fixEntityListCasesInplace = (entities: { keyRaw: string }[]) => {
.slice(-1) .slice(-1)
.join("/")}`; .join("/")}`;
e.keyRaw = newKeyRaw; e.keyRaw = newKeyRaw;
continue;
} else { } else {
throw Error(`${parentFolder} doesn't have cases record??`); throw Error(`${parentFolder} doesn't have cases record??`);
} }
@@ -651,3 +641,72 @@ export const fixEntityListCasesInplace = (entities: { keyRaw: string }[]) => {
return entities; return entities;
}; };
/**
* https://stackoverflow.com/questions/1248302/how-to-get-the-size-of-a-javascript-object
* @param object
* @returns bytes
*/
export const roughSizeOfObject = (object: any) => {
const objectList: any[] = [];
const stack = [object];
let bytes = 0;
while (stack.length) {
const value = stack.pop();
switch (typeof value) {
case "boolean":
bytes += 4;
break;
case "string":
bytes += value.length * 2;
break;
case "number":
bytes += 8;
break;
case "object":
if (!objectList.includes(value)) {
objectList.push(value);
for (const prop in value) {
if (value.hasOwnProperty(prop)) {
stack.push(value[prop]);
}
}
}
break;
}
}
return bytes;
};
export const splitFileSizeToChunkRanges = (
totalSize: number,
chunkSize: number
) => {
if (totalSize < 0) {
throw Error(`totalSize should not be negative`);
}
if (chunkSize <= 0) {
throw Error(`chunkSize should not be negative or zero`);
}
if (totalSize === 0) {
return [];
}
if (totalSize <= chunkSize) {
return [{ start: 0, end: totalSize - 1 }];
}
const res: { start: number; end: number }[] = [];
const blocksCount = Math.ceil((totalSize * 1.0) / chunkSize);
for (let i = 0; i < blocksCount; ++i) {
res.push({
start: i * chunkSize,
end: Math.min((i + 1) * chunkSize - 1, totalSize - 1),
});
}
return res;
};
+3 -3
View File
@@ -1,10 +1,10 @@
import type { Vault, Stat, ListedFiles } from "obsidian"; import type { ListedFiles, Vault } from "obsidian";
import type { Entity, MixedEntity } from "./baseTypes"; import type { Entity } from "./baseTypes";
import { Queue } from "@fyears/tsqueue"; import { Queue } from "@fyears/tsqueue";
import chunk from "lodash/chunk"; import chunk from "lodash/chunk";
import flatten from "lodash/flatten"; import flatten from "lodash/flatten";
import { statFix, isSpecialFolderNameToSkip } from "./misc"; import { isSpecialFolderNameToSkip, statFix } from "./misc";
const isPluginDirItself = (x: string, pluginId: string) => { const isPluginDirItself = (x: string, pluginId: string) => {
return ( return (
+73 -18
View File
@@ -1,29 +1,43 @@
import { SUPPORTED_SERVICES_TYPE } from "./baseTypes"; import type { ProfilerConfig, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
import { InternalDBs, insertProfilerResultByVault } from "./localdb"; import { type InternalDBs, insertProfilerResultByVault } from "./localdb";
import { unixTimeToStr } from "./misc"; import { roughSizeOfObject, unixTimeToStr } from "./misc";
interface BreakPoint { interface BreakPoint {
label: string; label: string;
fakeTimeMilli: number; // it's NOT a unix timestamp fakeTimeMilli: number; // it's NOT a unix timestamp
indent: number; indent: number;
size?: number;
} }
export const DEFAULT_PROFILER_CONFIG: ProfilerConfig = {
enablePrinting: false,
recordSize: false,
};
export class Profiler { export class Profiler {
startTime: number; startTime: number;
breakPoints: BreakPoint[]; breakPoints: BreakPoint[];
indent: number; indent: number;
constructor(label?: string) { enablePrinting: boolean;
recordSize: boolean;
constructor(label?: string, enablePrinting?: boolean, recordSize?: boolean) {
this.breakPoints = []; this.breakPoints = [];
this.indent = 0; this.indent = 0;
this.startTime = 0; this.startTime = 0;
this.enablePrinting = enablePrinting ?? false;
this.recordSize = recordSize ?? false;
if (label !== undefined) { if (label !== undefined) {
this.startTime = Date.now(); this.startTime = Date.now();
this.breakPoints.push({ const p = {
label: label, label: label,
fakeTimeMilli: performance.now(), fakeTimeMilli: performance.now(),
indent: this.indent, indent: this.indent,
}); };
this.breakPoints.push(p);
if (this.enablePrinting) {
console.debug(this.toString(-1));
}
} }
} }
@@ -31,11 +45,36 @@ export class Profiler {
if (this.breakPoints.length === 0) { if (this.breakPoints.length === 0) {
this.startTime = Date.now(); this.startTime = Date.now();
} }
this.breakPoints.push({ const p = {
label: label, label: label,
fakeTimeMilli: performance.now(), fakeTimeMilli: performance.now(),
indent: this.indent, indent: this.indent,
}); };
this.breakPoints.push(p);
if (this.enablePrinting) {
console.debug(this.toString(-1));
}
return this;
}
insertSize(label: string, obj: any) {
if (!this.recordSize) {
return;
}
if (this.breakPoints.length === 0) {
this.startTime = Date.now();
}
const p = {
label: label,
fakeTimeMilli: performance.now(),
indent: this.indent,
size: roughSizeOfObject(obj),
};
this.breakPoints.push(p);
if (this.enablePrinting) {
console.debug(this.toString(-1));
}
return this; return this;
} }
@@ -57,7 +96,31 @@ export class Profiler {
return this; return this;
} }
toString() { toString(idx?: number) {
if (idx !== undefined) {
let i = idx;
if (idx < 0) {
i = this.breakPoints.length + idx;
}
const label = this.breakPoints?.[i]["label"];
const indent = this.breakPoints?.[i]["indent"];
let millsec = 0;
if (i >= 1) {
millsec =
Math.round(
(this.breakPoints?.[i]["fakeTimeMilli"] -
this.breakPoints?.[i - 1]["fakeTimeMilli"]) *
10
) / 10.0;
}
let res = `${" ".repeat(indent)}[${label}]: ${millsec}ms`;
if (this.breakPoints[i].hasOwnProperty("size")) {
const size = this.breakPoints[i].size as number;
res += `, size=${size}`;
}
return res;
}
if (this.breakPoints.length === 0) { if (this.breakPoints.length === 0) {
return "nothing in profiler"; return "nothing in profiler";
} }
@@ -67,15 +130,7 @@ export class Profiler {
if (i === 0) { if (i === 0) {
res += `\n[${this.breakPoints[i]["label"]}]: start`; res += `\n[${this.breakPoints[i]["label"]}]: start`;
} else { } else {
const label = this.breakPoints[i]["label"]; res += `\n${this.toString(i)}`;
const indent = this.breakPoints[i]["indent"];
const millsec =
Math.round(
(this.breakPoints[i]["fakeTimeMilli"] -
this.breakPoints[i - 1]["fakeTimeMilli"]) *
10
) / 10.0;
res += `\n${" ".repeat(indent)}[${label}]: ${millsec}ms`;
} }
} }
+268 -71
View File
@@ -1,34 +1,45 @@
import { Eye, EyeOff, createElement } from "lucide";
import { import {
App, type App,
Modal, Modal,
Notice, Notice,
Platform,
PluginSettingTab, PluginSettingTab,
Setting, Setting,
Platform,
requireApiVersion, requireApiVersion,
requestUrl,
} from "obsidian"; } from "obsidian";
import type { TextComponent } from "obsidian"; import type { TextComponent } from "obsidian";
import { createElement, Eye, EyeOff } from "lucide"; import type {
import { CipherMethodType,
API_VER_ENSURE_REQURL_OK,
API_VER_REQURL,
ConflictActionType, ConflictActionType,
DEFAULT_DEBUG_FOLDER,
EmptyFolderCleanType, EmptyFolderCleanType,
QRExportType,
SUPPORTED_SERVICES_TYPE, SUPPORTED_SERVICES_TYPE,
SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR, SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR,
SyncDirectionType, SyncDirectionType,
VALID_REQURL,
WebdavAuthType, WebdavAuthType,
WebdavDepthType,
CipherMethodType,
QRExportType,
} from "./baseTypes"; } from "./baseTypes";
import cloneDeep from "lodash/cloneDeep";
import { API_VER_ENSURE_REQURL_OK, VALID_REQURL } from "./baseTypesObs";
import { messyConfigToNormal } from "./configPersist";
import { import {
exportVaultProfilerResultsToFiles, exportVaultProfilerResultsToFiles,
exportVaultSyncPlansToFiles, exportVaultSyncPlansToFiles,
} from "./debugMode"; } from "./debugMode";
import {
DEFAULT_DROPBOX_CONFIG,
getAuthUrlAndVerifier as getAuthUrlAndVerifierDropbox,
sendAuthReq as sendAuthReqDropbox,
setConfigBySuccessfullAuthInplace,
} from "./fsDropbox";
import { getClient } from "./fsGetter";
import {
DEFAULT_ONEDRIVE_CONFIG,
getAuthUrlAndVerifier as getAuthUrlAndVerifierOnedrive,
} from "./fsOnedrive";
import { simpleTransRemotePrefix } from "./fsS3";
import type { TransItemType } from "./i18n";
import { import {
exportQrCodeUri, exportQrCodeUri,
importQrCodeUri, importQrCodeUri,
@@ -41,27 +52,12 @@ import {
upsertLastSuccessSyncTimeByVault, upsertLastSuccessSyncTimeByVault,
} from "./localdb"; } from "./localdb";
import type RemotelySavePlugin from "./main"; // unavoidable import type RemotelySavePlugin from "./main"; // unavoidable
import { FakeFs } from "./fsAll";
import {
DEFAULT_DROPBOX_CONFIG,
getAuthUrlAndVerifier as getAuthUrlAndVerifierDropbox,
sendAuthReq as sendAuthReqDropbox,
setConfigBySuccessfullAuthInplace,
} from "./fsDropbox";
import {
DEFAULT_ONEDRIVE_CONFIG,
getAuthUrlAndVerifier as getAuthUrlAndVerifierOnedrive,
} from "./fsOnedrive";
import { messyConfigToNormal } from "./configPersist";
import type { TransItemType } from "./i18n";
import { import {
changeMobileStatusBar, changeMobileStatusBar,
checkHasSpecialCharForDir, checkHasSpecialCharForDir,
stringToFragment, stringToFragment,
} from "./misc"; } from "./misc";
import { simpleTransRemotePrefix } from "./fsS3"; import { DEFAULT_PROFILER_CONFIG } from "./profiler";
import cloneDeep from "lodash/cloneDeep";
import { getClient } from "./fsGetter";
class PasswordModal extends Modal { class PasswordModal extends Modal {
plugin: RemotelySavePlugin; plugin: RemotelySavePlugin;
@@ -73,7 +69,7 @@ class PasswordModal extends Modal {
} }
onOpen() { onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -128,7 +124,7 @@ class PasswordModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -141,7 +137,7 @@ class EncryptionMethodModal extends Modal {
} }
onOpen() { onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -167,7 +163,7 @@ class EncryptionMethodModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -189,7 +185,7 @@ class ChangeRemoteBaseDirModal extends Modal {
} }
onOpen() { onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -261,7 +257,7 @@ class ChangeRemoteBaseDirModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -280,7 +276,7 @@ class ChangeRemotePrefixModal extends Modal {
} }
onOpen() { onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -343,7 +339,7 @@ class ChangeRemotePrefixModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -368,7 +364,7 @@ class DropboxAuthModal extends Modal {
} }
async onOpen() { async onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -506,7 +502,7 @@ class DropboxAuthModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -531,7 +527,7 @@ export class OnedriveAuthModal extends Modal {
} }
async onOpen() { async onOpen() {
let { contentEl } = this; const { contentEl } = this;
const { authUrl, verifier } = await getAuthUrlAndVerifierOnedrive( const { authUrl, verifier } = await getAuthUrlAndVerifierOnedrive(
this.plugin.settings.onedrive.clientID, this.plugin.settings.onedrive.clientID,
@@ -580,7 +576,7 @@ export class OnedriveAuthModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -602,7 +598,7 @@ export class OnedriveRevokeAuthModal extends Modal {
} }
async onOpen() { async onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
}; };
@@ -650,7 +646,7 @@ export class OnedriveRevokeAuthModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -669,7 +665,7 @@ class SyncConfigDirModal extends Modal {
} }
async onOpen() { async onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -703,7 +699,7 @@ class SyncConfigDirModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -718,7 +714,7 @@ class ExportSettingsQrCodeModal extends Modal {
} }
async onOpen() { async onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
@@ -767,7 +763,7 @@ class ExportSettingsQrCodeModal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
} }
} }
@@ -807,7 +803,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
} }
display(): void { display(): void {
let { containerEl } = this; const { containerEl } = this;
containerEl.style.setProperty("overflow-wrap", "break-word"); containerEl.style.setProperty("overflow-wrap", "break-word");
containerEl.empty(); containerEl.empty();
@@ -1004,7 +1000,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${this.plugin.settings.s3.partsConcurrency}`) .setValue(`${this.plugin.settings.s3.partsConcurrency}`)
.onChange(async (val) => { .onChange(async (val) => {
const realVal = parseInt(val); const realVal = Number.parseInt(val);
this.plugin.settings.s3.partsConcurrency = realVal; this.plugin.settings.s3.partsConcurrency = realVal;
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
@@ -1083,7 +1079,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue( .setValue(
`${this.plugin.settings.s3.generateFolderObject ? "generate" : "notgenerate"}` `${
this.plugin.settings.s3.generateFolderObject
? "generate"
: "notgenerate"
}`
) )
.onChange(async (val) => { .onChange(async (val) => {
if (val === "generate") { if (val === "generate") {
@@ -1171,7 +1171,6 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.setButtonText(t("settings_dropbox_revoke_button")); button.setButtonText(t("settings_dropbox_revoke_button"));
button.onClick(async () => { button.onClick(async () => {
try { try {
const self = this;
const client = getClient( const client = getClient(
this.plugin.settings, this.plugin.settings,
this.app.vault.getName(), this.app.vault.getName(),
@@ -1282,7 +1281,6 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.setButtonText(t("settings_checkonnectivity_button")); button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => { button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking")); new Notice(t("settings_checkonnectivity_checking"));
const self = this;
const client = getClient( const client = getClient(
this.plugin.settings, this.plugin.settings,
this.app.vault.getName(), this.app.vault.getName(),
@@ -1420,6 +1418,20 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
new Setting(onedriveDiv)
.setName(t("settings_onedrive_emptyfile"))
.setDesc(t("settings_onedrive_emptyfile_desc"))
.addDropdown(async (dropdown) => {
dropdown
.addOption("skip", t("settings_onedrive_emptyfile_skip"))
.addOption("error", t("settings_onedrive_emptyfile_error"))
.setValue(this.plugin.settings.onedrive.emptyFile)
.onChange(async (val) => {
this.plugin.settings.onedrive.emptyFile = val as any;
await this.plugin.saveSettings();
});
});
new Setting(onedriveDiv) new Setting(onedriveDiv)
.setName(t("settings_checkonnectivity")) .setName(t("settings_checkonnectivity"))
.setDesc(t("settings_checkonnectivity_desc")) .setDesc(t("settings_checkonnectivity_desc"))
@@ -1427,7 +1439,6 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.setButtonText(t("settings_checkonnectivity_button")); button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => { button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking")); new Notice(t("settings_checkonnectivity_checking"));
const self = this;
const client = getClient( const client = getClient(
this.plugin.settings, this.plugin.settings,
this.app.vault.getName(), this.app.vault.getName(),
@@ -1632,7 +1643,6 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
button.setButtonText(t("settings_checkonnectivity_button")); button.setButtonText(t("settings_checkonnectivity_button"));
button.onClick(async () => { button.onClick(async () => {
new Notice(t("settings_checkonnectivity_checking")); new Notice(t("settings_checkonnectivity_checking"));
const self = this;
const client = getClient( const client = getClient(
this.plugin.settings, this.plugin.settings,
this.app.vault.getName(), this.app.vault.getName(),
@@ -1655,6 +1665,131 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
//////////////////////////////////////////////////
// below for webdis
//////////////////////////////////////////////////
const webdisDiv = containerEl.createEl("div", { cls: "webdis-hide" });
webdisDiv.toggleClass(
"webdis-hide",
this.plugin.settings.serviceType !== "webdis"
);
webdisDiv.createEl("h2", { text: t("settings_webdis") });
const webdisLongDescDiv = webdisDiv.createEl("div", {
cls: "settings-long-desc",
});
for (const c of [
t("settings_webdis_disclaimer1"),
t("settings_webdis_disclaimer2"),
]) {
webdisLongDescDiv.createEl("p", {
text: c,
cls: "webdis-disclaimer",
});
}
webdisLongDescDiv.createEl("p", {
text: t("settings_webdis_folder", {
remoteBaseDir:
this.plugin.settings.webdis.remoteBaseDir || this.app.vault.getName(),
}),
});
new Setting(webdisDiv)
.setName(t("settings_webdis_addr"))
.setDesc(t("settings_webdis_addr_desc"))
.addText((text) =>
text
.setPlaceholder("https://")
.setValue(this.plugin.settings.webdis.address)
.onChange(async (value) => {
this.plugin.settings.webdis.address = value.trim();
// normally saved
await this.plugin.saveSettings();
})
);
new Setting(webdisDiv)
.setName(t("settings_webdis_user"))
.setDesc(t("settings_webdis_user_desc"))
.addText((text) => {
wrapTextWithPasswordHide(text);
text
.setPlaceholder("")
.setValue(this.plugin.settings.webdis.username ?? "")
.onChange(async (value) => {
this.plugin.settings.webdis.username = (value ?? "").trim();
await this.plugin.saveSettings();
});
});
new Setting(webdisDiv)
.setName(t("settings_webdis_password"))
.setDesc(t("settings_webdis_password_desc"))
.addText((text) => {
wrapTextWithPasswordHide(text);
text
.setPlaceholder("")
.setValue(this.plugin.settings.webdis.password ?? "")
.onChange(async (value) => {
this.plugin.settings.webdis.password = (value ?? "").trim();
await this.plugin.saveSettings();
});
});
let newWebdisRemoteBaseDir =
this.plugin.settings.webdis.remoteBaseDir || "";
new Setting(webdisDiv)
.setName(t("settings_remotebasedir"))
.setDesc(t("settings_remotebasedir_desc"))
.addText((text) =>
text
.setPlaceholder(this.app.vault.getName())
.setValue(newWebdisRemoteBaseDir)
.onChange((value) => {
newWebdisRemoteBaseDir = value.trim();
})
)
.addButton((button) => {
button.setButtonText(t("confirm"));
button.onClick(() => {
new ChangeRemoteBaseDirModal(
this.app,
this.plugin,
newWebdisRemoteBaseDir,
"webdis"
).open();
});
});
new Setting(webdisDiv)
.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(
this.plugin.settings,
this.app.vault.getName(),
() => this.plugin.saveSettings()
);
const errors = { msg: "" };
const res = await client.checkConnect((err: any) => {
errors.msg = `${err}`;
});
if (res) {
new Notice(t("settings_webdis_connect_succ"));
} else {
new Notice(t("settings_webdis_connect_fail"));
new Notice(errors.msg);
}
});
});
////////////////////////////////////////////////// //////////////////////////////////////////////////
// below for general chooser (part 2/2) // below for general chooser (part 2/2)
////////////////////////////////////////////////// //////////////////////////////////////////////////
@@ -1669,6 +1804,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown.addOption("dropbox", t("settings_chooseservice_dropbox")); dropdown.addOption("dropbox", t("settings_chooseservice_dropbox"));
dropdown.addOption("webdav", t("settings_chooseservice_webdav")); dropdown.addOption("webdav", t("settings_chooseservice_webdav"));
dropdown.addOption("onedrive", t("settings_chooseservice_onedrive")); dropdown.addOption("onedrive", t("settings_chooseservice_onedrive"));
dropdown.addOption("webdis", t("settings_chooseservice_webdis"));
dropdown dropdown
.setValue(this.plugin.settings.serviceType) .setValue(this.plugin.settings.serviceType)
.onChange(async (val) => { .onChange(async (val) => {
@@ -1689,6 +1826,10 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
"webdav-hide", "webdav-hide",
this.plugin.settings.serviceType !== "webdav" this.plugin.settings.serviceType !== "webdav"
); );
webdisDiv.toggleClass(
"webdis-hide",
this.plugin.settings.serviceType !== "webdis"
);
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
}); });
@@ -1750,7 +1891,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${this.plugin.settings.autoRunEveryMilliseconds}`) .setValue(`${this.plugin.settings.autoRunEveryMilliseconds}`)
.onChange(async (val: string) => { .onChange(async (val: string) => {
const realVal = parseInt(val); const realVal = Number.parseInt(val);
this.plugin.settings.autoRunEveryMilliseconds = realVal; this.plugin.settings.autoRunEveryMilliseconds = realVal;
await this.plugin.saveSettings(); await this.plugin.saveSettings();
if ( if (
@@ -1795,7 +1936,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${this.plugin.settings.initRunAfterMilliseconds}`) .setValue(`${this.plugin.settings.initRunAfterMilliseconds}`)
.onChange(async (val: string) => { .onChange(async (val: string) => {
const realVal = parseInt(val); const realVal = Number.parseInt(val);
this.plugin.settings.initRunAfterMilliseconds = realVal; this.plugin.settings.initRunAfterMilliseconds = realVal;
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
@@ -1815,7 +1956,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${syncOnSaveEnabled ? "1000" : "-1"}`) .setValue(`${syncOnSaveEnabled ? "1000" : "-1"}`)
.onChange(async (val: string) => { .onChange(async (val: string) => {
this.plugin.settings.syncOnSaveAfterMilliseconds = parseInt(val); this.plugin.settings.syncOnSaveAfterMilliseconds =
Number.parseInt(val);
await this.plugin.saveSettings(); await this.plugin.saveSettings();
this.plugin.toggleSyncOnSaveIfSet(); this.plugin.toggleSyncOnSaveIfSet();
}); });
@@ -1827,14 +1969,14 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
.addDropdown((dropdown) => { .addDropdown((dropdown) => {
dropdown.addOption("-1", t("settings_skiplargefiles_notset")); dropdown.addOption("-1", t("settings_skiplargefiles_notset"));
const mbs = [1, 5, 10, 50, 100, 500, 1000]; const mbs = [1, 5, 10, 20, 50, 100, 200, 500, 1000];
for (const mb of mbs) { for (const mb of mbs) {
dropdown.addOption(`${mb * 1000 * 1000}`, `${mb} MB`); dropdown.addOption(`${mb * 1000 * 1000}`, `${mb} MB`);
} }
dropdown dropdown
.setValue(`${this.plugin.settings.skipSizeLargerThan}`) .setValue(`${this.plugin.settings.skipSizeLargerThan}`)
.onChange(async (val) => { .onChange(async (val) => {
this.plugin.settings.skipSizeLargerThan = parseInt(val); this.plugin.settings.skipSizeLargerThan = Number.parseInt(val);
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
}); });
@@ -1916,7 +2058,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${this.plugin.settings.concurrency}`) .setValue(`${this.plugin.settings.concurrency}`)
.onChange(async (val) => { .onChange(async (val) => {
const realVal = parseInt(val); const realVal = Number.parseInt(val);
this.plugin.settings.concurrency = realVal; this.plugin.settings.concurrency = realVal;
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
@@ -2044,7 +2186,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
dropdown dropdown
.setValue(`${this.plugin.settings.protectModifyPercentage ?? 50}`) .setValue(`${this.plugin.settings.protectModifyPercentage ?? 50}`)
.onChange(async (val) => { .onChange(async (val) => {
this.plugin.settings.protectModifyPercentage = parseInt(val); this.plugin.settings.protectModifyPercentage = Number.parseInt(val);
await this.plugin.saveSettings(); await this.plugin.saveSettings();
}); });
}); });
@@ -2119,13 +2261,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
importExportDiv.createEl("h2", { importExportDiv.createEl("h2", {
text: t("settings_importexport"), text: t("settings_importexport"),
}); });
if (Platform.isMobile) {
importExportDiv.addClass("setting-need-wrapping-mobile");
}
new Setting(importExportDiv) const importExportDivSetting1 = new Setting(importExportDiv)
.setName(t("settings_export")) .setName(t("settings_export"))
.setDesc(t("settings_export_desc")) .setDesc(t("settings_export_desc"));
importExportDivSetting1.settingEl.addClass("setting-need-wrapping");
importExportDivSetting1
.addButton(async (button) => { .addButton(async (button) => {
button.setButtonText(t("settings_export_all_but_oauth2_button")); button.setButtonText(t("settings_export_all_but_oauth2_button"));
button.onClick(async () => { button.onClick(async () => {
@@ -2271,9 +2412,24 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
.setName(t("settings_viewconsolelog")) .setName(t("settings_viewconsolelog"))
.setDesc(stringToFragment(t("settings_viewconsolelog_desc"))); .setDesc(stringToFragment(t("settings_viewconsolelog_desc")));
new Setting(debugDiv) const debugDivExportSyncPlans = new Setting(debugDiv)
.setName(t("settings_syncplans")) .setName(t("settings_syncplans"))
.setDesc(t("settings_syncplans_desc")) .setDesc(t("settings_syncplans_desc"));
debugDivExportSyncPlans.settingEl.addClass("setting-need-wrapping");
debugDivExportSyncPlans
.addButton(async (button) => {
button.setButtonText(t("settings_syncplans_button_1_only_change"));
button.onClick(async () => {
await exportVaultSyncPlansToFiles(
this.plugin.db,
this.app.vault,
this.plugin.vaultRandomID,
1,
true
);
new Notice(t("settings_syncplans_notice"));
});
})
.addButton(async (button) => { .addButton(async (button) => {
button.setButtonText(t("settings_syncplans_button_1")); button.setButtonText(t("settings_syncplans_button_1"));
button.onClick(async () => { button.onClick(async () => {
@@ -2281,7 +2437,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.db, this.plugin.db,
this.app.vault, this.app.vault,
this.plugin.vaultRandomID, this.plugin.vaultRandomID,
1 1,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}); });
@@ -2293,7 +2450,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.db, this.plugin.db,
this.app.vault, this.app.vault,
this.plugin.vaultRandomID, this.plugin.vaultRandomID,
5 5,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}); });
@@ -2305,7 +2463,8 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
this.plugin.db, this.plugin.db,
this.app.vault, this.app.vault,
this.plugin.vaultRandomID, this.plugin.vaultRandomID,
-1 -1,
false
); );
new Notice(t("settings_syncplans_notice")); new Notice(t("settings_syncplans_notice"));
}); });
@@ -2351,6 +2510,44 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
}); });
}); });
new Setting(debugDiv)
.setName(t("settings_profiler_enabledebugprint"))
.setDesc(t("settings_profiler_enabledebugprint_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("enable", t("enable"));
dropdown.addOption("disable", t("disable"));
dropdown
.setValue(
this.plugin.settings.profiler?.enablePrinting ? "enable" : "disable"
)
.onChange(async (val: string) => {
if (this.plugin.settings.profiler === undefined) {
this.plugin.settings.profiler = DEFAULT_PROFILER_CONFIG;
}
this.plugin.settings.profiler.enablePrinting = val === "enable";
await this.plugin.saveSettings();
});
});
new Setting(debugDiv)
.setName(t("settings_profiler_recordsize"))
.setDesc(t("settings_profiler_recordsize_desc"))
.addDropdown((dropdown) => {
dropdown.addOption("enable", t("enable"));
dropdown.addOption("disable", t("disable"));
dropdown
.setValue(
this.plugin.settings.profiler?.recordSize ? "enable" : "disable"
)
.onChange(async (val: string) => {
if (this.plugin.settings.profiler === undefined) {
this.plugin.settings.profiler = DEFAULT_PROFILER_CONFIG;
}
this.plugin.settings.profiler.recordSize = val === "enable";
await this.plugin.saveSettings();
});
});
new Setting(debugDiv) new Setting(debugDiv)
.setName(t("settings_outputbasepathvaultid")) .setName(t("settings_outputbasepathvaultid"))
.setDesc(t("settings_outputbasepathvaultid_desc")) .setDesc(t("settings_outputbasepathvaultid_desc"))
@@ -2376,7 +2573,7 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
} }
hide() { hide() {
let { containerEl } = this; const { containerEl } = this;
containerEl.empty(); containerEl.empty();
super.hide(); super.hide();
} }
+208 -105
View File
@@ -1,5 +1,8 @@
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
import AggregateError from "aggregate-error";
import PQueue from "p-queue";
import XRegExp from "xregexp"; import XRegExp from "xregexp";
import { import type {
ConflictActionType, ConflictActionType,
EmptyFolderCleanType, EmptyFolderCleanType,
Entity, Entity,
@@ -9,29 +12,28 @@ import {
SyncDirectionType, SyncDirectionType,
SyncTriggerSourceType, SyncTriggerSourceType,
} from "./baseTypes"; } from "./baseTypes";
import { FakeFs } from "./fsAll"; import type { FakeFs } from "./fsAll";
import { FakeFsEncrypt } from "./fsEncrypt"; import type { FakeFsEncrypt } from "./fsEncrypt";
import { import {
InternalDBs, type InternalDBs,
clearPrevSyncRecordByVaultAndProfile, clearPrevSyncRecordByVaultAndProfile,
getAllPrevSyncRecordsByVaultAndProfile, getAllPrevSyncRecordsByVaultAndProfile,
insertSyncPlanRecordByVault, insertSyncPlanRecordByVault,
upsertPrevSyncRecordByVaultAndProfile, upsertPrevSyncRecordByVaultAndProfile,
} from "./localdb"; } from "./localdb";
import {
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE,
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
} from "./metadataOnRemote";
import { import {
atWhichLevel, atWhichLevel,
getParentFolder, getParentFolder,
isHiddenPath, isHiddenPath,
isSpecialFolderNameToSkip, isSpecialFolderNameToSkip,
roughSizeOfObject,
unixTimeToStr, unixTimeToStr,
} from "./misc"; } from "./misc";
import { Profiler } from "./profiler"; import type { Profiler } from "./profiler";
import {
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE,
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
} from "./metadataOnRemote";
import AggregateError from "aggregate-error";
import PQueue from "p-queue";
const copyEntityAndFixTimeFormat = ( const copyEntityAndFixTimeFormat = (
src: Entity, src: Entity,
@@ -153,10 +155,13 @@ const ensembleMixedEnties = async (
fsEncrypt: FakeFsEncrypt, fsEncrypt: FakeFsEncrypt,
serviceType: SUPPORTED_SERVICES_TYPE, serviceType: SUPPORTED_SERVICES_TYPE,
profiler: Profiler profiler: Profiler | undefined
): Promise<SyncPlanType> => { ): Promise<SyncPlanType> => {
profiler.addIndent(); profiler?.addIndent();
profiler.insert("ensembleMixedEnties: enter"); profiler?.insert("ensembleMixedEnties: enter");
profiler?.insertSize("sizeof localEntityList", localEntityList);
profiler?.insertSize("sizeof prevSyncEntityList", prevSyncEntityList);
profiler?.insertSize("sizeof remoteEntityList", remoteEntityList);
const finalMappings: SyncPlanType = {}; const finalMappings: SyncPlanType = {};
@@ -185,7 +190,8 @@ const ensembleMixedEnties = async (
}; };
} }
profiler.insert("ensembleMixedEnties: finish remote"); profiler?.insert("ensembleMixedEnties: finish remote");
profiler?.insertSize("sizeof finalMappings", finalMappings);
if (Object.keys(finalMappings).length === 0 || localEntityList.length === 0) { if (Object.keys(finalMappings).length === 0 || localEntityList.length === 0) {
// Special checking: // Special checking:
@@ -225,7 +231,8 @@ const ensembleMixedEnties = async (
} }
} }
profiler.insert("ensembleMixedEnties: finish prevSync"); profiler?.insert("ensembleMixedEnties: finish prevSync");
profiler?.insertSize("sizeof finalMappings", finalMappings);
// local has to be last // local has to be last
// because we want to get keyEnc based on the remote // because we want to get keyEnc based on the remote
@@ -258,13 +265,14 @@ const ensembleMixedEnties = async (
} }
} }
profiler.insert("ensembleMixedEnties: finish local"); profiler?.insert("ensembleMixedEnties: finish local");
profiler?.insertSize("sizeof finalMappings", finalMappings);
console.debug("in the end of ensembleMixedEnties, finalMappings is:"); // console.debug("in the end of ensembleMixedEnties, finalMappings is:");
console.debug(finalMappings); // console.debug(finalMappings);
profiler.insert("ensembleMixedEnties: exit"); profiler?.insert("ensembleMixedEnties: exit");
profiler.removeIndent(); profiler?.removeIndent();
return finalMappings; return finalMappings;
}; };
@@ -279,19 +287,28 @@ const getSyncPlanInplace = async (
skipSizeLargerThan: number, skipSizeLargerThan: number,
conflictAction: ConflictActionType, conflictAction: ConflictActionType,
syncDirection: SyncDirectionType, syncDirection: SyncDirectionType,
profiler: Profiler profiler: Profiler | undefined,
settings: RemotelySavePluginSettings,
triggerSource: SyncTriggerSourceType
) => { ) => {
profiler.addIndent(); profiler?.addIndent();
profiler.insert("getSyncPlanInplace: enter"); profiler?.insert("getSyncPlanInplace: enter");
// from long(deep) to short(shadow) // from long(deep) to short(shadow)
const sortedKeys = Object.keys(mixedEntityMappings).sort( const sortedKeys = Object.keys(mixedEntityMappings).sort(
(k1, k2) => k2.length - k1.length (k1, k2) => k2.length - k1.length
); );
profiler.insert("getSyncPlanInplace: finish sorting"); profiler?.insert("getSyncPlanInplace: finish sorting");
profiler?.insertSize("sizeof sortedKeys", sortedKeys);
const keptFolder = new Set<string>(); const keptFolder = new Set<string>();
for (let i = 0; i < sortedKeys.length; ++i) { for (let i = 0; i < sortedKeys.length; ++i) {
if (i % 100 === 0) {
profiler?.insertSize(
`sizeof sortedKeys in the beginning of i=${i}`,
mixedEntityMappings
);
}
const key = sortedKeys[i]; const key = sortedKeys[i];
const mixedEntry = mixedEntityMappings[key]; const mixedEntry = mixedEntityMappings[key];
const { local, prevSync, remote } = mixedEntry; const { local, prevSync, remote } = mixedEntry;
@@ -309,69 +326,83 @@ const getSyncPlanInplace = async (
if (local !== undefined && remote !== undefined) { if (local !== undefined && remote !== undefined) {
mixedEntry.decisionBranch = 101; mixedEntry.decisionBranch = 101;
mixedEntry.decision = "folder_existed_both_then_do_nothing"; mixedEntry.decision = "folder_existed_both_then_do_nothing";
mixedEntry.change = false;
} else if (local !== undefined && remote === undefined) { } else if (local !== undefined && remote === undefined) {
if (syncDirection === "incremental_pull_only") { if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 107; mixedEntry.decisionBranch = 107;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} else { } else {
mixedEntry.decisionBranch = 102; mixedEntry.decisionBranch = 102;
mixedEntry.decision = mixedEntry.decision =
"folder_existed_local_then_also_create_remote"; "folder_existed_local_then_also_create_remote";
mixedEntry.change = true;
} }
} else if (local === undefined && remote !== undefined) { } else if (local === undefined && remote !== undefined) {
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 108; mixedEntry.decisionBranch = 108;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} else { } else {
mixedEntry.decisionBranch = 103; mixedEntry.decisionBranch = 103;
mixedEntry.decision = mixedEntry.decision =
"folder_existed_remote_then_also_create_local"; "folder_existed_remote_then_also_create_local";
mixedEntry.change = true;
} }
} else { } else {
// why?? how?? // why?? how??
mixedEntry.decisionBranch = 104; mixedEntry.decisionBranch = 104;
mixedEntry.decision = "folder_to_be_created"; mixedEntry.decision = "folder_to_be_created";
mixedEntry.change = true;
} }
keptFolder.delete(key); // no need to save it in the Set later keptFolder.delete(key); // no need to save it in the Set later
} else { } else {
if (howToCleanEmptyFolder === "skip") { if (howToCleanEmptyFolder === "skip") {
mixedEntry.decisionBranch = 105; mixedEntry.decisionBranch = 105;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} else if (howToCleanEmptyFolder === "clean_both") { } else if (howToCleanEmptyFolder === "clean_both") {
if (local !== undefined && remote !== undefined) { if (local !== undefined && remote !== undefined) {
if (syncDirection === "bidirectional") { if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 106; mixedEntry.decisionBranch = 106;
mixedEntry.decision = "folder_to_be_deleted_on_both"; mixedEntry.decision = "folder_to_be_deleted_on_both";
mixedEntry.change = true;
} else { } else {
// right now it does nothing because of "incremental" // right now it does nothing because of "incremental"
// TODO: should we delete?? // TODO: should we delete??
mixedEntry.decisionBranch = 109; mixedEntry.decisionBranch = 109;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} else if (local !== undefined && remote === undefined) { } else if (local !== undefined && remote === undefined) {
if (syncDirection === "bidirectional") { if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 110; mixedEntry.decisionBranch = 110;
mixedEntry.decision = "folder_to_be_deleted_on_local"; mixedEntry.decision = "folder_to_be_deleted_on_local";
mixedEntry.change = true;
} else { } else {
// right now it does nothing because of "incremental" // right now it does nothing because of "incremental"
// TODO: should we delete?? // TODO: should we delete??
mixedEntry.decisionBranch = 111; mixedEntry.decisionBranch = 111;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} else if (local === undefined && remote !== undefined) { } else if (local === undefined && remote !== undefined) {
if (syncDirection === "bidirectional") { if (syncDirection === "bidirectional") {
mixedEntry.decisionBranch = 112; mixedEntry.decisionBranch = 112;
mixedEntry.decision = "folder_to_be_deleted_on_remote"; mixedEntry.decision = "folder_to_be_deleted_on_remote";
mixedEntry.change = true;
} else { } else {
// right now it does nothing because of "incremental" // right now it does nothing because of "incremental"
// TODO: should we delete?? // TODO: should we delete??
mixedEntry.decisionBranch = 113; mixedEntry.decisionBranch = 113;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} else { } else {
// no folder to delete, do nothing // no folder to delete, do nothing
mixedEntry.decisionBranch = 114; mixedEntry.decisionBranch = 114;
mixedEntry.decision = "folder_to_skip"; mixedEntry.decision = "folder_to_skip";
mixedEntry.change = false;
} }
} else { } else {
throw Error( throw Error(
@@ -386,6 +417,7 @@ const getSyncPlanInplace = async (
// both deleted, only in history // both deleted, only in history
mixedEntry.decisionBranch = 1; mixedEntry.decisionBranch = 1;
mixedEntry.decision = "only_history"; mixedEntry.decision = "only_history";
mixedEntry.change = false;
} else if (local !== undefined && remote !== undefined) { } else if (local !== undefined && remote !== undefined) {
if ( if (
(local.mtimeCli === remote.mtimeCli || (local.mtimeCli === remote.mtimeCli ||
@@ -395,6 +427,7 @@ const getSyncPlanInplace = async (
// completely equal / identical // completely equal / identical
mixedEntry.decisionBranch = 2; mixedEntry.decisionBranch = 2;
mixedEntry.decision = "equal"; mixedEntry.decision = "equal";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
// Both exists, but modified or conflict // Both exists, but modified or conflict
@@ -417,10 +450,12 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 26; mixedEntry.decisionBranch = 26;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 9; mixedEntry.decisionBranch = 9;
mixedEntry.decision = "remote_is_modified_then_pull"; mixedEntry.decision = "remote_is_modified_then_pull";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
@@ -439,10 +474,12 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_pull_only") { if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 27; mixedEntry.decisionBranch = 27;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 10; mixedEntry.decisionBranch = 10;
mixedEntry.decision = "local_is_modified_then_push"; mixedEntry.decision = "local_is_modified_then_push";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
@@ -464,34 +501,41 @@ const getSyncPlanInplace = async (
) { ) {
mixedEntry.decisionBranch = 11; mixedEntry.decisionBranch = 11;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 12; mixedEntry.decisionBranch = 12;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (conflictAction === "keep_larger") { } else if (conflictAction === "keep_larger") {
if (local.sizeEnc! >= remote.sizeEnc!) { if (local.sizeEnc! >= remote.sizeEnc!) {
mixedEntry.decisionBranch = 13; mixedEntry.decisionBranch = 13;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 14; mixedEntry.decisionBranch = 14;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
mixedEntry.decisionBranch = 15; mixedEntry.decisionBranch = 15;
mixedEntry.decision = "conflict_created_then_keep_both"; mixedEntry.decision = "conflict_created_then_keep_both";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (syncDirection === "incremental_pull_only") { } else if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 22; mixedEntry.decisionBranch = 22;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_push_only") { } else if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 23; mixedEntry.decisionBranch = 23;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
throw Error( throw Error(
@@ -508,34 +552,41 @@ const getSyncPlanInplace = async (
) { ) {
mixedEntry.decisionBranch = 16; mixedEntry.decisionBranch = 16;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 17; mixedEntry.decisionBranch = 17;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (conflictAction === "keep_larger") { } else if (conflictAction === "keep_larger") {
if (local.sizeEnc! >= remote.sizeEnc!) { if (local.sizeEnc! >= remote.sizeEnc!) {
mixedEntry.decisionBranch = 18; mixedEntry.decisionBranch = 18;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 19; mixedEntry.decisionBranch = 19;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
mixedEntry.decisionBranch = 20; mixedEntry.decisionBranch = 20;
mixedEntry.decision = "conflict_modified_then_keep_both"; mixedEntry.decision = "conflict_modified_then_keep_both";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if (syncDirection === "incremental_pull_only") { } else if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 24; mixedEntry.decisionBranch = 24;
mixedEntry.decision = "conflict_modified_then_keep_remote"; mixedEntry.decision = "conflict_modified_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_push_only") { } else if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 25; mixedEntry.decisionBranch = 25;
mixedEntry.decision = "conflict_modified_then_keep_local"; mixedEntry.decision = "conflict_modified_then_keep_local";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
throw Error( throw Error(
@@ -549,6 +600,7 @@ const getSyncPlanInplace = async (
// The result should be equal!!! // The result should be equal!!!
mixedEntry.decisionBranch = 21; mixedEntry.decisionBranch = 21;
mixedEntry.decision = "equal"; mixedEntry.decision = "equal";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} }
@@ -563,15 +615,18 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 28; mixedEntry.decisionBranch = 28;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 3; mixedEntry.decisionBranch = 3;
mixedEntry.decision = "remote_is_created_then_pull"; mixedEntry.decision = "remote_is_created_then_pull";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
mixedEntry.decisionBranch = 36; mixedEntry.decisionBranch = 36;
mixedEntry.decision = "remote_is_created_too_large_then_do_nothing"; mixedEntry.decision = "remote_is_created_too_large_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if ( } else if (
@@ -583,14 +638,17 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 29; mixedEntry.decisionBranch = 29;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else if (syncDirection === "incremental_pull_only") { } else if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 35; mixedEntry.decisionBranch = 35;
mixedEntry.decision = "conflict_created_then_keep_remote"; mixedEntry.decision = "conflict_created_then_keep_remote";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 4; mixedEntry.decisionBranch = 4;
mixedEntry.decision = "local_is_deleted_thus_also_delete_remote"; mixedEntry.decision = "local_is_deleted_thus_also_delete_remote";
mixedEntry.change = true;
} }
} else { } else {
// if B is in the previous list and MODIFIED, B has been deleted by A but modified by B // if B is in the previous list and MODIFIED, B has been deleted by A but modified by B
@@ -601,10 +659,12 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 30; mixedEntry.decisionBranch = 30;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 5; mixedEntry.decisionBranch = 5;
mixedEntry.decision = "remote_is_modified_then_pull"; mixedEntry.decision = "remote_is_modified_then_pull";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
@@ -624,15 +684,18 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_pull_only") { if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 31; mixedEntry.decisionBranch = 31;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 6; mixedEntry.decisionBranch = 6;
mixedEntry.decision = "local_is_created_then_push"; mixedEntry.decision = "local_is_created_then_push";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
mixedEntry.decisionBranch = 37; mixedEntry.decisionBranch = 37;
mixedEntry.decision = "local_is_created_too_large_then_do_nothing"; mixedEntry.decision = "local_is_created_too_large_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else if ( } else if (
@@ -644,12 +707,15 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_push_only") { if (syncDirection === "incremental_push_only") {
mixedEntry.decisionBranch = 32; mixedEntry.decisionBranch = 32;
mixedEntry.decision = "conflict_created_then_keep_local"; mixedEntry.decision = "conflict_created_then_keep_local";
mixedEntry.change = true;
} else if (syncDirection === "incremental_pull_only") { } else if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 33; mixedEntry.decisionBranch = 33;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
} else { } else {
mixedEntry.decisionBranch = 7; mixedEntry.decisionBranch = 7;
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local"; mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
mixedEntry.change = true;
} }
} else { } else {
// if A is in the previous list and MODIFIED, A has been deleted by B but modified by A // if A is in the previous list and MODIFIED, A has been deleted by B but modified by A
@@ -657,10 +723,12 @@ const getSyncPlanInplace = async (
if (syncDirection === "incremental_pull_only") { if (syncDirection === "incremental_pull_only") {
mixedEntry.decisionBranch = 34; mixedEntry.decisionBranch = 34;
mixedEntry.decision = "conflict_created_then_do_nothing"; mixedEntry.decision = "conflict_created_then_do_nothing";
mixedEntry.change = false;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} else { } else {
mixedEntry.decisionBranch = 8; mixedEntry.decisionBranch = 8;
mixedEntry.decision = "local_is_modified_then_push"; mixedEntry.decision = "local_is_modified_then_push";
mixedEntry.change = true;
keptFolder.add(getParentFolder(key)); keptFolder.add(getParentFolder(key));
} }
} else { } else {
@@ -689,7 +757,7 @@ const getSyncPlanInplace = async (
} }
} }
profiler.insert("getSyncPlanInplace: finish looping"); profiler?.insert("getSyncPlanInplace: finish looping");
keptFolder.delete("/"); keptFolder.delete("/");
keptFolder.delete(""); keptFolder.delete("");
@@ -702,17 +770,29 @@ const getSyncPlanInplace = async (
const currTimeFmt = unixTimeToStr(currTime); const currTimeFmt = unixTimeToStr(currTime);
// because the path should not as / in the beginning, // because the path should not as / in the beginning,
// we should be safe to add these keys: // we should be safe to add these keys:
const sizeofmixedEntityMappings = roughSizeOfObject(mixedEntityMappings);
mixedEntityMappings["/$@meta"] = { mixedEntityMappings["/$@meta"] = {
key: "/$@meta", // don't mess up with the types key: "/$@meta", // don't mess up with the types
sideNotes: { sideNotes: {
version: "2024047 fs version", version: "20240508 fs version",
generateTime: currTime, generateTime: currTime,
generateTimeFmt: currTimeFmt, generateTimeFmt: currTimeFmt,
service: settings.serviceType,
hasPassword: settings.password !== "",
syncConfigDir: settings.syncConfigDir,
conflictAction: conflictAction,
syncDirection: syncDirection,
triggerSource: triggerSource,
sizeof: sizeofmixedEntityMappings,
}, },
}; };
profiler.insert("getSyncPlanInplace: exit"); profiler?.insert("getSyncPlanInplace: exit");
profiler.removeIndent(); profiler?.insertSize(
"sizeof mixedEntityMappings in the end of getSyncPlanInplace",
mixedEntityMappings
);
profiler?.removeIndent();
return mixedEntityMappings; return mixedEntityMappings;
}; };
@@ -921,12 +1001,21 @@ async function copyFile(
} }
// console.debug(`copyFile: about to start right.writeFile`); // console.debug(`copyFile: about to start right.writeFile`);
return await right.writeFile( if (typeof (content as any).transfer === "function") {
key, return await right.writeFile(
content, key,
statsLeft.mtimeCli, (content as any).transfer(),
statsLeft.mtimeCli /* TODO */ statsLeft.mtimeCli,
); statsLeft.mtimeCli /* TODO */
);
} else {
return await right.writeFile(
key,
content,
statsLeft.mtimeCli,
statsLeft.mtimeCli /* TODO */
);
}
} }
async function copyFileOrFolder( async function copyFileOrFolder(
@@ -1101,11 +1190,11 @@ export const doActualSync = async (
protectModifyPercentage: number, protectModifyPercentage: number,
getProtectModifyPercentageErrorStrFunc: any, getProtectModifyPercentageErrorStrFunc: any,
db: InternalDBs, db: InternalDBs,
profiler: Profiler, profiler: Profiler | undefined,
callbackSyncProcess?: any callbackSyncProcess?: any
) => { ) => {
profiler.addIndent(); profiler?.addIndent();
profiler.insert("doActualSync: enter"); profiler?.insert("doActualSync: enter");
console.debug(`concurrency === ${concurrency}`); console.debug(`concurrency === ${concurrency}`);
const { const {
onlyMarkSyncedOps, onlyMarkSyncedOps,
@@ -1123,7 +1212,17 @@ export const doActualSync = async (
console.debug(`allFilesCount: ${allFilesCount}`); console.debug(`allFilesCount: ${allFilesCount}`);
console.debug(`realModifyDeleteCount: ${realModifyDeleteCount}`); console.debug(`realModifyDeleteCount: ${realModifyDeleteCount}`);
console.debug(`realTotalCount: ${realTotalCount}`); console.debug(`realTotalCount: ${realTotalCount}`);
profiler.insert("doActualSync: finish splitting steps"); profiler?.insert("doActualSync: finish splitting steps");
profiler?.insertSize(
"doActualSync: sizeof onlyMarkSyncedOps",
onlyMarkSyncedOps
);
profiler?.insertSize(
"doActualSync: sizeof folderCreationOps",
folderCreationOps
);
profiler?.insertSize("doActualSync: sizeof realTotalCount", deletionOps);
console.debug(`protectModifyPercentage: ${protectModifyPercentage}`); console.debug(`protectModifyPercentage: ${protectModifyPercentage}`);
@@ -1148,8 +1247,8 @@ export const doActualSync = async (
allFilesCount allFilesCount
); );
profiler.insert("doActualSync: error branch"); profiler?.insert("doActualSync: error branch");
profiler.removeIndent(); profiler?.removeIndent();
throw Error(errorStr); throw Error(errorStr);
} }
} }
@@ -1169,8 +1268,8 @@ export const doActualSync = async (
let realCounter = 0; let realCounter = 0;
for (let i = 0; i < nested.length; ++i) { for (let i = 0; i < nested.length; ++i) {
profiler.addIndent(); profiler?.addIndent();
profiler.insert(`doActualSync: step ${i} start`); profiler?.insert(`doActualSync: step ${i} start`);
console.debug(logTexts[i]); console.debug(logTexts[i]);
const operations = nested[i]; const operations = nested[i];
@@ -1243,12 +1342,12 @@ export const doActualSync = async (
} }
} }
profiler.insert(`doActualSync: step ${i} end`); profiler?.insert(`doActualSync: step ${i} end`);
profiler.removeIndent(); profiler?.removeIndent();
} }
profiler.insert(`doActualSync: exit`); profiler?.insert(`doActualSync: exit`);
profiler.removeIndent(); profiler?.removeIndent();
}; };
export type SyncStatusType = export type SyncStatusType =
@@ -1270,7 +1369,7 @@ export async function syncer(
fsLocal: FakeFs, fsLocal: FakeFs,
fsRemote: FakeFs, fsRemote: FakeFs,
fsEncrypt: FakeFsEncrypt, fsEncrypt: FakeFsEncrypt,
profiler: Profiler, profiler: Profiler | undefined,
db: InternalDBs, db: InternalDBs,
triggerSource: SyncTriggerSourceType, triggerSource: SyncTriggerSourceType,
profileID: string, profileID: string,
@@ -1282,68 +1381,78 @@ export async function syncer(
notifyFunc?: (s: SyncTriggerSourceType, step: number) => Promise<any>, notifyFunc?: (s: SyncTriggerSourceType, step: number) => Promise<any>,
errNotifyFunc?: (s: SyncTriggerSourceType, error: Error) => Promise<any>, errNotifyFunc?: (s: SyncTriggerSourceType, error: Error) => Promise<any>,
ribboonFunc?: (s: SyncTriggerSourceType, step: number) => Promise<any>, ribboonFunc?: (s: SyncTriggerSourceType, step: number) => Promise<any>,
statusBarFunc?: (s: SyncTriggerSourceType, step: number) => any, statusBarFunc?: (
s: SyncTriggerSourceType,
step: number,
everythingOk: boolean
) => any,
callbackSyncProcess?: any callbackSyncProcess?: any
) { ) {
console.info(`startting sync.`);
markIsSyncingFunc(true); markIsSyncingFunc(true);
let everythingOk = true;
let step = 0; // dry mode only let step = 0; // dry mode only
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
step = 1; step = 1;
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step); await statusBarFunc?.(triggerSource, step, everythingOk);
profiler.insert("start big sync func"); profiler?.insert("start big sync func");
try { try {
step = 2;
await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step, everythingOk);
if (fsEncrypt.innerFs !== fsRemote) { if (fsEncrypt.innerFs !== fsRemote) {
throw Error(`your enc should has inner of the remote`); throw Error(`your enc should has inner of the remote`);
} }
const passwordCheckResult = await fsEncrypt.isPasswordOk(); const passwordCheckResult = await fsEncrypt.isPasswordOk();
if (!passwordCheckResult.ok) { if (!passwordCheckResult.ok) {
throw Error(passwordCheckResult.reason); throw Error(passwordCheckResult.reason);
} }
await notifyFunc?.(triggerSource, step); profiler?.insert(
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step);
profiler.insert(
`finish step${step} (list partial remote and check password)` `finish step${step} (list partial remote and check password)`
); );
step = 2;
const remoteEntityList = await fsEncrypt.walk();
console.debug(`remoteEntityList:`);
console.debug(remoteEntityList);
await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step);
profiler.insert(`finish step${step} (list remote)`);
step = 3; step = 3;
const localEntityList = await fsLocal.walk();
console.debug(`localEntityList:`);
console.debug(localEntityList);
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step); await statusBarFunc?.(triggerSource, step, everythingOk);
profiler.insert(`finish step${step} (list local)`); const remoteEntityList = await fsEncrypt.walk();
// console.debug(`remoteEntityList:`);
// console.debug(remoteEntityList);
profiler?.insert(`finish step${step} (list remote)`);
step = 4; step = 4;
await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step, everythingOk);
const localEntityList = await fsLocal.walk();
// console.debug(`localEntityList:`);
// console.debug(localEntityList);
profiler?.insert(`finish step${step} (list local)`);
step = 5;
await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step, everythingOk);
const prevSyncEntityList = await getAllPrevSyncRecordsByVaultAndProfile( const prevSyncEntityList = await getAllPrevSyncRecordsByVaultAndProfile(
db, db,
vaultRandomID, vaultRandomID,
profileID profileID
); );
console.debug(`prevSyncEntityList:`); // console.debug(`prevSyncEntityList:`);
console.debug(prevSyncEntityList); // console.debug(prevSyncEntityList);
profiler?.insert(`finish step${step} (prev sync)`);
step = 6;
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step); await statusBarFunc?.(triggerSource, step, everythingOk);
profiler.insert(`finish step${step} (prev sync)`);
step = 5;
let mixedEntityMappings = await ensembleMixedEnties( let mixedEntityMappings = await ensembleMixedEnties(
localEntityList, localEntityList,
prevSyncEntityList, prevSyncEntityList,
@@ -1356,26 +1465,21 @@ export async function syncer(
settings.serviceType, settings.serviceType,
profiler profiler
); );
await notifyFunc?.(triggerSource, step); profiler?.insert(`finish step${step} (build partial mixedEntity)`);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step);
profiler.insert(`finish step${step} (build partial mixedEntity)`);
step = 6;
mixedEntityMappings = await getSyncPlanInplace( mixedEntityMappings = await getSyncPlanInplace(
mixedEntityMappings, mixedEntityMappings,
settings.howToCleanEmptyFolder ?? "clean_both", settings.howToCleanEmptyFolder ?? "clean_both",
settings.skipSizeLargerThan ?? -1, settings.skipSizeLargerThan ?? -1,
settings.conflictAction ?? "keep_newer", settings.conflictAction ?? "keep_newer",
settings.syncDirection ?? "bidirectional", settings.syncDirection ?? "bidirectional",
profiler profiler,
settings,
triggerSource
); );
console.info(`mixedEntityMappings:`); console.debug(`mixedEntityMappings:`);
console.info(mixedEntityMappings); // for debugging console.debug(mixedEntityMappings); // for debugging
await notifyFunc?.(triggerSource, step); profiler?.insert("finish building full sync plan");
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step);
profiler.insert("finish building full sync plan");
await insertSyncPlanRecordByVault( await insertSyncPlanRecordByVault(
db, db,
@@ -1383,17 +1487,17 @@ export async function syncer(
vaultRandomID, vaultRandomID,
settings.serviceType settings.serviceType
); );
await notifyFunc?.(triggerSource, step); profiler?.insert("finish writing sync plan");
await ribboonFunc?.(triggerSource, step); profiler?.insert(`finish step${step} (make plan)`);
await statusBarFunc?.(triggerSource, step);
profiler.insert("finish writing sync plan");
profiler.insert(`finish step${step} (make plan)`);
// The operations above are almost read only and kind of safe. // The operations above are almost read only and kind of safe.
// The operations below begins to write or delete (!!!) something. // The operations below begins to write or delete (!!!) something.
step = 7; step = 7;
if (triggerSource !== "dry") { if (triggerSource !== "dry") {
await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step, everythingOk);
await doActualSync( await doActualSync(
mixedEntityMappings, mixedEntityMappings,
fsLocal, fsLocal,
@@ -1407,34 +1511,33 @@ export async function syncer(
profiler, profiler,
callbackSyncProcess callbackSyncProcess
); );
await notifyFunc?.(triggerSource, step); profiler?.insert(`finish step${step} (actual sync)`);
await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step);
profiler.insert(`finish step${step} (actual sync)`);
} else { } else {
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step); await statusBarFunc?.(triggerSource, step, everythingOk);
profiler.insert( profiler?.insert(
`finish step${step} (skip actual sync because of dry run)` `finish step${step} (skip actual sync because of dry run)`
); );
} }
} catch (error: any) { } catch (error: any) {
profiler.insert("start error branch"); profiler?.insert("start error branch");
everythingOk = false;
await errNotifyFunc?.(triggerSource, error as Error); await errNotifyFunc?.(triggerSource, error as Error);
profiler.insert("finish error branch"); profiler?.insert("finish error branch");
} finally { } finally {
} }
profiler.insert("finish syncRun"); profiler?.insert("finish syncRun");
console.debug(profiler.toString()); // console.debug(profiler?.toString());
await profiler.save(db, vaultRandomID, settings.serviceType); await profiler?.save(db, vaultRandomID, settings.serviceType);
step = 8; step = 8;
await notifyFunc?.(triggerSource, step); await notifyFunc?.(triggerSource, step);
await ribboonFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step);
await statusBarFunc?.(triggerSource, step); await statusBarFunc?.(triggerSource, step, everythingOk);
console.info(`endding sync.`);
markIsSyncingFunc(false); markIsSyncingFunc(false);
} }
+4 -4
View File
@@ -1,6 +1,6 @@
import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian"; import { type App, Modal } from "obsidian";
import type RemotelySavePlugin from "./main"; // unavoidable
import type { TransItemType } from "./i18n"; import type { TransItemType } from "./i18n";
import type RemotelySavePlugin from "./main"; // unavoidable
import { stringToFragment } from "./misc"; import { stringToFragment } from "./misc";
@@ -17,7 +17,7 @@ export class SyncAlgoV3Modal extends Modal {
this.requireUpdateAllDev = false; this.requireUpdateAllDev = false;
} }
onOpen() { onOpen() {
let { contentEl } = this; const { contentEl } = this;
const t = (x: TransItemType, vars?: any) => { const t = (x: TransItemType, vars?: any) => {
return this.plugin.i18n.t(x, vars); return this.plugin.i18n.t(x, vars);
}; };
@@ -112,7 +112,7 @@ export class SyncAlgoV3Modal extends Modal {
} }
onClose() { onClose() {
let { contentEl } = this; const { contentEl } = this;
contentEl.empty(); contentEl.empty();
if (this.agree) { if (this.agree) {
console.info("agree to use the new algorithm"); console.info("agree to use the new algorithm");
+10 -2
View File
@@ -61,6 +61,13 @@
display: none; display: none;
} }
.webdis-disclaimer {
font-weight: bold;
}
.webdis-hide {
display: none;
}
.qrcode-img { .qrcode-img {
width: 350px; width: 350px;
height: 350px; height: 350px;
@@ -75,6 +82,7 @@
font-weight: bolder; font-weight: bolder;
} }
.setting-need-wrapping-mobile .setting-item-control { .setting-need-wrapping .setting-item-control {
flex-wrap: wrap; /* flex-wrap: wrap; */
display: grid;
} }
+4 -1
View File
@@ -1,6 +1,6 @@
import { strict as assert } from "assert"; import { strict as assert } from "assert";
import { RemotelySavePluginSettings } from "../src/baseTypes"; import type { RemotelySavePluginSettings } from "../src/baseTypes";
import { messyConfigToNormal, normalConfigToMessy } from "../src/configPersist"; import { messyConfigToNormal, normalConfigToMessy } from "../src/configPersist";
const DEFAULT_SETTINGS: RemotelySavePluginSettings = { const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
@@ -16,6 +16,9 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
onedrive: { onedrive: {
username: "test 🍎 emoji", username: "test 🍎 emoji",
} as any, } as any,
webdis: {
address: "addr",
} as any,
password: "password", password: "password",
serviceType: "s3", serviceType: "s3",
currLogLevel: "info", currLogLevel: "info",
+2 -2
View File
@@ -13,7 +13,7 @@ import {
import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc"; import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
describe("Encryption OpenSSL tests", () => { describe("Encryption OpenSSL tests", () => {
beforeEach(function () { beforeEach(() => {
global.window = { global.window = {
crypto: require("crypto").webcrypto, crypto: require("crypto").webcrypto,
} as any; } as any;
@@ -157,7 +157,7 @@ describe("Encryption OpenSSL tests", () => {
assert.throws(() => getSizeFromEncToOrig(14787231)); assert.throws(() => getSizeFromEncToOrig(14787231));
let { minSize, maxSize } = getSizeFromEncToOrig(14787232); const { minSize, maxSize } = getSizeFromEncToOrig(14787232);
assert.ok(minSize <= 14787203 && 14787203 <= maxSize); assert.ok(minSize <= 14787203 && 14787203 <= maxSize);
}); });
}); });
+12
View File
@@ -0,0 +1,12 @@
import { strict as assert } from "assert";
import { getOrigPath } from "../src/fsWebdis";
describe("Webdis operations tests", () => {
it("should get orig keys correctly", () => {
const input = "rs:fs:v1:库名字/something dev.md:meta";
const output = getOrigPath(input, "库名字");
const expected = "something dev.md";
assert.equal(output, expected);
});
});
+1 -1
View File
@@ -1,7 +1,7 @@
import { strict as assert } from "assert"; import { strict as assert } from "assert";
import { import {
type MetadataOnRemote,
isEqualMetadataOnRemote, isEqualMetadataOnRemote,
MetadataOnRemote,
} from "../src/metadataOnRemote"; } from "../src/metadataOnRemote";
describe("Metadata operations tests", () => { describe("Metadata operations tests", () => {
+78 -1
View File
@@ -179,7 +179,7 @@ describe("Misc: get dirname", () => {
}); });
describe("Misc: extract svg", () => { describe("Misc: extract svg", () => {
beforeEach(function () { beforeEach(() => {
const fakeBrowser = new JSDOM(""); const fakeBrowser = new JSDOM("");
global.window = fakeBrowser.window as any; global.window = fakeBrowser.window as any;
}); });
@@ -286,6 +286,83 @@ describe("Misc: special char for dir", () => {
}); });
}); });
describe("Misc: split chunk ranges", () => {
it("should fail on negative numner", () => {
assert.throws(() => misc.splitFileSizeToChunkRanges(-1, 2));
assert.throws(() => misc.splitFileSizeToChunkRanges(1, -1));
assert.throws(() => misc.splitFileSizeToChunkRanges(1, 0));
});
it("should return nothing for 0 input", () => {
let input: [number, number] = [0, 1];
let output: any = [];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [0, 100];
output = [];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
});
it("should return single item for 1 input", () => {
let input: [number, number] = [1, 1];
let output = [{ start: 0, end: 0 }];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [1, 100];
output = [{ start: 0, end: 0 }];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
});
it("should return single item for larger or equal input", () => {
let input: [number, number] = [10, 10];
let output = [{ start: 0, end: 9 }];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [10, 21];
output = [{ start: 0, end: 9 }];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
});
it("should return correct items for normal input", () => {
let input: [number, number] = [10, 9];
let output = [
{ start: 0, end: 8 },
{ start: 9, end: 9 },
];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [10, 5];
output = [
{ start: 0, end: 4 },
{ start: 5, end: 9 },
];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [3, 1];
output = [
{ start: 0, end: 0 },
{ start: 1, end: 1 },
{ start: 2, end: 2 },
];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [15, 5];
output = [
{ start: 0, end: 4 },
{ start: 5, end: 9 },
{ start: 10, end: 14 },
];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
input = [1024, 578];
output = [
{ start: 0, end: 577 },
{ start: 578, end: 1023 },
];
assert.deepStrictEqual(output, misc.splitFileSizeToChunkRanges(...input));
});
});
describe("Misc: Dropbox: should fix the folder name cases", () => { describe("Misc: Dropbox: should fix the folder name cases", () => {
it("should do nothing on empty folders", () => { it("should do nothing on empty folders", () => {
const input: any[] = []; const input: any[] = [];