Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
63a66d69f9 | ||
|
|
79fb1d90d0 | ||
|
|
ac4eff376d | ||
|
|
5512978dee | ||
|
|
2bac0c32dc | ||
|
|
1cd02913bb | ||
|
|
51f6d600a6 | ||
|
|
a4905445c7 | ||
|
|
12d78444b3 | ||
|
|
dffada894f | ||
|
|
50ae224769 | ||
|
|
15b14ac488 | ||
|
|
f73e6b7796 | ||
|
|
6a820ddfdd | ||
|
|
81d7e120f5 | ||
|
|
57f538fa9e | ||
|
|
07402a09b5 | ||
|
|
ac3123f63f | ||
|
|
a2fb515b74 | ||
|
|
1699d39f62 | ||
|
|
70ad37d6d6 | ||
|
|
5add7ad645 |
@@ -30,6 +30,7 @@ jobs:
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
lfs: true
|
||||
submodules: recursive
|
||||
- name: Checkout LFS
|
||||
run: git lfs checkout
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
[submodule "src/langs"]
|
||||
path = src/langs
|
||||
url = https://github.com/remotely-save/langs.git
|
||||
@@ -14,7 +14,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
||||
|
||||
## !!!Caution!!!
|
||||
|
||||
As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
|
||||
**ALWAYS, ALWAYS, backup your vault before using this plugin.**
|
||||
|
||||
## Features
|
||||
|
||||
@@ -23,7 +23,7 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
|
||||
- Dropbox
|
||||
- OneDrive for personal
|
||||
- Webdav
|
||||
- A list of connectable / not-connectable / in-the-plan / never-possible services are noted down [here](./docs/services_connectable_or_not.md).
|
||||
- [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
|
||||
- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
|
||||
- **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||
- **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).
|
||||
@@ -35,8 +35,7 @@ As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any
|
||||
|
||||
- **To support deltions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
|
||||
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
|
||||
- **Cloud services cost you money.** Always be aware of the costs and pricing.
|
||||
- **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.
|
||||
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
|
||||
- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
|
||||
|
||||
## Questions, Suggestions, Or Bugs
|
||||
@@ -63,7 +62,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
|
||||
- About CORS:
|
||||
- If you are using Obsidian >= 0.13.25, you can skip this CORS part.
|
||||
- If you are using Obsidian < 0.13.25, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
|
||||
- If you are using Obsidian < 0.13.25, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
|
||||
- Download and enable this plugin.
|
||||
- Enter your information to the settings of this plugin.
|
||||
- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
|
||||
@@ -72,15 +71,13 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
|
||||
### Dropbox
|
||||
|
||||
- **This plugin's function for Dropbox is not as mature as functions for S3.**
|
||||
- **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
|
||||
- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
|
||||
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
|
||||
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
|
||||
### OneDrive for personal
|
||||
|
||||
- **This plugin's function for OneDrive is not as mature as functions for S3.**
|
||||
- **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
|
||||
- This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
|
||||
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
||||
@@ -89,7 +86,6 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
|
||||
### webdav
|
||||
|
||||
- **webdav support is considered experimental.**
|
||||
- About CORS:
|
||||
- If you are using Obsidian >= 0.13.25, you can skip this CORS part.
|
||||
- If you are using Obsidian < 0.13.25:
|
||||
@@ -105,6 +101,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- In auto sync mode, if any error occurs, the plugin would **fail silently**.
|
||||
- Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
|
||||
|
||||
## How To Deal With Hidden Files Or Folders
|
||||
|
||||
**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
|
||||
|
||||
In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
|
||||
|
||||
## How To Debug
|
||||
|
||||
See [here](./docs/how_to_debug/README.md) for more details.
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
## Material Source
|
||||
|
||||
To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
|
||||
|
||||
## Some Backgrounds
|
||||
|
||||
1. Obsidian allows users to take notes using markdown files.
|
||||
2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
|
||||
3. Technically, remotely-save is developed using web technologies.
|
||||
|
||||
## Api Usages
|
||||
|
||||
1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
|
||||
2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
|
||||
3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
|
||||
4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
|
||||
|
||||
## Steps
|
||||
|
||||
Here are the steps to see the functionality of remotely-save.
|
||||
|
||||
Most steps have screenshots.
|
||||
|
||||
1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
|
||||
2. Open Obsidian, click the "Create" button under "Create new vault".
|
||||
3. Pick a vault name, "example-vault", and choose a location, then click "Create".
|
||||

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

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

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

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

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

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

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

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

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

|
||||
14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:655f6f487cc24af0ab86b8592622a7701c30f3369e7847a1fbb783d0962829c3
|
||||
size 52910
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fe971af94f1f7b042b7313268e4d2d8432d926ce2392e50ca2a4abc21c8a4aab
|
||||
size 57033
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:025303053f2b2cedd2bdd61cd71e1f1c0fb12e45bfbc0e81f2c0d70747133505
|
||||
size 63458
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:061707977c8046a6f924881f86aac962e2f05618e201080768246270de792040
|
||||
size 100162
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:8add61e6ef34b2470e5a5bea3e10955a86eed5ed1fc4dd398f30835485a6c455
|
||||
size 158422
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:021ae1ce29d3932f088f0954787c475be826915b794320bf212d3ba7d58656da
|
||||
size 110529
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:b225d21de5778ddc032893e0f52150ab4260b0dfbe0e9141da4aa8b03131a9da
|
||||
size 147821
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fda4f6e8cf68833f239bdc85c46802fe2131d149011074f747b1829822a38939
|
||||
size 59041
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:576801d5ebd8cf7fcd3c9c0c6df325654338854f7d762a5680e9aab3c9e6508a
|
||||
size 142155
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:1c93f681f0f7ce74cee0f2ed193f574ef915554f1a9ef96ba54afdede302f13a
|
||||
size 112057
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.3.6",
|
||||
"version": "0.3.9",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
|
||||
+11
-10
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "remotely-save",
|
||||
"version": "0.3.6",
|
||||
"version": "0.3.9",
|
||||
"description": "This is yet another sync plugin for Obsidian app.",
|
||||
"scripts": {
|
||||
"dev2": "node esbuild.config.mjs",
|
||||
@@ -26,11 +26,11 @@
|
||||
"@microsoft/microsoft-graph-types": "^2.11.0",
|
||||
"@types/chai": "^4.2.22",
|
||||
"@types/chai-as-promised": "^7.1.4",
|
||||
"@types/feather-icons": "^4.7.0",
|
||||
"@types/jsdom": "^16.2.13",
|
||||
"@types/lodash": "^4.14.178",
|
||||
"@types/mime-types": "^2.1.1",
|
||||
"@types/mocha": "^9.0.0",
|
||||
"@types/mustache": "^4.1.2",
|
||||
"@types/node": "^14.14.37",
|
||||
"@types/qrcode": "^1.4.1",
|
||||
"builtin-modules": "^3.2.0",
|
||||
@@ -51,13 +51,13 @@
|
||||
"webpack-cli": "^4.9.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aws-sdk/client-s3": "^3.37.0",
|
||||
"@aws-sdk/fetch-http-handler": "^3.53.0",
|
||||
"@aws-sdk/lib-storage": "^3.53.1",
|
||||
"@aws-sdk/protocol-http": "^3.53.0",
|
||||
"@aws-sdk/querystring-builder": "^3.53.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.37.0",
|
||||
"@aws-sdk/types": "^3.53.0",
|
||||
"@aws-sdk/client-s3": "^3.54.0",
|
||||
"@aws-sdk/fetch-http-handler": "^3.54.0",
|
||||
"@aws-sdk/lib-storage": "^3.54.0",
|
||||
"@aws-sdk/protocol-http": "^3.54.0",
|
||||
"@aws-sdk/querystring-builder": "^3.54.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.54.0",
|
||||
"@aws-sdk/types": "^3.54.0",
|
||||
"@azure/msal-node": "^1.6.0",
|
||||
"@fyears/tsqueue": "^1.0.1",
|
||||
"@microsoft/microsoft-graph-client": "^3.0.1",
|
||||
@@ -68,12 +68,13 @@
|
||||
"codemirror": "^5.63.1",
|
||||
"crypto-browserify": "^3.12.0",
|
||||
"dropbox": "^10.22.0",
|
||||
"feather-icons": "^4.28.0",
|
||||
"http-status-codes": "^2.2.0",
|
||||
"localforage": "^1.10.0",
|
||||
"lodash": "^4.17.21",
|
||||
"loglevel": "^1.8.0",
|
||||
"lucide": "^0.17.12",
|
||||
"mime-types": "^2.1.33",
|
||||
"mustache": "^4.2.0",
|
||||
"nanoid": "^3.1.30",
|
||||
"obsidian": "^0.13.26",
|
||||
"p-queue": "^7.2.0",
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
* To avoid circular dependency.
|
||||
*/
|
||||
|
||||
import type { LangType, LangTypeAndAuto } from "./i18n";
|
||||
|
||||
export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
|
||||
|
||||
export interface S3Config {
|
||||
@@ -12,6 +14,8 @@ export interface S3Config {
|
||||
s3SecretAccessKey: string;
|
||||
s3BucketName: string;
|
||||
bypassCorsLocally?: boolean;
|
||||
partsConcurrency?: number;
|
||||
forcePathStyle?: boolean;
|
||||
}
|
||||
|
||||
export interface DropboxConfig {
|
||||
@@ -69,6 +73,7 @@ export interface RemotelySavePluginSettings {
|
||||
concurrency?: number;
|
||||
syncConfigDir?: boolean;
|
||||
syncUnderscoreItems?: boolean;
|
||||
lang?: LangTypeAndAuto;
|
||||
}
|
||||
|
||||
export interface RemoteItem {
|
||||
|
||||
@@ -165,3 +165,23 @@ export const decryptBase64urlToString = async (
|
||||
)
|
||||
);
|
||||
};
|
||||
|
||||
export const getSizeFromOrigToEnc = (x: number) => {
|
||||
if (x < 0 || !Number.isInteger(x)) {
|
||||
throw Error(`x=${x} is not a valid size`);
|
||||
}
|
||||
return (Math.floor(x / 16) + 1) * 16 + 16;
|
||||
};
|
||||
|
||||
export const getSizeFromEncToOrig = (x: number) => {
|
||||
if (x < 32 || !Number.isInteger(x)) {
|
||||
throw Error(`${x} is not a valid size`);
|
||||
}
|
||||
if (x % 16 !== 0) {
|
||||
throw Error(`${x} is not a valid encrypted file size`);
|
||||
}
|
||||
return {
|
||||
minSize: ((x - 16) / 16 - 1) * 16,
|
||||
maxSize: ((x - 16) / 16 - 1) * 16 + 15,
|
||||
};
|
||||
};
|
||||
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
import Mustache from "mustache";
|
||||
import { moment } from "obsidian";
|
||||
|
||||
import { LANGS } from "./langs";
|
||||
|
||||
export type LangType = keyof typeof LANGS;
|
||||
export type LangTypeAndAuto = LangType | "auto";
|
||||
export type TransItemType = keyof typeof LANGS["en"];
|
||||
|
||||
export class I18n {
|
||||
lang: LangTypeAndAuto;
|
||||
readonly saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>;
|
||||
constructor(
|
||||
lang: LangTypeAndAuto,
|
||||
saveSettingFunc: (tolang: LangTypeAndAuto) => Promise<void>
|
||||
) {
|
||||
this.lang = lang;
|
||||
this.saveSettingFunc = saveSettingFunc;
|
||||
}
|
||||
async changeTo(anotherLang: LangTypeAndAuto) {
|
||||
this.lang = anotherLang;
|
||||
await this.saveSettingFunc(anotherLang);
|
||||
}
|
||||
|
||||
_get(key: TransItemType) {
|
||||
let realLang = this.lang;
|
||||
if (this.lang === "auto" && moment.locale().replace("-", "_") in LANGS) {
|
||||
realLang = moment.locale().replace("-", "_") as LangType;
|
||||
} else {
|
||||
realLang = "en";
|
||||
}
|
||||
|
||||
const res: string =
|
||||
(LANGS[realLang] as typeof LANGS["en"])[key] || LANGS["en"][key] || key;
|
||||
return res;
|
||||
}
|
||||
|
||||
t(key: TransItemType, vars?: Record<string, string>) {
|
||||
if (vars === undefined) {
|
||||
return this._get(key);
|
||||
}
|
||||
return Mustache.render(this._get(key), vars);
|
||||
}
|
||||
}
|
||||
Submodule
+1
Submodule src/langs added at 28730585f8
+138
-62
@@ -1,7 +1,7 @@
|
||||
import { Modal, Notice, Plugin, Setting, addIcon, setIcon } from "obsidian";
|
||||
import cloneDeep from "lodash/cloneDeep";
|
||||
import { nanoid } from "nanoid";
|
||||
import feather from "feather-icons";
|
||||
import { createElement, RotateCcw, RefreshCcw } from "lucide";
|
||||
import type { RemotelySavePluginSettings } from "./baseTypes";
|
||||
import {
|
||||
COMMAND_CALLBACK,
|
||||
@@ -38,6 +38,8 @@ import { fetchMetadataFile, parseRemoteItems, SyncStatusType } from "./sync";
|
||||
import { doActualSync, getSyncPlan, isPasswordOk } from "./sync";
|
||||
import { messyConfigToNormal, normalConfigToMessy } from "./configPersist";
|
||||
import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
|
||||
import { I18n } from "./i18n";
|
||||
import type { LangType, LangTypeAndAuto, TransItemType } from "./i18n";
|
||||
|
||||
import * as origLog from "loglevel";
|
||||
import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
|
||||
@@ -59,6 +61,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
|
||||
concurrency: 5,
|
||||
syncConfigDir: false,
|
||||
syncUnderscoreItems: false,
|
||||
lang: "auto",
|
||||
};
|
||||
|
||||
interface OAuth2Info {
|
||||
@@ -73,14 +76,13 @@ type SyncTriggerSourceType = "manual" | "auto" | "dry" | "autoOnceInit";
|
||||
|
||||
const iconNameSyncWait = `remotely-save-sync-wait`;
|
||||
const iconNameSyncRunning = `remotely-save-sync-running`;
|
||||
const iconSvgSyncWait = feather.icons["rotate-ccw"].toSvg({
|
||||
width: 100,
|
||||
height: 100,
|
||||
});
|
||||
const iconSvgSyncRunning = feather.icons["refresh-ccw"].toSvg({
|
||||
width: 100,
|
||||
height: 100,
|
||||
});
|
||||
|
||||
const iconSvgSyncWait = createElement(RotateCcw);
|
||||
iconSvgSyncWait.setAttribute("width", "100");
|
||||
iconSvgSyncWait.setAttribute("height", "100");
|
||||
const iconSvgSyncRunning = createElement(RefreshCcw);
|
||||
iconSvgSyncRunning.setAttribute("width", "100");
|
||||
iconSvgSyncRunning.setAttribute("height", "100");
|
||||
|
||||
export default class RemotelySavePlugin extends Plugin {
|
||||
settings: RemotelySavePluginSettings;
|
||||
@@ -92,8 +94,13 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
currSyncMsg?: string;
|
||||
syncRibbon?: HTMLElement;
|
||||
autoRunIntervalID?: number;
|
||||
i18n: I18n;
|
||||
|
||||
async syncRun(triggerSource: SyncTriggerSourceType = "manual") {
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
const getNotice = (x: string) => {
|
||||
// only show notices in manual mode
|
||||
// no notice in auto mode
|
||||
@@ -103,7 +110,12 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
};
|
||||
if (this.syncStatus !== "idle") {
|
||||
// here the notice is shown regardless of triggerSource
|
||||
new Notice(`Remotely Save already running in stage ${this.syncStatus}!`);
|
||||
new Notice(
|
||||
t("syncrun_alreadyrunning", {
|
||||
pluginName: this.manifest.name,
|
||||
syncStatus: this.syncStatus,
|
||||
})
|
||||
);
|
||||
if (this.currSyncMsg !== undefined && this.currSyncMsg !== "") {
|
||||
new Notice(this.currSyncMsg);
|
||||
}
|
||||
@@ -126,7 +138,10 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
setIcon(this.syncRibbon, iconNameSyncRunning);
|
||||
this.syncRibbon.setAttribute(
|
||||
"aria-label",
|
||||
`${this.manifest.name}: ${triggerSource} syncing`
|
||||
t("syncrun_syncingribbon", {
|
||||
pluginName: this.manifest.name,
|
||||
triggerSource: triggerSource,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
@@ -134,17 +149,26 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
|
||||
if (triggerSource === "dry") {
|
||||
getNotice(
|
||||
`0/${MAX_STEPS} Remotely Save running in dry mode, not actual file changes would happen.`
|
||||
t("syncrun_step0", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
//log.info(`huh ${this.settings.password}`)
|
||||
getNotice(
|
||||
`1/${MAX_STEPS} Remotely Save Sync Preparing (${this.settings.serviceType})`
|
||||
t("syncrun_step1", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
serviceType: this.settings.serviceType,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "preparing";
|
||||
|
||||
getNotice(`2/${MAX_STEPS} Starting to fetch remote meta data.`);
|
||||
getNotice(
|
||||
t("syncrun_step2", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "getting_remote_files_list";
|
||||
const self = this;
|
||||
const client = new RemoteClient(
|
||||
@@ -159,18 +183,26 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
const remoteRsp = await client.listFromRemote();
|
||||
log.debug(remoteRsp);
|
||||
|
||||
getNotice(`3/${MAX_STEPS} Checking password correct or not.`);
|
||||
getNotice(
|
||||
t("syncrun_step3", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "checking_password";
|
||||
const passwordCheckResult = await isPasswordOk(
|
||||
remoteRsp.Contents,
|
||||
this.settings.password
|
||||
);
|
||||
if (!passwordCheckResult.ok) {
|
||||
getNotice("something goes wrong while checking password");
|
||||
getNotice(t("syncrun_passworderr"));
|
||||
throw Error(passwordCheckResult.reason);
|
||||
}
|
||||
|
||||
getNotice(`4/${MAX_STEPS} Trying to fetch extra meta data from remote.`);
|
||||
getNotice(
|
||||
t("syncrun_step4", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "getting_remote_extra_meta";
|
||||
const { remoteStates, metadataFile } = await parseRemoteItems(
|
||||
remoteRsp.Contents,
|
||||
@@ -186,7 +218,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.password
|
||||
);
|
||||
|
||||
getNotice(`5/${MAX_STEPS} Starting to fetch local meta data.`);
|
||||
getNotice(
|
||||
t("syncrun_step5", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "getting_local_meta";
|
||||
const local = this.app.vault.getAllLoadedFiles();
|
||||
const localHistory = await loadDeleteRenameHistoryTableByVault(
|
||||
@@ -204,7 +240,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
// log.info(local);
|
||||
// log.info(localHistory);
|
||||
|
||||
getNotice(`6/${MAX_STEPS} Starting to generate sync plan.`);
|
||||
getNotice(
|
||||
t("syncrun_step6", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "generating_plan";
|
||||
const { plan, sortedKeys, deletions } = await getSyncPlan(
|
||||
remoteStates,
|
||||
@@ -232,7 +272,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
// The operations below begins to write or delete (!!!) something.
|
||||
|
||||
if (triggerSource !== "dry") {
|
||||
getNotice(`7/${MAX_STEPS} Remotely Save Sync data exchanging!`);
|
||||
getNotice(
|
||||
t("syncrun_step7", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
|
||||
this.syncStatus = "syncing";
|
||||
await doActualSync(
|
||||
@@ -254,11 +298,17 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
} else {
|
||||
this.syncStatus = "syncing";
|
||||
getNotice(
|
||||
`7/${MAX_STEPS} Remotely Save real sync is skipped in dry run mode.`
|
||||
t("syncrun_step7skip", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
getNotice(`8/${MAX_STEPS} Remotely Save finish!`);
|
||||
getNotice(
|
||||
t("syncrun_step8", {
|
||||
maxSteps: `${MAX_STEPS}`,
|
||||
})
|
||||
);
|
||||
this.syncStatus = "finish";
|
||||
this.syncStatus = "idle";
|
||||
|
||||
@@ -273,11 +323,12 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
}-${Date.now()}: finish sync, triggerSource=${triggerSource}`
|
||||
);
|
||||
} catch (error) {
|
||||
const msg = `${
|
||||
this.manifest.id
|
||||
}-${Date.now()}: abort sync, triggerSource=${triggerSource}, error while ${
|
||||
this.syncStatus
|
||||
}`;
|
||||
const msg = t("syncrun_abort", {
|
||||
manifestID: this.manifest.id,
|
||||
theDate: `${Date.now()}`,
|
||||
triggerSource: triggerSource,
|
||||
syncStatus: this.syncStatus,
|
||||
});
|
||||
log.info(msg);
|
||||
log.info(error);
|
||||
getNotice(msg);
|
||||
@@ -293,8 +344,8 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
async onload() {
|
||||
log.info(`loading plugin ${this.manifest.id}`);
|
||||
|
||||
addIcon(iconNameSyncWait, iconSvgSyncWait);
|
||||
addIcon(iconNameSyncRunning, iconSvgSyncRunning);
|
||||
addIcon(iconNameSyncWait, iconSvgSyncWait.outerHTML);
|
||||
addIcon(iconNameSyncRunning, iconSvgSyncRunning.outerHTML);
|
||||
|
||||
this.oauth2Info = {
|
||||
verifier: "",
|
||||
@@ -308,6 +359,15 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
|
||||
await this.loadSettings();
|
||||
|
||||
// lang should be load early, but after settings
|
||||
this.i18n = new I18n(this.settings.lang, async (lang: LangTypeAndAuto) => {
|
||||
this.settings.lang = lang;
|
||||
await this.saveSettings();
|
||||
});
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
if (this.settings.currLogLevel !== undefined) {
|
||||
log.setLevel(this.settings.currLogLevel as any);
|
||||
}
|
||||
@@ -353,7 +413,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings = Object.assign({}, this.settings, copied);
|
||||
this.saveSettings();
|
||||
new Notice(
|
||||
`New not-oauth2 settings for ${this.manifest.name} saved. Reopen the plugin Settings to the effect.`
|
||||
t("protocol_saveqr", {
|
||||
manifestName: this.manifest.name,
|
||||
})
|
||||
);
|
||||
}
|
||||
});
|
||||
@@ -362,9 +424,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
COMMAND_CALLBACK,
|
||||
async (inputParams) => {
|
||||
new Notice(
|
||||
`Your uri call a callback that's not supported yet: ${JSON.stringify(
|
||||
inputParams
|
||||
)}`
|
||||
t("protocol_callbacknotsupported", {
|
||||
params: JSON.stringify(inputParams),
|
||||
})
|
||||
);
|
||||
}
|
||||
);
|
||||
@@ -375,12 +437,14 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
if (inputParams.code !== undefined) {
|
||||
if (this.oauth2Info.helperModal !== undefined) {
|
||||
this.oauth2Info.helperModal.contentEl.empty();
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: "Connecting to Dropbox...",
|
||||
});
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: "Please DO NOT close this modal.",
|
||||
});
|
||||
|
||||
t("protocol_dropbox_connecting")
|
||||
.split("\n")
|
||||
.forEach((val) => {
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: val,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
let authRes = await sendAuthReqDropbox(
|
||||
@@ -410,7 +474,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.settings.dropbox.username = username;
|
||||
await this.saveSettings();
|
||||
|
||||
new Notice(`Good! We've connected to Dropbox as user ${username}!`);
|
||||
new Notice(
|
||||
t("protocol_dropbox_connect_succ", {
|
||||
username: username,
|
||||
})
|
||||
);
|
||||
|
||||
this.oauth2Info.verifier = ""; // reset it
|
||||
this.oauth2Info.helperModal?.close(); // close it
|
||||
@@ -423,7 +491,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.oauth2Info.authDiv = undefined;
|
||||
|
||||
this.oauth2Info.revokeAuthSetting?.setDesc(
|
||||
`You've connected as user ${this.settings.dropbox.username}. If you want to disconnect, click this button.`
|
||||
t("protocol_dropbox_connect_succ_revoke", {
|
||||
username: this.settings.dropbox.username,
|
||||
})
|
||||
);
|
||||
this.oauth2Info.revokeAuthSetting = undefined;
|
||||
this.oauth2Info.revokeDiv?.toggleClass(
|
||||
@@ -432,13 +502,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
);
|
||||
this.oauth2Info.revokeDiv = undefined;
|
||||
} else {
|
||||
new Notice(
|
||||
"Something went wrong from response from Dropbox. Maybe you rejected the auth?"
|
||||
);
|
||||
new Notice(t("protocol_dropbox_connect_fail"));
|
||||
throw Error(
|
||||
`do not know how to deal with the callback: ${JSON.stringify(
|
||||
inputParams
|
||||
)}`
|
||||
t("protocol_dropbox_connect_unknown", {
|
||||
params: JSON.stringify(inputParams),
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -450,12 +518,14 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
if (inputParams.code !== undefined) {
|
||||
if (this.oauth2Info.helperModal !== undefined) {
|
||||
this.oauth2Info.helperModal.contentEl.empty();
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: "Connecting to Onedrive...",
|
||||
});
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: "Please DO NOT close this modal.",
|
||||
});
|
||||
|
||||
t("protocol_onedrive_connecting")
|
||||
.split("\n")
|
||||
.forEach((val) => {
|
||||
this.oauth2Info.helperModal.contentEl.createEl("p", {
|
||||
text: val,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
let rsp = await sendAuthReqOnedrive(
|
||||
@@ -499,7 +569,9 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
this.oauth2Info.authDiv = undefined;
|
||||
|
||||
this.oauth2Info.revokeAuthSetting?.setDesc(
|
||||
`You've connected as user ${this.settings.onedrive.username}. If you want to disconnect, click this button.`
|
||||
t("protocol_onedrive_connect_succ_revoke", {
|
||||
username: this.settings.onedrive.username,
|
||||
})
|
||||
);
|
||||
this.oauth2Info.revokeAuthSetting = undefined;
|
||||
this.oauth2Info.revokeDiv?.toggleClass(
|
||||
@@ -508,13 +580,11 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
);
|
||||
this.oauth2Info.revokeDiv = undefined;
|
||||
} else {
|
||||
new Notice(
|
||||
"Something went wrong from response from OneDrive. Maybe you rejected the auth?"
|
||||
);
|
||||
new Notice(t("protocol_onedrive_connect_fail"));
|
||||
throw Error(
|
||||
`do not know how to deal with the callback: ${JSON.stringify(
|
||||
inputParams
|
||||
)}`
|
||||
t("protocol_onedrive_connect_unknown", {
|
||||
params: JSON.stringify(inputParams),
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -528,7 +598,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
|
||||
this.addCommand({
|
||||
id: "start-sync",
|
||||
name: "start sync",
|
||||
name: t("command_startsync"),
|
||||
icon: iconNameSyncWait,
|
||||
callback: async () => {
|
||||
this.syncRun("manual");
|
||||
@@ -537,7 +607,7 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
|
||||
this.addCommand({
|
||||
id: "start-sync-dry-run",
|
||||
name: "start sync (dry run only)",
|
||||
name: t("command_drynrun"),
|
||||
icon: iconNameSyncWait,
|
||||
callback: async () => {
|
||||
this.syncRun("dry");
|
||||
@@ -585,6 +655,12 @@ export default class RemotelySavePlugin extends Plugin {
|
||||
if (this.settings.webdav.depth === undefined) {
|
||||
this.settings.webdav.depth = "auto_unknown";
|
||||
}
|
||||
if (this.settings.s3.partsConcurrency === undefined) {
|
||||
this.settings.s3.partsConcurrency = 20;
|
||||
}
|
||||
if (this.settings.s3.forcePathStyle === undefined) {
|
||||
this.settings.s3.forcePathStyle = false;
|
||||
}
|
||||
}
|
||||
|
||||
async saveSettings() {
|
||||
|
||||
+31
@@ -268,3 +268,34 @@ export const getSplitRanges = (bytesTotal: number, bytesEachPart: number) => {
|
||||
}
|
||||
return res;
|
||||
};
|
||||
|
||||
/**
|
||||
* https://stackoverflow.com/questions/332422
|
||||
* @param obj anything
|
||||
* @returns string of the name of the object
|
||||
*/
|
||||
export const getTypeName = (obj: any) => {
|
||||
return Object.prototype.toString.call(obj).slice(8, -1);
|
||||
};
|
||||
|
||||
/**
|
||||
* Startting from 1
|
||||
* @param x
|
||||
* @returns
|
||||
*/
|
||||
export const atWhichLevel = (x: string) => {
|
||||
if (
|
||||
x === undefined ||
|
||||
x === "" ||
|
||||
x === "." ||
|
||||
x === ".." ||
|
||||
x.startsWith("/")
|
||||
) {
|
||||
throw Error(`do not know which level for ${x}`);
|
||||
}
|
||||
let y = x;
|
||||
if (x.endsWith("/")) {
|
||||
y = x.slice(0, -1);
|
||||
}
|
||||
return y.split("/").length;
|
||||
};
|
||||
|
||||
+5
-1
@@ -154,6 +154,8 @@ export const DEFAULT_S3_CONFIG = {
|
||||
s3SecretAccessKey: "",
|
||||
s3BucketName: "",
|
||||
bypassCorsLocally: true,
|
||||
partsConcurrency: 20,
|
||||
forcePathStyle: false,
|
||||
};
|
||||
|
||||
export type S3ObjectType = _Object;
|
||||
@@ -191,6 +193,7 @@ export const getS3Client = (s3Config: S3Config) => {
|
||||
const s3Client = new S3Client({
|
||||
region: s3Config.s3Region,
|
||||
endpoint: endpoint,
|
||||
forcePathStyle: s3Config.forcePathStyle,
|
||||
credentials: {
|
||||
accessKeyId: s3Config.s3AccessKeyID,
|
||||
secretAccessKey: s3Config.s3SecretAccessKey,
|
||||
@@ -202,6 +205,7 @@ export const getS3Client = (s3Config: S3Config) => {
|
||||
const s3Client = new S3Client({
|
||||
region: s3Config.s3Region,
|
||||
endpoint: endpoint,
|
||||
forcePathStyle: s3Config.forcePathStyle,
|
||||
credentials: {
|
||||
accessKeyId: s3Config.s3AccessKeyID,
|
||||
secretAccessKey: s3Config.s3SecretAccessKey,
|
||||
@@ -291,7 +295,7 @@ export const uploadToRemote = async (
|
||||
const body = new Uint8Array(remoteContent);
|
||||
const upload = new Upload({
|
||||
client: s3Client,
|
||||
queueSize: 20, // concurrency
|
||||
queueSize: s3Config.partsConcurrency, // concurrency
|
||||
partSize: bytesIn5MB, // minimal 5MB by default
|
||||
leavePartsOnError: false,
|
||||
params: {
|
||||
|
||||
+350
-289
File diff suppressed because it is too large
Load Diff
+95
-79
@@ -32,6 +32,7 @@ import {
|
||||
mkdirpInVault,
|
||||
getFolderLevels,
|
||||
getParentFolder,
|
||||
atWhichLevel,
|
||||
} from "./misc";
|
||||
import { RemoteClient } from "./remote";
|
||||
import {
|
||||
@@ -43,10 +44,9 @@ import {
|
||||
DEFAULT_FILE_NAME_FOR_METADATAONREMOTE2,
|
||||
isEqualMetadataOnRemote,
|
||||
} from "./metadataOnRemote";
|
||||
import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
|
||||
|
||||
import * as origLog from "loglevel";
|
||||
import { padEnd } from "lodash";
|
||||
import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
|
||||
const log = origLog.getLogger("rs-default");
|
||||
|
||||
export type SyncStatusType =
|
||||
@@ -933,6 +933,70 @@ const dispatchOperationToActual = async (
|
||||
}
|
||||
};
|
||||
|
||||
const splitThreeSteps = (syncPlan: SyncPlanType, sortedKeys: string[]) => {
|
||||
const mixedStates = syncPlan.mixedStates;
|
||||
const totalCount = sortedKeys.length || 0;
|
||||
|
||||
const folderCreationOps: FileOrFolderMixedState[][] = [];
|
||||
const deletionOps: FileOrFolderMixedState[][] = [];
|
||||
const uploadDownloads: FileOrFolderMixedState[][] = [];
|
||||
let realTotalCount = 0;
|
||||
|
||||
for (let i = 0; i < sortedKeys.length; ++i) {
|
||||
const key = sortedKeys[i];
|
||||
const val: FileOrFolderMixedState = Object.assign({}, mixedStates[key]); // copy to avoid issue
|
||||
|
||||
if (val.decision === "skipFolder" || val.decision === "skipUploading") {
|
||||
// pass
|
||||
} else if (val.decision === "createFolder") {
|
||||
const level = atWhichLevel(key);
|
||||
if (folderCreationOps[level - 1] === undefined) {
|
||||
folderCreationOps[level - 1] = [val];
|
||||
} else {
|
||||
folderCreationOps[level - 1].push(val);
|
||||
}
|
||||
realTotalCount += 1;
|
||||
} else if (
|
||||
val.decision === "uploadLocalDelHistToRemoteFolder" ||
|
||||
val.decision === "keepRemoteDelHistFolder" ||
|
||||
val.decision === "uploadLocalDelHistToRemote" ||
|
||||
val.decision === "keepRemoteDelHist"
|
||||
) {
|
||||
const level = atWhichLevel(key);
|
||||
if (deletionOps[level - 1] === undefined) {
|
||||
deletionOps[level - 1] = [val];
|
||||
} else {
|
||||
deletionOps[level - 1].push(val);
|
||||
}
|
||||
realTotalCount += 1;
|
||||
} else if (
|
||||
val.decision === "uploadLocalToRemote" ||
|
||||
val.decision === "downloadRemoteToLocal"
|
||||
) {
|
||||
if (uploadDownloads.length === 0) {
|
||||
uploadDownloads[0] = [val];
|
||||
} else {
|
||||
uploadDownloads[0].push(val); // only one level needed here
|
||||
}
|
||||
realTotalCount += 1;
|
||||
} else {
|
||||
throw Error(`unknown decision ${val.decision} for ${key}`);
|
||||
}
|
||||
}
|
||||
|
||||
// the deletionOps should be run from max level to min level
|
||||
// right now it is sorted by level from min to max (NOT length of key!)
|
||||
// so we need to reverse it!
|
||||
deletionOps.reverse(); // inplace reverse
|
||||
|
||||
return {
|
||||
folderCreationOps: folderCreationOps,
|
||||
deletionOps: deletionOps,
|
||||
uploadDownloads: uploadDownloads,
|
||||
realTotalCount: realTotalCount,
|
||||
};
|
||||
};
|
||||
|
||||
export const doActualSync = async (
|
||||
client: RemoteClient,
|
||||
db: InternalDBs,
|
||||
@@ -987,95 +1051,47 @@ export const doActualSync = async (
|
||||
);
|
||||
log.debug(`finished ${key}`);
|
||||
}
|
||||
} else {
|
||||
let realCounter = 0;
|
||||
|
||||
log.debug(
|
||||
`1. create all folders from shadowest to deepest, also check undefined decision`
|
||||
);
|
||||
for (let i = sortedKeys.length - 1; i >= 0; --i) {
|
||||
const key = sortedKeys[i];
|
||||
const val = mixedStates[key];
|
||||
return; // shortcut return, avoid too many nests below
|
||||
}
|
||||
|
||||
if (
|
||||
val.decision === undefined ||
|
||||
val.decision === "skipFolder" ||
|
||||
val.decision === "createFolder"
|
||||
) {
|
||||
log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
|
||||
const { folderCreationOps, deletionOps, uploadDownloads, realTotalCount } =
|
||||
splitThreeSteps(syncPlan, sortedKeys);
|
||||
const nested = [folderCreationOps, deletionOps, uploadDownloads];
|
||||
const logTexts = [
|
||||
`1. create all folders from shadowest to deepest, also check undefined decision`,
|
||||
`2. delete files and folders from deepest to shadowest`,
|
||||
`3. upload or download files in parallel, with the desired concurrency=${concurrency}`,
|
||||
];
|
||||
|
||||
if (callbackSyncProcess !== undefined) {
|
||||
await callbackSyncProcess(realCounter, totalCount, key, val.decision);
|
||||
}
|
||||
realCounter += 1;
|
||||
let realCounter = 0;
|
||||
|
||||
await dispatchOperationToActual(
|
||||
key,
|
||||
vaultRandomID,
|
||||
val,
|
||||
client,
|
||||
db,
|
||||
vault,
|
||||
localDeleteFunc,
|
||||
password
|
||||
);
|
||||
log.debug(`finished ${key}`);
|
||||
for (let i = 0; i < nested.length; ++i) {
|
||||
log.debug(logTexts[i]);
|
||||
|
||||
const operations: FileOrFolderMixedState[][] = nested[i];
|
||||
|
||||
for (let j = 0; j < operations.length; ++j) {
|
||||
const singleLevelOps: FileOrFolderMixedState[] | undefined =
|
||||
operations[j];
|
||||
|
||||
if (singleLevelOps === undefined || singleLevelOps === null) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
log.debug(`2. delete files and folders from deepest to shadowest`);
|
||||
for (let i = 0; i < sortedKeys.length; ++i) {
|
||||
const key = sortedKeys[i];
|
||||
const val = mixedStates[key];
|
||||
if (
|
||||
val.decision === "uploadLocalDelHistToRemoteFolder" ||
|
||||
val.decision === "keepRemoteDelHistFolder" ||
|
||||
val.decision === "uploadLocalDelHistToRemote" ||
|
||||
val.decision === "keepRemoteDelHist"
|
||||
) {
|
||||
log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
|
||||
const queue = new PQueue({ concurrency: concurrency, autoStart: true });
|
||||
|
||||
if (callbackSyncProcess !== undefined) {
|
||||
await callbackSyncProcess(realCounter, totalCount, key, val.decision);
|
||||
}
|
||||
realCounter += 1;
|
||||
for (let k = 0; k < singleLevelOps.length; ++k) {
|
||||
const val: FileOrFolderMixedState = singleLevelOps[k];
|
||||
const key = val.key;
|
||||
|
||||
await dispatchOperationToActual(
|
||||
key,
|
||||
vaultRandomID,
|
||||
val,
|
||||
client,
|
||||
db,
|
||||
vault,
|
||||
localDeleteFunc,
|
||||
password
|
||||
);
|
||||
log.debug(`finished ${key}`);
|
||||
}
|
||||
}
|
||||
|
||||
log.debug(
|
||||
`3. upload or download files in parallel, with the desired concurrency=${concurrency}`
|
||||
);
|
||||
const queue = new PQueue({ concurrency: concurrency, autoStart: true });
|
||||
|
||||
// const commands: any[] = [];
|
||||
|
||||
for (let i = 0; i < sortedKeys.length; ++i) {
|
||||
const key = sortedKeys[i];
|
||||
const val = mixedStates[key];
|
||||
if (
|
||||
val.decision === "skipUploading" ||
|
||||
val.decision === "uploadLocalToRemote" ||
|
||||
val.decision === "downloadRemoteToLocal"
|
||||
) {
|
||||
const fn = async () => {
|
||||
log.debug(`start syncing "${key}" with plan ${JSON.stringify(val)}`);
|
||||
|
||||
if (callbackSyncProcess !== undefined) {
|
||||
await callbackSyncProcess(
|
||||
realCounter,
|
||||
totalCount,
|
||||
realTotalCount,
|
||||
key,
|
||||
val.decision
|
||||
);
|
||||
@@ -1098,8 +1114,8 @@ export const doActualSync = async (
|
||||
};
|
||||
queue.add(fn);
|
||||
}
|
||||
}
|
||||
|
||||
await queue.onIdle();
|
||||
await queue.onIdle();
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
+14
-20
@@ -1,5 +1,6 @@
|
||||
import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
|
||||
import type RemotelySavePlugin from "./main"; // unavoidable
|
||||
import type { TransItemType } from "./i18n";
|
||||
import * as origLog from "loglevel";
|
||||
const log = origLog.getLogger("rs-default");
|
||||
|
||||
@@ -13,40 +14,33 @@ export class SyncAlgoV2Modal extends Modal {
|
||||
}
|
||||
onOpen() {
|
||||
let { contentEl } = this;
|
||||
const t = (x: TransItemType, vars?: any) => {
|
||||
return this.plugin.i18n.t(x, vars);
|
||||
};
|
||||
|
||||
contentEl.createEl("h2", {
|
||||
text: "Remotely Save has a better sync algorithm",
|
||||
text: t("syncalgov2_title"),
|
||||
});
|
||||
|
||||
const texts = [
|
||||
"Welcome to use Remotely Save!",
|
||||
|
||||
"From version 0.3.0, a new algorithm has been developed, but it needs uploading extra meta data files _remotely-save-metadata-on-remote.{json,bin} to YOUR configured cloud destinations, besides your notes.",
|
||||
|
||||
"So that, for example, the second device can know that what files/folders have been deleted on the first device by reading those files.",
|
||||
|
||||
'If you agree, plase click the button "agree", and enjoy the plugin! AND PLEASE REMEMBER TO BACKUP YOUR VAULT FIRSTLY!',
|
||||
|
||||
'If you do not agree, you should stop using the current and later versions of Remotely Save. You could consider manually install the old version 0.2.14 which uses old algorithm and does not upload any extra meta data files. By clicking the "Do not agree" button, the plugin will unload itself, and you need to manually disable it in Obsidian settings.',
|
||||
];
|
||||
|
||||
const ul = contentEl.createEl("ul");
|
||||
|
||||
for (const t of texts) {
|
||||
ul.createEl("li", {
|
||||
text: t,
|
||||
t("syncalgov2_texts")
|
||||
.split("\n")
|
||||
.forEach((val) => {
|
||||
ul.createEl("li", {
|
||||
text: val,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
new Setting(contentEl)
|
||||
.addButton((button) => {
|
||||
button.setButtonText("Agree");
|
||||
button.setButtonText(t("syncalgov2_button_agree"));
|
||||
button.onClick(async () => {
|
||||
this.agree = true;
|
||||
this.close();
|
||||
});
|
||||
})
|
||||
.addButton((button) => {
|
||||
button.setButtonText("Do not agree");
|
||||
button.setButtonText(t("syncalgov2_button_disagree"));
|
||||
button.onClick(() => {
|
||||
this.close();
|
||||
});
|
||||
|
||||
@@ -8,6 +8,8 @@ import {
|
||||
encryptArrayBuffer,
|
||||
encryptStringToBase32,
|
||||
encryptStringToBase64url,
|
||||
getSizeFromEncToOrig,
|
||||
getSizeFromOrigToEnc,
|
||||
} from "../src/encrypt";
|
||||
import { base64ToBase64url, bufferToArrayBuffer } from "../src/misc";
|
||||
|
||||
@@ -110,4 +112,34 @@ describe("Encryption tests", () => {
|
||||
|
||||
expect(Buffer.from(dec).equals(Buffer.from(opensslArrBuf))).to.be.true;
|
||||
});
|
||||
|
||||
it("should get size from origin to encrypted correctly", () => {
|
||||
expect(() => getSizeFromOrigToEnc(-1)).to.throw();
|
||||
expect(() => getSizeFromOrigToEnc(0.5)).to.throw();
|
||||
expect(getSizeFromOrigToEnc(0)).equals(32);
|
||||
expect(getSizeFromOrigToEnc(15)).equals(32);
|
||||
expect(getSizeFromOrigToEnc(16)).equals(48);
|
||||
expect(getSizeFromOrigToEnc(31)).equals(48);
|
||||
expect(getSizeFromOrigToEnc(32)).equals(64);
|
||||
expect(getSizeFromOrigToEnc(14787203)).equals(14787232);
|
||||
});
|
||||
|
||||
it("should get size from encrypted to origin correctly", () => {
|
||||
expect(() => getSizeFromEncToOrig(-1)).to.throw();
|
||||
expect(() => getSizeFromEncToOrig(30)).to.throw();
|
||||
|
||||
expect(getSizeFromEncToOrig(32)).to.deep.equal({
|
||||
minSize: 0,
|
||||
maxSize: 15,
|
||||
});
|
||||
expect(getSizeFromEncToOrig(48)).to.deep.equal({
|
||||
minSize: 16,
|
||||
maxSize: 31,
|
||||
});
|
||||
|
||||
expect(() => getSizeFromEncToOrig(14787231)).to.throw();
|
||||
|
||||
let { minSize, maxSize } = getSizeFromEncToOrig(14787232);
|
||||
expect(minSize <= 14787203 && 14787203 <= maxSize).to.be.true;
|
||||
});
|
||||
});
|
||||
|
||||
@@ -244,3 +244,25 @@ describe("Misc: get split ranges", () => {
|
||||
expect(k).to.deep.equal(k2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Misc: at which level", () => {
|
||||
it("should throw error on some parameters", () => {
|
||||
expect(() => misc.atWhichLevel(undefined)).to.throw();
|
||||
expect(() => misc.atWhichLevel("")).to.throw();
|
||||
expect(() => misc.atWhichLevel("..")).to.throw();
|
||||
expect(() => misc.atWhichLevel(".")).to.throw();
|
||||
expect(() => misc.atWhichLevel("/")).to.throw();
|
||||
expect(() => misc.atWhichLevel("/xxyy")).to.throw();
|
||||
});
|
||||
|
||||
it("should treat folders correctly", () => {
|
||||
expect(misc.atWhichLevel("x/")).to.be.equal(1);
|
||||
expect(misc.atWhichLevel("x/y/")).to.be.equal(2);
|
||||
});
|
||||
|
||||
it("should treat files correctly", () => {
|
||||
expect(misc.atWhichLevel("x.md")).to.be.equal(1);
|
||||
expect(misc.atWhichLevel("x/y.md")).to.be.equal(2);
|
||||
expect(misc.atWhichLevel("x/y/z.md")).to.be.equal(3);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -9,6 +9,7 @@
|
||||
"noImplicitAny": true,
|
||||
"moduleResolution": "node",
|
||||
// "allowSyntheticDefaultImports": true,
|
||||
"resolveJsonModule": true,
|
||||
"esModuleInterop": true,
|
||||
"importHelpers": true,
|
||||
"isolatedModules": true,
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"0.3.2": "0.12.15",
|
||||
"0.3.6": "0.13.21"
|
||||
"0.3.9": "0.13.21"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user