public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2025-12-15 10:45:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add translation ids

Browse Source
This commit is contained in:
CRuiz
2025-01-22 13:41:18 -06:00
parent f2b667d75e
commit 73782c5389
15 changed files with 506 additions and 453 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
src/modules/essential/ModuleMigration.ts
View File

@@ -8,16 +8,12 @@ import {
} from "../../common/events.ts";
import { AbstractModule } from "../AbstractModule.ts";
import type { ICoreModule } from "../ModuleTypes.ts";
const URI_DOC = "https://github.com/vrtmrz/obsidian-livesync/blob/main/README.md#how-to-use";
import { $tf } from "src/lib/src/common/i18n.ts";
export class ModuleMigration extends AbstractModule implements ICoreModule {
async migrateDisableBulkSend() {
if (this.settings.sendChunksBulk) {
this._log(
"Send chunks in bulk has been enabled, however, this feature had been corrupted. Sorry for your inconvenience. Automatically disabled.",
LOG_LEVEL_NOTICE
);
this._log($tf('moduleMigration.logBulkSendCorrupted'), LOG_LEVEL_NOTICE);
this.settings.sendChunksBulk = false;
this.settings.sendChunksBulkMaxSize = 1;
await this.saveSettings();
@@ -28,7 +24,10 @@ export class ModuleMigration extends AbstractModule implements ICoreModule {
const current = SETTING_VERSION_SUPPORT_CASE_INSENSITIVE;
// Check each migrations(old -> current)
if (!(await this.migrateToCaseInsensitive(old, current))) {
this._log(`Migration failed or cancelled from ${old} to ${current}`, LOG_LEVEL_NOTICE);
this._log($tf('moduleMigration.logMigrationFailed', {
old: old.toString(),
current: current.toString()
}), LOG_LEVEL_NOTICE);
return;
}
}
@@ -68,10 +67,10 @@ export class ModuleMigration extends AbstractModule implements ICoreModule {
remoteChecked = true;
}
} else {
this._log("Failed to fetch remote tweak values", LOG_LEVEL_INFO);
this._log($tf('moduleMigration.logFetchRemoteTweakFailed'), LOG_LEVEL_INFO);
}
} catch (ex) {
this._log("Could not get remote tweak values", LOG_LEVEL_INFO);
this._log($tf('moduleMigration.logRemoteTweakUnavailable'), LOG_LEVEL_INFO);
this._log(ex, LOG_LEVEL_VERBOSE);
}
@@ -82,27 +81,21 @@ export class ModuleMigration extends AbstractModule implements ICoreModule {
this.settings.handleFilenameCaseSensitive = true;
this.settings.doNotUseFixedRevisionForChunks = true;
this.settings.settingVersion = SETTING_VERSION_SUPPORT_CASE_INSENSITIVE;
this._log(`Migrated to db:${current} with the same behaviour as before`, LOG_LEVEL_INFO);
this._log($tf('moduleMigration.logMigratedSameBehaviour', {
current: current.toString()
}), LOG_LEVEL_INFO);
await this.saveSettings();
return true;
}
const message = `As you may already know, the self-hosted LiveSync has changed its default behaviour and database structure.
And thankfully, with your time and efforts, the remote database appears to have already been migrated. Congratulations!
However, we need a bit more. The configuration of this device is not compatible with the remote database. We will need to fetch the remote database again. Should we fetch from the remote again now?
___Note: We cannot synchronise until the configuration has been changed and the database has been fetched again.___
___Note2: The chunks are completely immutable, we can fetch only the metadata and difference.___
`;
const OPTION_FETCH = "Yes, fetch again";
const DISMISS = "No, please ask again";
const message = $tf('moduleMigration.msgFetchRemoteAgain');
const OPTION_FETCH = $tf('moduleMigration.optionYesFetchAgain');
const DISMISS = $tf('moduleMigration.optionNoAskAgain');
const options = [OPTION_FETCH, DISMISS];
const ret = await this.core.confirm.confirmWithMessage(
"Case Sensitivity",
$tf('moduleMigration.titleCaseSensitivity'),
message,
options,
"No, please ask again",
DISMISS,
40
);
if (ret == OPTION_FETCH) {
@@ -114,7 +107,7 @@ ___Note2: The chunks are completely immutable, we can fetch only the metadata an
await this.core.rebuilder.scheduleFetch();
return;
} catch (ex) {
this._log("Failed to create redflag2", LOG_LEVEL_VERBOSE);
this._log($tf('moduleMigration.logRedflag2CreationFail'), LOG_LEVEL_VERBOSE);
this._log(ex, LOG_LEVEL_VERBOSE);
}
return false;
@@ -123,33 +116,19 @@ ___Note2: The chunks are completely immutable, we can fetch only the metadata an
}
}
const ENABLE_BOTH = "Enable both";
const ENABLE_FILENAME_CASE_INSENSITIVE = "Enable only #1";
const ENABLE_FIXED_REVISION_FOR_CHUNKS = "Enable only #2";
const ADJUST_TO_REMOTE = "Adjust to remote";
const DISMISS = "Decide it later";
const KEEP = "Keep previous behaviour";
const message = `Since v0.23.21, the self-hosted LiveSync has changed the default behaviour and database structure. The following changes have been made:
1. **Case sensitivity of filenames**
The handling of filenames is now case-insensitive. This is a beneficial change for most platforms, other than Linux and iOS, which do not manage filename case sensitivity effectively.
(On These, a warning will be displayed for files with the same name but different cases).
2. **Revision handling of the chunks**
Chunks are immutable, which allows their revisions to be fixed. This change will enhance the performance of file saving.
___However, to enable either of these changes, both remote and local databases need to be rebuilt. This process takes a few minutes, and we recommend doing it when you have ample time.___
- If you wish to maintain the previous behaviour, you can skip this process by using \`${KEEP}\`.
- If you do not have enough time, please choose \`${DISMISS}\`. You will be prompted again later.
- If you have rebuilt the database on another device, please select \`${DISMISS}\` and try synchronizing again. Since a difference has been detected, you will be prompted again.
`;
const ENABLE_BOTH = $tf('moduleMigration.optionEnableBoth');
const ENABLE_FILENAME_CASE_INSENSITIVE = $tf('moduleMigration.optionEnableFilenameCaseInsensitive');
const ENABLE_FIXED_REVISION_FOR_CHUNKS = $tf('moduleMigration.optionEnableFixedRevisionForChunks');
const ADJUST_TO_REMOTE = $tf('moduleMigration.optionAdjustRemote');
const KEEP = $tf('moduleMigration.optionKeepPreviousBehaviour');
const DISMISS = $tf('moduleMigration.optionDecideLater');
const message = $tf('moduleMigration.msgSinceV02321');
const options = [ENABLE_BOTH, ENABLE_FILENAME_CASE_INSENSITIVE, ENABLE_FIXED_REVISION_FOR_CHUNKS];
if (remoteChecked) {
options.push(ADJUST_TO_REMOTE);
}
options.push(KEEP, DISMISS);
const ret = await this.core.confirm.confirmWithMessage("Case Sensitivity", message, options, DISMISS, 40);
const ret = await this.core.confirm.confirmWithMessage($tf('moduleMigration.titleCaseSensitivity'), message, options, DISMISS, 40);
console.dir(ret);
switch (ret) {
case ENABLE_BOTH:
@@ -181,20 +160,14 @@ ___However, to enable either of these changes, both remote and local databases n
}
async initialMessage() {
const message = `Your device has **not been set up yet**. Let me guide you through the setup process.
Please keep in mind that every dialogue content can be copied to the clipboard. If you need to refer to it later, you can paste it into a note in Obsidian. You can also translate it into your language using a translation tool.
First, do you have **Setup URI**?
Note: If you do not know what it is, please refer to the [documentation](${URI_DOC}).
`;
const USE_SETUP = "Yes, I have";
const NEXT = "No, I do not have";
const message = $tf('moduleMigration.msgInitialSetup', {
URI_DOC: $tf('moduleMigration.docUri'),
});
const USE_SETUP = $tf('moduleMigration.optionHaveSetupUri');
const NEXT = $tf('moduleMigration.optionNoSetupUri');
const ret = await this.core.confirm.askSelectStringDialogue(message, [USE_SETUP, NEXT], {
title: "Welcome to Self-hosted LiveSync",
title: $tf('moduleMigration.titleWelcome'),
defaultAction: USE_SETUP,
});
if (ret === USE_SETUP) {
@@ -207,17 +180,13 @@ Note: If you do not know what it is, please refer to the [documentation](${URI_D
}
async askAgainForSetupURI() {
const message = `We strongly recommend that you generate a set-up URI and use it.
If you do not have knowledge about it, please refer to the [documentation](${URI_DOC}) (Sorry again, but it is important).
How do you want to set it up manually?`;
const USE_MINIMAL = "Take me into the setup wizard";
const USE_SETUP = "Set it up all manually";
const NEXT = "Remind me at the next launch";
const message = $tf('moduleMigration.msgRecommendSetupUri');
const USE_MINIMAL = $tf('moduleMigration.optionSetupWizard');
const USE_SETUP = $tf('moduleMigration.optionManualSetup');
const NEXT = $tf('moduleMigration.optionRemindNextLaunch');
const ret = await this.core.confirm.askSelectStringDialogue(message, [USE_MINIMAL, USE_SETUP, NEXT], {
title: "Recommendation to use Setup URI",
title: $tf('moduleMigration.titleRecommendSetupUri'),
defaultAction: USE_MINIMAL,
});
if (ret === USE_MINIMAL) {
@@ -235,7 +204,7 @@ How do you want to set it up manually?`;
async $everyOnFirstInitialize(): Promise<boolean> {
if (!this.localDatabase.isReady) {
this._log(`Something went wrong! The local database is not ready`, LOG_LEVEL_NOTICE);
this._log($tf('moduleMigration.logLocalDatabaseNotReady'), LOG_LEVEL_NOTICE);
return false;
}
if (this.settings.isConfigured) {
@@ -245,10 +214,7 @@ How do you want to set it up manually?`;
if (!this.settings.isConfigured) {
// Case sensitivity
if (!(await this.initialMessage()) || !(await this.askAgainForSetupURI())) {
this._log(
"The setup has been cancelled, Self-hosted LiveSync waiting for your setup!",
LOG_LEVEL_NOTICE
);
this._log($tf('moduleMigration.logSetupCancelled'), LOG_LEVEL_NOTICE);
return false;
}
}