From 06dad54d4ceac0ed0b2343a9e71ed57b09434400 Mon Sep 17 00:00:00 2001 From: fyears <1142836+fyears@users.noreply.github.com> Date: Mon, 27 May 2024 00:33:49 +0800 Subject: [PATCH] pro and smart conflict --- .env.example.txt | 2 + LICENSE | 203 +----------------- README.md | 10 +- esbuild.config.mjs | 5 + manifest-beta.json | 4 +- manifest.json | 4 +- package.json | 8 +- pro/LICENSE | 104 +++++++++ pro/README.md | 21 ++ pro/src/account.ts | 302 +++++++++++++++++++++++++++ pro/src/baseTypesPro.ts | 25 +++ pro/src/conflictLogic.ts | 257 +++++++++++++++++++++++ pro/src/langs/en.json | 39 ++++ pro/src/langs/index.ts | 9 + pro/src/langs/zh_cn.json | 39 ++++ pro/src/langs/zh_tw.json | 39 ++++ pro/src/localdb.ts | 47 +++++ pro/src/settingsPro.ts | 359 ++++++++++++++++++++++++++++++++ pro/tests/conflictLogic.test.ts | 68 ++++++ src/LICENSE | 201 ++++++++++++++++++ src/README.md | 9 + src/baseTypes.ts | 12 +- src/copyLogic.ts | 60 ++++++ src/fsAll.ts | 1 + src/fsDropbox.ts | 19 ++ src/fsEncrypt.ts | 25 +++ src/fsLocal.ts | 5 + src/fsMock.ts | 4 + src/fsOnedrive.ts | 12 ++ src/fsS3.ts | 4 + src/fsWebdav.ts | 29 ++- src/fsWebdis.ts | 9 + src/i18n.ts | 6 +- src/importExport.ts | 1 + src/langs/en.json | 2 +- src/localdb.ts | 7 + src/main.ts | 88 ++++++++ src/misc.ts | 2 +- src/settings.ts | 65 ++++-- src/sync.ts | 310 ++++++++++++++++++--------- styles.css | 15 ++ webpack.config.js | 4 + 42 files changed, 2087 insertions(+), 348 deletions(-) create mode 100644 pro/LICENSE create mode 100644 pro/README.md create mode 100644 pro/src/account.ts create mode 100644 pro/src/baseTypesPro.ts create mode 100644 pro/src/conflictLogic.ts create mode 100644 pro/src/langs/en.json create mode 100644 pro/src/langs/index.ts create mode 100644 pro/src/langs/zh_cn.json create mode 100644 pro/src/langs/zh_tw.json create mode 100644 pro/src/localdb.ts create mode 100644 pro/src/settingsPro.ts create mode 100644 pro/tests/conflictLogic.test.ts create mode 100644 src/LICENSE create mode 100644 src/README.md create mode 100644 src/copyLogic.ts diff --git a/.env.example.txt b/.env.example.txt index 05a634f..af42228 100644 --- a/.env.example.txt +++ b/.env.example.txt @@ -1,3 +1,5 @@ DROPBOX_APP_KEY= ONEDRIVE_CLIENT_ID= ONEDRIVE_AUTHORITY=https:// +REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683 +REMOTELYSAVE_CLIENT_ID=cli-xxx diff --git a/LICENSE b/LICENSE index e72929e..7d5e8f8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,3 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +The codes or files or subfolders inside the folder `src`, `tests`, `docs`, `assets`, are released under the "Open Source" license: "Apache License, version 2.0", described at: https://www.apache.org/licenses/LICENSE-2.0 . - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - \ No newline at end of file +The codes or files or subfolders inside the folder `pro`, are released under the "Source Available" license: "PolyForm Strict License 1.0.0", described at: https://polyformproject.org/licenses/strict/1.0.0/ . diff --git a/README.md b/README.md index 2927d12..1cc3504 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,9 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find - **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination). - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).** - **Skip Large files** and **skip paths** by custom regex conditions! -- **Fully open source under [Apache-2.0 License](./LICENSE).** -- **[Sync Algorithm open](./docs/sync_algorithm/v3/intro.md) for discussion.** -- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** now, more to come! +- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.** +- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Conflict Handling](./pro/README.md)** for PRO version. +- Source Available. See [License](./LICENSE) for details. ## Limitations @@ -131,6 +131,10 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders). +## PRO Features + +See [PRO](./pro/README.md) for more details. + ## How To Debug See [here](./docs/how_to_debug/README.md) for more details. diff --git a/esbuild.config.mjs b/esbuild.config.mjs index cf7aef1..5718a7f 100644 --- a/esbuild.config.mjs +++ b/esbuild.config.mjs @@ -1,3 +1,4 @@ +import "dotenv/config"; import esbuild from "esbuild"; import inlineWorkerPlugin from "esbuild-plugin-inline-worker"; import process from "process"; @@ -16,6 +17,8 @@ const prod = process.argv[2] === "production"; const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || ""; const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || ""; const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || ""; +const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || ""; +const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || ""; esbuild .context({ @@ -51,6 +54,8 @@ esbuild "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`, "process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`, "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`, + "process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`, + "process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`, global: "window", "process.env.NODE_DEBUG": `undefined`, // ugly fix "process.env.DEBUG": `undefined`, // ugly fix diff --git a/manifest-beta.json b/manifest-beta.json index 14ae165..7f3e133 100644 --- a/manifest-beta.json +++ b/manifest-beta.json @@ -1,11 +1,11 @@ { "id": "remotely-save", "name": "Remotely Save", - "version": "0.4.25", + "version": "0.5.1", "minAppVersion": "0.13.21", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "author": "fyears", "authorUrl": "https://github.com/fyears", "isDesktopOnly": false, - "fundingUrl": "https://github.com/remotely-save/donation" + "fundingUrl": "https://remotelysave.com" } diff --git a/manifest.json b/manifest.json index 14ae165..7f3e133 100644 --- a/manifest.json +++ b/manifest.json @@ -1,11 +1,11 @@ { "id": "remotely-save", "name": "Remotely Save", - "version": "0.4.25", + "version": "0.5.1", "minAppVersion": "0.13.21", "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.", "author": "fyears", "authorUrl": "https://github.com/fyears", "isDesktopOnly": false, - "fundingUrl": "https://github.com/remotely-save/donation" + "fundingUrl": "https://remotelysave.com" } diff --git a/package.json b/package.json index 96b48bc..6eb032f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "remotely-save", - "version": "0.4.25", + "version": "0.5.1", "description": "This is yet another sync plugin for Obsidian app.", "scripts": { "dev2": "node esbuild.config.mjs --watch", @@ -9,7 +9,7 @@ "dev": "webpack --mode development --watch", "format": "npx @biomejs/biome check --apply .", "clean": "npx rimraf main.js", - "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'" + "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts' 'pro/tests/**/*.ts'" }, "browser": { "path": "path-browserify", @@ -23,7 +23,7 @@ "source": "main.ts", "keywords": [], "author": "", - "license": "Apache-2.0", + "license": "SEE LICENSE IN LICENSE", "devDependencies": { "@biomejs/biome": "1.7.3", "@microsoft/microsoft-graph-types": "^2.40.0", @@ -63,6 +63,7 @@ "@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", @@ -83,6 +84,7 @@ "mime-types": "^2.1.35", "mustache": "^4.2.0", "nanoid": "^5.0.7", + "node-diff3": "^3.1.2", "p-queue": "^8.0.1", "path-browserify": "^1.0.1", "process": "^0.11.10", diff --git a/pro/LICENSE b/pro/LICENSE new file mode 100644 index 0000000..062a8f0 --- /dev/null +++ b/pro/LICENSE @@ -0,0 +1,104 @@ +# PolyForm Strict License 1.0.0 + + + +## Acceptance + +In order to get any license under these terms, you must agree +to them as both strict obligations and conditions to all +your licenses. + +## Copyright License + +The licensor grants you a copyright license for the software +to do everything you might do with the software that would +otherwise infringe the licensor's copyright in it for any +permitted purpose, other than distributing the software or +making changes or new works based on the software. + +## Patent License + +The licensor grants you a patent license for the software that +covers patent claims the licensor can license, or becomes able +to license, that you would infringe by using the software. + +## Noncommercial Purposes + +Any noncommercial purpose is a permitted purpose. + +## Personal Uses + +Personal use for research, experiment, and testing for +the benefit of public knowledge, personal study, private +entertainment, hobby projects, amateur pursuits, or religious +observance, without any anticipated commercial application, +is use for a permitted purpose. + +## Noncommercial Organizations + +Use by any charitable organization, educational institution, +public research organization, public safety or health +organization, environmental protection organization, +or government institution is use for a permitted purpose +regardless of the source of funding or obligations resulting +from the funding. + +## Fair Use + +You may have "fair use" rights for the software under the +law. These terms do not limit them. + +## No Other Rights + +These terms do not allow you to sublicense or transfer any of +your licenses to anyone else, or prevent the licensor from +granting licenses to anyone else. These terms do not imply +any other licenses. + +## Patent Defense + +If you make any written claim that the software infringes or +contributes to infringement of any patent, your patent license +for the software granted under these terms ends immediately. If +your company makes such a claim, your patent license ends +immediately for work on behalf of your company. + +## Violations + +The first time you are notified in writing that you have +violated any of these terms, or done anything with the software +not covered by your licenses, your licenses can nonetheless +continue if you come into full compliance with these terms, +and take practical steps to correct past violations, within +32 days of receiving notice. Otherwise, all your licenses +end immediately. + +## No Liability + +***As far as the law allows, the software comes as is, without +any warranty or condition, and the licensor will not be liable +to you for any damages arising out of these terms or the use +or nature of the software, under any kind of legal claim.*** + +## Definitions + +The **licensor** is the individual or entity offering these +terms, and the **software** is the software the licensor makes +available under these terms. + +**You** refers to the individual or entity agreeing to these +terms. + +**Your company** is any legal entity, sole proprietorship, +or other kind of organization that you work for, plus all +organizations that have control over, are under the control of, +or are under common control with that organization. **Control** +means ownership of substantially all the assets of an entity, +or the power to direct its management and policies by vote, +contract, or otherwise. Control can be direct or indirect. + +**Your licenses** are all the licenses granted to you for the +software under these terms. + +**Use** means anything you do with the software requiring one +of your licenses. diff --git a/pro/README.md b/pro/README.md new file mode 100644 index 0000000..f0690b4 --- /dev/null +++ b/pro/README.md @@ -0,0 +1,21 @@ +# Pro Features + +## What? + +Remotely Save has some "pro features", which users have to pay for using them. + +## Sign Up / Sign In + +Please go to to sign up and sign in an account firstly. + +## Smart Conflict + +Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files. + +PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files. + +## License + +The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0". + +Suggestions are welcome. diff --git a/pro/src/account.ts b/pro/src/account.ts new file mode 100644 index 0000000..3ab2db3 --- /dev/null +++ b/pro/src/account.ts @@ -0,0 +1,302 @@ +import { nanoid } from "nanoid"; +import { base64url } from "rfc4648"; +import { + OAUTH2_FORCE_EXPIRE_MILLISECONDS, + type RemotelySavePluginSettings, +} from "../../src/baseTypes"; +import { + COMMAND_CALLBACK_PRO, + type FeatureInfo, + PRO_CLIENT_ID, + type PRO_FEATURE_TYPE, + PRO_WEBSITE, + type ProConfig, +} from "./baseTypesPro"; + +const site = PRO_WEBSITE; +console.debug(`remotelysave official website: ${site}`); + +export const DEFAULT_PRO_CONFIG: ProConfig = { + accessToken: "", + accessTokenExpiresInMs: 0, + accessTokenExpiresAtTimeMs: 0, + refreshToken: "", + enabledProFeatures: [], + email: "", +}; + +/** + * https://datatracker.ietf.org/doc/html/rfc7636 + * dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk + * => E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM + * @param x + * @returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) + */ +async function codeVerifier2CodeChallenge(x: string) { + if (x === undefined || x === "") { + return ""; + } + try { + return base64url.stringify( + new Uint8Array( + await crypto.subtle.digest("SHA-256", new TextEncoder().encode(x)) + ), + { + pad: false, + } + ); + } catch (e) { + return ""; + } +} + +export const generateAuthUrlAndCodeVerifierChallenge = async ( + hasCallback: boolean +) => { + const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code + const codeVerifier = nanoid(128); + const codeChallenge = await codeVerifier2CodeChallenge(codeVerifier); + let authUrl = `${site}/oauth2/authorize?response_type=code&client_id=${appKey}&token_access_type=offline&code_challenge_method=S256&code_challenge=${codeChallenge}&scope=pro.list.read`; + if (hasCallback) { + authUrl += `&redirect_uri=obsidian://${COMMAND_CALLBACK_PRO}`; + } + return { + authUrl, + codeVerifier, + codeChallenge, + }; +}; + +export const sendAuthReq = async ( + verifier: string, + authCode: string, + errorCallBack: any +) => { + const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code + try { + const k = { + code: authCode, + grant_type: "authorization_code", + code_verifier: verifier, + client_id: appKey, + // redirect_uri: `obsidian://${COMMAND_CALLBACK_PRO}`, + scope: "pro.list.read", + }; + // console.debug(k); + const resp1 = await fetch(`${site}/api/v1/oauth2/token`, { + method: "POST", + body: new URLSearchParams(k), + }); + const resp2 = await resp1.json(); + return resp2; + } catch (e) { + console.error(e); + if (errorCallBack !== undefined) { + await errorCallBack(e); + } + } +}; + +export const sendRefreshTokenReq = async (refreshToken: string) => { + const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code + try { + console.info("start auto getting refreshed Remotely Save access token."); + const resp1 = await fetch(`${site}/api/v1/oauth2/token`, { + method: "POST", + body: new URLSearchParams({ + grant_type: "refresh_token", + refresh_token: refreshToken, + client_id: appKey, + scope: "pro.list.read", + }), + }); + const resp2: AuthResError | AuthResSucc = await resp1.json(); + console.info("finish auto getting refreshed Remotely Save access token."); + return resp2; + } catch (e) { + console.error(e); + throw e; + } +}; + +interface AuthResError { + error: "invalid_request"; +} + +interface AuthResSucc { + error: undefined; // needed for typescript + refresh_token?: string; + access_token: string; + expires_in: number; +} + +export const setConfigBySuccessfullAuthInplace = async ( + config: ProConfig, + authRes: AuthResError | AuthResSucc, + saveUpdatedConfigFunc: () => Promise | undefined +) => { + if (authRes.error !== undefined) { + throw Error(`you should not save the setting for ${authRes.error}`); + } + + config.accessToken = authRes.access_token; + config.accessTokenExpiresAtTimeMs = + Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000; + config.accessTokenExpiresInMs = authRes.expires_in * 1000; + config.refreshToken = authRes.refresh_token || config.refreshToken; + + // manually set it expired after 80 days; + config.credentialsShouldBeDeletedAtTimeMs = + Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS; + + await saveUpdatedConfigFunc?.(); + + console.info( + "finish updating local info of Remotely Save official website token" + ); +}; + +export const getAccessToken = async ( + config: ProConfig, + saveUpdatedConfigFunc: () => Promise | undefined +) => { + const ts = Date.now(); + if ( + config.accessToken !== undefined && + config.accessToken !== "" && + config.accessTokenExpiresAtTimeMs > ts && + (config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts + ) { + return config.accessToken; + } + + console.debug( + `currently, accessToken=${config.accessToken}, accessTokenExpiresAtTimeMs=${ + config.accessTokenExpiresAtTimeMs + }, credentialsShouldBeDeletedAtTimeMs=${ + config.credentialsShouldBeDeletedAtTimeMs + },comp1=${config.accessTokenExpiresAtTimeMs > ts}, comp2=${ + (config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts + }` + ); + + // try to get it again?? + const res = await sendRefreshTokenReq(config.refreshToken ?? "refresh-"); + await setConfigBySuccessfullAuthInplace(config, res, saveUpdatedConfigFunc); + + if (res.error !== undefined) { + throw Error("cannot update accessToken"); + } + return res.access_token; +}; + +export const getAndSaveProFeatures = async ( + config: ProConfig, + pluginVersion: string, + saveUpdatedConfigFunc: () => Promise | undefined +) => { + const access = await getAccessToken(config, saveUpdatedConfigFunc); + + const resp1 = await fetch(`${site}/api/v1/pro/list`, { + method: "GET", + headers: { + Authorization: `Bearer ${access}`, + "REMOTELYSAVE-API-Plugin-Ver": pluginVersion, + }, + }); + const rsp2: { + proFeatures: FeatureInfo[]; + } = await resp1.json(); + + config.enabledProFeatures = rsp2.proFeatures; + await saveUpdatedConfigFunc?.(); + return rsp2; +}; + +export const getAndSaveProEmail = async ( + config: ProConfig, + pluginVersion: string, + saveUpdatedConfigFunc: () => Promise | undefined +) => { + const access = await getAccessToken(config, saveUpdatedConfigFunc); + + const resp1 = await fetch(`${site}/api/v1/profile/list`, { + method: "GET", + headers: { + Authorization: `Bearer ${access}`, + "REMOTELYSAVE-API-Plugin-Ver": pluginVersion, + }, + }); + const rsp2: { + email: string; + } = await resp1.json(); + + config.email = rsp2.email; + await saveUpdatedConfigFunc?.(); + return rsp2; +}; + +/** + * If the check doesn't pass, the function should throw the error + * @returns + */ +export const checkProRunnableAndFixInplace = async ( + featuresToCheck: PRO_FEATURE_TYPE[], + config: RemotelySavePluginSettings, + pluginVersion: string, + saveUpdatedConfigFunc: () => Promise | undefined +): Promise => { + // if no pro features are used, we are good to go, no checking + if ( + featuresToCheck.contains("feature-smart_conflict") && + config.conflictAction !== "smart_conflict" + ) { + return true; + } + + // many checks if status is valid + + // no account + if (config.pro === undefined || config.pro.refreshToken === undefined) { + throw Error(`you need to "connect" to your account to use PRO features`); + } + + // every features should have at most 40 days expiration dates + // and if the time has expired, we also check + const msIn40Days = 1000 * 60 * 60 * 24 * 40; + for (const f of config.pro.enabledProFeatures) { + const tooFarInTheFuture = f.expireAtTimeMs >= Date.now() + msIn40Days; + const alreadyExpired = f.expireAtTimeMs <= Date.now(); + if (tooFarInTheFuture || alreadyExpired) { + console.info( + `the pro feature is too far in the future and has expired, check again.` + ); + await getAndSaveProFeatures( + config.pro, + pluginVersion, + saveUpdatedConfigFunc + ); + break; + } + } + + // check for the features + if (featuresToCheck.contains("feature-smart_conflict")) { + if (config.conflictAction === "smart_conflict") { + if ( + config.pro.enabledProFeatures.filter( + (x) => x.featureName === "feature-smart_conflict" + ).length === 1 + ) { + return true; + } else { + throw Error( + `You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.` + ); + } + } else { + return true; + } + } + return true; +}; diff --git a/pro/src/baseTypesPro.ts b/pro/src/baseTypesPro.ts new file mode 100644 index 0000000..7f8ae63 --- /dev/null +++ b/pro/src/baseTypesPro.ts @@ -0,0 +1,25 @@ +export const MERGABLE_SIZE = 1000 * 1000; // 1 MB + +export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro"; +export const PRO_CLIENT_ID = process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID; +export const PRO_WEBSITE = process.env.DEFAULT_REMOTELYSAVE_WEBSITE; + +export type PRO_FEATURE_TYPE = + | "feature-smart_conflict" + | "feature-google_drive"; + +export interface FeatureInfo { + featureName: PRO_FEATURE_TYPE; + enableAtTimeMs: bigint; + expireAtTimeMs: bigint; +} + +export interface ProConfig { + email?: string; + refreshToken?: string; + accessToken: string; + accessTokenExpiresInMs: number; + accessTokenExpiresAtTimeMs: number; + enabledProFeatures: FeatureInfo[]; + credentialsShouldBeDeletedAtTimeMs?: number; +} diff --git a/pro/src/conflictLogic.ts b/pro/src/conflictLogic.ts new file mode 100644 index 0000000..c19a7a7 --- /dev/null +++ b/pro/src/conflictLogic.ts @@ -0,0 +1,257 @@ +import isEqual from "lodash/isEqual"; +// import { +// makePatches, +// applyPatches, +// stringifyPatches, +// parsePatch, +// } from "@sanity/diff-match-patch"; +import { + LCS, + diff3Merge, + diffComm, + diffPatch, + mergeDiff3, + mergeDigIn, + patch, +} from "node-diff3"; +import type { Entity } from "../../src/baseTypes"; +import { copyFile } from "../../src/copyLogic"; +import type { FakeFs } from "../../src/fsAll"; +import { MERGABLE_SIZE } from "./baseTypesPro"; + +export function isMergable(a: Entity, b?: Entity) { + if (b !== undefined && a.keyRaw !== b.keyRaw) { + return false; + } + + return ( + !a.keyRaw.endsWith("/") && + a.sizeRaw <= MERGABLE_SIZE && + (a.keyRaw.endsWith(".md") || a.keyRaw.endsWith(".markdown")) + ); +} + +/** + * slightly modify to adjust in markdown context + * @param a + * @param o + * @param b + */ +function mergeDigInModified(a: string, o: string, b: string) { + const { conflict, result } = mergeDigIn(a, o, b); + for (let index = 0; index < result.length; ++index) { + if (["<<<<<<<", "=======", ">>>>>>>"].contains(result[index])) { + result[index] = "`" + result[index] + "`"; + } + } + return { + conflict, + result, + }; +} + +function getLCSText(a: string, b: string) { + const aa = a.split("\n"); + const bb = b.split("\n"); + let raw = LCS(aa, bb); + + const k: string[] = []; + + do { + k.unshift(aa[raw.buffer1index]); + + raw = raw.chain as any; + } while (raw !== null && raw !== undefined && raw.buffer1index !== -1); + + return k.join("\n"); +} + +/** + * It's tricky. We find LCS then pretend it's the original text + * @param a + * @param b + * @returns + */ +function twoWayMerge(a: string, b: string): string { + // const c = getLCSText(a, b); + // const patches = makePatches(c, a); + // const [d] = applyPatches(patches, b); + const c = getLCSText(a, b); + const d = mergeDigInModified(a, c, b).result.join("\n"); + return d; +} + +/** + * Originally three way merge. + * @param a + * @param b + * @param orig + * @returns + */ +function threeWayMerge(a: string, b: string, orig: string) { + return mergeDigInModified(a, orig, b).result.join("\n"); +} + +export async function mergeFile( + key: string, + left: FakeFs, + right: FakeFs, + contentOrig: ArrayBuffer | null | undefined +) { + // console.debug( + // `mergeFile: key=${key}, left=${left.kind}, right=${right.kind}` + // ); + if (key.endsWith("/")) { + throw Error(`should not call ${key} in mergeFile`); + } + + if (!key.endsWith(".md") && !key.endsWith(".markdown")) { + throw Error(`currently only support markdown files in mergeFile`); + } + + const [contentLeft, contentRight] = await Promise.all([ + left.readFile(key), + right.readFile(key), + ]); + + let newArrayBuffer: ArrayBuffer | undefined = undefined; + const decoder = new TextDecoder("utf-8"); + + if (isEqual(contentLeft, contentRight)) { + // we are lucky enough + newArrayBuffer = contentLeft; + // TODO: save the write + } else { + if (contentOrig === null || contentOrig === undefined) { + const newText = twoWayMerge( + decoder.decode(contentLeft), + decoder.decode(contentRight) + ); + // no need to worry about the offset here because the array is new and not sliced + newArrayBuffer = new TextEncoder().encode(newText).buffer; + } else { + const newText = threeWayMerge( + decoder.decode(contentLeft), + decoder.decode(contentRight), + decoder.decode(contentOrig) + ); + newArrayBuffer = new TextEncoder().encode(newText).buffer; + } + } + + const mtime = Date.now(); + + // left (local) must wait for the right + // because the mtime might be different after upload + // upload firstly + const rightEntity = await right.writeFile(key, newArrayBuffer, mtime, mtime); + // write local secondly + const leftEntity = await left.writeFile( + key, + newArrayBuffer, + rightEntity.mtimeCli ?? mtime, + rightEntity.mtimeCli ?? mtime + ); + + return { + entity: rightEntity, + content: newArrayBuffer, + }; +} + +export function getFileRename(key: string) { + if ( + key === "" || + key === "." || + key === ".." || + key === "/" || + key.endsWith("/") + ) { + throw Error(`we cannot rename key=${key}`); + } + + const segsPath = key.split("/"); + const name = segsPath[segsPath.length - 1]; + const segsName = name.split("."); + + if (segsName.length === 0) { + throw Error(`we cannot rename key=${key}`); + } else if (segsName.length === 1) { + // name = "kkk" without any dot + segsPath[segsPath.length - 1] = `${name}.dup`; + } else if (segsName.length === 2) { + if (segsName[0] === "") { + // name = ".kkkk" with leading dot + segsPath[segsPath.length - 1] = `${name}.dup`; + } else if (segsName[1] === "") { + // name = "kkkk." with tailing dot + segsPath[segsPath.length - 1] = `${segsName[0]}.dup`; + } else { + // name = "aaa.bbb" normally + segsPath[segsPath.length - 1] = `${segsName[0]}.dup.${segsName[1]}`; + } + } else { + // name = "[...].bbb.ccc" + const firstPart = segsName.slice(0, segsName.length - 1).join("."); + const thirdPart = segsName[segsName.length - 1]; + segsPath[segsPath.length - 1] = `${firstPart}.dup.${thirdPart}`; + } + const res = segsPath.join("/"); + return res; +} + +/** + * local: x.md -> x.dup.md -> upload to remote + * remote: x.md -> download to local -> using original name x.md + */ +export async function duplicateFile( + key: string, + left: FakeFs, + right: FakeFs, + uploadCallback: (entity: Entity) => Promise, + downloadCallback: (entity: Entity) => Promise +) { + let key2 = getFileRename(key); + let usable = false; + do { + try { + const s = await left.stat(key2); + if (s === null || s === undefined) { + throw Error(`not exist $${key2}`); + } + console.debug(`key2=${key2} exists, cannot use for new file`); + key2 = getFileRename(key2); + console.debug(`key2=${key2} is prepared for next try`); + } catch (e) { + // not exists, exactly what we want + console.debug(`key2=${key2} doesn't exist, usable for new file`); + usable = true; + } + } while (!usable); + await left.rename(key, key2); + + /** + * x.dup.md -> upload to remote + */ + async function f1() { + const k = await copyFile(key2, left, right); + await uploadCallback(k.entity); + return k.entity; + } + + /** + * x.md -> download to local + */ + async function f2() { + const k = await copyFile(key, right, left); + await downloadCallback(k.entity); + return k.entity; + } + + const [resUpload, resDownload] = await Promise.all([f1(), f2()]); + + return { + upload: resUpload, + download: resDownload, + }; +} diff --git a/pro/src/langs/en.json b/pro/src/langs/en.json new file mode 100644 index 0000000..99e6902 --- /dev/null +++ b/pro/src/langs/en.json @@ -0,0 +1,39 @@ +{ + "settings_conflictaction_smart_conflict": "Smart Conflict (PRO) (beta)", + "settings_conflictaction_smart_conflict_desc": "

!!It's a PRO feature! You need an online account for this feature!!(scroll down for more info about PRO account.)

  • For small markdown files, the plugin tries to merge them with diff3 algorithm.
  • For large files or not-markdown files, the plugin saves both files by renaming them.

Please manually backup your vaule before using this feature!

", + + "protocol_pro_connecting": "Connectting", + "protocol_pro_connect_manualinput_succ": "You've connected", + "protocol_pro_connect_fail": "Something went wrong from response from Remotely Save official website. Maybe the network connection is not good. Maybe you rejected the auth?", + "protocol_pro_connect_succ_revoke": "You've connected as user {{email}}. If you want to disconnect, click this button.", + + "modal_prorevokeauth": "Revoke auth by clicking here and follow the steps.", + "modal_prorevokeauth_clean": "Clean", + "modal_prorevokeauth_clean_desc": "Clean local auth record", + "modal_prorevokeauth_clean_button": "Clean", + "modal_prorevokeauth_clean_notice": "Local auth record is cleaned", + "modal_prorevokeauth_clean_fail": "Fail to clean local auth record.", + "modal_proauth_copybutton": "Click to copy the auth url", + "modal_proauth_copynotice": "The auth url is copied to the clipboard!", + "modal_proauth_maualinput": "The Code from the website", + "modal_proauth_maualinput_desc": "Please input the code here from the end of auth flow, and press confirm.", + "modal_proauth_maualinput_notice": "Trying to connect, wait...", + "modal_proauth_maualinput_conn_fail": "Failed to connect", + + "settings_pro": "Account (for PRO features)", + "settings_pro_tutorial": "

Using basic features of Remotely Save is FREE and do NOT need an account.

However, you will need an online account and PAY for the PRO features such as smart conflict.

Firstly please click the button to sign up and sign in to the website: https://remotelysave.com. Notice: It's different from, and NOT affiliated with Obsidian account.

Secondly please \"connect\" your local device to your online account.", + "settings_pro_features": "Features", + "settings_pro_features_desc": "Here are features you've enabled:
{{{features}}}", + "settings_pro_features_refresh_button": "Check again", + "settings_pro_features_refresh_fetch": "Fetching...", + "settings_pro_features_refresh_succ": "Refreshed!", + "settings_pro_revoke": "Disconnect", + "settings_pro_revoke_desc": "You've connected as user {{email}}. If you want to disconnect, click this button.", + "settings_pro_revoke_button": "Disconnect", + "settings_pro_intro": "Remotely Save Online Account", + "settings_pro_intro_desc": "Click the button to jump to the website to sign up or sign in.", + "settings_pro_intro_button": "Sign Up / Sign In", + "settings_pro_auth": "Connect", + "settings_pro_auth_desc": "After you sign up and sign in the account on the website, you need to connect your plugin here to the online account. Please click the button to connect.", + "settings_pro_auth_button": "Connect" +} diff --git a/pro/src/langs/index.ts b/pro/src/langs/index.ts new file mode 100644 index 0000000..5c091b4 --- /dev/null +++ b/pro/src/langs/index.ts @@ -0,0 +1,9 @@ +import en from "./en.json"; +import zh_cn from "./zh_cn.json"; +import zh_tw from "./zh_tw.json"; + +export const LANGS = { + en: en, + zh_cn: zh_cn, + zh_tw: zh_tw, +}; diff --git a/pro/src/langs/zh_cn.json b/pro/src/langs/zh_cn.json new file mode 100644 index 0000000..1a79e64 --- /dev/null +++ b/pro/src/langs/zh_cn.json @@ -0,0 +1,39 @@ +{ + "settings_conflictaction_smart_conflict": "智能处理冲突 (PRO) (beta)", + "settings_conflictaction_smart_conflict_desc": "

！！这是 PRO（付费）功能! 您需要在线账号来使用此功能！！（向下滑可以看到 PRO 账号的更多信息。）

  • 小 markdown 文件，本插件尝试使用 diff3 算法合并它；
  • 对于大文件或非 markdown 文件，本插件尝试改名字并均进行保存。

请注意先手动备份 vault 文件再用此功能！

", + + "protocol_pro_connecting": "正在连接", + "protocol_pro_connect_manualinput_succ": "连接成功", + "protocol_pro_connect_fail": "Remotely Save 官网返回错误。可能是网络连接不稳定。也可能是您拒绝了授权？", + "protocol_pro_connect_succ_revoke": "您已连接上账号 {{email}}。如果要取消连接，请点击此按钮。", + + "modal_prorevokeauth": "点击这里和按照步骤取消授权。", + "modal_prorevokeauth_clean": "清理", + "modal_prorevokeauth_clean_desc": "清理本地授权记录", + "modal_prorevokeauth_clean_button": "清理", + "modal_prorevokeauth_clean_notice": "清理本地授权记录完毕", + "modal_prorevokeauth_clean_fail": "清理本地授权记录粗错。", + "modal_proauth_copybutton": "点击从而复制授权网址", + "modal_proauth_copynotice": "授权网址已复制！", + "modal_proauth_maualinput": "网站的授权码", + "modal_proauth_maualinput_desc": "请输入授权流程最后一步的授权码，然后点击确认。", + "modal_proauth_maualinput_notice": "正在连接，请稍候......", + "modal_proauth_maualinput_conn_fail": "连接失败", + + "settings_pro": "账号（PRO 付费功能）", + "settings_pro_tutorial": "

使用 Remotely Save 的基本功能是免费的，而且不需要注册对应账号。

但是，您需要注册账号和对PRO功能付费使用，如智能处理冲突功能。

第一步：点击按钮从而注册和登录网站：https://remotelysave.com。注意：这和 Obsidian 官方账号无关，是不同的账号。

第二部：点击“连接”按钮，从而连接本设备和在线账号。", + "settings_pro_features": "功能", + "settings_pro_features_desc": "您开通了以下功能：
{{{features}}}", + "settings_pro_features_refresh_button": "再次检查", + "settings_pro_features_refresh_fetch": "正在获取数据......", + "settings_pro_features_refresh_succ": "已刷新！", + "settings_pro_revoke": "断开连接", + "settings_pro_revoke_desc": "您已连接上账号 {{email}}。如果要取消连接，请点击此按钮。", + "settings_pro_revoke_button": "断开连接", + "settings_pro_intro": "Remotely Save 账号", + "settings_pro_intro_desc": "点击此按钮，从而到网站上注册和登录。", + "settings_pro_intro_button": "注册或登录", + "settings_pro_auth": "连接", + "settings_pro_auth_desc": "在网站上注册和登录后，您需要“连接”本设备和在线账号。请点击按钮开始连接。", + "settings_pro_auth_button": "连接" +} diff --git a/pro/src/langs/zh_tw.json b/pro/src/langs/zh_tw.json new file mode 100644 index 0000000..ef8a885 --- /dev/null +++ b/pro/src/langs/zh_tw.json @@ -0,0 +1,39 @@ +{ + "settings_conflictaction_smart_conflict": "智慧處理衝突 (PRO) (beta)", + "settings_conflictaction_smart_conflict_desc": "

！！這是 PRO（付費）功能! 您需要線上賬號來使用此功能！！（向下滑可以看到 PRO 賬號的更多資訊。）

  • 小 markdown 檔案，本外掛嘗試使用 diff3 演算法合併它；
  • 對於大檔案或非 markdown 檔案，本外掛嘗試改名字並均進行儲存。

請注意先手動備份 vault 檔案再用此功能！

", + + "protocol_pro_connecting": "正在連線", + "protocol_pro_connect_manualinput_succ": "連線成功", + "protocol_pro_connect_fail": "Remotely Save 官網返回錯誤。可能是網路連線不穩定。也可能是您拒絕了授權？", + "protocol_pro_connect_succ_revoke": "您已連線上賬號 {{email}}。如果要取消連線，請點選此按鈕。", + + "modal_prorevokeauth": "點選這裡和按照步驟取消授權。", + "modal_prorevokeauth_clean": "清理", + "modal_prorevokeauth_clean_desc": "清理本地授權記錄", + "modal_prorevokeauth_clean_button": "清理", + "modal_prorevokeauth_clean_notice": "清理本地授權記錄完畢", + "modal_prorevokeauth_clean_fail": "清理本地授權記錄粗錯。", + "modal_proauth_copybutton": "點選從而複製授權網址", + "modal_proauth_copynotice": "授權網址已複製！", + "modal_proauth_maualinput": "網站的授權碼", + "modal_proauth_maualinput_desc": "請輸入授權流程最後一步的授權碼，然後點選確認。", + "modal_proauth_maualinput_notice": "正在連線，請稍候......", + "modal_proauth_maualinput_conn_fail": "連線失敗", + + "settings_pro": "賬號（PRO 付費功能）", + "settings_pro_tutorial": "

使用 Remotely Save 的基本功能是免費的，而且不需要註冊對應賬號。

但是，您需要註冊賬號和對PRO功能付費使用，如智慧處理衝突功能。

第一步：點選按鈕從而註冊和登入網站：https://remotelysave.com。注意：這和 Obsidian 官方賬號無關，是不同的賬號。

第二部：點選“連線”按鈕，從而連線本裝置和線上賬號。", + "settings_pro_features": "功能", + "settings_pro_features_desc": "您開通了以下功能：
{{{features}}}", + "settings_pro_features_refresh_button": "再次檢查", + "settings_pro_features_refresh_fetch": "正在獲取資料......", + "settings_pro_features_refresh_succ": "已重新整理！", + "settings_pro_revoke": "斷開連線", + "settings_pro_revoke_desc": "您已連線上賬號 {{email}}。如果要取消連線，請點選此按鈕。", + "settings_pro_revoke_button": "斷開連線", + "settings_pro_intro": "Remotely Save 賬號", + "settings_pro_intro_desc": "點選此按鈕，從而到網站上註冊和登入。", + "settings_pro_intro_button": "註冊或登入", + "settings_pro_auth": "連線", + "settings_pro_auth_desc": "在網站上註冊和登入後，您需要“連線”本裝置和線上賬號。請點選按鈕開始連線。", + "settings_pro_auth_button": "連線" +} diff --git a/pro/src/localdb.ts b/pro/src/localdb.ts new file mode 100644 index 0000000..aecb538 --- /dev/null +++ b/pro/src/localdb.ts @@ -0,0 +1,47 @@ +import type { Entity } from "../../src/baseTypes"; +import type { InternalDBs } from "../../src/localdb"; + +export const upsertFileContentHistoryByVaultAndProfile = async ( + db: InternalDBs, + vaultRandomID: string, + profileID: string, + prevSync: Entity, + prevContent: ArrayBuffer +) => { + await db.fileContentHistoryTbl.setItem( + `${vaultRandomID}\t${profileID}\t${prevSync.key}`, + prevContent + ); +}; + +export const getFileContentHistoryByVaultAndProfile = async ( + db: InternalDBs, + vaultRandomID: string, + profileID: string, + prevSync: Entity +) => { + return (await db.fileContentHistoryTbl.getItem( + `${vaultRandomID}\t${profileID}\t${prevSync.key}` + )) as ArrayBuffer | null | undefined; +}; + +export const clearFileContentHistoryByVaultAndProfile = async ( + db: InternalDBs, + vaultRandomID: string, + profileID: string, + key: string +) => { + await db.fileContentHistoryTbl.removeItem( + `${vaultRandomID}\t${profileID}\t${key}` + ); +}; + +export const clearAllFileContentHistoryByVault = async ( + db: InternalDBs, + vaultRandomID: string +) => { + const keys = (await db.fileContentHistoryTbl.keys()).filter((x) => + x.startsWith(`${vaultRandomID}\t`) + ); + await db.fileContentHistoryTbl.removeItems(keys); +}; diff --git a/pro/src/settingsPro.ts b/pro/src/settingsPro.ts new file mode 100644 index 0000000..e79bc66 --- /dev/null +++ b/pro/src/settingsPro.ts @@ -0,0 +1,359 @@ +import cloneDeep from "lodash/cloneDeep"; +import { type App, Modal, Notice, Setting } from "obsidian"; +import { features } from "process"; +import type { TransItemType } from "../../src/i18n"; +import type RemotelySavePlugin from "../../src/main"; +import { stringToFragment } from "../../src/misc"; +import { + DEFAULT_PRO_CONFIG, + generateAuthUrlAndCodeVerifierChallenge, + getAndSaveProEmail, + getAndSaveProFeatures, + sendAuthReq, + setConfigBySuccessfullAuthInplace, +} from "./account"; +import { + type FeatureInfo, + PRO_CLIENT_ID, + type ProConfig, +} from "./baseTypesPro"; + +export class ProAuthModal extends Modal { + readonly plugin: RemotelySavePlugin; + readonly authDiv: HTMLDivElement; + readonly revokeAuthDiv: HTMLDivElement; + readonly revokeAuthSetting: Setting; + readonly proFeaturesListSetting: Setting; + readonly t: (x: TransItemType, vars?: any) => string; + constructor( + app: App, + plugin: RemotelySavePlugin, + authDiv: HTMLDivElement, + revokeAuthDiv: HTMLDivElement, + revokeAuthSetting: Setting, + proFeaturesListSetting: Setting, + t: (x: TransItemType, vars?: any) => string + ) { + super(app); + this.plugin = plugin; + this.authDiv = authDiv; + this.revokeAuthDiv = revokeAuthDiv; + this.revokeAuthSetting = revokeAuthSetting; + this.proFeaturesListSetting = proFeaturesListSetting; + this.t = t; + } + + async onOpen() { + const { contentEl } = this; + + const { authUrl, codeVerifier, codeChallenge } = + await generateAuthUrlAndCodeVerifierChallenge(false); + this.plugin.oauth2Info.verifier = codeVerifier; + + const t = this.t; + + const div2 = contentEl.createDiv(); + div2.createEl( + "button", + { + text: t("modal_proauth_copybutton"), + }, + (el) => { + el.onclick = async () => { + await navigator.clipboard.writeText(authUrl); + new Notice(t("modal_proauth_copynotice")); + }; + } + ); + + contentEl.createEl("p").createEl("a", { + href: authUrl, + text: authUrl, + }); + + // manual paste + let authCode = ""; + new Setting(contentEl) + .setName(t("modal_proauth_maualinput")) + .setDesc(t("modal_proauth_maualinput_desc")) + .addText((text) => + text + .setPlaceholder("") + .setValue("") + .onChange((val) => { + authCode = val.trim(); + }) + ) + .addButton(async (button) => { + button.setButtonText(t("submit")); + button.onClick(async () => { + new Notice(t("modal_proauth_maualinput_notice")); + try { + const authRes = await sendAuthReq( + codeVerifier ?? "verifier", + authCode, + async (e: any) => { + new Notice(t("protocol_pro_connect_fail")); + new Notice(`${e}`); + throw e; + } + ); + console.debug(authRes); + const self = this; + setConfigBySuccessfullAuthInplace( + this.plugin.settings.pro!, + authRes!, + () => self.plugin.saveSettings() + ); + await getAndSaveProFeatures( + this.plugin.settings.pro!, + this.plugin.manifest.version, + () => self.plugin.saveSettings() + ); + this.proFeaturesListSetting.setDesc( + stringToFragment( + t("settings_pro_features_desc", { + features: featureListToText( + this.plugin.settings.pro!.enabledProFeatures + ), + }) + ) + ); + await getAndSaveProEmail( + this.plugin.settings.pro!, + this.plugin.manifest.version, + () => self.plugin.saveSettings() + ); + + new Notice( + t("protocol_pro_connect_manualinput_succ", { + email: this.plugin.settings.pro!.email ?? "(no email)", + }) + ); + + this.plugin.oauth2Info.verifier = ""; // reset it + this.plugin.oauth2Info.authDiv?.toggleClass( + "pro-auth-button-hide", + this.plugin.settings.pro?.refreshToken !== "" + ); + this.plugin.oauth2Info.authDiv = undefined; + + this.plugin.oauth2Info.revokeAuthSetting?.setDesc( + t("protocol_pro_connect_succ_revoke", { + email: this.plugin.settings.pro?.email, + }) + ); + this.plugin.oauth2Info.revokeAuthSetting = undefined; + this.plugin.oauth2Info.revokeDiv?.toggleClass( + "pro-revoke-auth-button-hide", + this.plugin.settings.pro?.email === "" + ); + this.plugin.oauth2Info.revokeDiv = undefined; + + this.close(); + } catch (err) { + console.error(err); + new Notice(t("modal_proauth_maualinput_conn_fail")); + } + }); + }); + } + + onClose() { + const { contentEl } = this; + contentEl.empty(); + } +} + +export class ProRevokeAuthModal extends Modal { + readonly plugin: RemotelySavePlugin; + readonly authDiv: HTMLDivElement; + readonly revokeAuthDiv: HTMLDivElement; + readonly t: (x: TransItemType, vars?: any) => string; + constructor( + app: App, + plugin: RemotelySavePlugin, + authDiv: HTMLDivElement, + revokeAuthDiv: HTMLDivElement, + t: (x: TransItemType, vars?: any) => string + ) { + super(app); + this.plugin = plugin; + this.authDiv = authDiv; + this.revokeAuthDiv = revokeAuthDiv; + this.t = t; + } + + async onOpen() { + const { contentEl } = this; + const t = this.t; + + contentEl.createEl("p", { + text: t("modal_prorevokeauth"), + }); + + new Setting(contentEl) + .setName(t("modal_prorevokeauth_clean")) + .setDesc(t("modal_prorevokeauth_clean_desc")) + .addButton(async (button) => { + button.setButtonText(t("modal_prorevokeauth_clean_button")); + button.onClick(async () => { + try { + this.plugin.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG); + await this.plugin.saveSettings(); + this.authDiv.toggleClass( + "pro-auth-button-hide", + this.plugin.settings.pro?.refreshToken !== "" + ); + this.revokeAuthDiv.toggleClass( + "pro-revoke-auth-button-hide", + this.plugin.settings.pro?.refreshToken === "" + ); + new Notice(t("modal_prorevokeauth_clean_notice")); + this.close(); + } catch (err) { + console.error(err); + new Notice(t("modal_prorevokeauth_clean_fail")); + } + }); + }); + } + + onClose() { + const { contentEl } = this; + contentEl.empty(); + } +} + +const featureListToText = (features: FeatureInfo[]) => { + // TODO: i18n + if (features === undefined || features.length === 0) { + return "No features enabled."; + } + return features + .map((x) => { + return `${x.featureName} (expire: ${new Date( + Number(x.expireAtTimeMs) + ).toISOString()})`; + }) + .join("
"); +}; + +export const generateProSettingsPart = ( + proDiv: HTMLDivElement, + t: (x: TransItemType, vars?: any) => string, + app: App, + plugin: RemotelySavePlugin, + saveUpdatedConfigFunc: () => Promise | undefined +) => { + proDiv + .createEl("h2", { text: t("settings_pro") }) + .setAttribute("id", "settings-pro"); + + proDiv.createEl("div", { + text: stringToFragment(t("settings_pro_tutorial")), + }); + + const proSelectAuthDiv = proDiv.createDiv(); + const proAuthDiv = proSelectAuthDiv.createDiv({ + cls: "pro-auth-button-hide settings-auth-related", + }); + + const proRevokeAuthDiv = proSelectAuthDiv.createDiv({ + cls: "pro-revoke-auth-button-hide settings-auth-related", + }); + + const proFeaturesListSetting = new Setting(proRevokeAuthDiv) + .setName(t("settings_pro_features")) + .setDesc( + stringToFragment( + t("settings_pro_features_desc", { + features: featureListToText(plugin.settings.pro!.enabledProFeatures), + }) + ) + ); + proFeaturesListSetting.addButton(async (button) => { + button.setButtonText(t("settings_pro_features_refresh_button")); + button.onClick(async () => { + new Notice(t("settings_pro_features_refresh_fetch")); + await getAndSaveProFeatures( + plugin.settings.pro!, + plugin.manifest.version, + saveUpdatedConfigFunc + ); + proFeaturesListSetting.setDesc( + stringToFragment( + t("settings_pro_features_desc", { + features: featureListToText( + plugin.settings.pro!.enabledProFeatures + ), + }) + ) + ); + new Notice(t("settings_pro_features_refresh_succ")); + }); + }); + + const proRevokeAuthSetting = new Setting(proRevokeAuthDiv) + .setName(t("settings_pro_revoke")) + .setDesc( + t("settings_pro_revoke_desc", { + email: plugin.settings.pro?.email, + }) + ) + .addButton(async (button) => { + button.setButtonText(t("settings_pro_revoke_button")); + button.onClick(async () => { + new ProRevokeAuthModal( + app, + plugin, + proAuthDiv, + proRevokeAuthDiv, + t + ).open(); + }); + }); + + new Setting(proAuthDiv) + .setName(t("settings_pro_intro")) + .setDesc(stringToFragment(t("settings_pro_intro_desc"))) + .addButton(async (button) => { + button.setButtonText(t("settings_pro_intro_button")); + button.onClick(async () => { + window.open("https://remotelysave.com/user/signupin", "_self"); + }); + }); + + new Setting(proAuthDiv) + .setName(t("settings_pro_auth")) + .setDesc(t("settings_pro_auth_desc")) + .addButton(async (button) => { + button.setButtonText(t("settings_pro_auth_button")); + button.onClick(async () => { + const modal = new ProAuthModal( + app, + plugin, + proAuthDiv, + proRevokeAuthDiv, + proRevokeAuthSetting, + proFeaturesListSetting, + t + ); + plugin.oauth2Info.helperModal = modal; + plugin.oauth2Info.authDiv = proAuthDiv; + plugin.oauth2Info.revokeDiv = proRevokeAuthDiv; + plugin.oauth2Info.revokeAuthSetting = proRevokeAuthSetting; + + modal.open(); + }); + }); + + proAuthDiv.toggleClass( + "pro-auth-button-hide", + plugin.settings.pro?.refreshToken !== "" + ); + proRevokeAuthDiv.toggleClass( + "pro-revoke-auth-button-hide", + plugin.settings.pro?.refreshToken === "" + ); +}; diff --git a/pro/tests/conflictLogic.test.ts b/pro/tests/conflictLogic.test.ts new file mode 100644 index 0000000..ecec402 --- /dev/null +++ b/pro/tests/conflictLogic.test.ts @@ -0,0 +1,68 @@ +import { deepStrictEqual, rejects, throws } from "assert"; +import { getFileRename } from "../src/conflictLogic"; + +describe("New name is generated", () => { + it("should throw for empty file", async () => { + for (const key of ["", "/", ".", ".."]) { + throws(() => getFileRename(key)); + } + }); + + it("should throw for folder", async () => { + for (const key of ["sss/", "ssss/yyy/"]) { + throws(() => getFileRename(key)); + } + }); + + it("should correctly get no ext files renamed", async () => { + deepStrictEqual(getFileRename("abc"), "abc.dup"); + + deepStrictEqual(getFileRename("xxxx/yyyy/abc"), "xxxx/yyyy/abc.dup"); + }); + + it("should correctly get dot files renamed", async () => { + deepStrictEqual(getFileRename(".abc"), ".abc.dup"); + + deepStrictEqual(getFileRename("xxxx/yyyy/.efg"), "xxxx/yyyy/.efg.dup"); + + deepStrictEqual(getFileRename("xxxx/yyyy/hij."), "xxxx/yyyy/hij.dup"); + }); + + it("should correctly get normal files renamed", async () => { + deepStrictEqual(getFileRename("abc.efg"), "abc.dup.efg"); + + deepStrictEqual( + getFileRename("xxxx/yyyy/abc.efg"), + "xxxx/yyyy/abc.dup.efg" + ); + + deepStrictEqual( + getFileRename("xxxx/yyyy/abc.tar.gz"), + "xxxx/yyyy/abc.tar.dup.gz" + ); + + deepStrictEqual( + getFileRename("xxxx/yyyy/.abc.efg"), + "xxxx/yyyy/.abc.dup.efg" + ); + }); + + it("should correctly get duplicated files renamed again", async () => { + deepStrictEqual(getFileRename("abc.dup"), "abc.dup.dup"); + + deepStrictEqual( + getFileRename("xxxx/yyyy/.abc.dup"), + "xxxx/yyyy/.abc.dup.dup" + ); + + deepStrictEqual( + getFileRename("xxxx/yyyy/abc.dup.md"), + "xxxx/yyyy/abc.dup.dup.md" + ); + + deepStrictEqual( + getFileRename("xxxx/yyyy/.abc.dup.md"), + "xxxx/yyyy/.abc.dup.dup.md" + ); + }); +}); diff --git a/src/LICENSE b/src/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/src/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..b288633 --- /dev/null +++ b/src/README.md @@ -0,0 +1,9 @@ +# Main Basic Source + +## What? + +The main basic source code for Remotely Save. + +## License + +The codes or files or subfolders inside the current folder (`src` in the repo), are released under "open source" license: "Apache License, version 2.0". diff --git a/src/baseTypes.ts b/src/baseTypes.ts index 03d8487..5574982 100644 --- a/src/baseTypes.ts +++ b/src/baseTypes.ts @@ -3,6 +3,7 @@ * To avoid circular dependency. */ +import type { ProConfig } from "../pro/src/baseTypesPro"; import type { LangTypeAndAuto } from "./i18n"; export const DEFAULT_CONTENT_TYPE = "application/octet-stream"; @@ -155,6 +156,8 @@ export interface RemotelySavePluginSettings { profiler?: ProfilerConfig; + pro?: ProConfig; + /** * @deprecated */ @@ -188,7 +191,10 @@ export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80; export type EmptyFolderCleanType = "skip" | "clean_both"; -export type ConflictActionType = "keep_newer" | "keep_larger" | "rename_both"; +export type ConflictActionType = + | "keep_newer" + | "keep_larger" + | "smart_conflict"; export type DecisionTypeForMixedEntity = | "only_history" @@ -203,11 +209,11 @@ export type DecisionTypeForMixedEntity = | "remote_is_deleted_thus_also_delete_local" | "conflict_created_then_keep_local" | "conflict_created_then_keep_remote" - | "conflict_created_then_keep_both" + | "conflict_created_then_smart_conflict" | "conflict_created_then_do_nothing" | "conflict_modified_then_keep_local" | "conflict_modified_then_keep_remote" - | "conflict_modified_then_keep_both" + | "conflict_modified_then_smart_conflict" | "folder_existed_both_then_do_nothing" | "folder_existed_local_then_also_create_remote" | "folder_existed_remote_then_also_create_local" diff --git a/src/copyLogic.ts b/src/copyLogic.ts new file mode 100644 index 0000000..851fe8a --- /dev/null +++ b/src/copyLogic.ts @@ -0,0 +1,60 @@ +import type { FakeFs } from "./fsAll"; + +export async function copyFolder(key: string, left: FakeFs, right: FakeFs) { + if (!key.endsWith("/")) { + throw Error(`should not call ${key} in copyFolder`); + } + const statsLeft = await left.stat(key); + const entity = await right.mkdir(key, statsLeft.mtimeCli); + return { + entity: entity, + content: undefined, + }; +} + +export async function copyFile(key: string, left: FakeFs, right: FakeFs) { + // console.debug(`copyFile: key=${key}, left=${left.kind}, right=${right.kind}`); + if (key.endsWith("/")) { + throw Error(`should not call ${key} in copyFile`); + } + const statsLeft = await left.stat(key); + const content = await left.readFile(key); + + if (statsLeft.size === undefined || statsLeft.size === 0) { + // some weird bugs on android not returning size. just ignore them + statsLeft.size = content.byteLength; + } else { + if (statsLeft.size !== content.byteLength) { + throw Error( + `error copying ${left.kind}=>${right.kind}: size not matched` + ); + } + } + + if (statsLeft.mtimeCli === undefined) { + throw Error(`error copying ${left.kind}=>${right.kind}, no mtimeCli`); + } + + // console.debug(`copyFile: about to start right.writeFile`); + return { + entity: await right.writeFile( + key, + content, + statsLeft.mtimeCli, + statsLeft.mtimeCli /* TODO */ + ), + content: content, + }; +} + +export async function copyFileOrFolder( + key: string, + left: FakeFs, + right: FakeFs +) { + if (key.endsWith("/")) { + return await copyFolder(key, left, right); + } else { + return await copyFile(key, left, right); + } +} diff --git a/src/fsAll.ts b/src/fsAll.ts index f1480b2..47fb2c7 100644 --- a/src/fsAll.ts +++ b/src/fsAll.ts @@ -13,6 +13,7 @@ export abstract class FakeFs { ctime: number ): Promise; abstract readFile(key: string): Promise; + abstract rename(key1: string, key2: string): Promise; abstract rm(key: string): Promise; abstract checkConnect(callbackFunc?: any): Promise; abstract getUserDisplayName(): Promise; diff --git a/src/fsDropbox.ts b/src/fsDropbox.ts index ea4db91..b5c8cb4 100644 --- a/src/fsDropbox.ts +++ b/src/fsDropbox.ts @@ -695,6 +695,25 @@ export class FakeFsDropbox extends FakeFs { } } + async rename(key1: string, key2: string): Promise { + const remoteFileName1 = getDropboxPath(key1, this.remoteBaseDir); + const remoteFileName2 = getDropboxPath(key2, this.remoteBaseDir); + await this._init(); + try { + await retryReq( + () => + this.dropbox.filesMoveV2({ + from_path: remoteFileName1, + to_path: remoteFileName2, + }), + `${key1}=>${key2}` // just a hint here + ); + } catch (err) { + console.error("some error while moving"); + console.error(err); + } + } + async rm(key: string): Promise { if (key === "/") { return; diff --git a/src/fsEncrypt.ts b/src/fsEncrypt.ts index b34de41..ba4717c 100644 --- a/src/fsEncrypt.ts +++ b/src/fsEncrypt.ts @@ -356,6 +356,31 @@ export class FakeFsEncrypt extends FakeFs { } } + async rename(key1: string, key2: string): Promise { + if (!this.hasCacheMap) { + throw new Error("You have to build the cacheMap firstly for readFile"); + } + let key1Enc = this.cacheMapOrigToEnc[key1]; + if (key1Enc === undefined) { + if (this.isPasswordEmpty()) { + key1Enc = key1; + } else { + key1Enc = await this._encryptName(key1); + } + this.cacheMapOrigToEnc[key1] = key1Enc; + } + let key2Enc = this.cacheMapOrigToEnc[key2]; + if (key2Enc === undefined) { + if (this.isPasswordEmpty()) { + key2Enc = key2; + } else { + key2Enc = await this._encryptName(key2); + } + this.cacheMapOrigToEnc[key2] = key2Enc; + } + return await this.innerFs.rename(key1Enc, key2Enc); + } + async rm(key: string): Promise { if (!this.hasCacheMap) { throw new Error("You have to build the cacheMap firstly for rm"); diff --git a/src/fsLocal.ts b/src/fsLocal.ts index 4ca1bfc..601ce71 100644 --- a/src/fsLocal.ts +++ b/src/fsLocal.ts @@ -145,6 +145,7 @@ export class FakeFsLocal extends FakeFs { ): Promise { await this.vault.adapter.writeBinary(key, content, { mtime: mtime, + ctime: ctime, }); return await this.stat(key); } @@ -153,6 +154,10 @@ export class FakeFsLocal extends FakeFs { return await this.vault.adapter.readBinary(key); } + async rename(key1: string, key2: string): Promise { + return await this.vault.adapter.rename(key1, key2); + } + async rm(key: string): Promise { if (this.deleteToWhere === "obsidian") { await this.vault.adapter.trashLocal(key); diff --git a/src/fsMock.ts b/src/fsMock.ts index 4925c93..e368e99 100644 --- a/src/fsMock.ts +++ b/src/fsMock.ts @@ -38,6 +38,10 @@ export class FakeFsMock extends FakeFs { throw new Error("Method not implemented."); } + async rename(key1: string, key2: string): Promise { + throw new Error("Method not implemented."); + } + async rm(key: string): Promise { throw new Error("Method not implemented."); } diff --git a/src/fsOnedrive.ts b/src/fsOnedrive.ts index c2ee0e3..d9bae6e 100644 --- a/src/fsOnedrive.ts +++ b/src/fsOnedrive.ts @@ -928,6 +928,18 @@ export class FakeFsOnedrive extends FakeFs { } } + async rename(key1: string, key2: string): Promise { + if (key1 === "" || key1 === "/" || key2 === "" || key2 === "/") { + return; + } + const remoteFileName1 = getOnedrivePath(key1, this.remoteBaseDir); + const remoteFileName2 = getOnedrivePath(key2, this.remoteBaseDir); + await this._init(); + await this._patchJson(remoteFileName1, { + name: remoteFileName2, + }); + } + async rm(key: string): Promise { if (key === "" || key === "/") { return; diff --git a/src/fsS3.ts b/src/fsS3.ts index 280b02d..c21ab53 100644 --- a/src/fsS3.ts +++ b/src/fsS3.ts @@ -746,6 +746,10 @@ export class FakeFsS3 extends FakeFs { return bodyContents; } + async rename(key1: string, key2: string): Promise { + throw Error(`rename not implemented for s3`); + } + async rm(key: string): Promise { if (key === "/") { return; diff --git a/src/fsWebdav.ts b/src/fsWebdav.ts index 84d07ef..345f0cf 100644 --- a/src/fsWebdav.ts +++ b/src/fsWebdav.ts @@ -66,24 +66,11 @@ if (VALID_REQURL) { const p: RequestUrlParam = { url: options.url, method: options.method, - // body: options.data as string | ArrayBuffer, + body: options.data as string | ArrayBuffer, headers: transformedHeaders, contentType: reqContentType, throw: false, }; - if ( - options.data === undefined || - options.data === null || - isString(options.data) - ) { - p.body = options.data; - } else { - if (typeof (options.data as any).transfer === "function") { - p.body = (options.data as any).transfer(); - } else { - p.body = options.data as ArrayBuffer; - } - } let r = await requestUrl(p); @@ -330,9 +317,9 @@ export class FakeFsWebdav extends FakeFs { */ _getnextcloudUploadServerAddress = () => { let k = this.webdavConfig.address; - if (k.endsWith('/')) { + if (k.endsWith("/")) { // no tailing slash - k = k.substring(0, k.length-1); + k = k.substring(0, k.length - 1); } const s = k.split("/"); if ( @@ -797,6 +784,16 @@ export class FakeFsWebdav extends FakeFs { throw Error(`unexpected file content result with type ${typeof buff}`); } + async rename(key1: string, key2: string): Promise { + if (key1 === "/" || key2 === "/") { + return; + } + const remoteFileName1 = getWebdavPath(key1, this.remoteBaseDir); + const remoteFileName2 = getWebdavPath(key2, this.remoteBaseDir); + await this._init(); + await this.client.moveFile(remoteFileName1, remoteFileName2); + } + async rm(key: string): Promise { if (key === "/") { return; diff --git a/src/fsWebdis.ts b/src/fsWebdis.ts index 5d89cb6..ac59951 100644 --- a/src/fsWebdis.ts +++ b/src/fsWebdis.ts @@ -230,6 +230,15 @@ export class FakeFsWebdis extends FakeFs { return rsp; } + async rename(key1: string, key2: string): Promise { + const fullKey1 = getWebdisPath(key1, this.remoteBaseDir); + const fullKey2 = getWebdisPath(key2, this.remoteBaseDir); + const commandContent = `RENAME/${fullKey1}:content/${fullKey2}:content`; + await this._fetchCommand("POST", commandContent); + const commandMeta = `RENAME/${fullKey1}:meta/${fullKey2}:meta`; + await this._fetchCommand("POST", commandMeta); + } + async rm(key: string): Promise { const fullKey = getWebdisPath(key, this.remoteBaseDir); const command = `DEL/${fullKey}:meta/${fullKey}:content`; diff --git a/src/i18n.ts b/src/i18n.ts index 349e81b..eec410e 100644 --- a/src/i18n.ts +++ b/src/i18n.ts @@ -1,7 +1,11 @@ +import merge from "lodash/merge"; import Mustache from "mustache"; import { moment } from "obsidian"; -import { LANGS } from "./langs"; +import { LANGS as LANGS_PRO } from "../pro/src/langs"; +import { LANGS as LANGS_BASIC } from "./langs"; + +const LANGS = merge(LANGS_BASIC, LANGS_PRO); export type LangType = keyof typeof LANGS; export type LangTypeAndAuto = LangType | "auto"; diff --git a/src/importExport.ts b/src/importExport.ts index 6401ab8..2f19eea 100644 --- a/src/importExport.ts +++ b/src/importExport.ts @@ -24,6 +24,7 @@ export const exportQrCodeUri = async ( delete settings2.onedrive; delete settings2.webdav; delete settings2.webdis; + delete settings2.pro; } else if (exportFields === "s3") { settings2 = { s3: cloneDeep(settings.s3) }; } else if (exportFields === "dropbox") { diff --git a/src/langs/en.json b/src/langs/en.json index bdf0274..62ae6a4 100644 --- a/src/langs/en.json +++ b/src/langs/en.json @@ -277,7 +277,7 @@ "settings_deletetowhere_system_trash": "system trash (default)", "settings_deletetowhere_obsidian_trash": "Obsidian .trash folder", "settings_conflictaction": "Action For Conflict", - "settings_conflictaction_desc": "If a file is created or modified on both side since last update, it's a conflict event. How to deal with it? This only works for bidirectional sync.", + "settings_conflictaction_desc": "

If a file is created or modified on both side since last update, it's a conflict event. How to deal with it? This only works for bidirectional sync.

", "settings_conflictaction_keep_newer": "newer version survives (default)", "settings_conflictaction_keep_larger": "larger size version survives", "settings_cleanemptyfolder": "Action For Empty Folders", diff --git a/src/localdb.ts b/src/localdb.ts index 377ef48..994319e 100644 --- a/src/localdb.ts +++ b/src/localdb.ts @@ -20,6 +20,7 @@ export const DEFAULT_TBL_LOGGER_OUTPUT = "loggeroutput"; export const DEFAULT_TBL_SIMPLE_KV_FOR_MISC = "simplekvformisc"; export const DEFAULT_TBL_PREV_SYNC_RECORDS = "prevsyncrecords"; export const DEFAULT_TBL_PROFILER_RESULTS = "profilerresults"; +export const DEFAULT_TBL_FILE_CONTENT_HISTORY = "filecontenthistory"; /** * @deprecated @@ -62,6 +63,7 @@ export interface InternalDBs { simpleKVForMiscTbl: LocalForage; prevSyncRecordsTbl: LocalForage; profilerResultsTbl: LocalForage; + fileContentHistoryTbl: LocalForage; /** * @deprecated @@ -221,6 +223,11 @@ export const prepareDBs = async ( name: DEFAULT_DB_NAME, storeName: DEFAULT_TBL_SYNC_MAPPING, }), + + fileContentHistoryTbl: localforage.createInstance({ + name: DEFAULT_DB_NAME, + storeName: DEFAULT_TBL_FILE_CONTENT_HISTORY, + }), } as InternalDBs; // try to get vaultRandomID firstly diff --git a/src/main.ts b/src/main.ts index 949f0c0..79b98df 100644 --- a/src/main.ts +++ b/src/main.ts @@ -13,6 +13,13 @@ import { requireApiVersion, setIcon, } from "obsidian"; +import { + DEFAULT_PRO_CONFIG, + getAndSaveProEmail, + getAndSaveProFeatures, + sendAuthReq as sendAuthReqPro, + setConfigBySuccessfullAuthInplace as setConfigBySuccessfullAuthInplacePro, +} from "../pro/src/account"; import type { RemotelySavePluginSettings, SyncTriggerSourceType, @@ -56,6 +63,7 @@ import { SyncAlgoV3Modal } from "./syncAlgoV3Notice"; // biome-ignore lint/suspicious/noShadowRestrictedNames: import AggregateError from "aggregate-error"; import throttle from "lodash/throttle"; +import { COMMAND_CALLBACK_PRO } from "../pro/src/baseTypesPro"; import { exportVaultSyncPlansToFiles } from "./debugMode"; import { FakeFsEncrypt } from "./fsEncrypt"; import { getClient } from "./fsGetter"; @@ -97,6 +105,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = { enableMobileStatusBar: false, encryptionMethod: "unknown", profiler: DEFAULT_PROFILER_CONFIG, + pro: DEFAULT_PRO_CONFIG, }; interface OAuth2Info { @@ -399,6 +408,8 @@ export default class RemotelySavePlugin extends Plugin { return; } + const configSaver = async () => await this.saveSettings(); + await syncer( fsLocal, fsRemote, @@ -410,6 +421,8 @@ export default class RemotelySavePlugin extends Plugin { this.vaultRandomID, this.app.vault.configDir, this.settings, + this.manifest.version, + configSaver, getProtectError, markIsSyncingFunc, notifyFunc, @@ -696,6 +709,77 @@ export default class RemotelySavePlugin extends Plugin { } ); + this.registerObsidianProtocolHandler( + COMMAND_CALLBACK_PRO, + async (inputParams) => { + if (this.oauth2Info.helperModal !== undefined) { + const k = this.oauth2Info.helperModal.contentEl; + k.empty(); + + t("protocol_pro_connecting") + .split("\n") + .forEach((val) => { + k.createEl("p", { + text: val, + }); + }); + } + + console.debug(inputParams); + const authRes = await sendAuthReqPro( + this.oauth2Info.verifier || "verifier", + inputParams.code, + async (e: any) => { + new Notice(t("protocol_pro_connect_fail")); + new Notice(`${e}`); + throw e; + } + ); + console.debug(authRes); + + const self = this; + await setConfigBySuccessfullAuthInplacePro( + this.settings.pro!, + authRes, + () => self.saveSettings() + ); + + await getAndSaveProFeatures( + this.settings.pro!, + this.manifest.version, + () => self.saveSettings() + ); + + await getAndSaveProEmail( + this.settings.pro!, + this.manifest.version, + () => self.saveSettings() + ); + + this.oauth2Info.verifier = ""; // reset it + this.oauth2Info.helperModal?.close(); // close it + this.oauth2Info.helperModal = undefined; + + this.oauth2Info.authDiv?.toggleClass( + "pro-auth-button-hide", + this.settings.pro?.refreshToken !== "" + ); + this.oauth2Info.authDiv = undefined; + + this.oauth2Info.revokeAuthSetting?.setDesc( + t("protocol_pro_connect_succ_revoke", { + email: this.settings.pro?.email, + }) + ); + this.oauth2Info.revokeAuthSetting = undefined; + this.oauth2Info.revokeDiv?.toggleClass( + "pro-revoke-auth-button-hide", + this.settings.pro?.email === "" + ); + this.oauth2Info.revokeDiv = undefined; + } + ); + this.syncRibbon = this.addRibbonIcon( iconNameSyncWait, `${this.manifest.name}`, @@ -1046,6 +1130,10 @@ export default class RemotelySavePlugin extends Plugin { needSave = true; } + if (this.settings.pro === undefined) { + this.settings.pro = cloneDeep(DEFAULT_PRO_CONFIG); + } + // save back if (needSave) { await this.saveSettings(); diff --git a/src/misc.ts b/src/misc.ts index 046693e..e2506f2 100644 --- a/src/misc.ts +++ b/src/misc.ts @@ -416,7 +416,7 @@ export const toText = (x: any) => { export const statFix = async (vault: Vault, path: string) => { const s = await vault.adapter.stat(path); if (s === undefined || s === null) { - return s; + throw Error(`${path} doesn't exist cannot run stat`); } if (s.ctime === undefined || s.ctime === null || Number.isNaN(s.ctime)) { s.ctime = undefined as any; // force assignment diff --git a/src/settings.ts b/src/settings.ts index e8dd381..5c99cdc 100644 --- a/src/settings.ts +++ b/src/settings.ts @@ -21,6 +21,7 @@ import type { } from "./baseTypes"; import cloneDeep from "lodash/cloneDeep"; +import { generateProSettingsPart } from "../pro/src/settingsPro"; import { API_VER_ENSURE_REQURL_OK, VALID_REQURL } from "./baseTypesObs"; import { messyConfigToNormal } from "./configPersist"; import { @@ -2130,25 +2131,44 @@ export class RemotelySaveSettingTab extends PluginSettingTab { }); }); - new Setting(advDiv) + let conflictActionSettingOrigDesc = t("settings_conflictaction_desc"); + if ( + (this.plugin.settings.conflictAction ?? "keep_newer") === "smart_conflict" + ) { + conflictActionSettingOrigDesc += t( + "settings_conflictaction_smart_conflict_desc" + ); + } + const conflictActionSetting = new Setting(advDiv) .setName(t("settings_conflictaction")) - .setDesc(t("settings_conflictaction_desc")) - .addDropdown((dropdown) => { - dropdown.addOption( - "keep_newer", - t("settings_conflictaction_keep_newer") - ); - dropdown.addOption( - "keep_larger", - t("settings_conflictaction_keep_larger") - ); - dropdown - .setValue(this.plugin.settings.conflictAction ?? "keep_newer") - .onChange(async (val) => { - this.plugin.settings.conflictAction = val as ConflictActionType; - await this.plugin.saveSettings(); - }); - }); + .setDesc(stringToFragment(conflictActionSettingOrigDesc)); + conflictActionSetting.addDropdown((dropdown) => { + dropdown + .addOption("keep_newer", t("settings_conflictaction_keep_newer")) + .addOption("keep_larger", t("settings_conflictaction_keep_larger")) + .addOption( + "smart_conflict", + t("settings_conflictaction_smart_conflict") + ) + .setValue(this.plugin.settings.conflictAction ?? "keep_newer") + .onChange(async (val) => { + this.plugin.settings.conflictAction = val as ConflictActionType; + await this.plugin.saveSettings(); + + conflictActionSettingOrigDesc = t("settings_conflictaction_desc"); + if ( + (this.plugin.settings.conflictAction ?? "keep_newer") === + "smart_conflict" + ) { + conflictActionSettingOrigDesc += t( + "settings_conflictaction_smart_conflict_desc" + ); + } + conflictActionSetting.setDesc( + stringToFragment(conflictActionSettingOrigDesc) + ); + }); + }); new Setting(advDiv) .setName(t("settings_cleanemptyfolder")) @@ -2417,6 +2437,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab { }); }); + ////////////////////////////////////////////////// + // below for pro + ////////////////////////////////////////////////// + + const proDiv = containerEl.createEl("div"); + generateProSettingsPart(proDiv, t, this.app, this.plugin, () => + this.plugin.saveSettings() + ); + ////////////////////////////////////////////////// // below for debug ////////////////////////////////////////////////// diff --git a/src/sync.ts b/src/sync.ts index 644ba36..724b352 100644 --- a/src/sync.ts +++ b/src/sync.ts @@ -2,6 +2,13 @@ import AggregateError from "aggregate-error"; import PQueue from "p-queue"; import XRegExp from "xregexp"; +import { checkProRunnableAndFixInplace } from "../pro/src/account"; +import { duplicateFile, isMergable, mergeFile } from "../pro/src/conflictLogic"; +import { + clearFileContentHistoryByVaultAndProfile, + getFileContentHistoryByVaultAndProfile, + upsertFileContentHistoryByVaultAndProfile, +} from "../pro/src/localdb"; import type { ConflictActionType, EmptyFolderCleanType, @@ -12,6 +19,7 @@ import type { SyncDirectionType, SyncTriggerSourceType, } from "./baseTypes"; +import { copyFile, copyFileOrFolder, copyFolder } from "./copyLogic"; import type { FakeFs } from "./fsAll"; import type { FakeFsEncrypt } from "./fsEncrypt"; import { @@ -432,7 +440,6 @@ const getSyncPlanInplace = async ( } else { // Both exists, but modified or conflict // Look for past files of A or B. - const localEqualPrevSync = prevSync?.mtimeCli === local.mtimeCli && prevSync?.sizeEnc === local.sizeEnc; @@ -521,9 +528,10 @@ const getSyncPlanInplace = async ( mixedEntry.change = true; keptFolder.add(getParentFolder(key)); } - } else { - mixedEntry.decisionBranch = 15; - mixedEntry.decision = "conflict_created_then_keep_both"; + } else if (conflictAction === "smart_conflict") { + // try merge! + mixedEntry.decisionBranch = 302; + mixedEntry.decision = "conflict_created_then_smart_conflict"; mixedEntry.change = true; keptFolder.add(getParentFolder(key)); } @@ -572,9 +580,10 @@ const getSyncPlanInplace = async ( mixedEntry.change = true; keptFolder.add(getParentFolder(key)); } - } else { - mixedEntry.decisionBranch = 20; - mixedEntry.decision = "conflict_modified_then_keep_both"; + } else if (conflictAction === "smart_conflict") { + // yeah, try to merge them! + mixedEntry.decisionBranch = 301; + mixedEntry.decision = "conflict_modified_then_smart_conflict"; mixedEntry.change = true; keptFolder.add(getParentFolder(key)); } @@ -900,10 +909,10 @@ const splitFourStepsOnEntityMappings = ( val.decision === "remote_is_created_then_pull" || val.decision === "conflict_created_then_keep_local" || val.decision === "conflict_created_then_keep_remote" || - val.decision === "conflict_created_then_keep_both" || + val.decision === "conflict_created_then_smart_conflict" || val.decision === "conflict_modified_then_keep_local" || val.decision === "conflict_modified_then_keep_remote" || - val.decision === "conflict_modified_then_keep_both" + val.decision === "conflict_modified_then_smart_conflict" ) { if ( uploadDownloads.length === 0 || @@ -966,75 +975,6 @@ const fullfillMTimeOfRemoteEntityInplace = ( return remote; }; -async function copyFolder( - key: string, - left: FakeFs, - right: FakeFs -): Promise { - if (!key.endsWith("/")) { - throw Error(`should not call ${key} in copyFolder`); - } - const statsLeft = await left.stat(key); - return await right.mkdir(key, statsLeft.mtimeCli); -} - -async function copyFile( - key: string, - left: FakeFs, - right: FakeFs -): Promise { - // console.debug(`copyFile: key=${key}, left=${left.kind}, right=${right.kind}`); - if (key.endsWith("/")) { - throw Error(`should not call ${key} in copyFile`); - } - const statsLeft = await left.stat(key); - const content = await left.readFile(key); - - if (statsLeft.size === undefined || statsLeft.size === 0) { - // some weird bugs on android not returning size. just ignore them - statsLeft.size = content.byteLength; - } else { - if (statsLeft.size !== content.byteLength) { - throw Error( - `error copying ${left.kind}=>${right.kind}: size not matched` - ); - } - } - - if (statsLeft.mtimeCli === undefined) { - throw Error(`error copying ${left.kind}=>${right.kind}, no mtimeCli`); - } - - // console.debug(`copyFile: about to start right.writeFile`); - if (typeof (content as any).transfer === "function") { - return await right.writeFile( - key, - (content as any).transfer(), - statsLeft.mtimeCli, - statsLeft.mtimeCli /* TODO */ - ); - } else { - return await right.writeFile( - key, - content, - statsLeft.mtimeCli, - statsLeft.mtimeCli /* TODO */ - ); - } -} - -async function copyFileOrFolder( - key: string, - left: FakeFs, - right: FakeFs -): Promise { - if (key.endsWith("/")) { - return await copyFolder(key, left, right); - } else { - return await copyFile(key, left, right); - } -} - const dispatchOperationToActualV3 = async ( key: string, vaultRandomID: string, @@ -1042,7 +982,8 @@ const dispatchOperationToActualV3 = async ( r: MixedEntity, fsLocal: FakeFs, fsEncrypt: FakeFsEncrypt, - db: InternalDBs + db: InternalDBs, + conflictAction: ConflictActionType ) => { // console.debug( // `inside dispatchOperationToActualV3, key=${key}, r=${JSON.stringify( @@ -1052,7 +993,20 @@ const dispatchOperationToActualV3 = async ( // )}` // ); if (r.decision === "only_history") { - clearPrevSyncRecordByVaultAndProfile(db, vaultRandomID, profileID, key); + await clearPrevSyncRecordByVaultAndProfile( + db, + vaultRandomID, + profileID, + key + ); + if (conflictAction === "smart_conflict") { + await clearFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + key + ); + } } else if ( r.decision === "local_is_created_too_large_then_do_nothing" || r.decision === "remote_is_created_too_large_then_do_nothing" || @@ -1071,12 +1025,34 @@ const dispatchOperationToActualV3 = async ( if (r.prevSync !== undefined) { // if we have prevSync, - // we don't need to do anything, because the record is already there! + // we don't need to update prevSync, because the record is already there! + + // but we might need to update content, because it's a new feature + if (conflictAction === "smart_conflict") { + if (isMergable(r.local!)) { + const k = await getFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.local! + ); + if (k === null || k === undefined) { + await upsertFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.local!, + await fsLocal.readFile(r.local!.keyRaw) + ); + } + } + } } else { // if we don't have prevSync, we use remote entity AND local mtime // as if it is "uploaded" if (r.remote !== undefined) { let entity = r.remote; + // TODO: abstract away the dirty hack entity = fullfillMTimeOfRemoteEntityInplace(entity, r.local?.mtimeCli); if (entity !== undefined) { @@ -1086,6 +1062,17 @@ const dispatchOperationToActualV3 = async ( profileID, entity ); + if (conflictAction === "smart_conflict") { + if (isMergable(entity)) { + await upsertFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + entity, + await fsLocal.readFile(entity.keyRaw) + ); + } + } } } } @@ -1098,7 +1085,12 @@ const dispatchOperationToActualV3 = async ( ) { // console.debug(`before upload in sync, r=${JSON.stringify(r, null, 2)}`); const mtimeCli = (await fsLocal.stat(r.key)).mtimeCli!; - const entity = await copyFileOrFolder(r.key, fsLocal, fsEncrypt); + const { entity, content } = await copyFileOrFolder( + r.key, + fsLocal, + fsEncrypt + ); + // TODO: abstract away the dirty hack fullfillMTimeOfRemoteEntityInplace(entity, mtimeCli); // console.debug(`after fullfill, entity=${JSON.stringify(entity,null,2)}`) await upsertPrevSyncRecordByVaultAndProfile( @@ -1107,6 +1099,17 @@ const dispatchOperationToActualV3 = async ( profileID, entity ); + if (conflictAction === "smart_conflict") { + if (isMergable(entity)) { + await upsertFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + entity, + content! + ); + } + } } else if ( r.decision === "remote_is_modified_then_pull" || r.decision === "remote_is_created_then_pull" || @@ -1114,10 +1117,14 @@ const dispatchOperationToActualV3 = async ( r.decision === "conflict_modified_then_keep_remote" || r.decision === "folder_existed_remote_then_also_create_local" ) { + let e1: Entity | undefined = undefined; + let c1: ArrayBuffer | undefined = undefined; if (r.key.endsWith("/")) { await fsLocal.mkdir(r.key); } else { - await copyFile(r.key, fsEncrypt, fsLocal); + const { entity, content } = await copyFile(r.key, fsEncrypt, fsLocal); + e1 = entity; + c1 = content; } await upsertPrevSyncRecordByVaultAndProfile( db, @@ -1125,6 +1132,17 @@ const dispatchOperationToActualV3 = async ( profileID, r.remote! ); + if (conflictAction === "smart_conflict") { + if (isMergable(r.remote!)) { + await upsertFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.remote!, + c1! // always file, always has real value + ); + } + } } else if (r.decision === "local_is_deleted_thus_also_delete_remote") { // local is deleted, we need to delete remote now await fsEncrypt.rm(r.key); @@ -1134,6 +1152,16 @@ const dispatchOperationToActualV3 = async ( profileID, r.key ); + if (conflictAction === "smart_conflict") { + if (isMergable(r.remote!)) { + await clearFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.key + ); + } + } } else if (r.decision === "remote_is_deleted_thus_also_delete_local") { // remote is deleted, we need to delete local now await fsLocal.rm(r.key); @@ -1143,20 +1171,92 @@ const dispatchOperationToActualV3 = async ( profileID, r.key ); + if (conflictAction === "smart_conflict") { + if (isMergable(r.remote!)) { + await clearFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.key + ); + } + } } else if ( - r.decision === "conflict_created_then_keep_both" || - r.decision === "conflict_modified_then_keep_both" + r.decision === "conflict_created_then_smart_conflict" || + r.decision === "conflict_modified_then_smart_conflict" ) { - throw Error(`${r.decision} not implemented yet: ${JSON.stringify(r)}`); + // heavy lifting + if (isMergable(r.local!, r.remote!)) { + const origContent = await getFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.local! + ); + // console.debug(`we get origContent:`) + // console.debug(origContent) + const { entity, content } = await mergeFile( + r.key, + fsLocal, + fsEncrypt, + origContent + ); + await upsertPrevSyncRecordByVaultAndProfile( + db, + vaultRandomID, + profileID, + entity + ); + await upsertFileContentHistoryByVaultAndProfile( + db, + vaultRandomID, + profileID, + entity, + content + ); + } else { + // duplicate the files + await clearPrevSyncRecordByVaultAndProfile( + db, + vaultRandomID, + profileID, + r.key + ); + const mtimeCli = (await fsLocal.stat(r.key)).mtimeCli!; + const { upload, download } = await duplicateFile( + r.key, + fsLocal, + fsEncrypt, + async (upload) => { + // TODO: abstract away the dirty hack + fullfillMTimeOfRemoteEntityInplace(upload, mtimeCli); + await upsertPrevSyncRecordByVaultAndProfile( + db, + vaultRandomID, + profileID, + upload + ); + }, + async (download) => { + await upsertPrevSyncRecordByVaultAndProfile( + db, + vaultRandomID, + profileID, + download + ); + } + ); + } } else if (r.decision === "folder_to_be_created") { await fsLocal.mkdir(r.key); - const entity = await copyFolder(r.key, fsLocal, fsEncrypt); + const { entity } = await copyFolder(r.key, fsLocal, fsEncrypt); await upsertPrevSyncRecordByVaultAndProfile( db, vaultRandomID, profileID, entity ); + // no need to record file content for folder here } else if ( r.decision === "folder_to_be_deleted_on_both" || r.decision === "folder_to_be_deleted_on_local" || @@ -1180,6 +1280,7 @@ const dispatchOperationToActualV3 = async ( profileID, r.key ); + // no need to record file content for folder here } else { throw Error(`don't know how to dispatch decision: ${JSON.stringify(r)}`); } @@ -1196,6 +1297,7 @@ export const doActualSync = async ( getProtectModifyPercentageErrorStrFunc: any, db: InternalDBs, profiler: Profiler | undefined, + conflictAction: ConflictActionType, callbackSyncProcess?: any ) => { profiler?.addIndent(); @@ -1318,7 +1420,8 @@ export const doActualSync = async ( val, fsLocal, fsEncrypt, - db + db, + conflictAction ); // console.debug(`finished ${key}`); @@ -1381,6 +1484,8 @@ export async function syncer( vaultRandomID: string, configDir: string, settings: RemotelySavePluginSettings, + pluginVersion: string, + configSaver: () => Promise, getProtectModifyPercentageErrorStrFunc: any, markIsSyncingFunc: (isSyncing: boolean) => void, notifyFunc?: (s: SyncTriggerSourceType, step: number) => Promise, @@ -1397,17 +1502,27 @@ export async function syncer( markIsSyncingFunc(true); let everythingOk = true; - - let step = 0; // dry mode only - await notifyFunc?.(triggerSource, step); - - step = 1; - await notifyFunc?.(triggerSource, step); - await ribboonFunc?.(triggerSource, step); - await statusBarFunc?.(triggerSource, step, everythingOk); - profiler?.insert("start big sync func"); + let step = 0; try { + // check pro feature + // if anything goes wrong, it will throw + await checkProRunnableAndFixInplace( + ["feature-smart_conflict"], + settings, + pluginVersion, + configSaver + ); + + // try mode? + await notifyFunc?.(triggerSource, step); + + step = 1; + await notifyFunc?.(triggerSource, step); + await ribboonFunc?.(triggerSource, step); + await statusBarFunc?.(triggerSource, step, everythingOk); + profiler?.insert("start big sync func"); + step = 2; await notifyFunc?.(triggerSource, step); await ribboonFunc?.(triggerSource, step); @@ -1514,6 +1629,7 @@ export async function syncer( getProtectModifyPercentageErrorStrFunc, db, profiler, + settings.conflictAction ?? "keep_newer", callbackSyncProcess ); profiler?.insert(`finish step${step} (actual sync)`); diff --git a/styles.css b/styles.css index 2804efe..42e9bff 100644 --- a/styles.css +++ b/styles.css @@ -90,3 +90,18 @@ /* flex-wrap: wrap; */ display: grid; } + +.pro-disclaimer { + font-weight: bold; +} +.pro-hide { + display: none; +} + +.pro-auth-button-hide { + display: none; +} + +.pro-revoke-auth-button-hide { + display: none; +} diff --git a/webpack.config.js b/webpack.config.js index 036d144..4ba8cbc 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -6,6 +6,8 @@ const TerserPlugin = require("terser-webpack-plugin"); const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || ""; const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || ""; const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || ""; +const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || ""; +const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || ""; module.exports = { entry: "./src/main.ts", @@ -20,6 +22,8 @@ module.exports = { "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`, "process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`, "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`, + "process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`, + "process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`, }), // Work around for Buffer is undefined: // https://github.com/webpack/changelog-v5/issues/10