Compare commits
55 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
34db181af0 | ||
|
|
6631a9c5eb | ||
|
|
e39edcea70 | ||
|
|
9ac7ecf828 | ||
|
|
50c08400ff | ||
|
|
7bc2fad88b | ||
|
|
6dc1c28361 | ||
|
|
2220f511e3 | ||
|
|
06de1a4ab0 | ||
|
|
df184ff9d8 | ||
|
|
f50ba953f1 | ||
|
|
55cb26bd22 | ||
|
|
36d3018efb | ||
|
|
421b43d937 | ||
|
|
17708359a1 | ||
|
|
9acae1b077 | ||
|
|
4ade975585 | ||
|
|
e988fc7ae9 | ||
|
|
5c56f2146f | ||
|
|
74125f8dff | ||
|
|
ace16de20c | ||
|
|
716e5aa6c5 | ||
|
|
fcdbb71493 | ||
|
|
0040e18b49 | ||
|
|
b5d56843fd | ||
|
|
b63b6791aa | ||
|
|
2a3d1265b3 | ||
|
|
245d529821 | ||
|
|
74e5231861 | ||
|
|
ac9c2a9248 | ||
|
|
b2dea5a351 | ||
|
|
e9b9cd97ac | ||
|
|
fccebb0594 | ||
|
|
dda304c857 | ||
|
|
c0aec40bcc | ||
|
|
fb2f4ef46f | ||
|
|
52f3e6a265 | ||
|
|
b5099854af | ||
|
|
d42b31cea2 | ||
|
|
69e0c77444 | ||
|
|
ee4394873b | ||
|
|
f2845cdcbf | ||
|
|
bbee873b64 | ||
|
|
f5fee16130 | ||
|
|
f4b82204c1 | ||
|
|
f1a06a3f52 | ||
|
|
ae4e67f3b4 | ||
|
|
254231e4bd | ||
|
|
871e8dc3cf | ||
|
|
85aed7cfb9 | ||
|
|
3f7a6dbf6a | ||
|
|
13cca9025e | ||
|
|
a81af9ccec | ||
|
|
db86a75534 | ||
|
|
72e059d5cc |
10
.github/workflows/auto-build.yml
vendored
10
.github/workflows/auto-build.yml
vendored
@ -34,18 +34,18 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
node-version: [20.x]
|
||||
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
|
||||
|
||||
steps:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
- name: Checkout LFS file list
|
||||
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||
- name: LFS Cache
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: .git/lfs/objects
|
||||
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||
@ -54,13 +54,13 @@ jobs:
|
||||
- name: Git LFS Pull
|
||||
run: git lfs pull
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- run: npm install
|
||||
- run: npm test
|
||||
- run: npm run build
|
||||
- uses: actions/upload-artifact@v2
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: my-dist
|
||||
path: |
|
||||
|
||||
56
.github/workflows/release.yml
vendored
56
.github/workflows/release.yml
vendored
@ -38,17 +38,17 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
node-version: [20.x]
|
||||
|
||||
steps:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
- name: Checkout LFS file list
|
||||
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||
- name: LFS Cache
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: .git/lfs/objects
|
||||
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||
@ -57,50 +57,20 @@ jobs:
|
||||
- name: Git LFS Pull
|
||||
run: git lfs pull
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- run: npm install
|
||||
- run: npm test
|
||||
- run: npm run build
|
||||
- name: Create Release
|
||||
id: create_release
|
||||
uses: actions/create-release@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
VERSION: ${{ github.ref }}
|
||||
- name: Create Release And Upload
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: ${{ github.ref }}
|
||||
release_name: ${{ github.ref }}
|
||||
files: |
|
||||
main.js
|
||||
manifest.json
|
||||
styles.css
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
draft: false
|
||||
prerelease: true
|
||||
- name: Upload main.js
|
||||
id: upload-main
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: ./main.js
|
||||
asset_name: main.js
|
||||
asset_content_type: text/javascript
|
||||
- name: Upload manifest.json
|
||||
id: upload-manifest
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: ./manifest.json
|
||||
asset_name: manifest.json
|
||||
asset_content_type: application/json
|
||||
- name: Upload styles.css
|
||||
id: upload-styles
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: ./styles.css
|
||||
asset_name: styles.css
|
||||
asset_content_type: text/css
|
||||
prerelease: false
|
||||
make_latest: true
|
||||
|
||||
46
README.md
46
README.md
@ -1,5 +1,7 @@
|
||||
# Remotely Save
|
||||
|
||||
English | [中文](./README.zh-cn.md)
|
||||
|
||||
This is yet another unofficial sync plugin for Obsidian. If you like it or find it useful, please consider give it a [star ](https://github.com/fyears/remotely-save) on Github.
|
||||
|
||||
[](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
|
||||
@ -31,7 +33,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
||||
- Azure Blob Storage (PRO feature)
|
||||
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
|
||||
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
||||
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||
- **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl / rclone crypt format before being sent to the cloud **if** user specify a password.
|
||||
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
|
||||
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
||||
- **Skip Large files** and **skip paths** by custom regex conditions!
|
||||
@ -46,21 +48,23 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
||||
- **You should protect your `data.json` file.** The file contains sensitive information.
|
||||
- It's strongly advised **NOT** to share your `data.json` file to anyone.
|
||||
- It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
|
||||
- **Obsidian API on Mobile has performance issues syncing large files (>= 50 MB).**
|
||||
- Setting the "Skip Large Files" option can help resolve issues related to syncing large files.
|
||||
|
||||
## Questions, Suggestions, Or Bugs
|
||||
|
||||
You are greatly welcome to ask questions, post any suggestions, or report any bugs! The project is mainly maintained on GitHub:
|
||||
|
||||
- Questions: [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
|
||||
- Suggestions: also in [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
|
||||
- Bugs: [GitHub repo Issues](https://github.com/fyears/remotely-save/issues) (NOT Discussion)
|
||||
- Questions: [GitHub repo Discussions](https://github.com/remotely-save/remotely-save/discussions)
|
||||
- Suggestions: also in [GitHub repo Discussions](https://github.com/remotely-save/remotely-save/discussions)
|
||||
- Bugs: [GitHub repo Issues](https://github.com/remotely-save/remotely-save/issues) (NOT Discussion)
|
||||
|
||||
Additionally, the plugin author may occasionally visit Obsidian official forum and official Discord server, and pay attention to this-plugin-related information there.
|
||||
|
||||
## Download and Install
|
||||
|
||||
- Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
|
||||
- Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
|
||||
- Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `remotely-save/remotely-save` in the configuration of BRAT.
|
||||
- Option #3: [](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
|
||||
- Option #4: [](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
|
||||
|
||||
@ -112,11 +116,13 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
|
||||
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
|
||||
- [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
|
||||
- [dufs](./docs/remote_services/webdav_dufs/README.md)
|
||||
- [AList（中文）](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
|
||||
- [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
||||
- [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
|
||||
- [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
|
||||
- [Apache (with Docker)](./docs/remote_services/webdav_apache/README.md)
|
||||
- [Caddy with `http.handlers.webdav` module](./docs/remote_services/webdav_caddy/README.md)
|
||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
|
||||
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
@ -161,7 +167,7 @@ PRO (paid) feature "sync with Azure Blob Storage" allows users to to sync with A
|
||||
|
||||
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||
|
||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or any-size non-markdown files.
|
||||
|
||||
See documents [here](./docs/pro/README.md)
|
||||
|
||||
@ -176,20 +182,40 @@ See documents [here](./docs/pro/README.md)
|
||||
- You can configure sync on save in settings.
|
||||
- In sync on save mode, if any error occurs, the plugin would **fail silently**.
|
||||
|
||||
## How To Deal With Hidden Files Or Folders
|
||||
## Config Folder / Files and Bookmarks
|
||||
|
||||
By default, the plugin doesn't sync config folder / files of obsidian (normally `.obsidian` folder) because it's one of the hidden files.
|
||||
|
||||
However, in the latest version, you can enable syncing config folder in settings. Please be aware that it's an experimental feature. Notably some config files' modified times are changed everytime when Obsidian is opened, and this destroys the assumptions of the plugin, so some information may not be synced properly.
|
||||
|
||||
Moreover, the bookmarks of Obsidian are actually stored in `.obsidian/bookmarks.json` file. You can also set syncing this file (instead of the whole config folder) in settings. The plugin will keep the latest modified one across devices.
|
||||
|
||||
## Hidden Files Or Folders
|
||||
|
||||
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
|
||||
|
||||
In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
|
||||
In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder as described above (but not any other `.` files or folders).
|
||||
|
||||
## PRO Features
|
||||
## PRO (paid) Features
|
||||
|
||||
See [PRO](./docs/pro/README.md) for more details.
|
||||
|
||||
## How To Debug
|
||||
|
||||
See [here](./docs/how_to_debug/README.md) for more details.
|
||||
If you see any errors, please check the doc [here](./docs/how_to_debug/README.md) for more details.
|
||||
|
||||
Moreover, sometimes the program runs but slowly, you want to check the performance by [enabling the profiler](./docs/check_performance/README.md).
|
||||
|
||||
## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
|
||||
|
||||
See [here](./docs/import_export_some_settings.md) for more details.
|
||||
|
||||
## Download History
|
||||
|
||||
Download history can be viewed on the unofficial [Obsidian Stats](https://www.moritzjung.dev/obsidian-stats/plugins/remotely-save/#downloads) (NOT affiliated with official Obsidian and GitHub and Remotely Save).
|
||||
|
||||
## Star History
|
||||
|
||||
(NOT affiliated with official Obsidian and GitHub and Remotely Save.)
|
||||
|
||||
[](https://star-history.com/#remotely-save/remotely-save&Date)
|
||||
|
||||
221
README.zh-cn.md
Normal file
221
README.zh-cn.md
Normal file
@ -0,0 +1,221 @@
|
||||
# Remotely Save
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
这是Obsidian的一个非官方同步插件。如果你喜欢它或觉得它帮到了你，请考虑在Github上给它一颗[星星 ](https://github.com/fyears/remotely-save)。
|
||||
|
||||
[](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
|
||||
|
||||
[](https://github.com/fyears/remotely-save/releases)
|
||||
|
||||
## 免责声明
|
||||
|
||||
- **这不是 Obsidian 提供的[官方同步服务](https://obsidian.md/sync)。**
|
||||
|
||||
## !!!警告!!!
|
||||
|
||||
**在使用此插件之前，一定，一定要记得备份你的 vault。**
|
||||
|
||||
## 功能
|
||||
|
||||
- 支持：
|
||||
- Amazon S3 或兼容 S3 的服务（Cloudflare R2 / BackBlaze B2 / MinIO / ...）
|
||||
- Dropbox
|
||||
- 个人版本 OneDrive（应用文件夹）
|
||||
- 个人版本 OneDrive（根目录）（PRO 功能）
|
||||
- Webdav（NextCloud / InfiniCloud / Synology webdav 服务器 / ...）
|
||||
- Webdis
|
||||
- Google Drive（GDrive）（PRO 功能）
|
||||
- Box（PRO 功能）
|
||||
- pCloud（PRO 功能）
|
||||
- Yandex Disk（PRO 功能）
|
||||
- Koofr（PRO 功能）
|
||||
- Azure Blob Storage（PRO 功能）
|
||||
- [这里](./docs/services_connectable_or_not.md)详细展示了更多可连接（或不可连接）的服务。
|
||||
- **支持 Obsidian 移动版。** vault 可以通过云服务作为“中介”在移动和桌面设备之间同步。
|
||||
- **支持[端到端加密](./docs/encryption/README.md)。** 如果用户指定密码，文件在发送到云之前会使用 openssl / rclone crypt 格式加密。
|
||||
- **支持计划自动同步。** 你也可以使用侧边栏按钮，或者或命令面板中的命令，来手动触发同步（又或者绑定热键组合然后触发）。
|
||||
- **[最小侵入性](./docs/minimal_intrusive_design.md)。**
|
||||
- 通过自定义正则表达式条件**跳过大文件和路径！**
|
||||
- **[同步算法](./docs/sync_algorithm/v3/intro.md)文档公开。**
|
||||
- 免费版本支持 **[基本冲突检测和处理](./docs/sync_algorithm/v3/intro.md)**。PRO 版本支持 **[高级智能冲突处理](./pro/README.md)**。
|
||||
- 源代码可阅。详见[许可证](./LICENSE)。
|
||||
|
||||
## 限制
|
||||
|
||||
- **云服务会产生费用。** 始终记得注意成本和定价。具体来说，所有操作，包括但不限于下载、上传、列出所有文件、调用任何 api、存储大小，可能会或可能不会产生费用。
|
||||
- **来自浏览器环境的一些限制。** 更多技术细节在[文档](./docs/browser_env.md)中。
|
||||
- **记得保护你的 `data.json` 文件。** 该文件包含敏感信息。
|
||||
- 强烈建议**不要**与任何人共享你的 `data.json` 文件。
|
||||
- 通常**不要**将此文件检入版本控制。默认情况下，插件会尝试在插件目录中创建一个 `.gitignore` 文件（如果不存在），以忽略 `git` 版本控制中的 `data.json`。如果你确切知道这意味着什么并想移除设置，请修改 `.gitignore` 文件或将其设置为空。
|
||||
- **Obsidian 移动版 API 在同步大文件（>= 50 MB）时存在性能问题。**
|
||||
- 设置“跳过大文件”选项可以帮助解决同步大文件的问题。
|
||||
|
||||
## 问题、建议或错误
|
||||
|
||||
非常欢迎你提出问题、发布任何建议或报告任何错误！该项目主要在GitHub上维护：
|
||||
|
||||
- 问题：[GitHub 仓库讨论](https://github.com/remotely-save/remotely-save/discussions)
|
||||
- 建议：也在[GitHub 仓库讨论](https://github.com/remotely-save/remotely-save/discussions)
|
||||
- 错误：[GitHub 仓库 Issue](https://github.com/remotely-save/remotely-save/issues)（注意这里是 bug 反馈，不是讨论）
|
||||
|
||||
此外，插件作者可能会偶尔访问 Obsidian 官方论坛和官方 Discord 服务器，并关注与该插件相关的信息。
|
||||
|
||||
## 下载和安装
|
||||
|
||||
- 选项 #1：在官方“社区插件列表”中搜索，或访问此链接：[https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save)（应该会重定向到 Obsidian app），然后安装插件。
|
||||
- 选项 #2：你也可以使用 [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) 来安装此插件。在 BRAT 的配置中输入 `remotely-save/remotely-save`。
|
||||
- 选项 #3：[](https://github.com/fyears/remotely-save/releases) 从最新发布中手动下载文件（`main.js`，`manifest.json`，`styles.css`）。
|
||||
- 选项 #4：[](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) 每个成功的构建的“摘要”下都有构建文件。它是由每个提交自动生成的，可能不会正常工作。
|
||||
|
||||
## 使用方法
|
||||
|
||||
### S3
|
||||
|
||||
- 教程/示例：
|
||||
- [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
|
||||
- [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
|
||||
- [Storj](./docs/remote_services/s3_storj_io/README.md)
|
||||
- [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
|
||||
- [MinIO](./docs/remote_services/s3_minio/README.md)
|
||||
- [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.md)
|
||||
- 准备你的 S3（兼容）服务信息：[端点，区域](https://docs.aws.amazon.com/general/latest/gr/s3.html)，[访问密钥 ID ，密钥](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html)，存储桶名称。
|
||||
- 如果你使用 AWS S3，还要创建[策略和用户](./docs/remote_services/s3_general/s3_user_policy.md)。
|
||||
- 非常旧版本的 Obsidian 需要[配置 CORS](./docs/remote_services/s3_general/s3_cors_configure.md)。
|
||||
- 下载并启用此插件。
|
||||
- 在插件的设置中输入你的信息。
|
||||
- 如果你没有在设置中设置前缀，存储桶应该是空的，并且仅用于同步一个 vault。你可以在设置中设置前缀，以便同一个存储桶可以存储多个 vault。
|
||||
- 如果你想启用端到端加密，也要在设置中设置一个密码。如果你没有指定密码，文件和文件夹将以明文、原始内容同步到云。
|
||||
- **每次**你想在本地和远程之间同步你的 vault 的时候，点击侧边栏上的新“圆形箭头”图标。（或者，你可以在设置面板中配置自动同步（见下一章）。）在同步过程中，图标变成“两个半圆形箭头”。除了点击侧边栏上的图标，你还可以在命令面板中激活相应的命令。
|
||||
- **同步时要有耐心。** 尤其是在第一次同步时。
|
||||
- 如果你想在多个设备之间同步文件，**在使用默认设置时，你的 vault 名称应该相同**。
|
||||
|
||||
### Dropbox
|
||||
|
||||
- **此插件不是官方Dropbox产品。** 插件只是使用 Dropbox 的公共API。
|
||||
- 授权后，插件可以读取你的姓名和电子邮件（在 Dropbox api 上无法取消选择），并读取和写入你的 Dropbox 的 `/Apps/remotely-save` 文件夹中的文件。
|
||||
- 如果你决定授权此插件连接到 Dropbox，请访问插件的设置页，选择Dropbox 然后按照说明操作。[更多带截图的信息在这里](./docs/dropbox_review_material/README.md)。
|
||||
- 基于密码的端到端加密也是可以的。但请注意，**vault 名称本身未加密**。
|
||||
- 如果你想在多个设备之间同步文件，**在使用默认设置时，你的 vault 名称应该相同**。
|
||||
|
||||
### 个人 OneDrive（应用文件夹）
|
||||
|
||||
- **此插件不是官方 Microsoft / OneDrive 产品。** 插件只是使用 Microsoft 的 [OneDrive 公共 API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api) 而已。
|
||||
- 此插件仅适用于“个人 OneDrive”，不适用于“OneDrive for Business。详见 [#11](https://github.com/fyears/remotely-save/issues/11)。
|
||||
- 授权后，插件可以读取你的姓名和电子邮件，并读取和写入你的OneDrive的 `/Apps/remotely-save` 文件夹中的文件。**Remotely Save 的免费版本仅连接到应用文件夹，而 PRO 版本可以连接到 Onedrive 的根文件夹。见下面的 PRO 部分。**
|
||||
- 如果你决定授权此插件连接到 OneDrive，请访问插件的设置页，选择OneDrive 然后按照说明操作。
|
||||
- 基于密码的端到端加密也是可以的。但请注意，**vault 名称本身未加密**。
|
||||
- 如果你想在多个设备之间同步文件，**在使用默认设置时，你的 vault 名称应该相同**。
|
||||
- 你可能还想查看 [OneDrive 的常见问题](./docs/remote_services/onedrive/README.md)。
|
||||
|
||||
### webdav
|
||||
|
||||
- 教程/示例：
|
||||
- [Nextcloud](./docs/remote_services/webdav_nextcloud/README.md)
|
||||
- [The Good Cloud](./docs/remote_services/webdav_thegoodcloud/README.md)
|
||||
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
|
||||
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
|
||||
- [Synology webdav 服务器](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav 服务器](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
|
||||
- [dufs](./docs/remote_services/webdav_dufs/README.md)
|
||||
- [AList（中文）](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
|
||||
- [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
||||
- [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
|
||||
- [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
|
||||
- [Apache (with Docker)](./docs/remote_services/webdav_apache/README.md)
|
||||
- [Caddy with `http.handlers.webdav` module](./docs/remote_services/webdav_caddy/README.md)
|
||||
- 非常旧版本的Obsidian需要[配置 CORS](./docs/remote_services/webdav_general/webav_cors.md)。
|
||||
- 你的数据会同步到你的webdav服务器上的 `${vaultName}` 子文件夹。
|
||||
- 基于密码的端到端加密也是可以的。但请注意，**vault 名称本身未加密**。
|
||||
- 如果你想在多个设备之间同步文件，**在使用默认设置时，你的 vault 名称应该相同**。
|
||||
|
||||
### Webdis
|
||||
|
||||
- 教程：
|
||||
- [Webdis](./docs/remote_services/webdis/README.md)
|
||||
- 实验性质。
|
||||
- 你必须自己设置和保护你的 web 服务器。
|
||||
|
||||
### Onedrive（完整访问）（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Onedrive（完整）同步”允许用户与 Onedrive 根文件夹进行同步。教程和限制在[这里](./docs/remote_services/onedrivefull/README.md)。
|
||||
|
||||
### Google Drive（GDrive）（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Google Drive 同步”允许用户与 Google Drive 进行同步。教程和限制在[这里](./docs/remote_services/googledrive/README.md)。
|
||||
|
||||
### Box（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Box 同步”允许用户与 Box 同步。教程和限制在[这里](./docs/remote_services/box/README.md)。
|
||||
|
||||
### pCloud（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 pCloud 同步”允许用户与 pCloud 同步（使用其原生 API 而不是 webdav）。教程和限制在[这里](./docs/remote_services/pcloud/README.md)。
|
||||
|
||||
### Yandex Disk（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Yandex Disk 同步”允许用户与 Yandex Disk 同步（使用其原生 API 而不是 webdav）。教程和限制在[这里](./docs/remote_services/yandexdisk/README.md)。
|
||||
|
||||
### Koofr（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Koofr 同步”允许用户与 Koofr 同步（使用其原生 API 而不是 webdav）。教程和限制在[这里](./docs/remote_services/koofr/README.md)。
|
||||
|
||||
### Azure Blob Storage（PRO 功能）
|
||||
|
||||
PRO（付费）功能“与 Azure Blob Storage 同步”允许用户与 Azure Blob Storage 同步。教程和限制在[这里](./docs/remote_services/azureblobstorage/README.md)。
|
||||
|
||||
## 智能冲突（PRO功能）
|
||||
|
||||
基本（免费）版本可以检测冲突，但用户必须选择保留较新版本或较大版本的文件两种选项之一。
|
||||
|
||||
PRO（付费）功能“智能冲突”为用户提供了另一个选项：合并小的 markdown 文件，或复制大的 markdown 文件或任何大小的非 markdown 文件。
|
||||
|
||||
文档见[这里](./docs/pro/README.md)。
|
||||
|
||||
## 定时自动同步
|
||||
|
||||
- 你可以在设置中配置每 N 分钟自动同步。
|
||||
- 在自动同步模式下，如果发生任何错误，插件会**静默失败**。
|
||||
- 自动同步仅在 Obsidian 打开时有效。由于插件仅在 Obsidian 提供的浏览器环境中工作，因此**技术上不可能**在 Obsidian 后台自动同步。
|
||||
|
||||
## 保存时同步
|
||||
|
||||
- 你可以在设置中配置保存时同步。
|
||||
- 在保存时同步模式下，如果发生任何错误，插件会**静默失败**。
|
||||
|
||||
## 配置文件夹/文件和书签
|
||||
|
||||
默认情况下，插件不同步 obsidian 的配置文件夹/文件（通常是 `.obsidian` 文件夹），因为它是隐藏文件之一。
|
||||
|
||||
然而，在最新版本中，你可以在设置中启用同步配置文件夹。请注意，这是一个实验性功能。特别是一些配置文件的修改时间每次 Obsidian 打开时都会改变，这破坏了插件的假设，因此某些信息可能无法正确同步。
|
||||
|
||||
此外，Obsidian的书签实际上存储在 `.obsidian/bookmarks.json` 文件中的。你也可以在设置中设置同步这个文件（而不是整个配置文件夹）。插件将保持跨设备最新修改的文件。
|
||||
|
||||
## 隐藏文件或文件夹
|
||||
|
||||
**默认情况下，所有以 `.`（点）或 `_`（下划线）开头的文件或文件夹都被视为隐藏文件，不会被同步。** 如果你有一些文件只是本地保留，这很有用。但这种策略也意味着主题/其他插件/此插件的设置也不会被同步。
|
||||
|
||||
在最新版本中，你可以更改设置以允许同步 `_` 文件或文件夹，以及如上所述的 `.obsidian` 特殊配置文件夹（但不包括其他任何 `.` 文件或文件夹）。
|
||||
|
||||
## PRO（付费）功能
|
||||
|
||||
详见[PRO](./docs/pro/README.md)了解更多详情。
|
||||
|
||||
## 如何调试（debug）
|
||||
|
||||
如发生错误，查看[这里文档](./docs/how_to_debug/README.md)了解调试方式。
|
||||
|
||||
如果没有发生错误，但是运行起来很慢，你需要[开启“性能收集”](./docs/check_performance/README)来看看有没有哪一步特别慢。
|
||||
|
||||
## 额外功能：通过 QR 码导入和导出非 OAuth2 插件设置
|
||||
|
||||
详见[这里](./docs/import_export_some_settings.md)了解更多详情。
|
||||
|
||||
## 下载历史
|
||||
|
||||
下载历史可以从非官方的 [Obsidian Stats](https://www.moritzjung.dev/obsidian-stats/plugins/remotely-save/#downloads) 查阅。（和官方 Obsidian，GitHub，Remotely Save 均无利益关系。）
|
||||
|
||||
## 星星历史
|
||||
|
||||
（和官方 Obsidian，GitHub，Remotely Save 均无利益关系。）
|
||||
|
||||
[](https://star-history.com/#remotely-save/remotely-save&Date)
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
|
||||
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
|
||||
"organizeImports": {
|
||||
"enabled": true
|
||||
},
|
||||
@ -24,7 +24,7 @@
|
||||
"jsxQuoteStyle": "double",
|
||||
"quoteProperties": "asNeeded",
|
||||
"semicolons": "always",
|
||||
"trailingComma": "es5"
|
||||
"trailingCommas": "es5"
|
||||
}
|
||||
},
|
||||
"linter": {
|
||||
|
||||
13
docs/check_performance/README.md
Normal file
13
docs/check_performance/README.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Check performance
|
||||
|
||||
1. Go to settings, scroll to the very end, and enable the "Enable Profiler" option.
|
||||
2. Also enable "Enable Profiler Printing".
|
||||
3. Check Console Output (directly or via `vConsole` plugin). More details are [here](../how_to_debug/README.md).
|
||||
4. Sync!
|
||||
5. You can also "Export Profiler Results" afterwards. A new file `_debug_remotely_save/profiler_results_exported_on_xxxx.md` will be generated.
|
||||
|
||||
In the console or exported files, you can see the time cost of each steps.
|
||||
|
||||
|
||||
|
||||
|
||||
3
docs/check_performance/profiler_exported.png
Normal file
3
docs/check_performance/profiler_exported.png
Normal file
@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5a71d0746a75c93aa4cb5be3f7964bfdf74722a10505f5a1965790738eaebdc4
|
||||
size 265289
|
||||
3
docs/check_performance/profiler_settings.png
Normal file
3
docs/check_performance/profiler_settings.png
Normal file
@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4ffd1557c2f714c56bfacd8166b85749d6bfa15c2f9c7363942b443d51288083
|
||||
size 81259
|
||||
@ -6,12 +6,18 @@ Ideally, users do not need to debug anything. But if something bad happened, we
|
||||
|
||||
See [here](./export_sync_plans.md).
|
||||
|
||||
## Advanced: Check Console Output Directly
|
||||
## Medium: Desktop: Check Console Output Directly
|
||||
|
||||
...of desktop and Android.
|
||||
|
||||
See [here](./check_console_output.md).
|
||||
|
||||
## Medium: Mobile: Use `Obsidian vConsole` to Check Console Ouput Directly
|
||||
|
||||
...of mobile (iOS and Android).
|
||||
|
||||
See [here](./check_vconsole_output.md).
|
||||
|
||||
## Advanced: Use `Logstravaganza` to export logs
|
||||
|
||||
This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
|
||||
|
||||
@ -18,6 +18,8 @@ Go to the plugin settings, scroll down to the section "Debug" -> "alter console
|
||||
|
||||
- If you are using Android
|
||||
|
||||
You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
|
||||
If you want to check the console **with the help of desktop Chrome**, you need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
|
||||
|
||||
If you want to check the console **directly on the mobile device**, check out [this doc](./check_vconsole_output.md).
|
||||
|
||||
Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.
|
||||
|
||||
21
docs/how_to_debug/check_vconsole_output.md
Normal file
21
docs/how_to_debug/check_vconsole_output.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Check "Obsidian vConsole" Output
|
||||
|
||||
It's quite hard to debug on mobile. But fortunately you can use another plugin to rescue!
|
||||
|
||||
This applies to both iOS (iPhone / iPad) and Android.
|
||||
|
||||
## Disable Auto Sync Firstly
|
||||
|
||||
You should disable auto sync to avoid any unexpected running.
|
||||
|
||||
## Set The Output Level To Debug
|
||||
|
||||
Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
|
||||
|
||||
## Use "Obsidian vConsole"
|
||||
|
||||
1. Install the third-party plugin ["Obsidian vConsole"](https://github.com/zhouhua/obsidian-vconsole).
|
||||
2. Enable "Obsidian vConsole". You shall see a green button in the right buttom corner of the interface of your mobile Obsidian. You can drag this green button to where you like.
|
||||
3. Sync! And quickly click the vConsole green button, you will see the console logs in its panel! Moreover, you can check browser network and Storage (LocalStorage) in the panel!
|
||||
4. You can copy (by clicking the small "disk" icon beside each line of the log) or take a screenshot of the logs, and report bugs in Remotely Save GitHub. You can click "Hide" in the panel to hide the panel.
|
||||
5. If you don't need to debug any more, you can disable Obsidian vConsole plugin, then the green button should disappear.
|
||||
33
docs/remote_services/webdav_caddy/README.md
Normal file
33
docs/remote_services/webdav_caddy/README.md
Normal file
@ -0,0 +1,33 @@
|
||||
# Caddy with `http.handlers.webdav` module
|
||||
|
||||
> modified from the instruction from @cyruz-git in https://github.com/remotely-save/remotely-save/issues/825
|
||||
|
||||
## Link
|
||||
|
||||
<https://caddyserver.com/download?package=github.com%2Fmholt%2Fcaddy-webdav>
|
||||
|
||||
## Steps
|
||||
|
||||
1. Download caddy with webdav module from <https://caddyserver.com/download?package=github.com%2Fmholt%2Fcaddy-webdav>. Or you can install Caddy then install the plugins.
|
||||
2. Create a folder for storing webdav server files. Like `/usr/local/mywebdav`.
|
||||
3. Create a `Caddyfile` (yeah the file name itself is `Caddyfile`.) like this:
|
||||
```caddy
|
||||
:8080 {
|
||||
route /dav/* {
|
||||
root /usr/local/mywebdav
|
||||
basicauth {
|
||||
# Username "Bob", password "hiccup"
|
||||
Bob $2a$14$Zkx19XLiW6VYouLHR5NmfOFU0z2GTNmpkT/5qqR7hx4IjWJPDhjvG
|
||||
}
|
||||
uri strip_prefix /dav
|
||||
webdav
|
||||
}
|
||||
}
|
||||
```
|
||||
The password hash is generated like [this](https://caddyserver.com/docs/caddyfile/directives/basic_auth).
|
||||
4. In Remotely Save, setup:
|
||||
* address `http://localhost:8080/dav/`
|
||||
* username `Bob`
|
||||
* password `hiccup`
|
||||
* auth type: `basic`
|
||||
5. Check the connection and sync!
|
||||
17
docs/remote_services/webdav_dufs/README.md
Normal file
17
docs/remote_services/webdav_dufs/README.md
Normal file
@ -0,0 +1,17 @@
|
||||
# dufs webdav
|
||||
|
||||
## Link
|
||||
|
||||
<https://github.com/sigoden/dufs>
|
||||
|
||||
## Steps
|
||||
|
||||
1. Download the latest version: <https://github.com/sigoden/dufs/releases> and save it to a folder
|
||||
2. Add the path environment variable.
|
||||
3. Start the server in terminal, you can change the address (`127.0.0.1`) and username (`user1`) and password (`pass1`) accordingly:
|
||||
```bash
|
||||
dufs -A --enable-cors --bind 127.0.0.1 --port 8080 --auth user1:pass1@/:rw
|
||||
```
|
||||
4. In remotely-save setting page, select webdav type, then input the address/account/**webdav password**(not your account password).
|
||||
5. In remotely-save setting page, click "Check Connectivity".
|
||||
6. Sync!
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.5.14",
|
||||
"version": "0.5.25",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.5.14",
|
||||
"version": "0.5.25",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
|
||||
68
package.json
68
package.json
@ -1,15 +1,15 @@
|
||||
{
|
||||
"name": "remotely-save",
|
||||
"version": "0.5.14",
|
||||
"version": "0.5.25",
|
||||
"description": "This is yet another sync plugin for Obsidian app.",
|
||||
"scripts": {
|
||||
"dev2": "node esbuild.config.mjs --watch",
|
||||
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"build": "webpack --mode production",
|
||||
"dev": "webpack --mode development --watch",
|
||||
"format": "npx @biomejs/biome check --apply .",
|
||||
"format": "npx @biomejs/biome check --write .",
|
||||
"clean": "npx rimraf main.js",
|
||||
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts' 'pro/tests/**/*.ts'"
|
||||
"test": "mocha --import=tsx 'tests/**/*.ts' 'pro/tests/**/*.ts'"
|
||||
},
|
||||
"browser": {
|
||||
"path": "path-browserify",
|
||||
@ -25,55 +25,55 @@
|
||||
"author": "",
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"devDependencies": {
|
||||
"@biomejs/biome": "1.7.3",
|
||||
"@biomejs/biome": "1.8.3",
|
||||
"@microsoft/microsoft-graph-types": "^2.40.0",
|
||||
"@types/chai": "^4.3.14",
|
||||
"@types/chai": "^4.3.16",
|
||||
"@types/chai-as-promised": "^7.1.8",
|
||||
"@types/jsdom": "^21.1.6",
|
||||
"@types/lodash": "^4.17.0",
|
||||
"@types/jsdom": "^21.1.7",
|
||||
"@types/lodash": "^4.17.7",
|
||||
"@types/mime-types": "^2.1.4",
|
||||
"@types/mocha": "^10.0.6",
|
||||
"@types/mocha": "^10.0.7",
|
||||
"@types/mustache": "^4.2.5",
|
||||
"@types/node": "^20.12.7",
|
||||
"@types/node": "^20.14.12",
|
||||
"@types/qrcode": "^1.5.5",
|
||||
"builtin-modules": "^3.3.0",
|
||||
"builtin-modules": "^4.0.0",
|
||||
"cross-env": "^7.0.3",
|
||||
"dotenv": "^16.4.5",
|
||||
"esbuild": "^0.20.2",
|
||||
"esbuild": "^0.23.0",
|
||||
"esbuild-plugin-inline-worker": "^0.1.1",
|
||||
"jsdom": "^24.0.0",
|
||||
"mocha": "^10.4.0",
|
||||
"jsdom": "^24.1.1",
|
||||
"mocha": "^10.7.0",
|
||||
"npm-check-updates": "^16.14.20",
|
||||
"obsidian": "^1.5.7",
|
||||
"openapi-typescript": "^7.0.0-rc.0",
|
||||
"openapi-typescript": "^7.1.0",
|
||||
"ts-loader": "^9.5.1",
|
||||
"ts-node": "^10.9.2",
|
||||
"tslib": "^2.6.2",
|
||||
"typescript": "^5.4.5",
|
||||
"tslib": "^2.6.3",
|
||||
"tsx": "^4.16.2",
|
||||
"typescript": "^5.5.4",
|
||||
"webdav-server": "^2.6.2",
|
||||
"webpack": "^5.91.0",
|
||||
"webpack": "^5.93.0",
|
||||
"webpack-cli": "^5.1.4",
|
||||
"worker-loader": "^3.0.8"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aws-sdk/client-s3": "^3.563.0",
|
||||
"@aws-sdk/lib-storage": "^3.563.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.556.0",
|
||||
"@aws-sdk/types": "^3.535.0",
|
||||
"@azure/msal-node": "^2.7.0",
|
||||
"@azure/storage-blob": "^12.23.0",
|
||||
"@aws-sdk/client-s3": "^3.620.0",
|
||||
"@aws-sdk/lib-storage": "^3.620.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.620.0",
|
||||
"@aws-sdk/types": "^3.609.0",
|
||||
"@azure/msal-node": "^2.12.0",
|
||||
"@azure/storage-blob": "^12.24.0",
|
||||
"@fyears/rclone-crypt": "^0.0.7",
|
||||
"@fyears/tsqueue": "^1.0.1",
|
||||
"@microsoft/microsoft-graph-client": "^3.0.7",
|
||||
"@sanity/diff-match-patch": "^3.1.1",
|
||||
"@smithy/fetch-http-handler": "^2.5.0",
|
||||
"@smithy/protocol-http": "^3.3.0",
|
||||
"@smithy/querystring-builder": "^2.2.0",
|
||||
"acorn": "^8.11.3",
|
||||
"@smithy/fetch-http-handler": "^3.2.4",
|
||||
"@smithy/protocol-http": "^4.1.0",
|
||||
"@smithy/querystring-builder": "^3.0.3",
|
||||
"acorn": "^8.12.1",
|
||||
"aggregate-error": "^5.0.0",
|
||||
"assert": "^2.1.0",
|
||||
"aws-crt": "^1.21.2",
|
||||
"box-typescript-sdk-gen": "^1.0.0",
|
||||
"aws-crt": "^1.21.3",
|
||||
"box-typescript-sdk-gen": "^1.3.0",
|
||||
"buffer": "^6.0.3",
|
||||
"crypto-browserify": "^3.12.0",
|
||||
"dropbox": "^10.34.0",
|
||||
@ -83,21 +83,21 @@
|
||||
"localforage-getitems": "^1.4.2",
|
||||
"localforage-removeitems": "^1.4.0",
|
||||
"lodash": "^4.17.21",
|
||||
"lucide": "^0.376.1",
|
||||
"lucide": "^0.416.0",
|
||||
"mime-types": "^2.1.35",
|
||||
"mustache": "^4.2.0",
|
||||
"nanoid": "^5.0.7",
|
||||
"node-diff3": "^3.1.2",
|
||||
"openapi-fetch": "^0.9.7",
|
||||
"openapi-fetch": "^0.10.2",
|
||||
"p-queue": "^8.0.1",
|
||||
"path-browserify": "^1.0.1",
|
||||
"pcloud-sdk-js": "^2.0.0",
|
||||
"process": "^0.11.10",
|
||||
"qrcode": "^1.5.3",
|
||||
"rfc4648": "^1.5.3",
|
||||
"rimraf": "^5.0.5",
|
||||
"rimraf": "^6.0.1",
|
||||
"stream-browserify": "^3.0.0",
|
||||
"url": "^0.11.3",
|
||||
"url": "^0.11.4",
|
||||
"util": "^0.12.5",
|
||||
"webdav": "^5.6.0",
|
||||
"xregexp": "^5.1.1"
|
||||
|
||||
@ -112,7 +112,9 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes.error !== undefined) {
|
||||
throw Error(`you should not save the setting for ${authRes.error}`);
|
||||
throw Error(
|
||||
`remotely save account auth failed, please auth again: ${authRes.error}`
|
||||
);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
|
||||
@ -38,9 +38,11 @@ export function isMergable(a: Entity, b?: Entity) {
|
||||
* @param b
|
||||
*/
|
||||
function mergeDigInModified(a: string, o: string, b: string) {
|
||||
const { conflict, result } = mergeDigIn(a, o, b);
|
||||
const { conflict, result } = mergeDigIn(a, o, b, {
|
||||
stringSeparator: /\n/,
|
||||
});
|
||||
for (let index = 0; index < result.length; ++index) {
|
||||
if (["<<<<<<<", "=======", ">>>>>>>"].contains(result[index])) {
|
||||
if (["<<<<<<<", "=======", ">>>>>>>"].includes(result[index])) {
|
||||
result[index] = "`" + result[index] + "`";
|
||||
}
|
||||
}
|
||||
@ -72,7 +74,7 @@ function getLCSText(a: string, b: string) {
|
||||
* @param b
|
||||
* @returns
|
||||
*/
|
||||
function twoWayMerge(a: string, b: string): string {
|
||||
export function twoWayMerge(a: string, b: string): string {
|
||||
const aa = a.trim();
|
||||
const bb = b.trim();
|
||||
if (aa === "" && bb === "") {
|
||||
@ -88,7 +90,10 @@ function twoWayMerge(a: string, b: string): string {
|
||||
// const c = getLCSText(a, b);
|
||||
// const patches = makePatches(c, a);
|
||||
// const [d] = applyPatches(patches, b);
|
||||
const c = getLCSText(a, b);
|
||||
const c = getLCSText(a, b); //.trim();
|
||||
// console.debug(`(start) LCS Text:`);
|
||||
// console.debug(c);
|
||||
// console.debug(`(end) LCS Text.`);
|
||||
const d = mergeDigInModified(a, c, b).result.join("\n");
|
||||
return d;
|
||||
}
|
||||
@ -100,7 +105,7 @@ function twoWayMerge(a: string, b: string): string {
|
||||
* @param orig
|
||||
* @returns
|
||||
*/
|
||||
function threeWayMerge(a: string, b: string, orig: string) {
|
||||
export function threeWayMerge(a: string, b: string, orig: string) {
|
||||
return mergeDigInModified(a, orig, b).result.join("\n");
|
||||
}
|
||||
|
||||
@ -162,7 +167,7 @@ export async function mergeFile(
|
||||
key,
|
||||
newArrayBuffer,
|
||||
rightEntity.mtimeCli ?? mtime,
|
||||
rightEntity.mtimeCli ?? mtime
|
||||
rightEntity.ctimeCli ?? rightEntity.mtimeCli ?? mtime
|
||||
);
|
||||
|
||||
return {
|
||||
|
||||
@ -320,12 +320,12 @@ export class FakeFsAzureBlobStorage extends FakeFs {
|
||||
// if we can walk, we can connect
|
||||
try {
|
||||
await this.walkPartial();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -112,7 +112,7 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
`remotely save account auth failed, please auth again: ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
@ -892,12 +892,12 @@ export class FakeFsBox extends FakeFs {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
throw new Error("Method not implemented.");
|
||||
|
||||
@ -728,12 +728,12 @@ export class FakeFsGoogleDrive extends FakeFs {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -140,7 +140,7 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
`remotely save account auth failed, please auth again: ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
@ -263,7 +263,7 @@ const getAuthMiddleware = (
|
||||
saveUpdatedConfigFunc: any
|
||||
) => {
|
||||
const authMiddleware: Middleware = {
|
||||
async onRequest(req) {
|
||||
async onRequest({ request }) {
|
||||
const getAccessToken = async () => {
|
||||
if (koofrConfig.refreshToken === "") {
|
||||
throw Error("The user has not manually auth yet.");
|
||||
@ -291,8 +291,8 @@ const getAuthMiddleware = (
|
||||
};
|
||||
|
||||
const access = await getAccessToken();
|
||||
req.headers.set("Authorization", `Bearer ${access}`);
|
||||
return req;
|
||||
request.headers.set("Authorization", `Bearer ${access}`);
|
||||
return request;
|
||||
},
|
||||
};
|
||||
return authMiddleware;
|
||||
@ -555,12 +555,12 @@ export class FakeFsKoofr extends FakeFs {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -290,13 +290,25 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
key = `${key}/`;
|
||||
}
|
||||
|
||||
const mtimeSvr = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
const mtimeCli = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
const mtimeTry = x?.fileSystemInfo?.lastModifiedDateTime;
|
||||
if (mtimeTry === undefined || mtimeTry === null) {
|
||||
throw Error(`onedrive cannot parse mtime: ${JSON.stringify(x, null, 2)}`);
|
||||
}
|
||||
let ctimeTry = x?.fileSystemInfo?.createdDateTime;
|
||||
if (ctimeTry === undefined || ctimeTry === null) {
|
||||
// throw Error(`onedrive cannot parse ctime: ${JSON.stringify(x, null, 2)}`);
|
||||
// it doesn't hurt, we just use mtimeTry to fullfill
|
||||
ctimeTry = mtimeTry;
|
||||
}
|
||||
const mtimeSvr = Date.parse(mtimeTry);
|
||||
const mtimeCli = Date.parse(mtimeTry);
|
||||
const ctimeCli = Date.parse(ctimeTry);
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeSvr: mtimeSvr,
|
||||
mtimeCli: mtimeCli,
|
||||
ctimeCli: ctimeCli,
|
||||
size: isFolder ? 0 : x.size!,
|
||||
sizeRaw: isFolder ? 0 : x.size!,
|
||||
synthesizedFile: false,
|
||||
@ -767,6 +779,7 @@ export class FakeFsOnedriveFull extends FakeFs {
|
||||
keyRaw: origKey,
|
||||
mtimeSvr: mtime,
|
||||
mtimeCli: mtime,
|
||||
ctimeCli: ctime,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
synthesizedFile: true,
|
||||
@ -912,12 +925,15 @@ export class FakeFsOnedriveFull extends FakeFs {
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
try {
|
||||
const k = await this.getUserDisplayName();
|
||||
return k !== "<unknown display name>";
|
||||
if (k === "<unknown display name>") {
|
||||
throw Error(`unknown display name!`);
|
||||
}
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName() {
|
||||
|
||||
@ -99,7 +99,9 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes === undefined) {
|
||||
throw Error(`you should not save the setting for undefined result`);
|
||||
throw Error(
|
||||
`remotely save account auth failed, please auth again: undefined result`
|
||||
);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
@ -604,12 +606,12 @@ export class FakeFsPCloud extends FakeFs {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -127,7 +127,7 @@ export const setConfigBySuccessfullAuthInplace = async (
|
||||
) => {
|
||||
if (authRes.access_token === undefined || authRes.access_token === "") {
|
||||
throw Error(
|
||||
`you should not save the setting for ${JSON.stringify(authRes)}`
|
||||
`remotely save account auth failed, please auth again: ${JSON.stringify(authRes)}`
|
||||
);
|
||||
}
|
||||
|
||||
@ -480,12 +480,12 @@ export class FakeFsYandexDisk extends FakeFs {
|
||||
// if we can init, we can connect
|
||||
try {
|
||||
await this._init();
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -268,7 +268,7 @@
|
||||
"settings_azureblobstorage_parts": "Parts Concurrency",
|
||||
"settings_azureblobstorage_parts_desc": "Large files are split into small parts to upload. How many parts do you want to upload in parallel at most?",
|
||||
"settings_azureblobstorage_generatefolderobject": "Generate Folder Object Or Not",
|
||||
"settings_azureblobstorage_generatefolderobject_desc": "Azure Blob Storage doesn't have \"real\" folder. If you set \"Generate\" here, the plugin will upload a zero-byte object endding with \"/\" to represent the folder. By default, the plugin skips generating folder object.",
|
||||
"settings_azureblobstorage_generatefolderobject_desc": "Azure Blob Storage doesn't have \"real\" folder. If you set \"Generate\" here, the plugin will upload a zero-byte object ending with \"/\" to represent the folder. By default, the plugin skips generating folder object.",
|
||||
"settings_azureblobstorage_generatefolderobject_notgenerate": "Not generate (default)",
|
||||
"settings_azureblobstorage_generatefolderobject_generate": "Generate",
|
||||
"settings_azureblobstorage_connect_succ": "Great! We can connect to Azure Blob Storage!",
|
||||
|
||||
@ -95,6 +95,10 @@ class GoogleDriveAuthModal extends Modal {
|
||||
k.expires_in * 1000;
|
||||
this.plugin.settings.googledrive.accessTokenExpiresAtTimeMs =
|
||||
ts + k.expires_in * 1000 - 60 * 2 * 1000;
|
||||
|
||||
// manually set it expired after 60 days;
|
||||
this.plugin.settings.googledrive.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + 1000 * 60 * 60 * 24 * 59;
|
||||
await this.plugin.saveSettings();
|
||||
|
||||
// try to remove data in clipboard
|
||||
|
||||
385
pro/src/sync.ts
385
pro/src/sync.ts
@ -28,6 +28,8 @@ import {
|
||||
} from "../../src/metadataOnRemote";
|
||||
import {
|
||||
atWhichLevel,
|
||||
checkValidName,
|
||||
getFolderLevels,
|
||||
getParentFolder,
|
||||
isHiddenPath,
|
||||
isSpecialFolderNameToSkip,
|
||||
@ -59,6 +61,17 @@ const copyEntityAndFixTimeFormat = (
|
||||
result.mtimeCliFmt = unixTimeToStr(result.mtimeCli);
|
||||
}
|
||||
}
|
||||
if (result.ctimeCli !== undefined) {
|
||||
if (result.ctimeCli === 0) {
|
||||
result.ctimeCli = undefined;
|
||||
} else {
|
||||
if (serviceType === "s3" || serviceType === "dropbox") {
|
||||
// round to second instead of millisecond
|
||||
result.ctimeCli = Math.floor(result.ctimeCli / 1000.0) * 1000;
|
||||
}
|
||||
result.ctimeCliFmt = unixTimeToStr(result.ctimeCli);
|
||||
}
|
||||
}
|
||||
if (result.mtimeSvr !== undefined) {
|
||||
if (result.mtimeSvr === 0) {
|
||||
result.mtimeSvr = undefined;
|
||||
@ -127,43 +140,218 @@ const isBookmarksFile = (x: string, configDir: string) => {
|
||||
);
|
||||
};
|
||||
|
||||
const isSkipItemByName = (
|
||||
interface IsSkipResult {
|
||||
enableAllowMode: boolean;
|
||||
isExplictlyAllowed: boolean;
|
||||
isExplictlyIgnored: boolean;
|
||||
finalIsIgnored: boolean;
|
||||
}
|
||||
|
||||
export const checkIsSkipItemOrNotByName = (
|
||||
key: string,
|
||||
syncConfigDir: boolean,
|
||||
syncBookmarks: boolean,
|
||||
syncUnderscoreItems: boolean,
|
||||
configDir: string,
|
||||
ignorePaths: string[]
|
||||
) => {
|
||||
ignorePaths: string[],
|
||||
onlyAllowPaths: string[]
|
||||
): IsSkipResult => {
|
||||
if (key === undefined) {
|
||||
throw Error(`isSkipItemByName meets undefinded key!`);
|
||||
throw Error(`checkIsSkipItemOrNotByName meets undefinded key!`);
|
||||
}
|
||||
if (ignorePaths !== undefined && ignorePaths.length > 0) {
|
||||
for (const r of ignorePaths) {
|
||||
|
||||
let finalIsIgnored: boolean | undefined = undefined;
|
||||
|
||||
let enableAllowMode = false;
|
||||
let isExplictlyAllowed = false;
|
||||
if (onlyAllowPaths !== undefined && onlyAllowPaths.length > 0) {
|
||||
for (const r of onlyAllowPaths) {
|
||||
if (r.trim() === "") {
|
||||
// ignore empty lines
|
||||
continue;
|
||||
}
|
||||
enableAllowMode = true; // we really want to check the allow list
|
||||
|
||||
if (XRegExp(r, "A").test(key)) {
|
||||
return true;
|
||||
isExplictlyAllowed = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (syncConfigDir && isInsideObsFolder(key, configDir)) {
|
||||
return false;
|
||||
// we want to determine "is skippable or not".
|
||||
// if the key meets the allow list,
|
||||
// it may or may not be skippable,
|
||||
// and is deferred to next checking steps
|
||||
// if the key doesn't meet the allow list,
|
||||
// it must be skippable.
|
||||
if (enableAllowMode && !isExplictlyAllowed) {
|
||||
finalIsIgnored = true; // must be skippable
|
||||
}
|
||||
|
||||
if (syncBookmarks && isBookmarksFile(key, configDir)) {
|
||||
return false;
|
||||
let isExplictlyIgnored = false;
|
||||
if (ignorePaths !== undefined && ignorePaths.length > 0) {
|
||||
for (const r of ignorePaths) {
|
||||
if (r.trim() === "") {
|
||||
// ignore empty lines
|
||||
continue;
|
||||
}
|
||||
if (XRegExp(r, "A").test(key)) {
|
||||
if (finalIsIgnored === undefined) {
|
||||
isExplictlyIgnored = true;
|
||||
finalIsIgnored = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// sync config, not sync bookmarks: sync config and **force syncing bookmarks as well**
|
||||
// not sync config, sync bookmarks: sync bookmars, not other config
|
||||
// not sync config, not sync bookmarks: not sync config
|
||||
if (finalIsIgnored === undefined) {
|
||||
if (syncConfigDir) {
|
||||
if (isInsideObsFolder(key, configDir)) {
|
||||
// force sync everything
|
||||
finalIsIgnored = false;
|
||||
} else {
|
||||
// not config files, do not judge now, do nothing
|
||||
}
|
||||
} else if (syncBookmarks) {
|
||||
// not sync config, sync bookmarks
|
||||
if (isBookmarksFile(key, configDir)) {
|
||||
// sync everything of bookmarks
|
||||
finalIsIgnored = false;
|
||||
} else if (isInsideObsFolder(key, configDir)) {
|
||||
// not sync any other thing in config
|
||||
finalIsIgnored = true;
|
||||
} else {
|
||||
// not config files, do not judge now, do nothing
|
||||
}
|
||||
} else {
|
||||
// not sync config, and not sync bookmarks
|
||||
if (isInsideObsFolder(key, configDir)) {
|
||||
// not sync any thing in config
|
||||
finalIsIgnored = true;
|
||||
} else {
|
||||
// not config files, do not judge now, do nothing
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isSpecialFolderNameToSkip(key, [])) {
|
||||
// some special dirs and files are always skipped
|
||||
return true;
|
||||
if (finalIsIgnored === undefined) {
|
||||
isExplictlyIgnored = true;
|
||||
finalIsIgnored = true;
|
||||
}
|
||||
}
|
||||
return (
|
||||
|
||||
const checkIsHidden =
|
||||
isHiddenPath(key, true, false) ||
|
||||
(!syncUnderscoreItems && isHiddenPath(key, false, true)) ||
|
||||
key === "/" ||
|
||||
key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE ||
|
||||
key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2
|
||||
);
|
||||
key === DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2;
|
||||
if (finalIsIgnored === undefined) {
|
||||
isExplictlyIgnored = checkIsHidden;
|
||||
finalIsIgnored = checkIsHidden;
|
||||
}
|
||||
|
||||
if (finalIsIgnored === undefined) {
|
||||
throw Error(`no finalIsIgnored in checkIsSkipItemOrNotByName for ${key}`);
|
||||
}
|
||||
|
||||
return {
|
||||
enableAllowMode: enableAllowMode,
|
||||
isExplictlyAllowed: isExplictlyAllowed,
|
||||
isExplictlyIgnored: isExplictlyIgnored,
|
||||
finalIsIgnored: finalIsIgnored,
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* | finalIgnored | reason | explictlyIgnored | allowMode | explictlyAllowed |
|
||||
* | ------------------------------- | -------------------------------------------- | ---------------- | --------- | ---------------- |
|
||||
* | no | nothing blocking | no | no | no |
|
||||
* | yes, MAY be changed by children | allow mode not allowed, inexplicitly ignored | no | yes | no |
|
||||
* | no, MAY apply to parents | allow mode allowed | no | yes | yes |
|
||||
* | yes, also apply to children | explictly ignored | yes | no | no |
|
||||
* | yes, also apply to children | explictly ignored | yes | yes | no |
|
||||
* | yes, also apply to children | explictly ignored | yes | yes | yes |
|
||||
*/
|
||||
export const getSkipItemsByList = (
|
||||
skipOrNotResults: Record<string, IsSkipResult>
|
||||
): string[] => {
|
||||
const allPotentialKeys = Object.keys(skipOrNotResults);
|
||||
|
||||
// from short(shadow) to long(deep) , ascending
|
||||
const sortedKeys = allPotentialKeys.sort((k1, k2) => k1.length - k2.length);
|
||||
|
||||
// we deal with explicty ignored list firstly, apply them to children
|
||||
const explictlyIgnoredSet = new Set<string>();
|
||||
for (const key of sortedKeys) {
|
||||
if (skipOrNotResults[key].isExplictlyIgnored) {
|
||||
skipOrNotResults[key].finalIsIgnored = true;
|
||||
explictlyIgnoredSet.add(key);
|
||||
} else {
|
||||
const parents = getFolderLevels(key, true).reverse();
|
||||
for (const key2 of parents) {
|
||||
if (explictlyIgnoredSet.has(key2)) {
|
||||
skipOrNotResults[key].isExplictlyIgnored = true;
|
||||
skipOrNotResults[key].finalIsIgnored = true;
|
||||
explictlyIgnoredSet.add(key);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// we deal with explictly allow list secondly, apply them to PARENTS if possible
|
||||
let enableAllowMode = false;
|
||||
if (
|
||||
allPotentialKeys.length > 0 &&
|
||||
allPotentialKeys[0] !== undefined &&
|
||||
skipOrNotResults[allPotentialKeys[0]] !== undefined
|
||||
) {
|
||||
enableAllowMode = skipOrNotResults[allPotentialKeys[0]].enableAllowMode;
|
||||
}
|
||||
if (enableAllowMode) {
|
||||
for (let index = 0; index < sortedKeys.length; index++) {
|
||||
// reverse order, long(deep) to short(shadow), ascending
|
||||
const key = sortedKeys[sortedKeys.length - index - 1];
|
||||
if (
|
||||
!skipOrNotResults[key].isExplictlyIgnored &&
|
||||
skipOrNotResults[key].isExplictlyAllowed
|
||||
) {
|
||||
// the file is explictly allowed, and not explictly ignored by anywhere
|
||||
// we allow all its parents!
|
||||
const parents = getFolderLevels(key, true).reverse();
|
||||
|
||||
for (const key2 of parents) {
|
||||
if (
|
||||
key2 in skipOrNotResults &&
|
||||
!skipOrNotResults[key2].isExplictlyIgnored &&
|
||||
!explictlyIgnoredSet.has(key2)
|
||||
) {
|
||||
skipOrNotResults[key2].isExplictlyAllowed = true;
|
||||
skipOrNotResults[key2].finalIsIgnored = false; // from ignored to allowed
|
||||
} else {
|
||||
throw Error(
|
||||
`${key}'s parent ${key2} in abnormal state: ${JSON.stringify(skipOrNotResults[key2])}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// get all finalIsIgnored
|
||||
const result: string[] = [];
|
||||
for (const key of sortedKeys) {
|
||||
if (skipOrNotResults[key].finalIsIgnored) {
|
||||
result.push(key);
|
||||
}
|
||||
}
|
||||
console.debug(`finalIsIgnored list= ${JSON.stringify(result)}`);
|
||||
return result;
|
||||
};
|
||||
|
||||
export type SyncPlanType = Record<string, MixedEntity>;
|
||||
@ -178,6 +366,7 @@ const ensembleMixedEnties = async (
|
||||
configDir: string,
|
||||
syncUnderscoreItems: boolean,
|
||||
ignorePaths: string[],
|
||||
onlyAllowPaths: string[],
|
||||
fsEncrypt: FakeFsEncrypt,
|
||||
serviceType: SUPPORTED_SERVICES_TYPE,
|
||||
|
||||
@ -191,26 +380,40 @@ const ensembleMixedEnties = async (
|
||||
|
||||
const finalMappings: SyncPlanType = {};
|
||||
|
||||
const skipOrNotResults: Record<string, IsSkipResult> = {};
|
||||
|
||||
// remote has to be first
|
||||
let remoteMaySkipCountAndNotConfig = 0;
|
||||
for (const remote of remoteEntityList) {
|
||||
const remoteCopied = ensureMTimeOfRemoteEntityValid(
|
||||
copyEntityAndFixTimeFormat(remote, serviceType)
|
||||
);
|
||||
|
||||
const key = remoteCopied.key!;
|
||||
if (
|
||||
isSkipItemByName(
|
||||
key,
|
||||
syncConfigDir,
|
||||
syncBookmarks,
|
||||
syncUnderscoreItems,
|
||||
configDir,
|
||||
ignorePaths
|
||||
)
|
||||
) {
|
||||
continue;
|
||||
|
||||
const skipOrNot = checkIsSkipItemOrNotByName(
|
||||
key,
|
||||
syncConfigDir,
|
||||
syncBookmarks,
|
||||
syncUnderscoreItems,
|
||||
configDir,
|
||||
ignorePaths,
|
||||
onlyAllowPaths
|
||||
);
|
||||
skipOrNotResults[key] = skipOrNot;
|
||||
if (skipOrNot.finalIsIgnored && !key.startsWith(configDir)) {
|
||||
remoteMaySkipCountAndNotConfig += 1;
|
||||
}
|
||||
|
||||
// 20240907: users (not on windows) doesn't like it. revert back now.
|
||||
// TODO: platform specific but not introducing obsidian dependency into sync.ts
|
||||
// const checkValidNameResult = checkValidName(key);
|
||||
// if (!checkValidNameResult.result) {
|
||||
// throw Error(
|
||||
// `your remote folder/file name is invalid: ${checkValidNameResult.reason}`
|
||||
// );
|
||||
// }
|
||||
|
||||
finalMappings[key] = {
|
||||
key: key,
|
||||
remote: remoteCopied,
|
||||
@ -220,28 +423,34 @@ const ensembleMixedEnties = async (
|
||||
profiler?.insert("ensembleMixedEnties: finish remote");
|
||||
profiler?.insertSize("sizeof finalMappings", finalMappings);
|
||||
|
||||
if (Object.keys(finalMappings).length === 0 || localEntityList.length === 0) {
|
||||
if (
|
||||
Object.keys(finalMappings).filter((k) => !k.startsWith(configDir)).length -
|
||||
remoteMaySkipCountAndNotConfig ===
|
||||
0 ||
|
||||
localEntityList.filter((e) => !e.key?.startsWith(configDir)).length === 0
|
||||
) {
|
||||
// Special checking:
|
||||
// if one side is totally empty,
|
||||
// usually that's a hard rest.
|
||||
// So we need to ignore everything of prevSyncEntityList to avoid deletions!
|
||||
// TODO: acutally erase everything of prevSyncEntityList?
|
||||
// TODO: local should also go through a isSkipItemByName checking beforehand
|
||||
// TODO: local should also go through a checkIsSkipItemOrNotByName checking beforehand
|
||||
} else {
|
||||
// normally go through the prevSyncEntityList
|
||||
for (const prevSync of prevSyncEntityList) {
|
||||
const key = prevSync.key!;
|
||||
if (
|
||||
isSkipItemByName(
|
||||
|
||||
if (!(key in skipOrNotResults)) {
|
||||
const skipOrNot = checkIsSkipItemOrNotByName(
|
||||
key,
|
||||
syncConfigDir,
|
||||
syncBookmarks,
|
||||
syncUnderscoreItems,
|
||||
configDir,
|
||||
ignorePaths
|
||||
)
|
||||
) {
|
||||
continue;
|
||||
ignorePaths,
|
||||
onlyAllowPaths
|
||||
);
|
||||
skipOrNotResults[key] = skipOrNot;
|
||||
}
|
||||
|
||||
// TODO: abstraction leaking?
|
||||
@ -267,19 +476,29 @@ const ensembleMixedEnties = async (
|
||||
// (we don't consume prevSync here because it gains no benefit)
|
||||
for (const local of localEntityList) {
|
||||
const key = local.key!;
|
||||
if (
|
||||
isSkipItemByName(
|
||||
|
||||
if (!(key in skipOrNotResults)) {
|
||||
const skipOrNot = checkIsSkipItemOrNotByName(
|
||||
key,
|
||||
syncConfigDir,
|
||||
syncBookmarks,
|
||||
syncUnderscoreItems,
|
||||
configDir,
|
||||
ignorePaths
|
||||
)
|
||||
) {
|
||||
continue;
|
||||
ignorePaths,
|
||||
onlyAllowPaths
|
||||
);
|
||||
skipOrNotResults[key] = skipOrNot;
|
||||
}
|
||||
|
||||
// 20240907: users (not on windows) doesn't like it. revert back now.
|
||||
// TODO: platform specific but not introducing obsidian dependency into sync.ts
|
||||
// const checkValidNameResult = checkValidName(key);
|
||||
// if (!checkValidNameResult.result) {
|
||||
// throw Error(
|
||||
// `your local folder/file name is invalid: ${checkValidNameResult.reason}`
|
||||
// );
|
||||
// }
|
||||
|
||||
// TODO: abstraction leaking?
|
||||
const localCopied = await fsEncrypt.encryptEntity(
|
||||
copyEntityAndFixTimeFormat(local, serviceType)
|
||||
@ -297,6 +516,15 @@ const ensembleMixedEnties = async (
|
||||
profiler?.insert("ensembleMixedEnties: finish local");
|
||||
profiler?.insertSize("sizeof finalMappings", finalMappings);
|
||||
|
||||
// we check the skipOrNotResults again! in case we adjust some paths!
|
||||
const allReallySkipKeys = getSkipItemsByList(skipOrNotResults);
|
||||
for (const key of allReallySkipKeys) {
|
||||
delete finalMappings[key];
|
||||
}
|
||||
|
||||
profiler?.insert("ensembleMixedEnties: finish parsing all skip items");
|
||||
profiler?.insertSize("sizeof finalMappings", finalMappings);
|
||||
|
||||
// console.debug("in the end of ensembleMixedEnties, finalMappings is:");
|
||||
// console.debug(finalMappings);
|
||||
|
||||
@ -322,7 +550,7 @@ const getSyncPlanInplace = async (
|
||||
) => {
|
||||
profiler?.addIndent();
|
||||
profiler?.insert("getSyncPlanInplace: enter");
|
||||
// from long(deep) to short(shadow)
|
||||
// from long(deep) to short(shadow), descending
|
||||
const sortedKeys = Object.keys(mixedEntityMappings).sort(
|
||||
(k1, k2) => k2.length - k1.length
|
||||
);
|
||||
@ -415,14 +643,36 @@ const getSyncPlanInplace = async (
|
||||
mixedEntry.change = false;
|
||||
keptFolder.add(getParentFolder(key));
|
||||
} else if (syncDirection === "incremental_pull_and_delete_only") {
|
||||
mixedEntry.decisionBranch = 135;
|
||||
mixedEntry.decision = "folder_to_be_deleted_on_local";
|
||||
mixedEntry.change = true;
|
||||
if (
|
||||
key === `${configDir}/` ||
|
||||
key === `${configDir}/bookmarks.json`
|
||||
) {
|
||||
// special: never delete .obsidian folder!
|
||||
mixedEntry.decisionBranch = 137;
|
||||
mixedEntry.decision = "folder_existed_both_then_do_nothing";
|
||||
mixedEntry.change = false;
|
||||
keptFolder.add(getParentFolder(key));
|
||||
} else {
|
||||
mixedEntry.decisionBranch = 135;
|
||||
mixedEntry.decision = "folder_to_be_deleted_on_local";
|
||||
mixedEntry.change = true;
|
||||
}
|
||||
} else {
|
||||
// bidirectional
|
||||
mixedEntry.decisionBranch = 124;
|
||||
mixedEntry.decision = "folder_to_be_deleted_on_local";
|
||||
mixedEntry.change = true;
|
||||
if (
|
||||
key === `${configDir}/` ||
|
||||
key === `${configDir}/bookmarks.json`
|
||||
) {
|
||||
// special: never delete .obsidian folder!
|
||||
mixedEntry.decisionBranch = 138;
|
||||
mixedEntry.decision = "folder_existed_both_then_do_nothing";
|
||||
mixedEntry.change = false;
|
||||
keptFolder.add(getParentFolder(key));
|
||||
} else {
|
||||
mixedEntry.decisionBranch = 124;
|
||||
mixedEntry.decision = "folder_to_be_deleted_on_local";
|
||||
mixedEntry.change = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// then the folder is created on local
|
||||
@ -864,13 +1114,35 @@ const getSyncPlanInplace = async (
|
||||
mixedEntry.decision = "conflict_created_then_do_nothing";
|
||||
mixedEntry.change = false;
|
||||
} else if (syncDirection === "incremental_pull_and_delete_only") {
|
||||
mixedEntry.decisionBranch = 39;
|
||||
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
|
||||
mixedEntry.change = true;
|
||||
if (
|
||||
key === `${configDir}/` ||
|
||||
key === `${configDir}/bookmarks.json`
|
||||
) {
|
||||
// special: never delete .obsidian/bookmarks.json file!
|
||||
mixedEntry.decisionBranch = 139;
|
||||
mixedEntry.decision = "conflict_created_then_keep_local";
|
||||
mixedEntry.change = true;
|
||||
keptFolder.add(getParentFolder(key));
|
||||
} else {
|
||||
mixedEntry.decisionBranch = 39;
|
||||
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
|
||||
mixedEntry.change = true;
|
||||
}
|
||||
} else {
|
||||
mixedEntry.decisionBranch = 7;
|
||||
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
|
||||
mixedEntry.change = true;
|
||||
if (
|
||||
key === `${configDir}/` ||
|
||||
key === `${configDir}/bookmarks.json`
|
||||
) {
|
||||
// special: never delete .obsidian/bookmarks.json file!
|
||||
mixedEntry.decisionBranch = 140;
|
||||
mixedEntry.decision = "conflict_created_then_keep_local";
|
||||
mixedEntry.change = true;
|
||||
keptFolder.add(getParentFolder(key));
|
||||
} else {
|
||||
mixedEntry.decisionBranch = 7;
|
||||
mixedEntry.decision = "remote_is_deleted_thus_also_delete_local";
|
||||
mixedEntry.change = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// if A is in the previous list and MODIFIED, A has been deleted by B but modified by A
|
||||
@ -920,6 +1192,8 @@ const getSyncPlanInplace = async (
|
||||
keptFolder.delete("/");
|
||||
keptFolder.delete("");
|
||||
if (keptFolder.size > 0) {
|
||||
console.error(sortedKeys);
|
||||
console.error(mixedEntityMappings);
|
||||
throw Error(`unexpectedly keptFolder no decisions: ${[...keptFolder]}`);
|
||||
}
|
||||
|
||||
@ -1656,7 +1930,7 @@ export async function syncer(
|
||||
) => any,
|
||||
callbackSyncProcess?: any
|
||||
) {
|
||||
console.info(`startting sync.`);
|
||||
console.info(`starting sync.`);
|
||||
markIsSyncingFunc(true);
|
||||
|
||||
let everythingOk = true;
|
||||
@ -1735,6 +2009,7 @@ export async function syncer(
|
||||
configDir,
|
||||
settings.syncUnderscoreItems ?? false,
|
||||
settings.ignorePaths ?? [],
|
||||
settings.onlyAllowPaths ?? [],
|
||||
fsEncrypt,
|
||||
settings.serviceType,
|
||||
profiler
|
||||
@ -1814,6 +2089,6 @@ export async function syncer(
|
||||
await ribboonFunc?.(triggerSource, step);
|
||||
await statusBarFunc?.(triggerSource, step, everythingOk);
|
||||
|
||||
console.info(`endding sync.`);
|
||||
console.info(`ending sync.`);
|
||||
markIsSyncingFunc(false);
|
||||
}
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
import { deepStrictEqual, rejects, throws } from "assert";
|
||||
import { getFileRenameForDup } from "../src/conflictLogic";
|
||||
import {
|
||||
getFileRenameForDup,
|
||||
threeWayMerge,
|
||||
twoWayMerge,
|
||||
} from "../src/conflictLogic";
|
||||
|
||||
describe("New name is generated", () => {
|
||||
it("should throw for empty file", async () => {
|
||||
@ -69,3 +73,224 @@ describe("New name is generated", () => {
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Two way merge", () => {
|
||||
it("should correctly merge from zero files", async () => {
|
||||
const a = "aaa";
|
||||
const b = "bbb";
|
||||
const res = twoWayMerge(a, b);
|
||||
const expected = `\`<<<<<<<\`
|
||||
aaa
|
||||
\`=======\`
|
||||
bbb
|
||||
\`>>>>>>>\``;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge from common lines", async () => {
|
||||
const a = `
|
||||
Something is cool. 中文1
|
||||
Other thing is cooler. 哈哈！
|
||||
`;
|
||||
const b = `
|
||||
Anything is cool. 中文2
|
||||
Other thing is cooler. 哈哈！
|
||||
`;
|
||||
const res = twoWayMerge(a, b);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
\`<<<<<<<\`
|
||||
Something is cool. 中文1
|
||||
\`=======\`
|
||||
Anything is cool. 中文2
|
||||
\`>>>>>>>\`
|
||||
Other thing is cooler. 哈哈！
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should merge by lines", async () => {
|
||||
const a = `
|
||||
Something is cool. 中文1
|
||||
`;
|
||||
const b = `
|
||||
Something is cooler. 中文2
|
||||
`;
|
||||
const res = twoWayMerge(a, b);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
\`<<<<<<<\`
|
||||
Something is cool. 中文1
|
||||
\`=======\`
|
||||
Something is cooler. 中文2
|
||||
\`>>>>>>>\`
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Three way merge", () => {
|
||||
it("should correctly merge from zero files", async () => {
|
||||
const orig = "";
|
||||
const a = "aaa";
|
||||
const b = "bbb";
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
const expected = `\`<<<<<<<\`
|
||||
aaa
|
||||
\`=======\`
|
||||
bbb
|
||||
\`>>>>>>>\``;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge after adding lines on both sides", async () => {
|
||||
const orig = `
|
||||
* [ ] A1
|
||||
* [ ] A2
|
||||
* [ ] A3
|
||||
`;
|
||||
const a = `
|
||||
* [ ] A1
|
||||
* [ ] new line after A1
|
||||
* [ ] A2
|
||||
* [ ] A3
|
||||
`;
|
||||
const b = `
|
||||
* [ ] A1
|
||||
* [ ] A2
|
||||
* [ ] New line after A2
|
||||
* [ ] A3
|
||||
`;
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
* [ ] A1
|
||||
* [ ] new line after A1
|
||||
* [ ] A2
|
||||
* [ ] New line after A2
|
||||
* [ ] A3
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge after adding lines on both sides (again)", async () => {
|
||||
const orig = `
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
`;
|
||||
const a = `
|
||||
* [ ] 中文
|
||||
* [ ] new line after 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
`;
|
||||
const b = `
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] New line after にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
`;
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
* [ ] 中文
|
||||
* [ ] new line after 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] New line after にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge after deleting lines on both sides", async () => {
|
||||
const orig = `
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const a = `
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const b = `
|
||||
* [ ] 中文
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
\`<<<<<<<\`
|
||||
* [ ] にほんご／にっぽんご
|
||||
\`=======\`
|
||||
* [ ] 中文
|
||||
\`>>>>>>>\`
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge after adding on one side and deleting on other side", async () => {
|
||||
const orig = `
|
||||
* [ ] 中文
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const a = `
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const b = `
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
\`<<<<<<<\`
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
\`=======\`
|
||||
\`>>>>>>>\`
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
|
||||
it("should correctly merge after adding on one side and deleting on other side (again)", async () => {
|
||||
const orig = `
|
||||
* [ ] 中文
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const a = `
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const b = `
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
const res = threeWayMerge(a, b, orig);
|
||||
// console.log(res);
|
||||
const expected = `
|
||||
\`<<<<<<<\`
|
||||
\`=======\`
|
||||
* [ ] 中文
|
||||
* [ ] にほんご／にっぽんご
|
||||
\`>>>>>>>\`
|
||||
* [ ] A3
|
||||
* [ ] A4
|
||||
`;
|
||||
deepStrictEqual(expected, res);
|
||||
});
|
||||
});
|
||||
|
||||
154
pro/tests/sync.test.ts
Normal file
154
pro/tests/sync.test.ts
Normal file
@ -0,0 +1,154 @@
|
||||
import { strict as assert } from "assert";
|
||||
import { checkIsSkipItemOrNotByName } from "../src/sync";
|
||||
|
||||
describe("Sync: checkIsSkipItemOrNotByName", () => {
|
||||
it("should be ok everywhere for empty config", async () => {
|
||||
let isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ [],
|
||||
/* onlyAllowPaths */ []
|
||||
).finalIsIgnored;
|
||||
assert.ok(!isSkip);
|
||||
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ [""],
|
||||
/* onlyAllowPaths */ ["", "\n"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(!isSkip);
|
||||
});
|
||||
|
||||
it("should be ok for deny list", async () => {
|
||||
let isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ ["xxx"],
|
||||
/* onlyAllowPaths */ []
|
||||
).finalIsIgnored;
|
||||
assert.ok(isSkip);
|
||||
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"yyy.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ ["xxx"],
|
||||
/* onlyAllowPaths */ []
|
||||
).finalIsIgnored;
|
||||
assert.ok(!isSkip);
|
||||
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ ["xxx$"],
|
||||
/* onlyAllowPaths */ []
|
||||
).finalIsIgnored;
|
||||
assert.ok(!isSkip);
|
||||
|
||||
// if we deny a folder, we have to deny all the sub files
|
||||
// TODO: it's soooo hard to do the path resolution in this func with regex,
|
||||
// so we defer the detection to later steps now.
|
||||
// the test here doesn't work.
|
||||
// isSkip = checkIsSkipItemOrNotByName(
|
||||
// 'xxx/yyy.md',
|
||||
// false,
|
||||
// false,
|
||||
// false,
|
||||
// '.obsidian',
|
||||
// /* ignorePaths */ ['xxx/$'],
|
||||
// /* onlyAllowPaths */ []
|
||||
// ).finalIsIgnored;
|
||||
// assert.ok(isSkip);
|
||||
});
|
||||
|
||||
it("should be ok for allow list", async () => {
|
||||
let isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ [],
|
||||
/* onlyAllowPaths */ ["xxx"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(!isSkip);
|
||||
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"yyy.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ [""],
|
||||
/* onlyAllowPaths */ ["xxx"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(isSkip);
|
||||
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ [],
|
||||
/* onlyAllowPaths */ ["xxx$"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(isSkip);
|
||||
|
||||
// should NOT skip because we allow the sub file AND not deny the folder
|
||||
// TODO: it's soooo hard to do the path resolution in this func with regex,
|
||||
// so we defer the detection to later steps now.
|
||||
// the test here doesn't work.
|
||||
// isSkip = checkIsSkipItemOrNotByName(
|
||||
// 'xxx/',
|
||||
// false,
|
||||
// false,
|
||||
// false,
|
||||
// '.obsidian',
|
||||
// /* ignorePaths */ [],
|
||||
// /* onlyAllowPaths */ ['xxx/yyy.md']
|
||||
// ).finalIsIgnored;
|
||||
// assert.ok(!isSkip);
|
||||
});
|
||||
|
||||
it("should detect the name by two lists together", async () => {
|
||||
// should skip because we ignore the path
|
||||
let isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ ["xxx"],
|
||||
/* onlyAllowPaths */ ["yyy"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(isSkip);
|
||||
|
||||
// should skip because we disallow the whole folder
|
||||
isSkip = checkIsSkipItemOrNotByName(
|
||||
"xxx/yyy.md",
|
||||
false,
|
||||
false,
|
||||
false,
|
||||
".obsidian",
|
||||
/* ignorePaths */ ["xxx"],
|
||||
/* onlyAllowPaths */ ["xxx/yyy.md"]
|
||||
).finalIsIgnored;
|
||||
assert.ok(isSkip);
|
||||
});
|
||||
});
|
||||
@ -140,6 +140,7 @@ export type CipherMethodType = "rclone-base64" | "openssl-base64" | "unknown";
|
||||
export type QRExportType = "basic_and_advanced" | SUPPORTED_SERVICES_TYPE;
|
||||
|
||||
export interface ProfilerConfig {
|
||||
enable?: boolean;
|
||||
enablePrinting?: boolean;
|
||||
recordSize?: boolean;
|
||||
}
|
||||
@ -173,6 +174,7 @@ export interface RemotelySavePluginSettings {
|
||||
agreeToUseSyncV3?: boolean;
|
||||
skipSizeLargerThan?: number;
|
||||
ignorePaths?: string[];
|
||||
onlyAllowPaths?: string[];
|
||||
enableStatusBarInfo?: boolean;
|
||||
deleteToWhere?: "system" | "obsidian";
|
||||
conflictAction?: ConflictActionType;
|
||||
@ -270,6 +272,8 @@ export interface Entity {
|
||||
keyRaw: string;
|
||||
mtimeCli?: number;
|
||||
mtimeCliFmt?: string;
|
||||
ctimeCli?: number;
|
||||
ctimeCliFmt?: string;
|
||||
mtimeSvr?: number;
|
||||
mtimeSvrFmt?: string;
|
||||
prevSyncTime?: number;
|
||||
|
||||
@ -41,7 +41,7 @@ export async function copyFile(key: string, left: FakeFs, right: FakeFs) {
|
||||
key,
|
||||
content,
|
||||
statsLeft.mtimeCli,
|
||||
statsLeft.mtimeCli /* TODO */
|
||||
statsLeft.ctimeCli ?? statsLeft.mtimeCli
|
||||
),
|
||||
content: content,
|
||||
};
|
||||
|
||||
@ -202,7 +202,7 @@ export class CipherRclone {
|
||||
},
|
||||
[
|
||||
channel.port1,
|
||||
// input // the array buffer might be re-used later, so we CANNOT transform here
|
||||
// input // the array buffer might be re-used later, so we CANNOT transfer here
|
||||
]
|
||||
);
|
||||
});
|
||||
@ -247,8 +247,10 @@ export class CipherRclone {
|
||||
action: "decryptContent",
|
||||
inputContent: input,
|
||||
},
|
||||
// the decrypted result is not used later in worker, so it's save to transfer
|
||||
[channel.port1, input]
|
||||
[
|
||||
channel.port1,
|
||||
input, // not transfer for safety
|
||||
]
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
@ -141,7 +141,7 @@ ctx.addEventListener("message", async (event: any) => {
|
||||
status: "ok",
|
||||
outputContent: outputContent,
|
||||
},
|
||||
[outputContent]
|
||||
[outputContent] // on worker side, we don't reuse anything so it's safe to transfer
|
||||
);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
@ -166,7 +166,7 @@ ctx.addEventListener("message", async (event: any) => {
|
||||
status: "ok",
|
||||
outputContent: outputContent,
|
||||
},
|
||||
[outputContent]
|
||||
[outputContent] // on worker side, we don't reuse anything so it's safe to transfer
|
||||
);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
|
||||
45
src/fsAll.ts
45
src/fsAll.ts
@ -1,3 +1,5 @@
|
||||
import isEqual from "lodash/isEqual";
|
||||
import { nanoid } from "nanoid";
|
||||
import type { Entity } from "./baseTypes";
|
||||
|
||||
export abstract class FakeFs {
|
||||
@ -16,6 +18,49 @@ export abstract class FakeFs {
|
||||
abstract rename(key1: string, key2: string): Promise<void>;
|
||||
abstract rm(key: string): Promise<void>;
|
||||
abstract checkConnect(callbackFunc?: any): Promise<boolean>;
|
||||
async checkConnectCommonOps(callbackFunc?: any) {
|
||||
try {
|
||||
console.info(`check connect: create folder`);
|
||||
const folderName = `rs-test-folder-${nanoid()}/`;
|
||||
await this.mkdir(folderName);
|
||||
// await delay(3000);
|
||||
|
||||
console.info(`check connect: upload file`);
|
||||
const filename = `${folderName}rs-test-file-${nanoid()}`;
|
||||
const ctime = Date.now();
|
||||
const mtime1 = Date.now();
|
||||
const content1 = new ArrayBuffer(100);
|
||||
await this.writeFile(filename, content1, mtime1, ctime);
|
||||
// await delay(3000);
|
||||
|
||||
console.info(`check connect: overwrite file`);
|
||||
const mtime2 = Date.now();
|
||||
const content2 = new ArrayBuffer(200);
|
||||
await this.writeFile(filename, content2, mtime2, ctime);
|
||||
// await delay(3000);
|
||||
|
||||
console.info(`check connect: download file`);
|
||||
const content3 = await this.readFile(filename);
|
||||
if (!isEqual(content2, content3)) {
|
||||
throw Error(`downloaded file is not equal with uploaded file!`);
|
||||
}
|
||||
// await delay(3000);
|
||||
|
||||
console.info(`check connect: delete file`);
|
||||
await this.rm(filename);
|
||||
// await delay(3000);
|
||||
|
||||
console.info(`check connect: delete folder`);
|
||||
await this.rm(folderName);
|
||||
// await delay(3000);
|
||||
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
abstract getUserDisplayName(): Promise<string>;
|
||||
abstract revokeAuth(): Promise<any>;
|
||||
abstract allowEmptyFile(): boolean;
|
||||
|
||||
@ -741,14 +741,15 @@ export class FakeFsDropbox extends FakeFs {
|
||||
await this._init();
|
||||
const results = await this._statFromRoot(`/${this.remoteBaseDir}`);
|
||||
if (results === undefined) {
|
||||
return false;
|
||||
throw Error(`cannot check root vault folder!`);
|
||||
}
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName() {
|
||||
|
||||
@ -133,8 +133,10 @@ export class FakeFsLocal extends FakeFs {
|
||||
return {
|
||||
key: isFolder ? `${key}/` : key, // local always unencrypted
|
||||
keyRaw: isFolder ? `${key}/` : key,
|
||||
ctimeCli: statRes.ctime,
|
||||
mtimeCli: statRes.mtime,
|
||||
mtimeSvr: statRes.mtime,
|
||||
ctimeCliFmt: unixTimeToStr(statRes.ctime),
|
||||
mtimeCliFmt: unixTimeToStr(statRes.mtime),
|
||||
mtimeSvrFmt: unixTimeToStr(statRes.mtime),
|
||||
size: statRes.size, // local always unencrypted
|
||||
|
||||
@ -47,7 +47,7 @@ export class FakeFsMock extends FakeFs {
|
||||
}
|
||||
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
return true;
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -252,6 +252,10 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
// why?? /drive/root:/Apps/Graph
|
||||
const FIFTH_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/Graph\//g;
|
||||
|
||||
// why again?? /drive/root:/Apps/Graph 1
|
||||
const SIXTH_COMMON_PREFIX_REGEX = /^\/drive\/root:\/[^\/]+\/Graph 1\//g;
|
||||
const SIXTH_COMMON_PREFIX_REGEX_V2 = /^\/drive\/root:\/[^\/]+\/Graph%201\//g;
|
||||
|
||||
// or the root is absolute path /Livefolders,
|
||||
// e.g.: /Livefolders/应用/remotely-save/${remoteBaseDir}
|
||||
const SECOND_COMMON_PREFIX_REGEX = /^\/Livefolders\/[^\/]+\/remotely-save\//g;
|
||||
@ -278,6 +282,11 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
const fullPathOriginal = `${x.parentReference.path}/${x.name}`;
|
||||
const matchFirstPrefixRes = fullPathOriginal.match(FIRST_COMMON_PREFIX_REGEX);
|
||||
const matchFifthPrefixRes = fullPathOriginal.match(FIFTH_COMMON_PREFIX_REGEX);
|
||||
const matchSixthPrefixRes = fullPathOriginal.match(SIXTH_COMMON_PREFIX_REGEX);
|
||||
const matchSixthV2PrefixRes = fullPathOriginal.match(
|
||||
SIXTH_COMMON_PREFIX_REGEX_V2
|
||||
);
|
||||
|
||||
const matchSecondPrefixRes = fullPathOriginal.match(
|
||||
SECOND_COMMON_PREFIX_REGEX
|
||||
);
|
||||
@ -317,6 +326,40 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// sixth
|
||||
else if (
|
||||
matchSixthPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchSixthPrefixRes[0]}${remoteBaseDir}`)
|
||||
) {
|
||||
const foundPrefix = `${matchSixthPrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (
|
||||
matchSixthPrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchSixthPrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchSixthPrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// sixth v2
|
||||
else if (
|
||||
matchSixthV2PrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(`${matchSixthV2PrefixRes[0]}${remoteBaseDir}`)
|
||||
) {
|
||||
const foundPrefix = `${matchSixthV2PrefixRes[0]}${remoteBaseDir}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
} else if (
|
||||
matchSixthV2PrefixRes !== null &&
|
||||
fullPathOriginal.startsWith(
|
||||
`${matchSixthV2PrefixRes[0]}${remoteBaseDirEncoded}`
|
||||
)
|
||||
) {
|
||||
const foundPrefix = `${matchSixthV2PrefixRes[0]}${remoteBaseDirEncoded}`;
|
||||
key = fullPathOriginal.substring(foundPrefix.length + 1);
|
||||
}
|
||||
|
||||
// second
|
||||
else if (
|
||||
matchSecondPrefixRes !== null &&
|
||||
@ -374,6 +417,8 @@ const fromDriveItemToEntity = (x: DriveItem, remoteBaseDir: string): Entity => {
|
||||
fullPathOriginal=${fullPathOriginal}
|
||||
matchFirstPrefixRes=${matchFirstPrefixRes}
|
||||
matchFifthPrefixRes=${matchFifthPrefixRes}
|
||||
matchSixthPrefixRes=${matchSixthPrefixRes}
|
||||
matchSixthV2PrefixRes=${matchSixthV2PrefixRes}
|
||||
matchSecondPrefixRes=${matchSecondPrefixRes}
|
||||
matchThirdPrefixRes=${matchThirdPrefixRes}
|
||||
${constructFromDriveItemToEntityError(x)}`
|
||||
@ -388,6 +433,8 @@ ${constructFromDriveItemToEntityError(x)}`
|
||||
fullPathOriginal=${fullPathOriginal}
|
||||
matchFirstPrefixRes=${matchFirstPrefixRes}
|
||||
matchFifthPrefixRes=${matchFifthPrefixRes}
|
||||
matchSixthPrefixRes=${matchSixthPrefixRes}
|
||||
matchSixthV2PrefixRes=${matchSixthV2PrefixRes}
|
||||
matchSecondPrefixRes=${matchSecondPrefixRes}
|
||||
matchThirdPrefixRes=${matchThirdPrefixRes}
|
||||
${constructFromDriveItemToEntityError(x)}`
|
||||
@ -399,13 +446,27 @@ ${constructFromDriveItemToEntityError(x)}`
|
||||
key = `${key}/`;
|
||||
}
|
||||
|
||||
const mtimeSvr = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
const mtimeCli = Date.parse(x?.fileSystemInfo!.lastModifiedDateTime!);
|
||||
const mtimeTry = x?.fileSystemInfo?.lastModifiedDateTime;
|
||||
if (mtimeTry === undefined || mtimeTry === null) {
|
||||
throw Error(`onedrive cannot parse mtime: ${JSON.stringify(x, null, 2)}`);
|
||||
}
|
||||
|
||||
let ctimeTry = x?.fileSystemInfo?.createdDateTime;
|
||||
if (ctimeTry === undefined || ctimeTry === null) {
|
||||
// throw Error(`onedrive cannot parse ctime: ${JSON.stringify(x, null, 2)}`);
|
||||
// it doesn't hurt, we just use mtimeTry to fullfill
|
||||
ctimeTry = mtimeTry;
|
||||
}
|
||||
|
||||
const mtimeSvr = Date.parse(mtimeTry);
|
||||
const mtimeCli = Date.parse(mtimeTry);
|
||||
const ctimeCli = Date.parse(ctimeTry);
|
||||
return {
|
||||
key: key,
|
||||
keyRaw: key,
|
||||
mtimeSvr: mtimeSvr,
|
||||
mtimeCli: mtimeCli,
|
||||
ctimeCli: ctimeCli,
|
||||
size: isFolder ? 0 : x.size!,
|
||||
sizeRaw: isFolder ? 0 : x.size!,
|
||||
synthesizedFile: false,
|
||||
@ -874,6 +935,7 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
keyRaw: origKey,
|
||||
mtimeSvr: mtime,
|
||||
mtimeCli: mtime,
|
||||
ctimeCli: ctime,
|
||||
size: 0,
|
||||
sizeRaw: 0,
|
||||
synthesizedFile: true,
|
||||
@ -1032,12 +1094,16 @@ export class FakeFsOnedrive extends FakeFs {
|
||||
async checkConnect(callbackFunc?: any): Promise<boolean> {
|
||||
try {
|
||||
const k = await this.getUserDisplayName();
|
||||
return k !== "<unknown display name>";
|
||||
if (k === "<unknown display name>") {
|
||||
throw Error(`unknown display name!`);
|
||||
}
|
||||
} catch (err) {
|
||||
console.debug(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName() {
|
||||
|
||||
14
src/fsS3.ts
14
src/fsS3.ts
@ -831,14 +831,11 @@ export class FakeFsS3 extends FakeFs {
|
||||
results.$metadata === undefined ||
|
||||
results.$metadata.httpStatusCode === undefined
|
||||
) {
|
||||
const err = "results or $metadata or httStatusCode is undefined";
|
||||
console.debug(err);
|
||||
if (callbackFunc !== undefined) {
|
||||
callbackFunc(err);
|
||||
}
|
||||
return false;
|
||||
throw Error("results or $metadata or httStatusCode is undefined");
|
||||
}
|
||||
if (results.$metadata.httpStatusCode !== 200) {
|
||||
throw Error(`not 200 httpStatusCode`);
|
||||
}
|
||||
return results.$metadata.httpStatusCode === 200;
|
||||
} catch (err: any) {
|
||||
console.debug(err);
|
||||
if (callbackFunc !== undefined) {
|
||||
@ -854,9 +851,10 @@ export class FakeFsS3 extends FakeFs {
|
||||
callbackFunc(err);
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
163
src/fsWebdav.ts
163
src/fsWebdav.ts
@ -4,8 +4,6 @@ import { getReasonPhrase } from "http-status-codes/build/cjs/utils-functions";
|
||||
import chunk from "lodash/chunk";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import flatten from "lodash/flatten";
|
||||
import isString from "lodash/isString";
|
||||
import { nanoid } from "nanoid";
|
||||
import { Platform, type RequestUrlParam, requestUrl } from "obsidian";
|
||||
import type {
|
||||
FileStat,
|
||||
@ -170,23 +168,37 @@ const getWebdavPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
return key;
|
||||
};
|
||||
|
||||
/**
|
||||
* sometimes the path startswith /../../......
|
||||
* we want to make sure the path is compatible
|
||||
*/
|
||||
const stripLeadingPath = (x: string) => {
|
||||
let y = x;
|
||||
while (y.startsWith("/..")) {
|
||||
y = y.slice("/..".length);
|
||||
}
|
||||
return y;
|
||||
};
|
||||
|
||||
const getNormPath = (fileOrFolderPath: string, remoteBaseDir: string) => {
|
||||
const strippedFileOrFolderPath = stripLeadingPath(fileOrFolderPath);
|
||||
if (
|
||||
!(
|
||||
fileOrFolderPath === `/${remoteBaseDir}` ||
|
||||
fileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
|
||||
strippedFileOrFolderPath === `/${remoteBaseDir}` ||
|
||||
strippedFileOrFolderPath.startsWith(`/${remoteBaseDir}/`)
|
||||
)
|
||||
) {
|
||||
throw Error(
|
||||
`"${fileOrFolderPath}" doesn't starts with "/${remoteBaseDir}/"`
|
||||
`"${fileOrFolderPath}" after stripping doesn't starts with "/${remoteBaseDir}/"`
|
||||
);
|
||||
}
|
||||
|
||||
return fileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
|
||||
const result = strippedFileOrFolderPath.slice(`/${remoteBaseDir}/`.length);
|
||||
return result;
|
||||
};
|
||||
|
||||
const fromWebdavItemToEntity = (x: FileStat, remoteBaseDir: string): Entity => {
|
||||
let key = getNormPath(x.filename, remoteBaseDir);
|
||||
|
||||
if (x.type === "directory" && !key.endsWith("/")) {
|
||||
key = `${key}/`;
|
||||
}
|
||||
@ -209,6 +221,13 @@ const tryEncodeURI = (x: string) => {
|
||||
return encodeURI(x);
|
||||
};
|
||||
|
||||
const tryEncodeUsernamePassword = (x: string) => {
|
||||
if (onlyAscii(x)) {
|
||||
return x;
|
||||
}
|
||||
return unescape(encodeURIComponent(x));
|
||||
};
|
||||
|
||||
const parseCustomHeaders = (x: string): Record<string, string> => {
|
||||
const y = x.trim();
|
||||
if (y === "") {
|
||||
@ -241,7 +260,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
vaultFolderExists: boolean;
|
||||
saveUpdatedConfigFunc: () => Promise<any>;
|
||||
|
||||
supportNativePartial: boolean;
|
||||
supportApachePartial: boolean;
|
||||
supportSabrePartial: boolean;
|
||||
isNextcloud: boolean;
|
||||
nextcloudUploadServerAddress: string;
|
||||
|
||||
@ -258,7 +278,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
this.vaultFolderExists = false;
|
||||
this.saveUpdatedConfigFunc = saveUpdatedConfigFunc;
|
||||
|
||||
this.supportNativePartial = false;
|
||||
this.supportApachePartial = false;
|
||||
this.supportSabrePartial = false;
|
||||
this.isNextcloud = false;
|
||||
this.nextcloudUploadServerAddress = "";
|
||||
}
|
||||
@ -282,8 +303,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
this.webdavConfig.password !== ""
|
||||
) {
|
||||
this.client = createClient(this.webdavConfig.address, {
|
||||
username: this.webdavConfig.username,
|
||||
password: this.webdavConfig.password,
|
||||
username: tryEncodeUsernamePassword(this.webdavConfig.username),
|
||||
password: tryEncodeUsernamePassword(this.webdavConfig.password),
|
||||
headers: headers,
|
||||
authType:
|
||||
this.webdavConfig.authType === "digest"
|
||||
@ -392,15 +413,20 @@ export class FakeFsWebdav extends FakeFs {
|
||||
// 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")
|
||||
compliance.server.includes("Apache") &&
|
||||
compliance.compliance.includes("<http://apache.org/dav/propset/fs/1>")
|
||||
) {
|
||||
this.supportNativePartial = true;
|
||||
this.supportApachePartial = true;
|
||||
console.debug(
|
||||
`supportNativePartial=true, compliance=${JSON.stringify(compliance)}`
|
||||
`supportApachePartial=true, compliance=${JSON.stringify(compliance)}`
|
||||
);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (compliance.compliance.includes("sabredav-partialupdate")) {
|
||||
this.supportSabrePartial = true;
|
||||
console.debug(
|
||||
`supportSabrePartial=true, compliance=${JSON.stringify(compliance)}`
|
||||
);
|
||||
return true;
|
||||
}
|
||||
@ -417,7 +443,9 @@ export class FakeFsWebdav extends FakeFs {
|
||||
this.webdavConfig.depth === "auto_unknown" ||
|
||||
this.webdavConfig.depth === "auto_1" ||
|
||||
this.webdavConfig.depth === "auto_infinity" /* don't trust auto now */ ||
|
||||
this.webdavConfig.depth === "manual_1"
|
||||
this.webdavConfig.depth === "manual_1" ||
|
||||
this.webdavConfig.address.includes("jianguoyun.com") ||
|
||||
this.webdavConfig.address.includes("teracloud.jp")
|
||||
) {
|
||||
// the remote doesn't support infinity propfind,
|
||||
// we need to do a bfs here
|
||||
@ -432,15 +460,17 @@ export class FakeFsWebdav extends FakeFs {
|
||||
// console.debug(itemsToFetchChunks);
|
||||
const subContents = [] as FileStat[];
|
||||
for (const singleChunk of itemsToFetchChunks) {
|
||||
const r = singleChunk.map((x) => {
|
||||
return this.client.getDirectoryContents(x, {
|
||||
const r = singleChunk.map(async (x) => {
|
||||
let k = (await this.client.getDirectoryContents(x, {
|
||||
deep: false,
|
||||
details: false /* no need for verbose details here */,
|
||||
// TODO: to support .obsidian,
|
||||
// we need to load all files including dot,
|
||||
// anyway to reduce the resources?
|
||||
// glob: "/**" /* avoid dot files by using glob */,
|
||||
}) as Promise<FileStat[]>;
|
||||
})) as FileStat[];
|
||||
k = k.filter((sub) => stripLeadingPath(sub.filename) !== x);
|
||||
return k;
|
||||
});
|
||||
const r3 = await Promise.all(r);
|
||||
for (const r4 of r3) {
|
||||
@ -462,7 +492,7 @@ export class FakeFsWebdav extends FakeFs {
|
||||
const f = subContents[i];
|
||||
contents.push(f);
|
||||
if (f.type === "directory") {
|
||||
q.push(f.filename);
|
||||
q.push(stripLeadingPath(f.filename));
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -480,7 +510,11 @@ export class FakeFsWebdav extends FakeFs {
|
||||
}
|
||||
)) as FileStat[];
|
||||
}
|
||||
return contents.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir));
|
||||
|
||||
const result = contents
|
||||
.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir))
|
||||
.filter((x) => x.keyRaw !== "/");
|
||||
return result;
|
||||
}
|
||||
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
@ -493,7 +527,9 @@ export class FakeFsWebdav extends FakeFs {
|
||||
details: false /* no need for verbose details here */,
|
||||
}
|
||||
)) as FileStat[];
|
||||
return contents.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir));
|
||||
return contents
|
||||
.map((x) => fromWebdavItemToEntity(x, this.remoteBaseDir))
|
||||
.filter((x) => x.keyRaw !== "/");
|
||||
}
|
||||
|
||||
async stat(key: string): Promise<Entity> {
|
||||
@ -570,7 +606,11 @@ export class FakeFsWebdav extends FakeFs {
|
||||
}
|
||||
|
||||
// larger than 10 MB
|
||||
if (!this.isNextcloud && !this.supportNativePartial) {
|
||||
if (
|
||||
!this.isNextcloud &&
|
||||
!this.supportApachePartial &&
|
||||
!this.supportSabrePartial
|
||||
) {
|
||||
// give up and upload by whole, and directly return
|
||||
return await this._writeFileFromRootFull(
|
||||
key,
|
||||
@ -591,8 +631,16 @@ export class FakeFsWebdav extends FakeFs {
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
} else if (this.supportNativePartial) {
|
||||
return await this._writeFileFromRootNativePartial(
|
||||
} else if (this.supportApachePartial) {
|
||||
return await this._writeFileFromRootApachePartial(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
ctime,
|
||||
origKey
|
||||
);
|
||||
} else if (this.supportSabrePartial) {
|
||||
return await this._writeFileFromRootSabrePartial(
|
||||
key,
|
||||
content,
|
||||
mtime,
|
||||
@ -608,7 +656,7 @@ export class FakeFsWebdav extends FakeFs {
|
||||
console.error(e);
|
||||
throw e;
|
||||
// this.isNextcloud = false;
|
||||
// this.supportNativePartial = false;
|
||||
// this.supportApachePartial = false;
|
||||
// return await this._writeFileFromRootFull(
|
||||
// key,
|
||||
// content,
|
||||
@ -676,8 +724,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
console.debug(`tmpFolderName=${tmpFolderName}`);
|
||||
|
||||
const clientForUpload = createClient(uploadServerAddress, {
|
||||
username: this.webdavConfig.username,
|
||||
password: this.webdavConfig.password,
|
||||
username: tryEncodeUsernamePassword(this.webdavConfig.username),
|
||||
password: tryEncodeUsernamePassword(this.webdavConfig.password),
|
||||
headers: {
|
||||
"Cache-Control": "no-cache",
|
||||
},
|
||||
@ -753,7 +801,7 @@ export class FakeFsWebdav extends FakeFs {
|
||||
return k;
|
||||
}
|
||||
|
||||
async _writeFileFromRootNativePartial(
|
||||
async _writeFileFromRootApachePartial(
|
||||
key: string,
|
||||
content: ArrayBuffer,
|
||||
mtime: number,
|
||||
@ -775,6 +823,8 @@ export class FakeFsWebdav extends FakeFs {
|
||||
content.byteLength,
|
||||
sizePerChunk
|
||||
);
|
||||
|
||||
// TODO: parallel
|
||||
for (let i = 0; i < chunkRanges.length; ++i) {
|
||||
const { start, end } = chunkRanges[i];
|
||||
await this.client.partialUpdateFileContents(
|
||||
@ -789,6 +839,47 @@ export class FakeFsWebdav extends FakeFs {
|
||||
return await this.stat(origKey);
|
||||
}
|
||||
|
||||
async _writeFileFromRootSabrePartial(
|
||||
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
|
||||
);
|
||||
|
||||
// diff from apachePartial: we use "append" header here for dufs...
|
||||
// we cannot parallel here
|
||||
for (let i = 0; i < chunkRanges.length; ++i) {
|
||||
const { start, end } = chunkRanges[i];
|
||||
await this.client.customRequest(key, {
|
||||
method: "PATCH",
|
||||
headers: {
|
||||
"X-Update-Range": "append",
|
||||
"Content-Type": "application/x-sabredav-partialupdate",
|
||||
},
|
||||
data: content.slice(start, end + 1),
|
||||
});
|
||||
}
|
||||
|
||||
// lastly return
|
||||
return await this.stat(origKey);
|
||||
}
|
||||
|
||||
async readFile(key: string): Promise<ArrayBuffer> {
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`you should not call readFile on ${key}`);
|
||||
@ -853,17 +944,15 @@ export class FakeFsWebdav extends FakeFs {
|
||||
await this._init();
|
||||
const results = await this._statFromRoot(`/${this.remoteBaseDir}/`);
|
||||
if (results === undefined) {
|
||||
const err = "results is undefined";
|
||||
console.error(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
throw Error("cannot stat root vault folder!");
|
||||
}
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -117,7 +117,7 @@ export class FakeFsWebdis extends FakeFs {
|
||||
let cursor = "0";
|
||||
const res: Entity[] = [];
|
||||
do {
|
||||
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:*:meta/COUNT/1000`;
|
||||
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:${encodeURIComponent(this.remoteBaseDir + "/")}*:meta/COUNT/1000`;
|
||||
const rsp = (await (await this._fetchCommand("GET", command)).json())[
|
||||
"SCAN"
|
||||
];
|
||||
@ -136,7 +136,7 @@ export class FakeFsWebdis extends FakeFs {
|
||||
async walkPartial(): Promise<Entity[]> {
|
||||
let cursor = "0";
|
||||
const res: Entity[] = [];
|
||||
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:*:meta/COUNT/10`; // fewer keys
|
||||
const command = `SCAN/${cursor}/MATCH/rs:fs:v1:${encodeURIComponent(this.remoteBaseDir + "/")}*:meta/COUNT/10`; // fewer keys
|
||||
const rsp = (await (await this._fetchCommand("GET", command)).json())[
|
||||
"SCAN"
|
||||
];
|
||||
@ -252,12 +252,16 @@ export class FakeFsWebdis extends FakeFs {
|
||||
const k = await (
|
||||
await this._fetchCommand("GET", "PING/helloworld")
|
||||
).json();
|
||||
return isEqual(k, { PING: "helloworld" });
|
||||
if (!isEqual(k, { PING: "helloworld" })) {
|
||||
throw Error(`no correct ping response`);
|
||||
}
|
||||
} catch (err: any) {
|
||||
console.error(err);
|
||||
callbackFunc?.(err);
|
||||
return false;
|
||||
}
|
||||
return await this.checkConnectCommonOps(callbackFunc);
|
||||
// return true;
|
||||
}
|
||||
|
||||
async getUserDisplayName(): Promise<string> {
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
"protocol_dropbox_connect_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
|
||||
"protocol_dropbox_connect_fail": "Something went wrong from response from Dropbox. Maybe the network connection is not good. Maybe you rejected the auth?",
|
||||
"protocol_dropbox_connect_unknown": "Do not know how to deal with the callback: {{params}}",
|
||||
"protocol_dropbox_no_modal": "You are not startting Dropbox connection from the settings page. Abort.",
|
||||
"protocol_dropbox_no_modal": "You are not starting Dropbox connection from the settings page. Abort.",
|
||||
"protocol_onedrive_connecting": "Connecting to OneDrive...\nPlease DO NOT close this modal.",
|
||||
"protocol_onedrive_connect_succ_revoke": "You've connected as user {{username}}. If you want to disconnect, click this button.",
|
||||
"protocol_onedrive_connect_fail": "Something went wrong from response from OneDrive. Maybe you rejected the auth?",
|
||||
@ -110,7 +110,7 @@
|
||||
"modal_onedriverevokeauth_clean_button": "Clean",
|
||||
"modal_onedriverevokeauth_clean_notice": "Cleaned!",
|
||||
"modal_onedriverevokeauth_clean_fail": "Something goes wrong while revoking.",
|
||||
"modal_syncconfig_attn": "Attention 1/2: This only syncs (copies) the whole Obsidian config dir, not other startting-with-dot folders or files. Except for ignoring folders .git and node_modules, it also doesn't understand the meaning of sub-files and sub-folders inside the config dir.\nAttention 2/2: After the config dir is synced, plugins settings might be corrupted, and Obsidian might need to be restarted to load the new settings.\nIf you are agreed to take your own risk, please click the following second confirm button.",
|
||||
"modal_syncconfig_attn": "Attention 1/2: This only syncs (copies) the whole Obsidian config dir, not other starting-with-dot folders or files. Except for ignoring folders .git and node_modules, it also doesn't understand the meaning of sub-files and sub-folders inside the config dir.\nAttention 2/2: After the config dir is synced, plugins settings might be corrupted, and Obsidian might need to be restarted to load the new settings.\nIf you are agreed to take your own risk, please click the following second confirm button.",
|
||||
"modal_syncconfig_secondconfirm": "The Second Confirm To Enable.",
|
||||
"modal_syncconfig_notice": "You've enabled syncing config folder!",
|
||||
"modal_qr_shortdesc": "This exports (partial) settings.\nYou can use another device to scan this qrcode.\nOr, you can click the button to copy the special uri and paste it into another device's web browser or Remotely Save Import Setting.",
|
||||
@ -149,7 +149,9 @@
|
||||
"settings_skiplargefiles_desc": "Skip files with sizes larger than the threshold. Here 1 MB = 10^6 bytes.",
|
||||
"settings_skiplargefiles_notset": "(not set)",
|
||||
"settings_ignorepaths": "Regex Of Paths To Ignore",
|
||||
"settings_ignorepaths_desc": "Regex of paths of folders or files to ignore. One regex per line. The path is relative to the vault root without leading slash.",
|
||||
"settings_ignorepaths_desc": "Regex of paths of folders or files to ignore. One regex per line. The path is relative to the vault root without leading slash. Non-empty allow paths and non-empty ignore paths are effective together.",
|
||||
"settings_onlyallowpaths": "Regex Of Paths To Allow",
|
||||
"settings_onlyallowpaths_desc": "Regex of paths of folders or files to allow to sync. One regex per line. The path is relative to the vault root without leading slash. If this setting is not empty, all paths you want to sync including config dirs must be explicitly set here. Non-empty allow paths and non-empty ignore paths are effective together.",
|
||||
"settings_enablestatusbar_info": "Show Last Successful Sync In Status Bar",
|
||||
"settings_enablestatusbar_info_desc": "Show the time of the last successful sync in the status bar.",
|
||||
"settings_enablestatusbar_reloadrequired_notice": "Reload the plugin for the changes to take effect.",
|
||||
@ -192,7 +194,7 @@
|
||||
"settings_s3_reverse_proxy_no_sign_url": "S3 Reverse Proxy (No Sign) Url (experimental)",
|
||||
"settings_s3_reverse_proxy_no_sign_url_desc": "S3 reverse proxy url without signature. This is useful if you use a revers proxy but do not change the original credential signature. No http(s):// prefix. Leave it blank if you don't know what it is.",
|
||||
"settings_s3_generatefolderobject": "Generate Folder Object Or Not",
|
||||
"settings_s3_generatefolderobject_desc": "S3 doesn't have \"real\" folder. If you set \"Generate\" here (or use old version), the plugin will upload a zero-byte object endding with \"/\" to represent the folder. In the new version, the plugin skips generating folder object by default.",
|
||||
"settings_s3_generatefolderobject_desc": "S3 doesn't have \"real\" folder. If you set \"Generate\" here (or use old version), the plugin will upload a zero-byte object ending with \"/\" to represent the folder. In the new version, the plugin skips generating folder object by default.",
|
||||
"settings_s3_generatefolderobject_notgenerate": "Not generate (default)",
|
||||
"settings_s3_generatefolderobject_generate": "Generate",
|
||||
"settings_s3_connect_succ": "Great! The bucket can be accessed.",
|
||||
@ -338,7 +340,7 @@
|
||||
"settings_obfuscatesettingfile": "Obfuscate The Setting File Or Not",
|
||||
"settings_obfuscatesettingfile_desc": "The setting file (data.json) has some sensitive information. It's strongly recommended to obfuscate it to avoid unexpected read and modification. If you are sure to view and edit it manually, you can disable the obfuscation.",
|
||||
"settings_viewconsolelog": "View Console Log",
|
||||
"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+option+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_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)",
|
||||
@ -359,6 +361,8 @@
|
||||
"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_button_all": "Export All",
|
||||
"settings_profiler_enableprofiler": "Enable Profiler",
|
||||
"settings_profiler_enableprofiler_desc": "Collect performance data or not?",
|
||||
"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",
|
||||
|
||||
@ -148,7 +148,9 @@
|
||||
"settings_skiplargefiles_desc": "跳过大于某一个阈值的文件。这里 1 MB = 10^6 bytes。",
|
||||
"settings_skiplargefiles_notset": "（不设置）",
|
||||
"settings_ignorepaths": "忽略的文件或文件夹的正则表达式",
|
||||
"settings_ignorepaths_desc": "忽略的文件或文件夹的正则表达式。每行一条。路径是相对于库（Vault）根目录的，没有前置 / 符号。",
|
||||
"settings_ignorepaths_desc": "忽略的文件或文件夹的正则表达式。每行一条。路径是相对于库（Vault）根目录的，没有前置 / 符号。非空的忽略列表和非空的允许列表会一起生效。",
|
||||
"settings_onlyallowpaths": "允许同步的文件或文件夹的正则表达式",
|
||||
"settings_onlyallowpaths_desc": "允许同步的文件或文件夹的正则表达式。每行一条。路径是相对于库（Vault）根目录的，没有前置 / 符号。如果这个设置非空，那么所有您想同步的路径（包括隐藏的设置文件夹）都要明确地列出到这里。非空的忽略列表和非空的允许列表会一起生效。",
|
||||
"settings_enablestatusbar_info": "在状态栏显示上一次成功的同步",
|
||||
"settings_enablestatusbar_info_desc": "在状态栏显示上一次成功的同步的时间。",
|
||||
"settings_enablestatusbar_reloadrequired_notice": "需要重新载入此插件才生效。",
|
||||
@ -358,6 +360,12 @@
|
||||
"settings_profiler_results_desc": "插件记录了每次同步每一步的耗时。这里可以导出记录得知哪一步最慢。",
|
||||
"settings_profiler_results_notice": "性能数据已导出",
|
||||
"settings_profiler_results_button_all": "导出所有",
|
||||
"settings_profiler_enableprofiler": "性能收集",
|
||||
"settings_profiler_enableprofiler_desc": "是否开启性能收集功能？",
|
||||
"settings_profiler_enabledebugprint": "性能收集输出",
|
||||
"settings_profiler_enabledebugprint_desc": "是否直接输出性能收集结果到终端里？",
|
||||
"settings_profiler_recordsize": "性能收集统计对象大小",
|
||||
"settings_profiler_recordsize_desc": "是否收集对象的大小？",
|
||||
"settings_outputbasepathvaultid": "输出资料库对应的位置和随机分配的 ID",
|
||||
"settings_outputbasepathvaultid_desc": "用于调试。",
|
||||
"settings_outputbasepathvaultid_button": "输出",
|
||||
|
||||
@ -147,7 +147,9 @@
|
||||
"settings_skiplargefiles_desc": "跳過大於某一個閾值的檔案。這裡 1 MB = 10^6 bytes。",
|
||||
"settings_skiplargefiles_notset": "（不設定）",
|
||||
"settings_ignorepaths": "忽略的檔案或資料夾的正則表示式",
|
||||
"settings_ignorepaths_desc": "忽略的檔案或資料夾的正則表示式。每行一條。路徑是相對於庫（Vault）根目錄的，沒有前置 / 符號。",
|
||||
"settings_ignorepaths_desc": "忽略的檔案或資料夾的正則表示式。每行一條。路徑是相對於庫（Vault）根目錄的，沒有前置 / 符號。非空的忽略列表和非空的允許列表會一起生效。",
|
||||
"settings_onlyallowpaths": "允許同步的檔案或資料夾的正則表示式",
|
||||
"settings_onlyallowpaths_desc": "允許同步的檔案或資料夾的正則表示式。每行一條。路徑是相對於庫（Vault）根目錄的，沒有前置 / 符號。如果這個設定非空，那麼所有您想同步的路徑（包括隱藏的設定資料夾）都要明確地列出到這裡。非空的忽略列表和非空的允許列表會一起生效。",
|
||||
"settings_enablestatusbar_info": "在狀態列顯示上一次成功的同步",
|
||||
"settings_enablestatusbar_info_desc": "在狀態列顯示上一次成功的同步的時間。",
|
||||
"settings_enablestatusbar_reloadrequired_notice": "需要重新載入此外掛才生效。",
|
||||
@ -357,6 +359,12 @@
|
||||
"settings_profiler_results_desc": "外掛記錄了每次同步每一步的耗時。這裡可以匯出記錄得知哪一步最慢。",
|
||||
"settings_profiler_results_notice": "效能資料已匯出",
|
||||
"settings_profiler_results_button_all": "匯出所有",
|
||||
"settings_profiler_enableprofiler": "效能收集",
|
||||
"settings_profiler_enableprofiler_desc": "是否開啟效能收集功能？",
|
||||
"settings_profiler_enabledebugprint": "效能收集輸出",
|
||||
"settings_profiler_enabledebugprint_desc": "是否直接輸出效能收集結果到終端裡？",
|
||||
"settings_profiler_recordsize": "效能收集統計物件大小",
|
||||
"settings_profiler_recordsize_desc": "是否收集物件的大小？",
|
||||
"settings_outputbasepathvaultid": "輸出資料庫對應的位置和隨機分配的 ID",
|
||||
"settings_outputbasepathvaultid_desc": "用於除錯。",
|
||||
"settings_outputbasepathvaultid_button": "輸出",
|
||||
|
||||
31
src/main.ts
31
src/main.ts
@ -108,7 +108,7 @@ import {
|
||||
upsertPluginVersionByVault,
|
||||
} from "./localdb";
|
||||
import { changeMobileStatusBar } from "./misc";
|
||||
import { DEFAULT_PROFILER_CONFIG, type Profiler } from "./profiler";
|
||||
import { DEFAULT_PROFILER_CONFIG, Profiler } from "./profiler";
|
||||
import { RemotelySaveSettingTab } from "./settings";
|
||||
import { SyncAlgoV3Modal } from "./syncAlgoV3Notice";
|
||||
|
||||
@ -141,6 +141,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
|
||||
logToDB: false,
|
||||
skipSizeLargerThan: -1,
|
||||
ignorePaths: [],
|
||||
onlyAllowPaths: [],
|
||||
enableStatusBarInfo: true,
|
||||
deleteToWhere: "system",
|
||||
agreeToUseSyncV3: false,
|
||||
@ -231,12 +232,14 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
appContainerObserver?: MutationObserver;
|
||||
|
||||
async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
|
||||
// const profiler = new Profiler(
|
||||
// undefined,
|
||||
// this.settings.profiler?.enablePrinting ?? false,
|
||||
// this.settings.profiler?.recordSize ?? false
|
||||
// );
|
||||
const profiler: Profiler | undefined = undefined;
|
||||
let profiler: Profiler | undefined = undefined;
|
||||
if (this.settings.profiler?.enable ?? false) {
|
||||
profiler = new Profiler(
|
||||
undefined,
|
||||
this.settings.profiler?.enablePrinting ?? false,
|
||||
this.settings.profiler?.recordSize ?? false
|
||||
);
|
||||
}
|
||||
const fsLocal = new FakeFsLocal(
|
||||
this.app.vault,
|
||||
this.settings.syncConfigDir ?? false,
|
||||
@ -1409,6 +1412,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
if (this.settings.ignorePaths === undefined) {
|
||||
this.settings.ignorePaths = [];
|
||||
}
|
||||
if (this.settings.onlyAllowPaths === undefined) {
|
||||
this.settings.onlyAllowPaths = [];
|
||||
}
|
||||
if (this.settings.enableStatusBarInfo === undefined) {
|
||||
this.settings.enableStatusBarInfo = true;
|
||||
}
|
||||
@ -1467,6 +1473,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
if (this.settings.profiler === undefined) {
|
||||
this.settings.profiler = DEFAULT_PROFILER_CONFIG;
|
||||
}
|
||||
if (this.settings.profiler.enable === undefined) {
|
||||
this.settings.profiler.enable = false;
|
||||
}
|
||||
if (this.settings.profiler.enablePrinting === undefined) {
|
||||
this.settings.profiler.enablePrinting = false;
|
||||
}
|
||||
@ -1551,6 +1560,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.dropbox.refreshToken !== "" &&
|
||||
current >= this.settings!.dropbox!.credentialsShouldBeDeletedAtTime!
|
||||
) {
|
||||
console.warn(`dropbox expired`);
|
||||
dropboxExpired = true;
|
||||
this.settings.dropbox = cloneDeep(DEFAULT_DROPBOX_CONFIG);
|
||||
needSave = true;
|
||||
@ -1561,6 +1571,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.onedrive.refreshToken !== "" &&
|
||||
current >= this.settings!.onedrive!.credentialsShouldBeDeletedAtTime!
|
||||
) {
|
||||
console.warn(`onedrive expired`);
|
||||
onedriveExpired = true;
|
||||
this.settings.onedrive = cloneDeep(DEFAULT_ONEDRIVE_CONFIG);
|
||||
needSave = true;
|
||||
@ -1571,6 +1582,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.onedrivefull.refreshToken !== "" &&
|
||||
current >= this.settings!.onedrivefull!.credentialsShouldBeDeletedAtTime!
|
||||
) {
|
||||
console.warn(`onedrive full expired`);
|
||||
onedriveFullExpired = true;
|
||||
this.settings.onedrivefull = cloneDeep(DEFAULT_ONEDRIVEFULL_CONFIG);
|
||||
needSave = true;
|
||||
@ -1581,6 +1593,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.googledrive.refreshToken !== "" &&
|
||||
current >= this.settings!.googledrive!.credentialsShouldBeDeletedAtTimeMs!
|
||||
) {
|
||||
console.warn(`google drive expired`);
|
||||
googleDriveExpired = true;
|
||||
this.settings.googledrive = cloneDeep(DEFAULT_GOOGLEDRIVE_CONFIG);
|
||||
needSave = true;
|
||||
@ -1591,6 +1604,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.box.refreshToken !== "" &&
|
||||
current >= this.settings!.box!.credentialsShouldBeDeletedAtTimeMs!
|
||||
) {
|
||||
console.warn(`box expired`);
|
||||
boxExpired = true;
|
||||
this.settings.box = cloneDeep(DEFAULT_BOX_CONFIG);
|
||||
needSave = true;
|
||||
@ -1601,6 +1615,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.pcloud.accessToken !== "" &&
|
||||
current >= this.settings!.pcloud!.credentialsShouldBeDeletedAtTimeMs!
|
||||
) {
|
||||
console.warn(`pcloud expired`);
|
||||
pCloudExpired = true;
|
||||
this.settings.pcloud = cloneDeep(DEFAULT_PCLOUD_CONFIG);
|
||||
needSave = true;
|
||||
@ -1611,6 +1626,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.yandexdisk.refreshToken !== "" &&
|
||||
current >= this.settings!.yandexdisk!.credentialsShouldBeDeletedAtTimeMs!
|
||||
) {
|
||||
console.warn(`yandex disk expired`);
|
||||
yandexDiskExpired = true;
|
||||
this.settings.yandexdisk = cloneDeep(DEFAULT_YANDEXDISK_CONFIG);
|
||||
needSave = true;
|
||||
@ -1621,6 +1637,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.koofr.refreshToken !== "" &&
|
||||
current >= this.settings!.koofr!.credentialsShouldBeDeletedAtTimeMs!
|
||||
) {
|
||||
console.warn(`koofr expired`);
|
||||
koofrExpired = true;
|
||||
this.settings.koofr = cloneDeep(DEFAULT_KOOFR_CONFIG);
|
||||
needSave = true;
|
||||
|
||||
111
src/misc.ts
111
src/misc.ts
@ -279,7 +279,7 @@ export const reverseString = (x: string) => {
|
||||
};
|
||||
|
||||
export interface SplitRange {
|
||||
partNum: number; // startting from 1
|
||||
partNum: number; // starting from 1
|
||||
start: number;
|
||||
end: number; // exclusive
|
||||
}
|
||||
@ -316,7 +316,7 @@ export const getTypeName = (obj: any) => {
|
||||
};
|
||||
|
||||
/**
|
||||
* Startting from 1
|
||||
* starting from 1
|
||||
* @param x
|
||||
* @returns
|
||||
*/
|
||||
@ -742,3 +742,110 @@ export const getSha1 = async (x: ArrayBuffer, stringify: "base64" | "hex") => {
|
||||
}
|
||||
throw Error(`not supported stringify option = ${stringify}`);
|
||||
};
|
||||
|
||||
/**
|
||||
* https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions
|
||||
* https://support.microsoft.com/en-us/office/restrictions-and-limitations-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa#invalidcharacters
|
||||
*/
|
||||
export const checkValidName = (x: string) => {
|
||||
if (x === undefined || x === "") {
|
||||
// what??
|
||||
return {
|
||||
reason: "empty",
|
||||
result: false,
|
||||
};
|
||||
}
|
||||
|
||||
// The following reserved characters:
|
||||
const invalidChars = '*"<>:|?'.split("");
|
||||
for (const c of invalidChars) {
|
||||
if (x.includes(c)) {
|
||||
return {
|
||||
reason: `reserved character: ${c}`,
|
||||
result: false,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// directory component
|
||||
for (const c of [".", ".."]) {
|
||||
if (
|
||||
x === c ||
|
||||
x.endsWith(`/${c}`) ||
|
||||
x.startsWith(`${c}/`) ||
|
||||
x.includes(`/${c}/`)
|
||||
) {
|
||||
return {
|
||||
reason: `directory being ${c}`,
|
||||
result: false,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// reserved file names
|
||||
const reservedNames = [
|
||||
"CON",
|
||||
"PRN",
|
||||
"AUX",
|
||||
"NUL",
|
||||
"COM0",
|
||||
"COM1",
|
||||
"COM2",
|
||||
"COM3",
|
||||
"COM4",
|
||||
"COM5",
|
||||
"COM6",
|
||||
"COM7",
|
||||
"COM8",
|
||||
"COM9",
|
||||
"COM¹",
|
||||
"COM²",
|
||||
"COM³",
|
||||
"LPT0",
|
||||
"LPT1",
|
||||
"LPT2",
|
||||
"LPT3",
|
||||
"LPT4",
|
||||
"LPT5",
|
||||
"LPT6",
|
||||
"LPT7",
|
||||
"LPT8",
|
||||
"LPT9",
|
||||
"LPT¹",
|
||||
"LPT²",
|
||||
"LPT³",
|
||||
];
|
||||
for (const f of reservedNames) {
|
||||
if (
|
||||
x === f ||
|
||||
x.startsWith(`${f}.`) ||
|
||||
x.startsWith(`${f}/`) ||
|
||||
x.includes(`/${f}/`) ||
|
||||
x.endsWith(`/${f}`) ||
|
||||
x.includes(`/${f}.`)
|
||||
) {
|
||||
return {
|
||||
reason: `reserved folder/file name: ${f}`,
|
||||
result: false,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Do not end a file or directory name with a space or a period.
|
||||
if (
|
||||
x.endsWith(" ") ||
|
||||
x.endsWith(".") ||
|
||||
x.includes(" /") ||
|
||||
x.includes("./")
|
||||
) {
|
||||
return {
|
||||
reason: `folder/file name ending with a space or a period`,
|
||||
result: false,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
reason: "ok",
|
||||
result: true,
|
||||
};
|
||||
};
|
||||
|
||||
@ -10,6 +10,7 @@ interface BreakPoint {
|
||||
}
|
||||
|
||||
export const DEFAULT_PROFILER_CONFIG: ProfilerConfig = {
|
||||
enable: false,
|
||||
enablePrinting: false,
|
||||
recordSize: false,
|
||||
};
|
||||
|
||||
@ -2247,6 +2247,27 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
|
||||
textArea.inputEl.addClass("ignorepaths-textarea");
|
||||
});
|
||||
|
||||
new Setting(basicDiv)
|
||||
.setName(t("settings_onlyallowpaths"))
|
||||
.setDesc(t("settings_onlyallowpaths_desc"))
|
||||
.setClass("onlyallowpaths-settings")
|
||||
|
||||
.addTextArea((textArea) => {
|
||||
textArea
|
||||
.setValue(`${(this.plugin.settings.onlyAllowPaths ?? []).join("\n")}`)
|
||||
.onChange(async (value) => {
|
||||
this.plugin.settings.onlyAllowPaths = value
|
||||
.trim()
|
||||
.split("\n")
|
||||
.filter((x) => x.trim() !== "");
|
||||
await this.plugin.saveSettings();
|
||||
});
|
||||
textArea.inputEl.rows = 10;
|
||||
textArea.inputEl.cols = 30;
|
||||
|
||||
textArea.inputEl.addClass("onlyallowpaths-textarea");
|
||||
});
|
||||
|
||||
//////////////////////////////////////////////////
|
||||
// below for advanced settings
|
||||
//////////////////////////////////////////////////
|
||||
@ -2919,6 +2940,25 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(debugDiv)
|
||||
.setName(t("settings_profiler_enableprofiler"))
|
||||
.setDesc(t("settings_profiler_enableprofiler_desc"))
|
||||
.addDropdown((dropdown) => {
|
||||
dropdown.addOption("enable", t("enable"));
|
||||
dropdown.addOption("disable", t("disable"));
|
||||
dropdown
|
||||
.setValue(
|
||||
this.plugin.settings.profiler?.enable ? "enable" : "disable"
|
||||
)
|
||||
.onChange(async (val: string) => {
|
||||
if (this.plugin.settings.profiler === undefined) {
|
||||
this.plugin.settings.profiler = DEFAULT_PROFILER_CONFIG;
|
||||
}
|
||||
this.plugin.settings.profiler.enable = val === "enable";
|
||||
await this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(debugDiv)
|
||||
.setName(t("settings_profiler_enabledebugprint"))
|
||||
.setDesc(t("settings_profiler_enabledebugprint_desc"))
|
||||
|
||||
@ -214,6 +214,10 @@
|
||||
font-family: monospace;
|
||||
}
|
||||
|
||||
.onlyallowpaths-textarea {
|
||||
font-family: monospace;
|
||||
}
|
||||
|
||||
.logtohttpserver-warning {
|
||||
color: red;
|
||||
font-weight: bolder;
|
||||
|
||||
@ -363,6 +363,82 @@ describe("Misc: split chunk ranges", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("Misc: check valid file names", () => {
|
||||
it("should be ok for normal file nmes", () => {
|
||||
let item = "what/.hidden/what/what/what";
|
||||
assert.ok(misc.checkValidName(item).result);
|
||||
|
||||
item = "ssss/%%%^^^$xxxx.md";
|
||||
assert.ok(misc.checkValidName(item).result);
|
||||
});
|
||||
|
||||
it("should be not ok for reserved characters", () => {
|
||||
let item = "a**";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "a?*";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "<>:";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "<>:/ssss";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
});
|
||||
|
||||
it("should be not ok for reserved names", () => {
|
||||
let item = "CON";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "CON.txt";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "CON.md";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "con"; // lower case is ok
|
||||
assert.ok(misc.checkValidName(item).result);
|
||||
|
||||
item = "CON/";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "CON.dir/";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "CON.dir.folder/";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx/CON";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx/CON.txt";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx/CON.txt.md";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
});
|
||||
|
||||
it("should be not ok for invalid endings", () => {
|
||||
let item = "xxx ";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "/xxx ";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx.yyy.";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx.yyy.";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx /";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
|
||||
item = "xxx.yyy./";
|
||||
assert.ok(!misc.checkValidName(item).result);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Misc: Dropbox: should fix the folder name cases", () => {
|
||||
it("should do nothing on empty folders", () => {
|
||||
const input: any[] = [];
|
||||
|
||||
Loading…
Reference in New Issue
Block a user