diff --git a/chat/ChatView.vue b/chat/ChatView.vue index c2727a251..4099850d6 100644 --- a/chat/ChatView.vue +++ b/chat/ChatView.vue @@ -331,6 +331,13 @@ + + @@ -366,6 +373,9 @@ import AdLauncherDialog from './ads/AdLauncher.vue'; import Modal from '../components/Modal.vue'; import QuickJump from './QuickJump.vue'; + import { ipcRenderer } from 'electron'; + import { toasts, showToast, updateToast, dismissToast } from './toast'; + import Toast from '../components/Toast.vue'; const unreadClasses = { [Conversation.UnreadState.None]: '', @@ -391,7 +401,8 @@ adCenter: AdCenterDialog, adLauncher: AdLauncherDialog, modal: Modal, - 'quick-jump': QuickJump + 'quick-jump': QuickJump, + toast: Toast } }) export default class ChatView extends Vue { @@ -405,6 +416,8 @@ focusListener!: () => void; blurListener!: () => void; readonly isMac = process.platform === 'darwin'; + toasts = toasts; + dismissToast = dismissToast; channelConversations = core.conversations.channelConversations; privateConversations = core.conversations.privateConversations; @@ -426,6 +439,42 @@ this.mouseButtonListener = (e: MouseEvent) => this.onMouseButton(e); window.addEventListener('mouseup', this.mouseButtonListener); + ipcRenderer.on( + 'auto-backup-status', + (_e, status: string, progress?: number) => { + const id = 'auto-backup'; + if (status === 'started') { + showToast({ + id, + message: 'Auto backup in progress...', + icon: 'fa-sync', + iconSpin: true, + progress: 0 + }); + } else if (status === 'progress' && typeof progress === 'number') { + updateToast(id, { progress }); + } else if (status === 'success') { + updateToast(id, { + message: 'Auto backup complete', + icon: 'fa-check', + iconSpin: false, + variant: 'success', + progress: 1, + autoDismiss: 5000 + }); + } else if (status === 'error') { + updateToast(id, { + message: 'Auto backup failed', + icon: 'fa-exclamation-triangle', + iconSpin: false, + variant: 'error', + progress: undefined, + autoDismiss: 5000 + }); + } + } + ); + //We do this because it's a massive pain in the ๐Ÿซ to read some monstrosity of //an if-else statement to compare our platforms and then pick a keyboard shortcut in our keyboard handle event this.historyNavigateHandleForward = !this.isMac diff --git a/chat/locales/en_us.json b/chat/locales/en_us.json index 301891a4a..62688ac56 100644 --- a/chat/locales/en_us.json +++ b/chat/locales/en_us.json @@ -644,6 +644,7 @@ "settings.export.noCharacters": "No character data is available to export.", "settings.export.saveTitle": "Save Horizon export", "settings.export.summary": "Exported data for {0} character(s) to {1}.", + "settings.export.manageData": "Manage Data", "settings.export.title": "Export Horizon data", "settings.export.zipping": "Finalizing export", "settings.filter.hideAds": "Hide [b]ads[/b] from matching characters", diff --git a/chat/locales/en_uwu.json b/chat/locales/en_uwu.json index ef6bd8d75..198d05474 100644 --- a/chat/locales/en_uwu.json +++ b/chat/locales/en_uwu.json @@ -636,6 +636,7 @@ "settings.export.noCharacters": "Sumimasen... No chawacter data is available to export.", "settings.export.saveTitle": "Save Howizon expowt", "settings.export.summary": "Expowted data for {0} chawacter(s) to {1}.", + "settings.export.manageData": "Manage Data", "settings.export.title": "Expowt Howizon data", "settings.export.zipping": "Finalizing expowt", "settings.filter.hideAds": "Hide [b]ads[/b] fwom matching chawactews", diff --git a/chat/toast.ts b/chat/toast.ts new file mode 100644 index 000000000..e2900b10d --- /dev/null +++ b/chat/toast.ts @@ -0,0 +1,70 @@ +import Vue from 'vue'; + +export interface ToastEntry { + id: string; + message: string; + icon?: string; + iconSpin?: boolean; + variant?: 'default' | 'error' | 'success'; + progress?: number; + autoDismiss?: number; +} + +type ToastUpdate = Partial>; + +const state = Vue.observable({ toasts: [] as ToastEntry[] }); + +const timers = new Map>(); + +let nextId = 0; + +function scheduleAutoDismiss(id: string, ms: number): void { + clearTimer(id); + if (ms > 0) { + timers.set( + id, + setTimeout(() => dismissToast(id), ms) + ); + } +} + +function clearTimer(id: string): void { + const t = timers.get(id); + if (t !== undefined) { + clearTimeout(t); + timers.delete(id); + } +} + +export function showToast( + opts: Omit & { id?: string } +): string { + const id = opts.id ?? `toast-${++nextId}`; + const entry: ToastEntry = { + variant: 'default', + autoDismiss: 0, + ...opts, + id + }; + state.toasts.push(entry); + if (entry.autoDismiss) scheduleAutoDismiss(id, entry.autoDismiss); + return id; +} + +export function updateToast(id: string, partial: ToastUpdate): void { + const idx = state.toasts.findIndex(t => t.id === id); + if (idx === -1) return; + const entry = { ...state.toasts[idx], ...partial }; + Vue.set(state.toasts, idx, entry); + if (partial.autoDismiss !== undefined) { + scheduleAutoDismiss(id, partial.autoDismiss); + } +} + +export function dismissToast(id: string): void { + clearTimer(id); + const idx = state.toasts.findIndex(t => t.id === id); + if (idx !== -1) state.toasts.splice(idx, 1); +} + +export const toasts = state.toasts; diff --git a/components/Toast.vue b/components/Toast.vue new file mode 100644 index 000000000..278d82d64 --- /dev/null +++ b/components/Toast.vue @@ -0,0 +1,95 @@ + + + + + diff --git a/docs/export-format.md b/docs/export-format.md new file mode 100644 index 000000000..b3d570350 --- /dev/null +++ b/docs/export-format.md @@ -0,0 +1,137 @@ +# Horizon Export Format (v2) + +This document describes the ZIP-based export format used by Horizon for +backing up and restoring user data. Other clients can produce or consume +this format by following the specification below. + +## Overview + +A Horizon export is a standard ZIP archive (deflate, level 6 recommended) +containing a flat `manifest.json`, an optional top-level `settings` file, +and per-character data nested under `characters//`. + +## ZIP layout + +``` +manifest.json # required (v2+) +settings # general app settings (JSON, no extension) +characters/ + / + logs/ + .json # chat log (JSON array, see below) + settings/ + pinned # pinned conversations (JSON, no extension) + favoriteEIcons # favorite eicons (JSON, no extension) + recent # recent conversations (JSON, no extension) + recentChannels # recent channels (JSON, no extension) + hiddenUsers # hidden users list (JSON, no extension) + ... # other character settings files + drafts.txt # message drafts (JSON, .txt extension) +``` + +### Path conventions + +- All paths use forward slashes (`/`). +- Character names are used verbatim as directory names (case-sensitive). +- Settings files have no file extension; they contain JSON. +- Log files are JSON arrays (`.txt.json`), organized by target name and + date. Each element is an object with `time` (unix seconds), `type` + (message type integer), `sender` (character name), and `text` fields. + On import, these are converted back to the application's binary format. + +## manifest.json + +The manifest **must** be the first entry in the ZIP. It is a JSON object +with the following fields: + +| Field | Type | Description | +| --------------- | ---------- | ----------------------------------------------------- | +| `version` | `number` | Format version. Currently `2`. | +| `createdAt` | `string` | ISO 8601 timestamp of when the export was created. | +| `app` | `string` | Always `"horizon"`. | +| `expectedFiles` | `number` | Number of data files (excludes `manifest.json`). | +| `characters` | `string[]` | Character names included in the export. | +| `includes` | `object` | Flags indicating which data categories were selected. | + +### `includes` object + +| Field | Type | Description | +| ------------------- | --------- | -------------------------------------------- | +| `generalSettings` | `boolean` | Top-level `settings` file is included. | +| `logs` | `boolean` | Chat log files are included. | +| `drafts` | `boolean` | Draft files are included. | +| `characterSettings` | `boolean` | Full character settings dirs included. | +| `pinned` | `boolean` | Pinned conversations files included. | +| `eicons` | `boolean` | Favorite eicons files included. | +| `recents` | `boolean` | Recent conversations/channels included. | +| `hidden` | `boolean` | Hidden users lists included. | +| `jsonLogs` | `boolean` | If `true`, log files are JSON (`.txt.json`). | + +When `characterSettings` is `true`, all files under each character's +`settings/` directory are included. The `pinned`, `eicons`, `recents`, +and `hidden` flags are still set to reflect what is present, but +`characterSettings` being `true` implies all of them. + +### Example + +```json +{ + "version": 2, + "createdAt": "2026-02-09T14:30:00.000Z", + "app": "horizon", + "expectedFiles": 142, + "characters": ["Alice", "Bob"], + "includes": { + "generalSettings": true, + "logs": true, + "drafts": true, + "characterSettings": true, + "pinned": true, + "eicons": true, + "recents": true, + "hidden": true + } +} +``` + +## Backwards compatibility + +Exports created before v2 do not contain a `manifest.json`. Importers +should handle this gracefully: + +- If `manifest.json` is absent, scan the ZIP entries directly to + determine available characters and data categories. +- If `manifest.json` is present but has an unrecognized `version`, + the importer should warn the user but may still attempt import. + +## Producing an export + +1. Build the list of data files to include. +2. Create the manifest with `expectedFiles` set to the data file count. +3. Write `manifest.json` as the **first** ZIP entry. +4. Add all data files. +5. Finalize the archive. +6. **Verify**: Re-open the ZIP and confirm: + - `manifest.json` exists and parses as valid JSON. + - The entry count matches `expectedFiles + 1` (within a tolerance + of 1 to account for the manifest itself). + - Each character listed in the manifest has at least one entry under + `characters//`. + +## Consuming an import + +1. Open the ZIP and look for `manifest.json`. +2. If present, parse it and validate the `version` and `app` fields. + Use the manifest to populate the UI (character list, available + categories, file counts). +3. If absent, fall back to scanning ZIP entries to build the character + list and detect available data categories. +4. For each file written during import, catch and count per-file errors + rather than aborting the entire operation. +5. After import, report success counts, skip counts, and error counts. + +## Security + +- Validate all ZIP entry paths. Reject entries containing `..` or + entries that resolve outside the target data directory (path + traversal). diff --git a/electron/Exporter.vue b/electron/Exporter.vue index fb90c8251..87379f548 100644 --- a/electron/Exporter.vue +++ b/electron/Exporter.vue @@ -11,8 +11,8 @@
- - {{ l('settings.export.title') }} + + {{ l('settings.export.manageData') }}
- -
-
-
{{ l('settings.export.title') }}
-

- {{ l('settings.export.description') }} -

-
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- {{ l('settings.import.charactersLegend') }} -
- +
+
+ + Auto Backup + + + Export + + + Import + + + Import from + Vanilla + +
+
+
+
Auto Backup
+

+ Automatically create backups based on triggers you choose. + Old backups are removed based on the retention count. +

+
+ +
-
-
-
- -
- - - {{ Math.round((exportProgress ?? 0) * 100) }}% - - ยท {{ exportCount || 0 }}/{{ exportTotal }} - - - ยท {{ l('settings.export.zipping') - }}{{ exportAnimatedDots }} - - +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + + + Estimated usage: ~{{ estimatedRetentionSize }} + +
+
+ +
+ + + +
+ + Default: {{ defaultBackupDir }} + +
-
-
- {{ exportSummary }} -
-
- {{ exportError }} -
-
- -
{{ l('settings.import.zip.title') }}
-

- {{ l('settings.import.zip.description') }} -

-
- -
- {{ l('settings.import.zip.selected', importZipName) }} -
-
- {{ l('settings.import.zip.noFile') }} +
+
Restore from Auto Backup
+

+ Select an auto backup to restore. This loads it into the + import section below. +

+
+ + +
-
- {{ importZipError }} -
-
+
+
{{ l('settings.export.title') }}
+

+ {{ l('settings.export.description') }} +

- - {{ l('settings.import.zip.generalUnavailable') }} -
- - {{ - l('settings.import.zip.characterSettingsUnavailable') - }} -
-
-
- - {{ l('settings.import.zip.pinnedUnavailable') }} - - - {{ l('settings.import.zip.pinnedIncludedWithSettings') }} -
- - {{ l('settings.import.zip.pinnedUnavailable') }} - - - {{ l('settings.import.zip.pinnedIncludedWithSettings') }} -
-
-
+
-
{{ l('settings.import.charactersLegend') }} @@ -433,10 +529,10 @@
+
+ +
+ + + {{ Math.round((exportProgress ?? 0) * 100) }}% + + ยท {{ exportCount || 0 }}/{{ exportTotal }} + + + ยท {{ l('settings.export.zipping') + }}{{ exportAnimatedDots }} + + +
+
+
+ {{ exportSummary }} +
+
+ {{ exportError }} +
+
+
+
{{ l('settings.import.zip.title') }}
+

+ {{ l('settings.import.zip.description') }} +

+
+ +
+ {{ l('settings.import.zip.selected', importZipName) }} +
+
+ {{ l('settings.import.zip.noFile') }} +
+
+
+ {{ importZipError }} +
+
+ Horizon export v{{ importZipManifest.version }} · + {{ importZipManifest.characters.length }} character(s) + · {{ importZipManifest.expectedFiles }} file(s) + · created + {{ new Date(importZipManifest.createdAt).toLocaleString() }} + · Logs: + {{ + importZipManifest.includes && + importZipManifest.includes.jsonLogs + ? 'JSON' + : 'Binary' + }} +
+
+ This export was created without a manifest. It may be from + an older version of Horizon. Import should still work + normally. +
+
+
+ + + + {{ l('settings.import.zip.generalUnavailable') }} + +
+
+ + + + {{ + l('settings.import.zip.characterSettingsUnavailable') + }} + +
+
+ + + + {{ l('settings.import.zip.logsUnavailable') }} + +
+
+ + + + {{ l('settings.import.zip.draftsUnavailable') }} + +
+
+ + + + {{ l('settings.import.zip.pinnedUnavailable') }} + + + {{ + l('settings.import.zip.pinnedIncludedWithSettings') + }} + +
+
+ + + + {{ l('settings.import.zip.pinnedUnavailable') }} + + + {{ + l('settings.import.zip.pinnedIncludedWithSettings') + }} + +
+
+ + + + {{ l('settings.import.zip.recentsUnavailable') }} + +
+
+ + + + {{ l('settings.import.zip.hiddenUnavailable') }} + +
+
+ + {{ l('settings.import.charactersLegend') }} + +
+ +
+
+ +
+ {{ l('settings.import.zip.noCharacters') }}
+
+
+
+ + +
+
- {{ l('settings.import.zip.noCharacters') }} + {{ + l('settings.import.lockedWhileConnected') || + 'Import is disabled while signed into a character.' + }} + + ({{ connectedCharacters.join(', ') }}) +
+
- -
- - -
-
-
- {{ - l('settings.import.lockedWhileConnected') || - 'Import is disabled while signed into a character.' - }} - - ({{ connectedCharacters.join(', ') }}) - +
+ {{ importSummary }} +
+
+ {{ importError }}
- -
-
- {{ importSummary }} -
-
- {{ importError }} -
-
-
-
-
{{ l('settings.import.vanilla.title') }}
-
- -
- - -
- - {{ l('settings.import.vanilla.customDirHelp') }} -
-
-
- {{ l('settings.import.vanilla.location', vanillaBaseDir) }} -
-
- - - - {{ l('settings.import.vanilla.generalUnavailable') }} - -
-
- +
+
{{ l('settings.import.vanilla.title') }}
+
+
+ + + +
+ + {{ l('settings.import.vanilla.customDirHelp') }} +
-
- - - +
+
{{ - l('settings.import.vanilla.pinnedIncludedWithSettings') + l('settings.import.vanilla.location', vanillaBaseDir) }} - -
-
- - -
-
- - -
-
- {{ l('settings.import.charactersLegend') }} -
- +
-
+
+ + + {{ + l( + 'settings.import.vanilla.pinnedIncludedWithSettings' + ) + }} + +
+
+ + +
+
+ + +
+
+ + {{ l('settings.import.charactersLegend') }} + +
+ +
+ +
+ {{ l('settings.import.vanilla.noCharacters') }} +
+
+
+
+
- {{ l('settings.import.vanilla.noCharacters') }} + {{ + l('settings.import.lockedWhileConnected') || + 'Import is disabled while signed into a character.' + }} + + ({{ connectedCharacters.join(', ') }}) +
+
-
-
- {{ - l('settings.import.lockedWhileConnected') || - 'Import is disabled while signed into a character.' - }} - - ({{ connectedCharacters.join(', ') }}) - + {{ vanillaImportSummary }} +
+
+ {{ vanillaImportError }}
- -
-
- {{ vanillaImportSummary }}
-
- {{ vanillaImportError }} +
+ {{ l('settings.import.vanilla.notFound') }}
-
- {{ l('settings.import.vanilla.notFound') }} -
@@ -778,16 +1221,13 @@ import fs from 'fs'; import path from 'path'; import { ipcRenderer } from 'electron'; - import Tabs from '../components/tabs'; import * as ImportExport from './services'; import type { VanillaContext } from './services/importer/vanilla-importer'; import type { BackupCharacterInfo } from './services/importer/backup-import'; const browserWindow = remote.getCurrentWindow(); - @Component({ - components: { tabs: Tabs } - }) + @Component({}) export default class ExporterWindow extends Vue { settings!: GeneralSettings; importHint: @@ -798,10 +1238,10 @@ | undefined = undefined; l = l; osIsDark: boolean = remote.nativeTheme.shouldUseDarkColors; - selectedTab = '0'; + selectedSection: 'auto-backup' | 'export' | 'import' | 'vanilla' = + 'auto-backup'; isMac = process.platform === 'darwin'; platform = process.platform; - vanillaTabId = '1'; vanillaContext?: VanillaContext; vanillaImportAvailable = false; @@ -861,8 +1301,27 @@ importZipName: string | undefined = undefined; importZipError: string | undefined = undefined; private importZipArchive?: any; + importZipHasManifest = false; + importZipManifest: any = undefined; connectedCharacters: string[] = []; + autoBackups: { name: string; path: string; mtime: number; size: number }[] = + []; + selectedAutoBackup: string | undefined = undefined; + + get defaultBackupDir(): string { + return path.join(remote.app.getPath('userData'), 'backups'); + } + + async chooseAutoBackupDir(): Promise { + const result = await remote.dialog.showOpenDialog(browserWindow, { + properties: ['openDirectory'], + defaultPath: this.settings.autoBackupDirectory || this.defaultBackupDir + }); + if (!result.canceled && result.filePaths.length > 0) { + this.settings.autoBackupDirectory = result.filePaths[0]; + } + } get anyCharactersConnected(): boolean { return ( @@ -1047,6 +1506,12 @@ this.osIsDark = remote.nativeTheme.shouldUseDarkColors; }); + window.addEventListener('beforeunload', e => { + if (this.exportInProgress || this.importInProgress) { + e.preventDefault(); + } + }); + window.addEventListener('keyup', e => { if (e.key === 'Escape') { this.close(); @@ -1066,6 +1531,27 @@ this.refreshExportCharacters(); } ); + this.$watch( + () => [ + this.settings.autoBackupEnabled, + ...(this.settings.autoBackupTriggers || []), + this.settings.autoBackupIntervalHours, + ...(this.settings.autoBackupCronTimes || []), + this.settings.autoBackupIncludeGeneralSettings, + this.settings.autoBackupIncludeCharacterSettings, + this.settings.autoBackupIncludeLogs, + this.settings.autoBackupIncludeDrafts, + this.settings.autoBackupIncludePinnedConversations, + this.settings.autoBackupIncludePinnedEicons, + this.settings.autoBackupIncludeRecents, + this.settings.autoBackupIncludeHidden, + this.settings.autoBackupRetention, + this.settings.autoBackupDirectory + ], + () => { + ipcRenderer.send('general-settings-update', this.settings); + } + ); this.$watch( () => this.importIncludeCharacterSettings, include => { @@ -1083,6 +1569,19 @@ } ); + this.$watch( + () => this.selectedAutoBackup, + async (backupPath: string | undefined) => { + if (!backupPath) return; + await ImportExport.loadImportZip(this, backupPath); + this.selectedSection = 'import'; + } + ); + + if (this.settings.autoBackupEnabled) { + this.refreshAutoBackups(); + } + await this.initializeImportExport(); try { @@ -1137,6 +1636,24 @@ ImportExport.describeImportCharacter(character); runZipImport = () => ImportExport.runZipImport(this); + async refreshAutoBackups(): Promise { + try { + this.autoBackups = await ipcRenderer.invoke('list-auto-backups'); + } catch { + this.autoBackups = []; + } + } + + formatBackupLabel(backup: { + name: string; + mtime: number; + size: number; + }): string { + const date = new Date(backup.mtime).toLocaleString(); + const mb = (backup.size / (1024 * 1024)).toFixed(1); + return `${date} (${mb} MB)`; + } + startExportAnimation(): void { this.exportAnimatedDots = ''; this.exportAnimationTimer = setInterval(() => { @@ -1156,7 +1673,76 @@ this.exportAnimatedDots = ''; } + get estimatedRetentionSize(): string | undefined { + if (!this.autoBackups.length) return undefined; + const latest = this.autoBackups[0]; + const total = latest.size * (this.settings.autoBackupRetention || 1); + if (total < 1024 * 1024) { + return `${(total / 1024).toFixed(0)} KB`; + } + if (total < 1024 * 1024 * 1024) { + return `${(total / (1024 * 1024)).toFixed(1)} MB`; + } + return `${(total / (1024 * 1024 * 1024)).toFixed(2)} GB`; + } + + hasTrigger(t: string): boolean { + const triggers = this.settings.autoBackupTriggers; + return Array.isArray(triggers) && triggers.includes(t); + } + + toggleTrigger(t: string): void { + if (!Array.isArray(this.settings.autoBackupTriggers)) { + this.settings.autoBackupTriggers = ['launch']; + } + const idx = this.settings.autoBackupTriggers.indexOf(t); + if (idx === -1) { + this.settings.autoBackupTriggers.push(t); + } else { + this.settings.autoBackupTriggers.splice(idx, 1); + } + this.settings.autoBackupTriggers = [...this.settings.autoBackupTriggers]; + } + + setCronTime(idx: number, value: string): void { + if (!Array.isArray(this.settings.autoBackupCronTimes)) return; + this.settings.autoBackupCronTimes.splice(idx, 1, value); + this.settings.autoBackupCronTimes = [ + ...this.settings.autoBackupCronTimes + ]; + } + + removeCronTime(idx: number): void { + if (!Array.isArray(this.settings.autoBackupCronTimes)) return; + this.settings.autoBackupCronTimes.splice(idx, 1); + this.settings.autoBackupCronTimes = [ + ...this.settings.autoBackupCronTimes + ]; + } + + addCronTime(): void { + if (!Array.isArray(this.settings.autoBackupCronTimes)) { + this.settings.autoBackupCronTimes = []; + } + this.settings.autoBackupCronTimes = [ + ...this.settings.autoBackupCronTimes, + '02:00' + ]; + } + close(): void { + if (this.exportInProgress || this.importInProgress) { + const choice = remote.dialog.showMessageBoxSync(browserWindow, { + type: 'warning', + buttons: ['Cancel', 'Close anyway'], + defaultId: 0, + cancelId: 0, + title: 'Operation in progress', + message: + 'An export or import is still running. Closing now may result in incomplete or corrupted data.' + }); + if (choice === 0) return; + } browserWindow.close(); } @@ -1202,10 +1788,6 @@ width: 100%; } - .tab-content { - overflow: auto; - } - .modal-body { height: 100%; display: flex; @@ -1221,15 +1803,33 @@ padding-bottom: 1rem; } - .modal-body .nav-tabs-scroll { - flex: 0 1 auto; - min-height: 42px; + .data-manager-sidebar { + width: 200px; + min-width: 200px; + border-right: 1px solid var(--bs-border-color); + padding: 0.5rem 0; + } + + .data-manager-sidebar .nav-link { + color: var(--bs-body-color); + padding: 0.5rem 1rem; + font-size: 0.875rem; + border-radius: 0; + + &:hover { + background: var(--bs-tertiary-bg); + } + + &.active { + background: var(--bs-primary); + color: #fff; + } } - .modal-body .tab-content { + .data-manager-content { + flex: 1; overflow: auto; - flex: 1 1 auto; - padding-bottom: 1em; + padding: 1rem 1.25rem; } .label-full { diff --git a/electron/common.ts b/electron/common.ts index 8adc45f6b..2c8c9995f 100644 --- a/electron/common.ts +++ b/electron/common.ts @@ -67,6 +67,20 @@ export class GeneralSettings { hasImportedVanillaLogs: boolean = false; hasDismissedVanillaImport: boolean = false; vanillaCustomBaseDir: string | undefined = undefined; + autoBackupEnabled: boolean = false; + autoBackupTriggers: string[] = ['launch']; + autoBackupIntervalHours: number = 6; + autoBackupCronTimes: string[] = ['02:00']; + autoBackupIncludeGeneralSettings: boolean = true; + autoBackupIncludeCharacterSettings: boolean = true; + autoBackupIncludeLogs: boolean = true; + autoBackupIncludeDrafts: boolean = true; + autoBackupIncludePinnedConversations: boolean = true; + autoBackupIncludePinnedEicons: boolean = true; + autoBackupIncludeRecents: boolean = true; + autoBackupIncludeHidden: boolean = true; + autoBackupRetention: number = 5; + autoBackupDirectory: string = ''; } log.debug('init.common.done'); diff --git a/electron/main.ts b/electron/main.ts index ff07eb176..75ba602ae 100644 --- a/electron/main.ts +++ b/electron/main.ts @@ -70,6 +70,9 @@ const app = electron.app; remoteMain.initialize(); const characters: string[] = []; +let autoBackupScheduler: + | import('./services/exporter/auto-backup').AutoBackupScheduler + | undefined; async function tryHandleCli(): Promise { const argv = process.argv.slice(1); @@ -682,12 +685,6 @@ async function onReady(): Promise { accelerator: process.platform === 'darwin' ? 'CmdOrCtrl+,' : undefined }, - { - label: l('settings.export.title'), - click: (_m, window: electron.BrowserWindow) => { - browserWindows.createExporterWindow(settings, 'none', window); - } - }, { label: l('fixLogs.action'), click: (_m, window: electron.BrowserWindow) => @@ -735,6 +732,12 @@ async function onReady(): Promise { { role: 'selectall' } ] as MenuItemConstructorOptions[] }, + { + label: `&${l('settings.export.manageData')}`, + click: (_m: electron.MenuItem, w: electron.BrowserWindow) => { + browserWindows.createExporterWindow(settings, 'none', w); + } + }, viewItem, ...(process.platform === 'darwin' ? [windowItem] : []), { @@ -931,6 +934,7 @@ async function onReady(): Promise { characters.push(character); e.returnValue = true; broadcastConnectedCharacters(); + if (autoBackupScheduler) autoBackupScheduler.runOnConnect(); } ); electron.ipcMain.on( @@ -962,6 +966,28 @@ async function onReady(): Promise { return characters.slice(); }); + electron.ipcMain.handle('list-auto-backups', () => { + const backupDir = + settings.autoBackupDirectory || path.join(baseDir, 'backups'); + try { + return fs + .readdirSync(backupDir) + .filter(f => /^auto-backup-.*\.zip$/.test(f)) + .map(f => { + const stat = fs.statSync(path.join(backupDir, f)); + return { + name: f, + path: path.join(backupDir, f), + mtime: stat.mtimeMs, + size: stat.size + }; + }) + .sort((a, b) => b.mtime - a.mtime); + } catch { + return []; + } + }); + const adCoordinator = new AdCoordinatorHost(); electron.ipcMain.on('request-send-ad', (event: IpcMainEvent, adId: string) => adCoordinator.processAdRequest(event, adId) @@ -1047,6 +1073,9 @@ async function onReady(): Promise { settings.horizonCustomCssEnabled ); } + if (autoBackupScheduler) { + autoBackupScheduler.reload(); + } } } ); @@ -1068,6 +1097,13 @@ async function onReady(): Promise { ); showChangelogOnBoot = false; } + + import('./services/exporter/auto-backup').then(({ AutoBackupScheduler }) => { + autoBackupScheduler = new AutoBackupScheduler(settings, baseDir); + if (settings.autoBackupEnabled) { + autoBackupScheduler.start(); + } + }); } // Twitter fix @@ -1114,4 +1150,23 @@ app.on('before-quit', (event: Event) => { } browserWindows.quitAllWindows(); }); +let willQuitHandled = false; +app.on('will-quit', (event: Event) => { + if ( + !willQuitHandled && + autoBackupScheduler && + settings.autoBackupEnabled && + Array.isArray(settings.autoBackupTriggers) && + settings.autoBackupTriggers.includes('close') + ) { + willQuitHandled = true; + event.preventDefault(); + autoBackupScheduler.runOnClose().finally(() => { + if (autoBackupScheduler) autoBackupScheduler.stop(); + app.quit(); + }); + } else if (autoBackupScheduler) { + autoBackupScheduler.stop(); + } +}); app.on('window-all-closed', () => app.quit()); diff --git a/electron/services/exporter/auto-backup.ts b/electron/services/exporter/auto-backup.ts new file mode 100644 index 000000000..ec5f593f5 --- /dev/null +++ b/electron/services/exporter/auto-backup.ts @@ -0,0 +1,190 @@ +import fs from 'fs'; +import path from 'path'; +import * as electron from 'electron'; +import log from 'electron-log'; +import { runExportCli } from './backup-export-cli'; +import type { GeneralSettings } from '../../common'; + +function formatTimestamp(): string { + const now = new Date(); + const pad = (n: number) => String(n).padStart(2, '0'); + return ( + `${now.getFullYear()}-${pad(now.getMonth() + 1)}-${pad(now.getDate())}` + + `T${pad(now.getHours())}-${pad(now.getMinutes())}-${pad(now.getSeconds())}` + ); +} + +function broadcast(channel: string, ...args: any[]): void { + for (const w of electron.webContents.getAllWebContents()) { + try { + w.send(channel, ...args); + } catch {} + } +} + +function cleanupOldBackups(dir: string, retention: number): void { + try { + const files = fs + .readdirSync(dir) + .filter(f => /^auto-backup-.*\.zip$/.test(f)) + .map(f => ({ + name: f, + mtime: fs.statSync(path.join(dir, f)).mtimeMs + })) + .sort((a, b) => b.mtime - a.mtime); + + for (const file of files.slice(retention)) { + try { + fs.unlinkSync(path.join(dir, file.name)); + log.info('auto-backup.cleanup.deleted', file.name); + } catch (err) { + log.warn('auto-backup.cleanup.delete-failed', file.name, err); + } + } + } catch (err) { + log.warn('auto-backup.cleanup.failed', err); + } +} + +export async function performAutoBackup( + settings: GeneralSettings, + baseDir: string +): Promise { + const backupDir = + settings.autoBackupDirectory || path.join(baseDir, 'backups'); + const outPath = path.join(backupDir, `auto-backup-${formatTimestamp()}.zip`); + + log.info('auto-backup.start', outPath); + broadcast('auto-backup-status', 'started'); + + try { + await runExportCli({ + dataDir: settings.logDirectory, + out: outPath, + includeGeneral: settings.autoBackupIncludeGeneralSettings, + includeCharacterSettings: settings.autoBackupIncludeCharacterSettings, + includeLogs: settings.autoBackupIncludeLogs, + includeDrafts: settings.autoBackupIncludeDrafts, + includePinnedConversations: settings.autoBackupIncludePinnedConversations, + includePinnedEicons: settings.autoBackupIncludePinnedEicons, + includeRecents: settings.autoBackupIncludeRecents, + includeHidden: settings.autoBackupIncludeHidden, + onProgress: (fraction: number) => { + broadcast('auto-backup-status', 'progress', fraction); + } + }); + + log.info('auto-backup.success', outPath); + broadcast('auto-backup-status', 'success'); + + const retention = Math.max(1, Math.min(50, settings.autoBackupRetention)); + cleanupOldBackups(backupDir, retention); + } catch (err) { + log.error('auto-backup.failed', err); + broadcast('auto-backup-status', 'error'); + } +} + +function msUntilTime(hhmm: string): number { + const [h, m] = hhmm.split(':').map(Number); + const now = new Date(); + const target = new Date(now); + target.setHours(h, m, 0, 0); + if (target.getTime() <= now.getTime()) { + target.setDate(target.getDate() + 1); + } + return target.getTime() - now.getTime(); +} + +export class AutoBackupScheduler { + private intervalTimer?: NodeJS.Timeout; + private cronTimers: NodeJS.Timeout[] = []; + private launchTimer?: NodeJS.Timeout; + private running = false; + private backupInProgress = false; + + constructor( + private settings: GeneralSettings, + private baseDir: string + ) {} + + private hasTrigger(t: string): boolean { + const triggers = this.settings.autoBackupTriggers; + return Array.isArray(triggers) && triggers.includes(t); + } + + start(): void { + if (this.running) return; + this.running = true; + + if (this.hasTrigger('launch')) { + this.launchTimer = setTimeout(() => this.runOnce(), 30000); + } + + if (this.hasTrigger('interval')) { + const hours = Math.max(0.5, this.settings.autoBackupIntervalHours || 6); + const ms = hours * 60 * 60 * 1000; + this.intervalTimer = setInterval(() => this.runOnce(), ms); + } + + if (this.hasTrigger('cron')) { + const times = this.settings.autoBackupCronTimes || []; + for (const time of times) { + if (!/^\d{2}:\d{2}$/.test(time)) continue; + this.scheduleCron(time); + } + } + } + + private scheduleCron(time: string): void { + const ms = msUntilTime(time); + const timer = setTimeout(() => { + this.runOnce(); + const idx = this.cronTimers.indexOf(timer); + if (idx !== -1) this.cronTimers.splice(idx, 1); + if (this.running) this.scheduleCron(time); + }, ms); + this.cronTimers.push(timer); + } + + stop(): void { + this.running = false; + if (this.launchTimer) { + clearTimeout(this.launchTimer); + this.launchTimer = undefined; + } + if (this.intervalTimer) { + clearInterval(this.intervalTimer); + this.intervalTimer = undefined; + } + for (const t of this.cronTimers) clearTimeout(t); + this.cronTimers = []; + } + + reload(): void { + this.stop(); + if (this.settings.autoBackupEnabled) { + this.start(); + } + } + + async runOnce(): Promise { + if (this.backupInProgress) return; + this.backupInProgress = true; + try { + await performAutoBackup(this.settings, this.baseDir); + } finally { + this.backupInProgress = false; + } + } + + async runOnClose(): Promise { + if (!this.hasTrigger('close')) return; + await this.runOnce(); + } + + async runOnConnect(): Promise { + if (!this.hasTrigger('connect')) return; + await this.runOnce(); + } +} diff --git a/electron/services/exporter/backup-export-cli.ts b/electron/services/exporter/backup-export-cli.ts index cba3b9ba9..27b2afcd0 100644 --- a/electron/services/exporter/backup-export-cli.ts +++ b/electron/services/exporter/backup-export-cli.ts @@ -1,6 +1,8 @@ import fs from 'fs'; import path from 'path'; import archiver from 'archiver'; +import { createManifest } from './manifest'; +import type { ExportManifest } from './manifest'; /** * Configuration options for CLI-based export operations. @@ -31,6 +33,37 @@ export interface ExportCliOptions { includeHidden: boolean; characters?: string[]; dryRun?: boolean; + onProgress?: (fraction: number) => void; +} + +export function binaryLogToJson( + buffer: Buffer +): { time: number; type: number; sender: string; text: string }[] { + const messages: { + time: number; + type: number; + sender: string; + text: string; + }[] = []; + let offset = 0; + while (offset + 10 <= buffer.length) { + const time = buffer.readUInt32LE(offset); + const type = buffer.readUInt8(offset + 4); + const senderLength = buffer.readUInt8(offset + 5); + if (offset + 6 + senderLength + 2 > buffer.length) break; + const sender = buffer.toString( + 'utf8', + offset + 6, + offset + 6 + senderLength + ); + const textLength = buffer.readUInt16LE(offset + 6 + senderLength); + const textStart = offset + 6 + senderLength + 2; + if (textStart + textLength + 2 > buffer.length) break; + const text = buffer.toString('utf8', textStart, textStart + textLength); + messages.push({ time, type, sender, text }); + offset = textStart + textLength + 2; + } + return messages; } function getCharacters(dataDir: string, filter?: string[]): string[] { @@ -181,6 +214,56 @@ function logDryRunDetails( } } +function countEntries( + dataDir: string, + characters: string[], + opts: ExportCliOptions +): number { + let count = 0; + + if (opts.includeGeneral) { + const generalSettingsFile = path.join(dataDir, 'settings'); + if (fs.existsSync(generalSettingsFile)) count++; + } + + for (const character of characters) { + const characterDir = path.join(dataDir, character); + if (!fs.existsSync(characterDir)) continue; + + if (opts.includeLogs) { + const logsDir = path.join(characterDir, 'logs'); + if (fs.existsSync(logsDir)) { + count += listFilesRecursive(logsDir).length; + } + } + + if (opts.includeDrafts) { + if (fs.existsSync(path.join(characterDir, 'drafts.txt'))) count++; + } + + const settingsDir = path.join(characterDir, 'settings'); + if (fs.existsSync(settingsDir)) { + if (opts.includeCharacterSettings) { + count += listFilesRecursive(settingsDir).length; + } else { + const files = new Set(); + if (opts.includePinnedConversations) files.add('pinned'); + if (opts.includePinnedEicons) files.add('favoriteEIcons'); + if (opts.includeRecents) { + files.add('recent'); + files.add('recentChannels'); + } + if (opts.includeHidden) files.add('hiddenUsers'); + for (const f of Array.from(files)) { + if (fs.existsSync(path.join(settingsDir, f))) count++; + } + } + } + } + + return count; +} + async function createArchive( opts: ExportCliOptions, dataDir: string, @@ -196,6 +279,27 @@ async function createArchive( const output = fs.createWriteStream(opts.out); archive.pipe(output); + // Write manifest + const expectedFiles = countEntries(dataDir, characters, opts); + const manifest = createManifest( + characters, + { + generalSettings: opts.includeGeneral, + logs: opts.includeLogs, + drafts: opts.includeDrafts, + characterSettings: opts.includeCharacterSettings, + pinned: opts.includePinnedConversations, + eicons: opts.includePinnedEicons, + recents: opts.includeRecents, + hidden: opts.includeHidden, + jsonLogs: undefined + }, + expectedFiles + ); + archive.append(JSON.stringify(manifest, null, 2), { + name: 'manifest.json' + }); + if (opts.includeGeneral) { const generalSettingsFile = path.join(dataDir, 'settings'); if (fs.existsSync(generalSettingsFile)) { @@ -207,6 +311,15 @@ async function createArchive( addCharacterToArchive(archive, dataDir, c, opts); } + if (opts.onProgress) { + const total = expectedFiles + 1; // +1 for manifest + const cb = opts.onProgress; + archive.on('progress', (progressData: any) => { + const processed = progressData.entries?.processed || 0; + cb(Math.min(0.99, processed / total)); + }); + } + const result = new Promise<{ characters: string[]; out: string }>( (resolve, reject) => { output.on('close', () => { diff --git a/electron/services/exporter/backup-export.ts b/electron/services/exporter/backup-export.ts index a4b0755d6..1790b9b09 100644 --- a/electron/services/exporter/backup-export.ts +++ b/electron/services/exporter/backup-export.ts @@ -3,6 +3,10 @@ import fs from 'fs'; import path from 'path'; import log from 'electron-log'; import archiver from 'archiver'; +import AdmZip from 'adm-zip'; +import { createManifest, isValidManifest } from './manifest'; +import type { ExportManifest } from './manifest'; +import { binaryLogToJson } from './backup-export-cli'; async function yieldToUi(vm?: any): Promise { try { @@ -109,7 +113,7 @@ function listFilesRecursive(rootDir: string): string[] { return results; } -type ExportEntry = { abs: string; zip: string }; +type ExportEntry = { abs: string; zip: string; isLog?: boolean }; function buildExportEntries( dataDir: string, @@ -133,9 +137,15 @@ function buildExportEntries( if (fs.existsSync(logsDir)) { const files = listFilesRecursive(logsDir); for (const abs of files) { + if (abs.endsWith('.idx')) continue; const rel = path.relative(logsDir, abs).replace(/\\/g, '/'); - const zip = path.posix.join('characters', character, 'logs', rel); - entries.push({ abs, zip }); + const zip = path.posix.join( + 'characters', + character, + 'logs', + rel + '.json' + ); + entries.push({ abs, zip, isLog: true }); } } } @@ -197,6 +207,60 @@ function getSettingsFilesToInclude(vm: any): Set { * @param vm - Vue component instance with export state and settings * @returns A promise that resolves when export completes or is cancelled */ +function buildManifestIncludes(vm: any): ExportManifest['includes'] { + return { + generalSettings: !!vm.exportIncludeGeneralSettings, + logs: !!vm.exportIncludeLogs, + drafts: !!vm.exportIncludeDrafts, + characterSettings: !!vm.exportIncludeCharacterSettings, + pinned: !!vm.exportIncludePinnedConversations, + eicons: !!vm.exportIncludePinnedEicons, + recents: !!vm.exportIncludeRecents, + hidden: !!vm.exportIncludeHidden, + jsonLogs: vm.exportIncludeLogs ? true : undefined + }; +} + +function verifyExportZip( + filePath: string, + manifest: ExportManifest +): string | undefined { + try { + const zip = new AdmZip(filePath); + const manifestEntry = zip.getEntry('manifest.json'); + if (!manifestEntry) + return 'Verification failed: manifest.json missing from ZIP.'; + + let parsed: unknown; + try { + parsed = JSON.parse(manifestEntry.getData().toString('utf8')); + } catch { + return 'Verification failed: manifest.json is not valid JSON.'; + } + + if (!isValidManifest(parsed)) + return 'Verification failed: manifest.json has invalid format.'; + + const entries = zip.getEntries().filter(e => !e.isDirectory); + const expected = manifest.expectedFiles + 1; // +1 for manifest itself + if (Math.abs(entries.length - expected) > 1) + return `Verification failed: expected ~${expected} files but ZIP contains ${entries.length}.`; + + const zipPaths = new Set(entries.map(e => e.entryName.replace(/\\/g, '/'))); + for (const char of manifest.characters) { + const hasEntry = Array.from(zipPaths).some(p => + p.startsWith(`characters/${char}/`) + ); + if (!hasEntry) + return `Verification failed: no files found for character "${char}".`; + } + + return undefined; + } catch (err) { + return `Verification failed: ${err instanceof Error ? err.message : String(err)}`; + } +} + export async function runExport(vm: any): Promise { if (!vm.canRunExport) return; vm.exportInProgress = true; @@ -206,6 +270,8 @@ export async function runExport(vm: any): Promise { vm.exportCount = 0; vm.exportTotal = 0; + let outputPath: string | undefined; + try { const saveResult = await remote.dialog.showSaveDialog({ title: 'Save Horizon Export', // TODO: localize @@ -219,6 +285,8 @@ export async function runExport(vm: any): Promise { return; } + outputPath = saveResult.filePath; + const dataDir = vm.settings.logDirectory; if (!dataDir || !fs.existsSync(dataDir)) throw new Error('Log directory not found'); @@ -233,26 +301,58 @@ export async function runExport(vm: any): Promise { zlib: { level: 6 } }); - const output = fs.createWriteStream(saveResult.filePath); + const output = fs.createWriteStream(outputPath); + let streamErrored = false; + + output.on('error', () => { + streamErrored = true; + }); + archive.pipe(output); + // Write manifest as first entry + const manifest = createManifest( + selectedCharacters, + buildManifestIncludes(vm), + entries.length + ); + archive.append(JSON.stringify(manifest, null, 2), { + name: 'manifest.json' + }); + archive.on('progress', progressData => { const processed = progressData.entries.processed || 0; - vm.exportCount = processed; - vm.exportProgress = Math.max(0, Math.min(0.98, processed / total)); + vm.exportCount = Math.max(0, processed - 1); // -1 for manifest + vm.exportProgress = Math.max(0, Math.min(0.98, processed / (total + 1))); }); let count = 0; + const failedFiles: string[] = []; for (const e of entries) { - if (fs.existsSync(e.abs)) { - archive.file(e.abs, { name: e.zip }); - count++; - if (count % 10 === 0) { - await yieldToUi(vm); + try { + if (fs.existsSync(e.abs)) { + if (e.isLog) { + const buf = fs.readFileSync(e.abs); + const json = binaryLogToJson(buf); + archive.append(JSON.stringify(json), { name: e.zip }); + } else { + archive.file(e.abs, { name: e.zip }); + } + count++; + if (count % 10 === 0) { + await yieldToUi(vm); + } } + } catch (err) { + failedFiles.push(e.zip); + log.warn('export.file.error', e.zip, err); } } + if (streamErrored) { + throw new Error('Output stream error during export.'); + } + vm.exportProgress = 0.99; await archive.finalize(); @@ -260,17 +360,40 @@ export async function runExport(vm: any): Promise { output.on('close', () => { vm.exportProgress = 1; const bytes = archive.pointer(); - log.info('export.complete', saveResult.filePath, `${bytes} bytes`); + log.info('export.complete', outputPath, `${bytes} bytes`); resolve(); }); output.on('error', reject); archive.on('error', reject); }); - vm.exportSummary = `Exported data for ${selectedCharacters.length} character(s) to ${saveResult.filePath}`; + if (archive.pointer() === 0) { + throw new Error('Export produced an empty ZIP file.'); + } + + // Verify the written ZIP + const verifyError = verifyExportZip(outputPath, manifest); + if (verifyError) { + log.error('export.verify.failed', verifyError); + vm.exportError = verifyError; + return; + } + + let summary = `Exported ${count} file(s) for ${selectedCharacters.length} character(s) to ${outputPath}`; + if (failedFiles.length > 0) { + summary += ` (${failedFiles.length} file(s) skipped due to errors)`; + } + vm.exportSummary = summary; } catch (error) { log.error('settings.export.error', error); - vm.exportError = 'Export failed. Please check the logs for details.'; + vm.exportError = `Export failed: ${error instanceof Error ? error.message : 'Please check the logs for details.'}`; + + // Clean up partial ZIP on failure + if (outputPath) { + try { + if (fs.existsSync(outputPath)) fs.unlinkSync(outputPath); + } catch {} + } } finally { vm.exportInProgress = false; vm.exportProgress = undefined; diff --git a/electron/services/exporter/manifest.ts b/electron/services/exporter/manifest.ts new file mode 100644 index 000000000..f18007274 --- /dev/null +++ b/electron/services/exporter/manifest.ts @@ -0,0 +1,47 @@ +export interface ExportManifest { + version: number; + createdAt: string; + app: 'horizon'; + expectedFiles: number; + characters: string[]; + includes: { + generalSettings: boolean; + logs: boolean; + drafts: boolean; + characterSettings: boolean; + pinned: boolean; + eicons: boolean; + recents: boolean; + hidden: boolean; + jsonLogs?: boolean; + }; +} + +export function createManifest( + characters: string[], + includes: ExportManifest['includes'], + expectedFiles: number +): ExportManifest { + return { + version: 2, + createdAt: new Date().toISOString(), + app: 'horizon', + expectedFiles, + characters, + includes + }; +} + +export function isValidManifest(data: unknown): data is ExportManifest { + if (!data || typeof data !== 'object') return false; + const m = data as any; + return ( + typeof m.version === 'number' && + typeof m.createdAt === 'string' && + m.app === 'horizon' && + typeof m.expectedFiles === 'number' && + Array.isArray(m.characters) && + typeof m.includes === 'object' && + m.includes !== null + ); +} diff --git a/electron/services/importer/backup-import.ts b/electron/services/importer/backup-import.ts index d4b089680..fb0436c13 100644 --- a/electron/services/importer/backup-import.ts +++ b/electron/services/importer/backup-import.ts @@ -4,6 +4,8 @@ import path from 'path'; import { ipcRenderer } from 'electron'; import log from 'electron-log'; import AdmZip from 'adm-zip'; +import { isValidManifest } from '../exporter/manifest'; +import type { ExportManifest } from '../exporter/manifest'; /** * Information about a character found in a Horizon backup ZIP file. @@ -75,6 +77,8 @@ export function resetImportZipState(vm: any): void { vm.importIncludeHidden = false; vm.importIncludeDrafts = false; vm.importZipError = undefined; + vm.importZipHasManifest = false; + vm.importZipManifest = undefined; } /** @@ -142,6 +146,15 @@ function parseCharacterEntry( characterMap.set(characterName, info); } + // Recognize JSON log files (e.g. characters/X/logs/foo.json) + if (category === 'logs') { + const fileName = segments.slice(3).join('/'); + if (fileName && fileName.endsWith('.json')) { + info.hasLogs = true; + return; + } + } + updateCharacterInfo(info, category, segments); } @@ -189,6 +202,27 @@ export function parseImportZip(vm: any): void { const characterMap = new Map(); const entries = zip.getEntries(); + // Check for manifest + const manifestEntry = zip.getEntry('manifest.json'); + if (manifestEntry) { + try { + const parsed = JSON.parse(manifestEntry.getData().toString('utf8')); + if (isValidManifest(parsed)) { + vm.importZipHasManifest = true; + vm.importZipManifest = parsed as ExportManifest; + } else { + vm.importZipHasManifest = false; + vm.importZipManifest = undefined; + } + } catch { + vm.importZipHasManifest = false; + vm.importZipManifest = undefined; + } + } else { + vm.importZipHasManifest = false; + vm.importZipManifest = undefined; + } + vm.importGeneralAvailable = entries.some(e => e.entryName === 'settings'); for (const entry of entries) { @@ -339,11 +373,35 @@ function isEffectivelyEmptyDraftsFile(p: string): boolean { } } +export function jsonLogToBinary( + json: { time: number; type: number; sender: string; text: string }[] +): Buffer { + const chunks: Buffer[] = []; + for (const msg of json) { + const sender = msg.sender || ''; + const senderLength = Buffer.byteLength(sender); + const textLength = Buffer.byteLength(msg.text); + const buf = Buffer.allocUnsafe(senderLength + textLength + 10); + buf.writeUInt32LE(msg.time, 0); + buf.writeUInt8(msg.type, 4); + buf.writeUInt8(senderLength, 5); + buf.write(sender, 6); + let offset = 6 + senderLength; + buf.writeUInt16LE(textLength, offset); + buf.write(msg.text, offset + 2); + offset += 2 + textLength; + buf.writeUInt16LE(offset, offset); + chunks.push(buf); + } + return Buffer.concat(chunks); +} + interface ImportStats { logsCopied: number; logsSkipped: number; settingsCopied: number; settingsSkipped: number; + filesErrored: number; generalImported: boolean; generalCandidate: boolean; charactersTouched: Set; @@ -483,27 +541,51 @@ function importCharacterFile( const decision = shouldImportEntry(vm, category, segments, info); if (!decision.shouldImport) return; - const relative = normalized.substring('characters/'.length); + let relative = normalized.substring('characters/'.length); + // Strip .json suffix for JSON log files so they're written as binary + if (decision.isLog && relative.endsWith('.json')) { + relative = relative.slice(0, -5); + } const destination = getSafeDestination(dataDir, relative); if (!destination) return; - fs.mkdirSync(path.dirname(destination), { recursive: true }); + try { + fs.mkdirSync(path.dirname(destination), { recursive: true }); + + const exists = fs.existsSync(destination); + if ( + shouldSkipExistingFile(destination, exists, vm.importOverwrite, decision) + ) { + if (decision.isLog) stats.logsSkipped++; + else stats.settingsSkipped++; + return; + } - const exists = fs.existsSync(destination); - if ( - shouldSkipExistingFile(destination, exists, vm.importOverwrite, decision) - ) { - if (decision.isLog) stats.logsSkipped++; - else stats.settingsSkipped++; - return; - } + let fileData: Buffer = entry.getData(); + + // JSON log from export: re-serialize to binary + if (decision.isLog && normalized.endsWith('.json')) { + try { + const parsed = JSON.parse(fileData.toString('utf8')); + if (Array.isArray(parsed)) { + fileData = jsonLogToBinary(parsed); + } + } catch (err) { + stats.filesErrored++; + log.warn('import.file.json-convert-error', normalized, err); + return; + } + } - const fileData = entry.getData(); - fs.writeFileSync(destination, fileData); - stats.charactersTouched.add(characterName); + fs.writeFileSync(destination, fileData); + stats.charactersTouched.add(characterName); - if (decision.isLog) stats.logsCopied++; - else stats.settingsCopied++; + if (decision.isLog) stats.logsCopied++; + else stats.settingsCopied++; + } catch (err) { + stats.filesErrored++; + log.warn('import.file.error', normalized, err); + } } function importCharacterData( @@ -542,7 +624,11 @@ function finalizeImport(vm: any, stats: ImportStats): void { generalState = 'not imported'; } - vm.importSummary = `Restored data for ${stats.charactersTouched.size} character(s). Logs copied: ${stats.logsCopied} (skipped ${stats.logsSkipped}). Settings copied: ${stats.settingsCopied} (skipped ${stats.settingsSkipped}). General settings: ${generalState}.`; + let summary = `Restored data for ${stats.charactersTouched.size} character(s). Logs copied: ${stats.logsCopied} (skipped ${stats.logsSkipped}). Settings copied: ${stats.settingsCopied} (skipped ${stats.settingsSkipped}). General settings: ${generalState}.`; + if (stats.filesErrored > 0) { + summary += ` ${stats.filesErrored} file(s) failed to import.`; + } + vm.importSummary = summary; } /** @@ -580,6 +666,7 @@ export async function runZipImport(vm: any): Promise { logsSkipped: 0, settingsCopied: 0, settingsSkipped: 0, + filesErrored: 0, generalImported: false, generalCandidate: false, charactersTouched: new Set() diff --git a/electron/services/importer/vanilla-import-ui.ts b/electron/services/importer/vanilla-import-ui.ts index e323892ae..d3baf8011 100644 --- a/electron/services/importer/vanilla-import-ui.ts +++ b/electron/services/importer/vanilla-import-ui.ts @@ -22,8 +22,12 @@ export async function initializeVanillaImport(vm: any): Promise { vm.vanillaImportAvailable) || vm.importHint === 'advanced'; if (vm.showVanillaAutoPrompt) { - const targetTab = vm.vanillaTabId ?? '6'; - vm.selectedTab = targetTab; + if ('selectedSection' in vm) { + vm.selectedSection = 'vanilla'; + } else { + const targetTab = vm.vanillaTabId ?? '6'; + vm.selectedTab = targetTab; + } } } diff --git a/electron/services/index.ts b/electron/services/index.ts index 7e0155358..7fcdb865f 100644 --- a/electron/services/index.ts +++ b/electron/services/index.ts @@ -9,6 +9,7 @@ export * from './importer/startup-import'; export * as VanillaImporter from './importer/vanilla-importer'; export * from './importer/vanilla-import-ui'; export * from './exporter/backup-export'; +export type { ExportManifest } from './exporter/manifest'; export * from './importer/backup-import'; export * as SlimcatImporter from './importer/importer';