From 9e2960881b51939960c3d8f3be48063676e2c113 Mon Sep 17 00:00:00 2001 From: t8y2 <1156263951@qq.com> Date: Fri, 10 Jul 2026 15:32:35 +0800 Subject: [PATCH] feat(sync): add GitHub and Gitee snippet providers --- .../editor/EditorSettingsDialog.vue | 389 +++++++++++++----- apps/desktop/src/i18n/locales/en.ts | 15 +- apps/desktop/src/i18n/locales/zh-CN.ts | 15 +- apps/desktop/src/lib/backend/api.ts | 11 + apps/desktop/src/lib/backend/http.ts | 51 +++ apps/desktop/src/lib/backend/tauri.ts | 51 +++ crates/dbx-core/src/cloud_sync.rs | 313 +++++++++++++- crates/dbx-web/src/main.rs | 8 +- crates/dbx-web/src/routes/cloud_sync.rs | 125 +++++- docs/content/docs/cloud-sync.cn.mdx | 122 ++++++ docs/content/docs/cloud-sync.mdx | 122 ++++++ docs/content/docs/meta.cn.json | 1 + docs/content/docs/meta.json | 1 + src-tauri/src/commands/cloud_sync.rs | 99 ++++- src-tauri/src/lib.rs | 6 + 15 files changed, 1220 insertions(+), 109 deletions(-) create mode 100644 docs/content/docs/cloud-sync.cn.mdx create mode 100644 docs/content/docs/cloud-sync.mdx diff --git a/apps/desktop/src/components/editor/EditorSettingsDialog.vue b/apps/desktop/src/components/editor/EditorSettingsDialog.vue index 61776bfbd8..0e98ef90c3 100644 --- a/apps/desktop/src/components/editor/EditorSettingsDialog.vue +++ b/apps/desktop/src/components/editor/EditorSettingsDialog.vue @@ -55,12 +55,18 @@ import { aiTestConnection, checkMcpServerStatus, installMcpServer, + forgetSnippetSavedToken, forgetWebdavSyncSecretsPassphrase, forgetWebdavSavedPassword, getAppSupportInfo, listSystemFonts, saveWebdavSyncSecretsPreference, saveWebdavSavedPassword, + saveSnippetSavedToken, + snippetSyncDownload, + snippetSyncTest, + snippetSyncUpload, + snippetTokenStatus, webdavPasswordStatus, webdavSyncDownload, webdavSyncSecretsStatus, @@ -69,6 +75,8 @@ import { type AppSupportInfo, type AiModelInfo, type McpServerStatus, + type SnippetProvider, + type SnippetSyncConfig, type WebDavConfig, } from "@/lib/backend/api"; import { eventToShortcut } from "@/lib/editor/keyboardShortcuts"; @@ -1430,8 +1438,104 @@ const webdavAutoUploadIntervalMinutes = ref(Number(localStorage.getItem("dbx-web const webdavBusy = ref<"" | "test" | "upload" | "download">(""); const webdavMessage = ref(""); const webdavError = ref(false); +const syncMethodTab = ref<"webdav" | "snippet">("webdav"); + +const snippetProvider = ref((localStorage.getItem("dbx-snippet-provider") as SnippetProvider) || "github"); +const snippetId = ref(localStorage.getItem(`dbx-snippet-id-${snippetProvider.value}`) || ""); +const snippetToken = ref(""); +const snippetRememberToken = ref(localStorage.getItem(`dbx-snippet-remember-token-${snippetProvider.value}`) === "true"); +const snippetHasSavedToken = ref(false); +const snippetBusy = ref<"" | "test" | "upload" | "download">(""); +const snippetMessage = ref(""); +const snippetError = ref(false); const webdavReady = computed(() => !!webdavEndpoint.value.trim() && !webdavBusy.value && (!webdavSyncSecrets.value || !!webdavSecretsPassphrase.value.trim() || webdavHasSavedSecretsPassphrase.value)); +const snippetReady = computed(() => !snippetBusy.value && (!!snippetToken.value.trim() || snippetHasSavedToken.value)); + +function currentSnippetConfig(): SnippetSyncConfig { + return { + provider: snippetProvider.value, + token: snippetToken.value.trim() || undefined, + snippetId: snippetId.value.trim() || undefined, + }; +} + +function currentSnippetAccountConfig(): SnippetSyncConfig { + return { ...currentSnippetConfig(), token: undefined }; +} + +async function refreshSnippetTokenStatus() { + try { + const status = await snippetTokenStatus(currentSnippetAccountConfig()); + snippetHasSavedToken.value = status.hasSavedToken; + if (status.hasSavedToken) snippetRememberToken.value = true; + } catch { + snippetHasSavedToken.value = false; + } +} + +async function applySnippetTokenPreference() { + const token = snippetToken.value.trim(); + if (snippetRememberToken.value && token) { + await saveSnippetSavedToken(currentSnippetAccountConfig(), token); + snippetHasSavedToken.value = true; + return; + } + if (!snippetRememberToken.value && snippetHasSavedToken.value) { + await forgetSnippetSavedToken(currentSnippetAccountConfig()); + snippetHasSavedToken.value = false; + } +} + +async function runSnippetAction(kind: "test" | "upload" | "download", action: () => Promise) { + snippetBusy.value = kind; + snippetMessage.value = ""; + snippetError.value = false; + try { + localStorage.setItem("dbx-snippet-provider", snippetProvider.value); + localStorage.setItem(`dbx-snippet-id-${snippetProvider.value}`, snippetId.value.trim()); + localStorage.setItem(`dbx-snippet-remember-token-${snippetProvider.value}`, String(snippetRememberToken.value)); + await applySnippetTokenPreference(); + await applyWebDavSyncSecretsPreference(); + snippetMessage.value = await action(); + } catch (e: any) { + snippetMessage.value = e?.message || String(e); + snippetError.value = true; + } finally { + snippetBusy.value = ""; + } +} + +async function testSnippetSync() { + await runSnippetAction("test", async () => { + await snippetSyncTest(currentSnippetConfig()); + return t("settings.syncSnippetTestSuccess"); + }); +} + +async function uploadSnippetSnapshot() { + await runSnippetAction("upload", async () => { + const summary = await snippetSyncUpload(currentSnippetConfig(), settingsStore.editorSettings, webdavSyncSecrets.value ? webdavSecretsPassphrase.value : undefined); + snippetId.value = summary.snippetId; + localStorage.setItem(`dbx-snippet-id-${snippetProvider.value}`, summary.snippetId); + return t("settings.syncSnippetUploadSuccess", { bytes: summary.bytes, id: summary.snippetId }); + }); +} + +async function downloadSnippetSnapshot() { + if (!snippetId.value.trim() || !window.confirm(t("settings.syncDownloadConfirm"))) return; + await runSnippetAction("download", async () => { + const result = await snippetSyncDownload(currentSnippetConfig(), webdavSyncSecrets.value ? webdavSecretsPassphrase.value : undefined); + if (result.editorSettings && typeof result.editorSettings === "object") settingsStore.updateEditorSettings(result.editorSettings as any); + await settingsStore.updateDesktopSettings(result.desktopSettings); + await connectionStore.initFromDisk(); + await savedSqlStore.initFromStorage(); + let message = t("settings.syncSnippetDownloadSuccess", { bytes: result.summary.bytes, id: result.summary.snippetId }); + if (result.applySummary.encryptedSecretsPresent && !result.applySummary.secretsApplied) message += ` ${t("settings.syncSecretsSkipped")}`; + if (result.applySummary.secretsApplied) message += ` ${t("settings.syncSecretsApplied")}`; + return message; + }); +} function currentWebDavConfig(): WebDavConfig { return { @@ -1614,9 +1718,11 @@ watch( } editSidebarTablePageSize.value = settingsStore.desktopSettings.sidebar_table_page_size ?? DEFAULT_SIDEBAR_TABLE_PAGE_SIZE; webdavPassword.value = ""; + snippetToken.value = ""; webdavSecretsPassphrase.value = ""; await refreshWebDavPasswordStatus(); await refreshWebDavSyncSecretsStatus(); + await refreshSnippetTokenStatus(); syncAiEditState(); if (!isWeb && activeSettingsTab.value === "mcp") void refreshMcpStatus(); if (!isWeb && activeSettingsTab.value === "ai" && aiIsCodexCli.value) void ensureCodexMcpStatus(); @@ -1653,6 +1759,13 @@ watch([webdavAutoUploadEnabled, webdavAutoUploadIntervalMinutes], () => { webdavAutoUploadIntervalMinutes.value = normalizedWebDavAutoUploadInterval(webdavAutoUploadIntervalMinutes.value); rememberWebDavFields(); }); +watch(snippetProvider, (provider) => { + localStorage.setItem("dbx-snippet-provider", provider); + snippetId.value = localStorage.getItem(`dbx-snippet-id-${provider}`) || ""; + snippetRememberToken.value = localStorage.getItem(`dbx-snippet-remember-token-${provider}`) === "true"; + snippetToken.value = ""; + void refreshSnippetTokenStatus(); +}); watch(activeSettingsTab, (tab) => { if (tab === "mcp" && !mcpStatus.value && !mcpStatusLoading.value) void refreshMcpStatus(); @@ -3618,91 +3731,199 @@ onUnmounted(cleanupPreviewEditor); -
-
-
- - {{ t("settings.syncWebDavTitle") }} -
-

{{ t("settings.syncWebDavDescription") }}

-
+
+ + + WebDAV + GitHub / Gitee + -
-
- - -
-
- - -
-
- -
- - + +
+
+ + {{ t("settings.syncWebDavTitle") }} +
+

{{ t("settings.syncWebDavDescription") }}

-
- - - {{ t("settings.syncRememberWebDavPasswordDescription") }} - -
-
-
- - -

{{ t("settings.syncRemotePathDescription") }}

-
-
- -
- - - {{ t("settings.syncAutoUploadMinutes") }} -
-

{{ t("settings.syncAutoUploadDescription") }}

-
-
-
- {{ t("settings.syncSecretNotice") }} -
+
+
+ + +
+
+ + +
+
+ +
+ + +
+
+ + + {{ t("settings.syncRememberWebDavPasswordDescription") }} + +
+
+
+ + +

{{ t("settings.syncRemotePathDescription") }}

+
+
+ +
+ + + {{ t("settings.syncAutoUploadMinutes") }} +
+

{{ t("settings.syncAutoUploadDescription") }}

+
+
-
+
+ {{ webdavMessage }} +
+
+ + + +
+ + + +
+
+
+ + {{ t("settings.syncSnippetTitle") }} +
+ +
+

{{ t("settings.syncSnippetDescription") }}

+
+ +
+
+ + +
+
+ + +
+
+ +
+ + +
+ +

{{ t("settings.syncSnippetTokenDescription") }}

+
+
+
+ {{ snippetMessage }} +
+
+
+ + + +
+
+
+ + + +
- -

{{ t("settings.syncSecretsDescription") }}

+ +

{{ t("settings.syncSecretsSharedDescription") }}

- + +
+
+ {{ t("settings.syncSecretNotice") }}
- +
- + -

- {{ webdavMessage }} -

-
- - - diff --git a/apps/desktop/src/i18n/locales/en.ts b/apps/desktop/src/i18n/locales/en.ts index 1b16d53a8b..ce015fa0df 100644 --- a/apps/desktop/src/i18n/locales/en.ts +++ b/apps/desktop/src/i18n/locales/en.ts @@ -3085,7 +3085,8 @@ export default { syncRemotePathDescription: "DBX will create missing parent folders when uploading.", syncSecretNotice: "By default, DBX syncs connection details and settings only. Database passwords, SSH passwords, proxy passwords, HTTP tunnel tokens, connection strings, and AI API keys stay local.", syncSecrets: "Sync encrypted secrets", - syncSecretsDescription: "When enabled, DBX encrypts database passwords, SSH passwords, proxy passwords, HTTP tunnel tokens, and AI API keys before uploading them to WebDAV.", + syncSecretsDescription: "When enabled, DBX encrypts database passwords, SSH passwords, proxy passwords, HTTP tunnel tokens, and AI API keys before uploading them to remote storage.", + syncSecretsSharedDescription: "Applies to WebDAV, GitHub Gist, and Gitee snippets. Secrets are encrypted before being included in the snapshot.", syncSecretsPassphrase: "Sync password", syncSecretsPassphraseDescription: "This password is only used to encrypt and restore sensitive data. DBX does not save it; enter it again on each device.", syncTest: "Test", @@ -3102,6 +3103,18 @@ export default { syncSecretsApplied: "Encrypted secrets were restored.", syncSecretsSkipped: "Encrypted secrets were present but were not restored.", syncDownloadConfirm: "Download and apply the remote DBX snapshot? Local metadata and saved SQL will be replaced.", + syncSnippetTitle: "GitHub / Gitee Snippet Sync", + syncSnippetDescription: "Store the same DBX snapshot in a private code snippet. The first upload creates a snippet and saves its ID.", + syncSnippetProvider: "Provider", + syncSnippetId: "Snippet ID", + syncSnippetIdPlaceholder: "Leave empty for the first upload", + syncSnippetToken: "Access token", + syncSnippetRememberToken: "Store encrypted on this device", + syncSnippetTokenDescription: "GitHub tokens need Gists write permission. Tokens are never included in the sync snapshot.", + syncSnippetTestSuccess: "The snippet sync target is accessible.", + syncSnippetUploadSuccess: "Uploaded {bytes} bytes to snippet {id}.", + syncSnippetDownloadSuccess: "Downloaded and applied {bytes} bytes from snippet {id}.", + syncSnippetGuide: "Setup guide", apply: "Apply", applyAndClose: "Apply and Close", reset: "Reset", diff --git a/apps/desktop/src/i18n/locales/zh-CN.ts b/apps/desktop/src/i18n/locales/zh-CN.ts index 766a70d72a..b8d19d8158 100644 --- a/apps/desktop/src/i18n/locales/zh-CN.ts +++ b/apps/desktop/src/i18n/locales/zh-CN.ts @@ -3084,7 +3084,8 @@ export default withEnglishFallback({ syncRemotePathDescription: "上传时 DBX 会自动创建缺失的父目录。", syncSecretNotice: "默认只同步连接信息和设置,不会同步数据库密码、SSH 密码、代理密码、HTTP 隧道 Token、连接串或 AI API Key。", syncSecrets: "同步加密后的敏感信息", - syncSecretsDescription: "开启后,DBX 会先加密数据库密码、SSH 密码、代理密码、HTTP 隧道 Token 和 AI API Key,再上传到 WebDAV。", + syncSecretsDescription: "开启后,DBX 会先加密数据库密码、SSH 密码、代理密码、HTTP 隧道 Token 和 AI API Key,再上传到远端存储。", + syncSecretsSharedDescription: "适用于 WebDAV、GitHub Gist 和 Gitee 代码片段。开启后,敏感信息会加密后随快照同步。", syncSecretsPassphrase: "同步密码", syncSecretsPassphraseDescription: "这个密码只用于加密和恢复敏感信息,DBX 不会保存;换设备恢复时需要再次输入。", syncTest: "测试", @@ -3101,6 +3102,18 @@ export default withEnglishFallback({ syncSecretsApplied: "已恢复加密敏感信息。", syncSecretsSkipped: "远端包含加密敏感信息,但本次未恢复。", syncDownloadConfirm: "要下载并应用远端 DBX 快照吗?本地元信息和保存的 SQL 会被替换。", + syncSnippetTitle: "GitHub / Gitee 代码片段同步", + syncSnippetDescription: "将同一份 DBX 快照保存到私有代码片段。首次上传会自动创建代码片段并保存其 ID。", + syncSnippetProvider: "平台", + syncSnippetId: "代码片段 ID", + syncSnippetIdPlaceholder: "首次上传可留空", + syncSnippetToken: "访问令牌", + syncSnippetRememberToken: "加密保存在本机", + syncSnippetTokenDescription: "GitHub 令牌需要 Gists 写权限;令牌不会写入同步快照。", + syncSnippetTestSuccess: "代码片段同步目标可访问。", + syncSnippetUploadSuccess: "已上传 {bytes} 字节到代码片段 {id}。", + syncSnippetDownloadSuccess: "已从代码片段 {id} 下载并应用 {bytes} 字节。", + syncSnippetGuide: "配置指南", apply: "应用", applyAndClose: "应用并关闭", reset: "重置", diff --git a/apps/desktop/src/lib/backend/api.ts b/apps/desktop/src/lib/backend/api.ts index a386424e0a..41260c41a3 100644 --- a/apps/desktop/src/lib/backend/api.ts +++ b/apps/desktop/src/lib/backend/api.ts @@ -241,6 +241,12 @@ export const saveWebdavSyncSecretsPreference = forward("saveWebdavSyncSecretsPre export const forgetWebdavSyncSecretsPassphrase = forward("forgetWebdavSyncSecretsPassphrase"); export const webdavSyncUpload = forward("webdavSyncUpload"); export const webdavSyncDownload = forward("webdavSyncDownload"); +export const snippetSyncTest = forward("snippetSyncTest"); +export const snippetTokenStatus = forward("snippetTokenStatus"); +export const saveSnippetSavedToken = forward("saveSnippetSavedToken"); +export const forgetSnippetSavedToken = forward("forgetSnippetSavedToken"); +export const snippetSyncUpload = forward("snippetSyncUpload"); +export const snippetSyncDownload = forward("snippetSyncDownload"); export const saveAiConversation = forward("saveAiConversation"); export const loadAiConversations = forward("loadAiConversations"); export const deleteAiConversation = forward("deleteAiConversation"); @@ -476,6 +482,11 @@ export type { WebDavPasswordStatus, WebDavSyncSummary, WebDavDownloadResult, + SnippetProvider, + SnippetSyncConfig, + SnippetSyncSummary, + SnippetDownloadResult, + SnippetTokenStatus, McpServerStatus, UpdateInfo, RedisBlob, diff --git a/apps/desktop/src/lib/backend/http.ts b/apps/desktop/src/lib/backend/http.ts index 5b34ae1b43..1f24e6da3a 100644 --- a/apps/desktop/src/lib/backend/http.ts +++ b/apps/desktop/src/lib/backend/http.ts @@ -1181,6 +1181,33 @@ export interface WebDavSyncSecretsStatus { hasSavedPassphrase: boolean; } +export type SnippetProvider = "github" | "gitee"; + +export interface SnippetSyncConfig { + provider: SnippetProvider; + token?: string; + snippetId?: string; +} + +export interface SnippetSyncSummary { + provider: SnippetProvider; + snippetId: string; + bytes: number; + exportedAt?: string; + appVersion?: string; +} + +export interface SnippetDownloadResult { + summary: SnippetSyncSummary; + editorSettings?: unknown; + desktopSettings: DesktopSettings; + applySummary: WebDavDownloadResult["applySummary"]; +} + +export interface SnippetTokenStatus { + hasSavedToken: boolean; +} + export async function webdavSyncTest(config: WebDavConfig): Promise { return post("/api/cloud-sync/webdav/test", { config }); } @@ -1217,6 +1244,30 @@ export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase return post("/api/cloud-sync/webdav/download", { config, secretsPassphrase }); } +export async function snippetSyncTest(config: SnippetSyncConfig): Promise { + await post("/api/cloud-sync/snippet/test", { config }); +} + +export async function snippetTokenStatus(config: SnippetSyncConfig): Promise { + return post("/api/cloud-sync/snippet/token-status", { config }); +} + +export async function saveSnippetSavedToken(config: SnippetSyncConfig, token: string): Promise { + await post("/api/cloud-sync/snippet/save-token", { config, token }); +} + +export async function forgetSnippetSavedToken(config: SnippetSyncConfig): Promise { + await post("/api/cloud-sync/snippet/forget-token", { config }); +} + +export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, secretsPassphrase?: string): Promise { + return post("/api/cloud-sync/snippet/upload", { config, editorSettings, secretsPassphrase }); +} + +export async function snippetSyncDownload(config: SnippetSyncConfig, secretsPassphrase?: string): Promise { + return post("/api/cloud-sync/snippet/download", { config, secretsPassphrase }); +} + export async function loadPinnedTreeNodeIds(): Promise { return get("/api/app-settings/pinned-tree-node-ids"); } diff --git a/apps/desktop/src/lib/backend/tauri.ts b/apps/desktop/src/lib/backend/tauri.ts index 115d66fc17..a06d31aede 100644 --- a/apps/desktop/src/lib/backend/tauri.ts +++ b/apps/desktop/src/lib/backend/tauri.ts @@ -201,6 +201,33 @@ export interface WebDavSyncSecretsStatus { hasSavedPassphrase: boolean; } +export type SnippetProvider = "github" | "gitee"; + +export interface SnippetSyncConfig { + provider: SnippetProvider; + token?: string; + snippetId?: string; +} + +export interface SnippetSyncSummary { + provider: SnippetProvider; + snippetId: string; + bytes: number; + exportedAt?: string; + appVersion?: string; +} + +export interface SnippetDownloadResult { + summary: SnippetSyncSummary; + editorSettings?: unknown; + desktopSettings: DesktopSettings; + applySummary: WebDavDownloadResult["applySummary"]; +} + +export interface SnippetTokenStatus { + hasSavedToken: boolean; +} + export interface AppSupportInfo { appVersion: string; runtime: "desktop" | "web"; @@ -496,6 +523,30 @@ export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase return invoke("webdav_sync_download", { config, secretsPassphrase }); } +export async function snippetSyncTest(config: SnippetSyncConfig): Promise { + return invoke("snippet_sync_test", { config }); +} + +export async function snippetTokenStatus(config: SnippetSyncConfig): Promise { + return invoke("snippet_token_status", { config }); +} + +export async function saveSnippetSavedToken(config: SnippetSyncConfig, token: string): Promise { + return invoke("save_snippet_saved_token", { config, token }); +} + +export async function forgetSnippetSavedToken(config: SnippetSyncConfig): Promise { + return invoke("forget_snippet_saved_token", { config }); +} + +export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, secretsPassphrase?: string): Promise { + return invoke("snippet_sync_upload", { config, editorSettings, secretsPassphrase }); +} + +export async function snippetSyncDownload(config: SnippetSyncConfig, secretsPassphrase?: string): Promise { + return invoke("snippet_sync_download", { config, secretsPassphrase }); +} + export async function loadPinnedTreeNodeIds(): Promise { return invoke("load_pinned_tree_node_ids"); } diff --git a/crates/dbx-core/src/cloud_sync.rs b/crates/dbx-core/src/cloud_sync.rs index bcf3c44fce..99cdf70531 100644 --- a/crates/dbx-core/src/cloud_sync.rs +++ b/crates/dbx-core/src/cloud_sync.rs @@ -20,6 +20,9 @@ use crate::storage::{DesktopSettings, Storage}; const SNAPSHOT_SCHEMA_VERSION: u32 = 1; const DEFAULT_REMOTE_PATH: &str = "DBX/sync/snapshot.json"; +const DEFAULT_SNIPPET_FILE_NAME: &str = "dbx-sync.json"; +const GITHUB_API_BASE: &str = "https://api.github.com"; +const GITEE_API_BASE: &str = "https://gitee.com/api/v5"; const SECRET_KEYS: &[&str] = &[ "password", "ssh_password", @@ -46,6 +49,28 @@ pub struct WebDavConfig { pub remote_path: Option, } +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub enum SnippetProvider { + #[serde(rename = "github", alias = "git_hub")] + GitHub, + #[serde(rename = "gitee")] + Gitee, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetSyncConfig { + pub provider: SnippetProvider, + pub token: Option, + pub snippet_id: Option, +} + +#[derive(Debug, Clone, Copy, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetTokenStatus { + pub has_saved_token: bool, +} + #[derive(Debug, Clone, Copy, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct WebDavPasswordStatus { @@ -121,6 +146,16 @@ pub struct WebDavSyncSummary { pub app_version: Option, } +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetSyncSummary { + pub provider: SnippetProvider, + pub snippet_id: String, + pub bytes: usize, + pub exported_at: Option, + pub app_version: Option, +} + pub async fn build_sync_snapshot( storage: &Storage, app_version: impl Into, @@ -206,6 +241,11 @@ pub struct WebDavClient { config: WebDavConfig, } +pub struct SnippetSyncClient { + http: Client, + config: SnippetSyncConfig, +} + pub async fn webdav_saved_password_status( storage: &Storage, config: &WebDavConfig, @@ -238,6 +278,38 @@ pub async fn resolve_webdav_password(storage: &Storage, config: &mut WebDavConfi Ok(()) } +pub async fn snippet_saved_token_status( + storage: &Storage, + config: &SnippetSyncConfig, +) -> Result { + let account = snippet_token_account(config.provider); + Ok(SnippetTokenStatus { has_saved_token: storage.load_webdav_password_blob(&account).await?.is_some() }) +} + +pub async fn save_snippet_token(storage: &Storage, config: &SnippetSyncConfig, token: &str) -> Result<(), String> { + let secret = storage.load_or_create_local_device_secret().await?; + let blob = encrypt_text_with_secret(token, &secret)?; + let value = serde_json::to_value(blob).map_err(|e| e.to_string())?; + storage.save_webdav_password_blob(&snippet_token_account(config.provider), &value).await +} + +pub async fn forget_snippet_token(storage: &Storage, config: &SnippetSyncConfig) -> Result<(), String> { + storage.delete_webdav_password_blob(&snippet_token_account(config.provider)).await +} + +pub async fn resolve_snippet_token(storage: &Storage, config: &mut SnippetSyncConfig) -> Result<(), String> { + if config.token.as_deref().is_some_and(|token| !token.trim().is_empty()) { + return Ok(()); + } + let Some(value) = storage.load_webdav_password_blob(&snippet_token_account(config.provider)).await? else { + return Ok(()); + }; + let blob: EncryptedSecretsBlob = serde_json::from_value(value).map_err(|e| e.to_string())?; + let secret = storage.load_or_create_local_device_secret().await?; + config.token = Some(decrypt_text_with_secret(&blob, &secret)?); + Ok(()) +} + pub async fn webdav_sync_secrets_status(storage: &Storage) -> Result { Ok(WebDavSyncSecretsStatus { enabled: storage.load_webdav_sync_secrets_enabled().await?, @@ -372,6 +444,131 @@ impl WebDavClient { } } +impl SnippetSyncClient { + pub fn new(config: SnippetSyncConfig) -> Self { + Self { http: Client::new(), config } + } + + pub async fn test(&self) -> Result<(), String> { + self.require_token()?; + let url = match (self.config.provider, normalized_snippet_id(self.config.snippet_id.as_deref())) { + (SnippetProvider::GitHub, Some(id)) => format!("{GITHUB_API_BASE}/gists/{id}"), + (SnippetProvider::GitHub, None) => format!("{GITHUB_API_BASE}/user"), + (SnippetProvider::Gitee, Some(id)) => format!("{GITEE_API_BASE}/gists/{id}"), + (SnippetProvider::Gitee, None) => format!("{GITEE_API_BASE}/user"), + }; + let response = self.request(Method::GET, &url)?.send().await.map_err(|e| e.to_string())?; + ensure_snippet_success(response.status(), "test") + } + + pub async fn put_snapshot(&self, snapshot: &SyncSnapshot) -> Result { + self.require_token()?; + let bytes = serde_json::to_vec_pretty(snapshot).map_err(|e| e.to_string())?; + let content = String::from_utf8(bytes.clone()).map_err(|e| e.to_string())?; + let existing_id = normalized_snippet_id(self.config.snippet_id.as_deref()); + let (method, url) = match (self.config.provider, existing_id) { + (SnippetProvider::GitHub, Some(id)) => (Method::PATCH, format!("{GITHUB_API_BASE}/gists/{id}")), + (SnippetProvider::GitHub, None) => (Method::POST, format!("{GITHUB_API_BASE}/gists")), + (SnippetProvider::Gitee, Some(id)) => (Method::PATCH, format!("{GITEE_API_BASE}/gists/{id}")), + (SnippetProvider::Gitee, None) => (Method::POST, format!("{GITEE_API_BASE}/gists")), + }; + + let response = match self.config.provider { + SnippetProvider::GitHub => { + let payload = serde_json::json!({ + "description": "DBX encrypted configuration sync", + "public": false, + "files": { DEFAULT_SNIPPET_FILE_NAME: { "content": content } } + }); + self.request(method, &url)?.json(&payload).send().await + } + SnippetProvider::Gitee => { + let files = serde_json::json!({ DEFAULT_SNIPPET_FILE_NAME: { "content": content } }).to_string(); + self.request(method, &url)? + .form(&[ + ("files", files), + ("description", "DBX configuration sync".to_string()), + ("public", "false".to_string()), + ]) + .send() + .await + } + } + .map_err(|e| e.to_string())?; + let status = response.status(); + let response_body = response.text().await.map_err(|e| e.to_string())?; + ensure_snippet_response_success(status, "upload", &response_body)?; + let value: serde_json::Value = serde_json::from_str(&response_body).map_err(|e| e.to_string())?; + let snippet_id = snippet_response_id(&value) + .or_else(|| existing_id.map(str::to_string)) + .ok_or_else(|| "Snippet API response did not include an id".to_string())?; + Ok(SnippetSyncSummary { + provider: self.config.provider, + snippet_id, + bytes: bytes.len(), + exported_at: Some(snapshot.exported_at.clone()), + app_version: Some(snapshot.app_version.clone()), + }) + } + + pub async fn get_snapshot(&self) -> Result<(SyncSnapshot, SnippetSyncSummary), String> { + self.require_token()?; + let snippet_id = normalized_snippet_id(self.config.snippet_id.as_deref()) + .ok_or_else(|| "Snippet id is required for download".to_string())?; + let url = match self.config.provider { + SnippetProvider::GitHub => format!("{GITHUB_API_BASE}/gists/{snippet_id}"), + SnippetProvider::Gitee => format!("{GITEE_API_BASE}/gists/{snippet_id}"), + }; + let response = self.request(Method::GET, &url)?.send().await.map_err(|e| e.to_string())?; + let status = response.status(); + let response_body = response.text().await.map_err(|e| e.to_string())?; + ensure_snippet_response_success(status, "download", &response_body)?; + let value: serde_json::Value = serde_json::from_str(&response_body).map_err(|e| e.to_string())?; + let (content, raw_url) = snippet_file_content(&value, DEFAULT_SNIPPET_FILE_NAME)?; + let content = match content { + Some(content) => content, + None => { + let raw_url = raw_url.ok_or_else(|| "Snippet file content is unavailable".to_string())?; + let response = self.request(Method::GET, &raw_url)?.send().await.map_err(|e| e.to_string())?; + ensure_snippet_success(response.status(), "raw download")?; + response.text().await.map_err(|e| e.to_string())? + } + }; + let snapshot: SyncSnapshot = serde_json::from_str(&content).map_err(|e| e.to_string())?; + let summary = SnippetSyncSummary { + provider: self.config.provider, + snippet_id: snippet_id.to_string(), + bytes: content.len(), + exported_at: Some(snapshot.exported_at.clone()), + app_version: Some(snapshot.app_version.clone()), + }; + Ok((snapshot, summary)) + } + + fn require_token(&self) -> Result<&str, String> { + self.config + .token + .as_deref() + .map(str::trim) + .filter(|token| !token.is_empty()) + .ok_or_else(|| "Access token is required".to_string()) + } + + fn request(&self, method: Method, url: &str) -> Result { + let token = self.require_token()?; + let request = self.http.request(method, url); + Ok(match self.config.provider { + SnippetProvider::GitHub => request + .header(header::ACCEPT, "application/vnd.github+json") + .header(header::USER_AGENT, "DBX") + .header("X-GitHub-Api-Version", "2022-11-28") + .bearer_auth(token), + // Gitee API v5 documents access_token as a request parameter rather than an Authorization header. + SnippetProvider::Gitee => request.query(&[("access_token", token)]), + }) + } +} + fn scrub_connection_secrets(config: &mut ConnectionConfig) { config.password.clear(); for layer in &mut config.transport_layers { @@ -690,6 +887,75 @@ fn normalized_passphrase(passphrase: Option<&str>) -> Option<&str> { passphrase.map(str::trim).filter(|value| !value.is_empty()) } +fn normalized_snippet_id(snippet_id: Option<&str>) -> Option<&str> { + snippet_id.map(str::trim).filter(|value| !value.is_empty()) +} + +fn snippet_token_account(provider: SnippetProvider) -> String { + match provider { + SnippetProvider::GitHub => "snippet-token:github".to_string(), + SnippetProvider::Gitee => "snippet-token:gitee".to_string(), + } +} + +fn ensure_snippet_success(status: StatusCode, operation: &str) -> Result<(), String> { + if status.is_success() { + Ok(()) + } else { + Err(format!("Snippet {operation} failed with HTTP {status}")) + } +} + +fn ensure_snippet_response_success(status: StatusCode, operation: &str, response_body: &str) -> Result<(), String> { + if status.is_success() { + return Ok(()); + } + let message = serde_json::from_str::(response_body) + .ok() + .and_then(|value| { + value + .get("message") + .or_else(|| value.get("error_description")) + .and_then(serde_json::Value::as_str) + .map(str::to_string) + }) + .unwrap_or_else(|| response_body.trim().chars().take(300).collect()); + if message.is_empty() { + Err(format!("Snippet {operation} failed with HTTP {status}")) + } else { + Err(format!("Snippet {operation} failed with HTTP {status}: {message}")) + } +} + +fn snippet_response_id(value: &serde_json::Value) -> Option { + if let Some(id) = value.get("id").and_then(serde_json::Value::as_str) { + return Some(id.to_string()); + } + // Some Gitee endpoints historically document an array response despite returning one created snippet. + value.as_array()?.first()?.get("id")?.as_str().map(str::to_string) +} + +fn snippet_file_content( + value: &serde_json::Value, + file_name: &str, +) -> Result<(Option, Option), String> { + let files = value.get("files").ok_or_else(|| "Snippet response did not include files".to_string())?; + let files = if let Some(value) = files.as_str() { + serde_json::from_str::(value).map_err(|e| e.to_string())? + } else { + files.clone() + }; + let file = files + .get(file_name) + .or_else(|| files.as_object().and_then(|files| files.values().next())) + .ok_or_else(|| format!("Snippet does not contain {file_name}"))?; + let truncated = file.get("truncated").and_then(serde_json::Value::as_bool).unwrap_or(false); + let content = + if truncated { None } else { file.get("content").and_then(serde_json::Value::as_str).map(str::to_string) }; + let raw_url = file.get("raw_url").and_then(serde_json::Value::as_str).map(str::to_string); + Ok((content, raw_url)) +} + fn normalized_remote_path(value: Option<&str>) -> String { let value = value.unwrap_or(DEFAULT_REMOTE_PATH).trim().replace('\\', "/"); let mut parts: Vec<&str> = Vec::new(); @@ -732,7 +998,8 @@ mod tests { build_sync_snapshot_with_saved_secrets, decrypt_sensitive_payload, encrypt_sensitive_payload, forget_webdav_sync_secrets_passphrase, normalized_remote_path, parent_collection_paths, resolve_webdav_sync_secrets_passphrase, save_webdav_sync_secrets_preference, scrub_connection_secrets, - webdav_sync_secrets_status, ConnectionSecretSnapshot, SensitiveSyncPayload, + snippet_file_content, snippet_response_id, webdav_sync_secrets_status, ConnectionSecretSnapshot, + SensitiveSyncPayload, }; use crate::connection_secrets::NACOS_AUTH_PASSWORD_KEY; use crate::models::connection::{ @@ -1009,6 +1276,50 @@ mod tests { assert!(decrypt_sensitive_payload(&encrypted, "wrong-pass").is_err()); } + #[test] + fn snippet_response_id_supports_github_object_and_gitee_array() { + assert_eq!(snippet_response_id(&serde_json::json!({ "id": "github-id" })).as_deref(), Some("github-id")); + assert_eq!(snippet_response_id(&serde_json::json!([{ "id": "gitee-id" }])).as_deref(), Some("gitee-id")); + } + + #[test] + fn snippet_provider_uses_frontend_wire_values() { + assert_eq!(serde_json::to_string(&super::SnippetProvider::GitHub).unwrap(), "\"github\""); + assert_eq!( + serde_json::from_str::("\"github\"").unwrap(), + super::SnippetProvider::GitHub + ); + assert_eq!( + serde_json::from_str::("\"git_hub\"").unwrap(), + super::SnippetProvider::GitHub + ); + assert_eq!(serde_json::to_string(&super::SnippetProvider::Gitee).unwrap(), "\"gitee\""); + } + + #[test] + fn snippet_file_content_uses_raw_url_for_truncated_github_files() { + let value = serde_json::json!({ + "files": { + "dbx-sync.json": { + "content": "truncated", + "truncated": true, + "raw_url": "https://example.com/raw" + } + } + }); + assert_eq!( + snippet_file_content(&value, "dbx-sync.json").unwrap(), + (None, Some("https://example.com/raw".to_string())) + ); + } + + #[test] + fn snippet_file_content_parses_gitee_string_files() { + let files = serde_json::json!({ "dbx-sync.json": { "content": "{}" } }).to_string(); + let value = serde_json::json!({ "files": files }); + assert_eq!(snippet_file_content(&value, "dbx-sync.json").unwrap(), (Some("{}".to_string()), None)); + } + #[tokio::test] async fn webdav_sync_secrets_preference_round_trips_and_clears_passphrase() { let storage = Storage::open(&temp_db_path("sync-secrets-preference")).await.unwrap(); diff --git a/crates/dbx-web/src/main.rs b/crates/dbx-web/src/main.rs index b03219b232..66074b4a1a 100644 --- a/crates/dbx-web/src/main.rs +++ b/crates/dbx-web/src/main.rs @@ -571,7 +571,13 @@ async fn main() { post(routes::cloud_sync::forget_webdav_sync_secrets_passphrase), ) .route("/cloud-sync/webdav/upload", post(routes::cloud_sync::webdav_sync_upload)) - .route("/cloud-sync/webdav/download", post(routes::cloud_sync::webdav_sync_download)); + .route("/cloud-sync/webdav/download", post(routes::cloud_sync::webdav_sync_download)) + .route("/cloud-sync/snippet/test", post(routes::cloud_sync::snippet_sync_test)) + .route("/cloud-sync/snippet/token-status", post(routes::cloud_sync::snippet_token_status)) + .route("/cloud-sync/snippet/save-token", post(routes::cloud_sync::save_snippet_saved_token)) + .route("/cloud-sync/snippet/forget-token", post(routes::cloud_sync::forget_snippet_saved_token)) + .route("/cloud-sync/snippet/upload", post(routes::cloud_sync::snippet_sync_upload)) + .route("/cloud-sync/snippet/download", post(routes::cloud_sync::snippet_sync_download)); let api = add_mq_routes(api) .layer(middleware::from_fn_with_state(web_state.clone(), auth::auth_middleware)) diff --git a/crates/dbx-web/src/routes/cloud_sync.rs b/crates/dbx-web/src/routes/cloud_sync.rs index 4417b9076e..c7b42cc418 100644 --- a/crates/dbx-web/src/routes/cloud_sync.rs +++ b/crates/dbx-web/src/routes/cloud_sync.rs @@ -3,12 +3,13 @@ use std::sync::Arc; use axum::extract::State; use axum::Json; use dbx_core::cloud_sync::{ - apply_sync_snapshot, build_sync_snapshot_with_saved_secrets, forget_webdav_password, - forget_webdav_sync_secrets_passphrase as core_forget_webdav_sync_secrets_passphrase, resolve_webdav_password, - resolve_webdav_sync_secrets_passphrase, save_webdav_password, - save_webdav_sync_secrets_preference as core_save_webdav_sync_secrets_preference, webdav_saved_password_status, - webdav_sync_secrets_status as core_webdav_sync_secrets_status, ApplySnapshotOptions, ApplySnapshotSummary, - WebDavClient, WebDavConfig, WebDavPasswordStatus, WebDavSyncSecretsStatus, WebDavSyncSummary, + apply_sync_snapshot, build_sync_snapshot_with_saved_secrets, forget_snippet_token, forget_webdav_password, + forget_webdav_sync_secrets_passphrase as core_forget_webdav_sync_secrets_passphrase, resolve_snippet_token, + resolve_webdav_password, resolve_webdav_sync_secrets_passphrase, save_snippet_token, save_webdav_password, + save_webdav_sync_secrets_preference as core_save_webdav_sync_secrets_preference, snippet_saved_token_status, + webdav_saved_password_status, webdav_sync_secrets_status as core_webdav_sync_secrets_status, ApplySnapshotOptions, + ApplySnapshotSummary, SnippetSyncClient, SnippetSyncConfig, SnippetSyncSummary, SnippetTokenStatus, WebDavClient, + WebDavConfig, WebDavPasswordStatus, WebDavSyncSecretsStatus, WebDavSyncSummary, }; use dbx_core::storage::DesktopSettings; use serde::{Deserialize, Serialize}; @@ -25,6 +26,15 @@ pub struct WebDavDownloadResult { pub apply_summary: ApplySnapshotSummary, } +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetDownloadResult { + pub summary: SnippetSyncSummary, + pub editor_settings: Option, + pub desktop_settings: DesktopSettings, + pub apply_summary: ApplySnapshotSummary, +} + #[derive(Debug, Clone, Deserialize)] #[serde(rename_all = "camelCase")] pub struct WebDavConfigRequest { @@ -60,6 +70,34 @@ pub struct WebDavSyncSecretsPreferenceRequest { pub passphrase: Option, } +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetConfigRequest { + pub config: SnippetSyncConfig, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SaveSnippetTokenRequest { + pub config: SnippetSyncConfig, + pub token: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetUploadRequest { + pub config: SnippetSyncConfig, + pub editor_settings: Option, + pub secrets_passphrase: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetDownloadRequest { + pub config: SnippetSyncConfig, + pub secrets_passphrase: Option, +} + pub async fn webdav_sync_test( State(state): State>, Json(mut req): Json, @@ -155,3 +193,78 @@ pub async fn webdav_sync_download( apply_summary, })) } + +pub async fn snippet_sync_test( + State(state): State>, + Json(mut req): Json, +) -> Result, AppError> { + resolve_snippet_token(&state.app.storage, &mut req.config).await.map_err(AppError)?; + SnippetSyncClient::new(req.config).test().await.map_err(AppError)?; + Ok(Json(())) +} + +pub async fn snippet_token_status( + State(state): State>, + Json(req): Json, +) -> Result, AppError> { + snippet_saved_token_status(&state.app.storage, &req.config).await.map(Json).map_err(AppError) +} + +pub async fn save_snippet_saved_token( + State(state): State>, + Json(req): Json, +) -> Result, AppError> { + save_snippet_token(&state.app.storage, &req.config, &req.token).await.map_err(AppError)?; + Ok(Json(())) +} + +pub async fn forget_snippet_saved_token( + State(state): State>, + Json(req): Json, +) -> Result, AppError> { + forget_snippet_token(&state.app.storage, &req.config).await.map_err(AppError)?; + Ok(Json(())) +} + +pub async fn snippet_sync_upload( + State(state): State>, + Json(mut req): Json, +) -> Result, AppError> { + resolve_snippet_token(&state.app.storage, &mut req.config).await.map_err(AppError)?; + let snapshot = build_sync_snapshot_with_saved_secrets( + &state.app.storage, + env!("CARGO_PKG_VERSION"), + req.editor_settings, + req.secrets_passphrase.as_deref(), + ) + .await + .map_err(AppError)?; + SnippetSyncClient::new(req.config).put_snapshot(&snapshot).await.map(Json).map_err(AppError) +} + +pub async fn snippet_sync_download( + State(state): State>, + Json(mut req): Json, +) -> Result, AppError> { + resolve_snippet_token(&state.app.storage, &mut req.config).await.map_err(AppError)?; + let (snapshot, summary) = SnippetSyncClient::new(req.config).get_snapshot().await.map_err(AppError)?; + let explicit_passphrase = req.secrets_passphrase.as_deref().map(str::trim).filter(|value| !value.is_empty()); + let saved_passphrase = if explicit_passphrase.is_some() { + None + } else { + resolve_webdav_sync_secrets_passphrase(&state.app.storage).await.map_err(AppError)? + }; + let apply_summary = apply_sync_snapshot( + &state.app.storage, + &snapshot, + ApplySnapshotOptions { secrets_passphrase: explicit_passphrase.or(saved_passphrase.as_deref()) }, + ) + .await + .map_err(AppError)?; + Ok(Json(SnippetDownloadResult { + summary, + editor_settings: snapshot.editor_settings, + desktop_settings: snapshot.desktop_settings, + apply_summary, + })) +} diff --git a/docs/content/docs/cloud-sync.cn.mdx b/docs/content/docs/cloud-sync.cn.mdx new file mode 100644 index 0000000000..8cbf1bf2bf --- /dev/null +++ b/docs/content/docs/cloud-sync.cn.mdx @@ -0,0 +1,122 @@ +--- +title: 云同步与备份 +description: 使用 WebDAV、GitHub Gist 或 Gitee 代码片段同步 DBX 连接、设置和 SQL 库。 +--- + + +DBX 可以把连接配置、界面设置和保存的 SQL 组成一个快照,上传到 WebDAV 或私有代码片段,并在另一台设备恢复。 + + +在 **设置 → 同步** 中选择同步方式: + +- **WebDAV**:适合已有 NAS、Nextcloud、坚果云或其他 WebDAV 服务的用户,支持定时自动上传。 +- **GitHub / Gitee 代码片段**:不需要自己维护服务器,通过私有 Gist 或私有代码片段保存快照。目前需要手动上传和下载。 + +## 同步哪些内容 + +| 项目 | 默认行为 | +| --- | --- | +| 数据库连接及普通连接参数 | 同步 | +| 侧边栏布局、固定节点 | 同步 | +| 保存的 SQL 库 | 同步 | +| 桌面和编辑器设置 | 同步 | +| 数据库密码、SSH 密码、代理密码、HTTP 隧道 Token、连接串、AI API Key | 默认不同步;可以选择加密后同步 | +| JDBC 驱动、插件和本地文件 | 不同步 | + + +下载会用远端快照替换本地连接元信息和保存的 SQL。恢复前请确认代码片段 ID 或 WebDAV 路径正确。 + + +## GitHub Gist + +### 创建访问令牌 + +推荐使用 GitHub **Fine-grained personal access token**: + +[打开 GitHub Fine-grained token 创建页面](https://github.com/settings/personal-access-tokens/new) + + + ### 打开令牌设置 登录 GitHub,进入 **Settings → Developer settings → Personal access tokens → Fine-grained tokens**。 + ### 创建令牌 点击 **Generate new token**,设置名称和有效期。 + ### 设置权限 在 **Account permissions** 中找到 **Gists**,选择 **Read and write**。不需要授予仓库权限。 + ### 保存令牌 创建后立即复制令牌。GitHub 只会完整显示一次。 + + +也可以使用 Classic token,但只应勾选 `gist` scope,不要授予无关权限。 + +### 首次上传 + + + ### 选择平台 打开 **设置 → 同步 → GitHub / Gitee**,平台选择 **GitHub Gist**。 + ### 填写令牌 将访问令牌粘贴到 **访问令牌**。建议勾选 **加密保存在本机**。 + ### 创建 Gist 将 **代码片段 ID** 留空,点击 **上传**。DBX 会创建私有 Gist,并自动保存返回的 ID。 + + +DBX 会在 Gist 中保存一个 `dbx-sync.json` 文件。后续上传会更新同一个 Gist,GitHub 会保留 Gist 的修改历史。 + +### 在另一台设备恢复 + +1. 打开该私有 Gist,从地址栏复制 ID。地址通常类似 `https://gist.github.com/<实际用户名>/`,最后一段就是 ID。也可以直接访问 `https://gist.github.com/`,GitHub 会跳转到包含实际用户名的地址。 +2. 在新设备填写相同的 GitHub 令牌和 Gist ID。 +3. 点击 **测试**,确认令牌和 ID 可访问。 +4. 点击 **下载** 并确认恢复。 + +## Gitee 代码片段 + +### 创建私人令牌 + +[打开 Gitee 私人令牌页面](https://gitee.com/profile/personal_access_tokens) + + + ### 打开私人令牌页面 登录 Gitee,进入 **设置 → 私人令牌**。 + ### 生成新令牌 点击 **生成新令牌**,填写描述。 + ### 设置权限 只勾选代码片段(`gists`)相关权限。如果界面只提供合并权限,选择能够读写代码片段的最小权限。 + ### 保存令牌 生成后立即复制令牌,并存放在密码管理器中。 + + +### 上传与恢复 + +1. 在 **设置 → 同步 → GitHub / Gitee** 中选择 **Gitee 代码片段**。 +2. 输入私人令牌。首次上传时将代码片段 ID 留空,DBX 会创建私有代码片段并保存 ID。 +3. 在其他设备恢复时,填写同一个代码片段 ID,然后点击 **下载**。 + +Gitee 代码片段中同样使用 `dbx-sync.json` 文件。 + +## 同步敏感信息 + +默认快照不会包含数据库密码等密钥。如果需要在新设备直接恢复密码: + +1. 开启 **同步加密后的敏感信息**。 +2. 输入单独的 **同步密码**。 +3. 上传快照。 +4. 在另一台设备下载时输入相同的同步密码。 + +敏感信息使用 **Argon2id** 派生密钥,并使用 **AES-256-GCM** 加密。访问令牌只会使用设备密钥加密保存在本机,永远不会写入 `dbx-sync.json`。 + + +同步密码无法找回。丢失同步密码后,仍可恢复普通连接信息和 SQL,但无法解密远端敏感信息。 + + +## WebDAV + +填写 WebDAV 服务地址、用户名、应用密码和远端快照路径。默认路径为 `DBX/sync/snapshot.json`。 + +WebDAV 支持定时自动上传。自动上传只在 DBX 运行期间执行;下载始终需要手动确认,避免远端快照意外覆盖本地数据。 + +## 常见问题 + +### HTTP 401 或 403 + +令牌无效、已过期,或没有代码片段读写权限。重新创建最小权限令牌后再测试。 + +### HTTP 404 + +代码片段 ID 不正确,或者当前令牌无权访问该私有代码片段。 + +### 首次上传后在哪里找 ID + +DBX 会自动保存 ID。也可以在 GitHub Gist 或 Gitee 代码片段页面的地址栏中查看。 + +### 多台设备可以同时自动同步吗 + +代码片段同步目前只支持手动上传和下载,不会自动合并两台设备上的修改。上传前建议先下载最新快照,避免覆盖另一台设备刚上传的版本。 diff --git a/docs/content/docs/cloud-sync.mdx b/docs/content/docs/cloud-sync.mdx new file mode 100644 index 0000000000..d72d5969fc --- /dev/null +++ b/docs/content/docs/cloud-sync.mdx @@ -0,0 +1,122 @@ +--- +title: Cloud Sync and Backup +description: Sync DBX connections, settings, and saved SQL with WebDAV, GitHub Gist, or Gitee snippets. +--- + + +DBX can package connections, application settings, and saved SQL into a snapshot, upload it to WebDAV or a private code snippet, and restore it on another device. + + +Choose a provider under **Settings → Sync**: + +- **WebDAV**: Best when you already use a NAS, Nextcloud, or another WebDAV service. Supports scheduled uploads. +- **GitHub / Gitee snippets**: Stores the snapshot in a private Gist or code snippet without requiring your own server. Uploads and downloads are currently manual. + +## What Is Synchronized + +| Item | Default behavior | +| --- | --- | +| Database connections and non-secret options | Synchronized | +| Sidebar layout and pinned nodes | Synchronized | +| Saved SQL library | Synchronized | +| Desktop and editor settings | Synchronized | +| Database, SSH, proxy, HTTP tunnel, connection string, and AI API secrets | Excluded by default; can be encrypted and synchronized | +| JDBC drivers, plugins, and local files | Not synchronized | + + +Downloading replaces local connection metadata and saved SQL with the remote snapshot. Verify the snippet ID or WebDAV path before restoring. + + +## GitHub Gist + +### Create an Access Token + +A GitHub **fine-grained personal access token** is recommended: + +[Open the GitHub fine-grained token creation page](https://github.com/settings/personal-access-tokens/new) + + + ### Open token settings Sign in to GitHub and open **Settings → Developer settings → Personal access tokens → Fine-grained tokens**. + ### Create a token Select **Generate new token**, then set a name and expiration. + ### Grant permission Under **Account permissions**, set **Gists** to **Read and write**. Repository permissions are not required. + ### Save the token Copy the token immediately. GitHub only displays the complete token once. + + +A classic token also works, but grant only the `gist` scope. + +### First Upload + + + ### Select GitHub Open **Settings → Sync → GitHub / Gitee** and select **GitHub Gist**. + ### Enter the token Paste the access token. Enabling **Store encrypted on this device** is recommended. + ### Create the Gist Leave **Snippet ID** empty and select **Upload**. DBX creates a private Gist and stores the returned ID. + + +DBX stores the snapshot as `dbx-sync.json`. Later uploads update the same Gist, and GitHub keeps its revision history. + +### Restore on Another Device + +1. Open the private Gist and copy its ID from the URL. The URL normally looks like `https://gist.github.com//`, where the final segment is the ID. You can also open `https://gist.github.com/` and let GitHub redirect to the URL containing the actual username. +2. Enter the same GitHub token and Gist ID on the new device. +3. Select **Test** to verify access. +4. Select **Download** and confirm the restore. + +## Gitee Snippets + +### Create a Personal Access Token + +[Open the Gitee personal access token page](https://gitee.com/profile/personal_access_tokens) + + + ### Open token settings Sign in to Gitee and open **Settings → Personal Access Tokens**. + ### Create a token Select **Generate new token** and enter a description. + ### Grant permission Select only the code snippet (`gists`) permission. If permissions are grouped, choose the smallest permission that allows reading and writing snippets. + ### Save the token Copy the generated token immediately and store it in a password manager. + + +### Upload and Restore + +1. Select **Gitee Snippet** under **Settings → Sync → GitHub / Gitee**. +2. Enter the personal access token. Leave the snippet ID empty on the first upload; DBX creates a private snippet and stores its ID. +3. To restore elsewhere, enter the same snippet ID and select **Download**. + +Gitee snippets also use a `dbx-sync.json` file. + +## Synchronizing Secrets + +Snapshots exclude credentials by default. To restore passwords on another device: + +1. Enable **Synchronize encrypted secrets**. +2. Enter a separate **sync passphrase**. +3. Upload the snapshot. +4. Enter the same passphrase when downloading on another device. + +DBX derives the encryption key with **Argon2id** and encrypts secrets using **AES-256-GCM**. Provider access tokens are encrypted with a device-local key and are never written to `dbx-sync.json`. + + +The sync passphrase cannot be recovered. Without it, DBX can still restore non-secret connection settings and saved SQL, but not the encrypted secrets. + + +## WebDAV + +Enter the WebDAV endpoint, username, application password, and remote snapshot path. The default path is `DBX/sync/snapshot.json`. + +WebDAV supports scheduled uploads while DBX is running. Downloads always require confirmation to prevent accidental replacement of local data. + +## Troubleshooting + +### HTTP 401 or 403 + +The token is invalid, expired, or missing snippet read/write permission. Create a new least-privilege token and test again. + +### HTTP 404 + +The snippet ID is incorrect, or the current token cannot access the private snippet. + +### Where is the ID after the first upload? + +DBX stores it automatically. You can also find it in the URL of the GitHub Gist or Gitee snippet page. + +### Can multiple devices synchronize automatically? + +Snippet synchronization currently uses manual upload and download and does not merge concurrent changes. Download the latest snapshot before uploading to avoid replacing changes from another device. diff --git a/docs/content/docs/meta.cn.json b/docs/content/docs/meta.cn.json index 7011633ee2..c26d840289 100644 --- a/docs/content/docs/meta.cn.json +++ b/docs/content/docs/meta.cn.json @@ -34,6 +34,7 @@ "keyboard-shortcuts", "connection-import", "config-export", + "cloud-sync", "ssh-tunnel" ] } diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json index 6bdfd1c156..6f42cf3da0 100644 --- a/docs/content/docs/meta.json +++ b/docs/content/docs/meta.json @@ -34,6 +34,7 @@ "keyboard-shortcuts", "connection-import", "config-export", + "cloud-sync", "ssh-tunnel" ] } diff --git a/src-tauri/src/commands/cloud_sync.rs b/src-tauri/src/commands/cloud_sync.rs index c52cd37536..14223054f7 100644 --- a/src-tauri/src/commands/cloud_sync.rs +++ b/src-tauri/src/commands/cloud_sync.rs @@ -1,12 +1,13 @@ use std::sync::Arc; use dbx_core::cloud_sync::{ - apply_sync_snapshot, build_sync_snapshot_with_saved_secrets, forget_webdav_password, - forget_webdav_sync_secrets_passphrase as core_forget_webdav_sync_secrets_passphrase, resolve_webdav_password, - resolve_webdav_sync_secrets_passphrase, save_webdav_password, - save_webdav_sync_secrets_preference as core_save_webdav_sync_secrets_preference, webdav_saved_password_status, - webdav_sync_secrets_status as core_webdav_sync_secrets_status, ApplySnapshotOptions, ApplySnapshotSummary, - WebDavClient, WebDavConfig, WebDavPasswordStatus, WebDavSyncSecretsStatus, WebDavSyncSummary, + apply_sync_snapshot, build_sync_snapshot_with_saved_secrets, forget_snippet_token, forget_webdav_password, + forget_webdav_sync_secrets_passphrase as core_forget_webdav_sync_secrets_passphrase, resolve_snippet_token, + resolve_webdav_password, resolve_webdav_sync_secrets_passphrase, save_snippet_token, save_webdav_password, + save_webdav_sync_secrets_preference as core_save_webdav_sync_secrets_preference, snippet_saved_token_status, + webdav_saved_password_status, webdav_sync_secrets_status as core_webdav_sync_secrets_status, ApplySnapshotOptions, + ApplySnapshotSummary, SnippetSyncClient, SnippetSyncConfig, SnippetSyncSummary, SnippetTokenStatus, WebDavClient, + WebDavConfig, WebDavPasswordStatus, WebDavSyncSecretsStatus, WebDavSyncSummary, }; use dbx_core::storage::DesktopSettings; use serde::{Deserialize, Serialize}; @@ -23,6 +24,15 @@ pub struct WebDavDownloadResult { pub apply_summary: ApplySnapshotSummary, } +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SnippetDownloadResult { + pub summary: SnippetSyncSummary, + pub editor_settings: Option, + pub desktop_settings: DesktopSettings, + pub apply_summary: ApplySnapshotSummary, +} + #[tauri::command] pub async fn webdav_sync_test(state: State<'_, Arc>, mut config: WebDavConfig) -> Result<(), String> { resolve_webdav_password(&state.storage, &mut config).await?; @@ -115,3 +125,80 @@ pub async fn webdav_sync_download( apply_summary, }) } + +#[tauri::command] +pub async fn snippet_sync_test(state: State<'_, Arc>, mut config: SnippetSyncConfig) -> Result<(), String> { + resolve_snippet_token(&state.storage, &mut config).await?; + SnippetSyncClient::new(config).test().await +} + +#[tauri::command] +pub async fn snippet_token_status( + state: State<'_, Arc>, + config: SnippetSyncConfig, +) -> Result { + snippet_saved_token_status(&state.storage, &config).await +} + +#[tauri::command] +pub async fn save_snippet_saved_token( + state: State<'_, Arc>, + config: SnippetSyncConfig, + token: String, +) -> Result<(), String> { + save_snippet_token(&state.storage, &config, &token).await +} + +#[tauri::command] +pub async fn forget_snippet_saved_token( + state: State<'_, Arc>, + config: SnippetSyncConfig, +) -> Result<(), String> { + forget_snippet_token(&state.storage, &config).await +} + +#[tauri::command] +pub async fn snippet_sync_upload( + state: State<'_, Arc>, + mut config: SnippetSyncConfig, + editor_settings: Option, + secrets_passphrase: Option, +) -> Result { + resolve_snippet_token(&state.storage, &mut config).await?; + let snapshot = build_sync_snapshot_with_saved_secrets( + &state.storage, + env!("CARGO_PKG_VERSION"), + editor_settings, + secrets_passphrase.as_deref(), + ) + .await?; + SnippetSyncClient::new(config).put_snapshot(&snapshot).await +} + +#[tauri::command] +pub async fn snippet_sync_download( + state: State<'_, Arc>, + mut config: SnippetSyncConfig, + secrets_passphrase: Option, +) -> Result { + resolve_snippet_token(&state.storage, &mut config).await?; + let (snapshot, summary) = SnippetSyncClient::new(config).get_snapshot().await?; + let explicit_passphrase = secrets_passphrase.as_deref().map(str::trim).filter(|value| !value.is_empty()); + let saved_passphrase = if explicit_passphrase.is_some() { + None + } else { + resolve_webdav_sync_secrets_passphrase(&state.storage).await? + }; + let apply_summary = apply_sync_snapshot( + &state.storage, + &snapshot, + ApplySnapshotOptions { secrets_passphrase: explicit_passphrase.or(saved_passphrase.as_deref()) }, + ) + .await?; + Ok(SnippetDownloadResult { + summary, + editor_settings: snapshot.editor_settings, + desktop_settings: snapshot.desktop_settings, + apply_summary, + }) +} diff --git a/src-tauri/src/lib.rs b/src-tauri/src/lib.rs index 64c93aa71f..4fd12ca01d 100644 --- a/src-tauri/src/lib.rs +++ b/src-tauri/src/lib.rs @@ -796,6 +796,12 @@ pub fn run() { commands::cloud_sync::forget_webdav_sync_secrets_passphrase, commands::cloud_sync::webdav_sync_upload, commands::cloud_sync::webdav_sync_download, + commands::cloud_sync::snippet_sync_test, + commands::cloud_sync::snippet_token_status, + commands::cloud_sync::save_snippet_saved_token, + commands::cloud_sync::forget_snippet_saved_token, + commands::cloud_sync::snippet_sync_upload, + commands::cloud_sync::snippet_sync_download, commands::connection::test_connection, commands::connection::connect_db, commands::connection::connection_final_proxy_port,