sync: add sync status menu item in view menu, closes #844 (#1324)

2025-06-03 17:43:58 +08:00
parent 146a71fdef
commit 3f8d03ae28
22 changed files with 142 additions and 57 deletions
@@ -346,5 +346,8 @@
  "Search in {{count}} Book(s)..._many": "بحث في {{count}} كتابًا...",
  "Search in {{count}} Book(s)..._other": "بحث في {{count}} من الكتب...",
  "No notes match your search": "لا توجد ملاحظات تطابق بحثك",
-  "Search notes and excerpts...": "بحث في الملاحظات والمقتطفات..."
+  "Search notes and excerpts...": "بحث في الملاحظات والمقتطفات...",
+  "Sign in to Sync": "سجّل للمزامنة",
+  "Synced at {{time}}": "تمت عند {{time}}",
+  "Never synced": "لم تُزامَن"
 }
@@ -338,5 +338,8 @@
  "Search in {{count}} Book(s)..._one": "Suche in {{count}} Buch...",
  "Search in {{count}} Book(s)..._other": "Suche in {{count}} Büchern...",
  "No notes match your search": "Noch keine Notizen gefunden",
-  "Search notes and excerpts...": "Notizen und Auszüge suchen..."
+  "Search notes and excerpts...": "Notizen und Auszüge suchen...",
+  "Sign in to Sync": "Anmelden zum Synchronisieren",
+  "Synced at {{time}}": "Synchronisiert um {{time}}",
+  "Never synced": "Nie synchronisiert"
 }
@@ -338,5 +338,8 @@
  "Search in {{count}} Book(s)..._one": "Αναζήτηση σε {{count}} Βιβλίο...",
  "Search in {{count}} Book(s)..._other": "Αναζήτηση σε {{count}} Βιβλία...",
  "No notes match your search": "Καμία σημείωση δεν βρέθηκε",
-  "Search notes and excerpts...": "Αναζήτηση σημειώσεων..."
+  "Search notes and excerpts...": "Αναζήτηση σημειώσεων...",
+  "Sign in to Sync": "Σύνδεση για συγχρονισμό",
+  "Synced at {{time}}": "Συγχρονίστηκε στις {{time}}",
+  "Never synced": "Ποτέ δεν συγχρονίστηκε"
 }
@@ -340,5 +340,8 @@
  "Search in {{count}} Book(s)..._many": "Buscar en {{count}} libros...",
  "Search in {{count}} Book(s)..._other": "Buscar en {{count}} libros...",
  "No notes match your search": "No se encontraron notas",
-  "Search notes and excerpts...": "Buscar notas..."
+  "Search notes and excerpts...": "Buscar notas...",
+  "Sign in to Sync": "Inicia sesión para sincronizar",
+  "Synced at {{time}}": "Sincronizado a las {{time}}",
+  "Never synced": "Nunca sincronizado"
 }
@@ -340,5 +340,8 @@
  "Search in {{count}} Book(s)..._many": "Rechercher dans {{count}} Livres...",
  "Search in {{count}} Book(s)..._other": "Rechercher dans {{count}} Livres...",
  "No notes match your search": "Aucune note trouvée",
-  "Search notes and excerpts...": "Rechercher des notes..."
+  "Search notes and excerpts...": "Rechercher des notes...",
+  "Sign in to Sync": "Connectez-vous pour synchroniser",
+  "Synced at {{time}}": "Synchronisé à {{time}}",
+  "Never synced": "Jamais synchronisé"
 }
@@ -338,5 +338,8 @@
  "Search in {{count}} Book(s)..._one": "{{count}} पुस्तक में खोजें...",
  "Search in {{count}} Book(s)..._other": "{{count}} पुस्तकों में खोजें...",
  "No notes match your search": "कोई नोट्स नहीं मिले",
-  "Search notes and excerpts...": "नोट्स खोजें..."
+  "Search notes and excerpts...": "नोट्स खोजें...",
+  "Sign in to Sync": "सिंक करने के लिए साइन इन करें",
+  "Synced at {{time}}": "{{time}} पर सिंक किया गया",
+  "Never synced": "कभी सिंक नहीं किया गया"
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "Urutkan TOC berdasarkan Halaman",
  "Search in {{count}} Book(s)..._other": "Cari di {{count}} Buku...",
  "No notes match your search": "Tidak ada catatan ditemukan",
-  "Search notes and excerpts...": "Cari catatan..."
+  "Search notes and excerpts...": "Cari catatan...",
+  "Sign in to Sync": "Masuk untuk Sinkronisasi",
+  "Synced at {{time}}": "Disinkronkan pada {{time}}",
+  "Never synced": "Belum pernah disinkronkan"
 }
@@ -340,5 +340,8 @@
  "Search in {{count}} Book(s)..._many": "Cerca in {{count}} libri...",
  "Search in {{count}} Book(s)..._other": "Cerca in {{count}} libri...",
  "No notes match your search": "Nessuna nota trovata",
-  "Search notes and excerpts...": "Cerca nelle note..."
+  "Search notes and excerpts...": "Cerca nelle note...",
+  "Sign in to Sync": "Accedi per sincronizzare",
+  "Synced at {{time}}": "Sincronizzato alle {{time}}",
+  "Never synced": "Mai sincronizzato"
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "目次をページで並べ替え",
  "Search in {{count}} Book(s)..._other": "{{count}}冊の本を検索...",
  "No notes match your search": "ノートが見つかりません",
-  "Search notes and excerpts...": "ノートを検索..."
+  "Search notes and excerpts...": "ノートを検索...",
+  "Sign in to Sync": "同期するにはサインイン",
+  "Synced at {{time}}": "{{time}} に同期済み",
+  "Never synced": "まだ同期されていません"
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "목차를 페이지별로 정렬",
  "Search in {{count}} Book(s)..._other": "{{count}}권의 책에서 검색...",
  "No notes match your search": "일치하는 노트가 없습니다",
-  "Search notes and excerpts...": "노트 검색..."
+  "Search notes and excerpts...": "노트 검색...",
+  "Sign in to Sync": "동기화를 위해 로그인하세요",
+  "Synced at {{time}}": "{{time}}에 동기화됨",
+  "Never synced": "동기화된 적 없음"
 }
@@ -338,5 +338,8 @@
  "Search in {{count}} Book(s)..._one": "Zoeken in {{count}} Boek...",
  "Search in {{count}} Book(s)..._other": "Zoeken in {{count}} Boeken...",
  "No notes match your search": "Geen notities gevonden",
-  "Search notes and excerpts...": "Zoek notities..."
+  "Search notes and excerpts...": "Zoek notities...",
+  "Sign in to Sync": "Meld je aan om te synchroniseren",
+  "Synced at {{time}}": "Gesynchroniseerd om {{time}}",
+  "Never synced": "Nooit gesynchroniseerd"
 }
@@ -342,5 +342,8 @@
  "Search in {{count}} Book(s)..._many": "Szukaj w {{count}} książkach...",
  "Search in {{count}} Book(s)..._other": "Szukaj w {{count}} książkach...",
  "No notes match your search": "Nie znaleziono notatek",
-  "Search notes and excerpts...": "Szukaj notatek..."
+  "Search notes and excerpts...": "Szukaj notatek...",
+  "Sign in to Sync": "Zaloguj się",
+  "Synced at {{time}}": "Sync: {{time}}",
+  "Never synced": "Brak synchronizacji"
 }
@@ -340,5 +340,8 @@
  "Search in {{count}} Book(s)..._many": "Pesquisar em {{count}} Livros...",
  "Search in {{count}} Book(s)..._other": "Pesquisar em {{count}} Livros...",
  "No notes match your search": "Nenhuma nota encontrada",
-  "Search notes and excerpts...": "Buscar notas..."
+  "Search notes and excerpts...": "Buscar notas...",
+  "Sign in to Sync": "Entrar",
+  "Synced at {{time}}": "Sincronizado às {{time}}",
+  "Never synced": "Nunca sincronizado"
 }
@@ -342,5 +342,8 @@
  "Search in {{count}} Book(s)..._many": "Поиск в {{count}} книгах...",
  "Search in {{count}} Book(s)..._other": "Поиск в {{count}} книгах...",
  "No notes match your search": "Записи не найдены",
-  "Search notes and excerpts...": "Искать записи..."
+  "Search notes and excerpts...": "Искать записи...",
+  "Sign in to Sync": "Войти",
+  "Synced at {{time}}": "Синхр. в {{time}}",
+  "Never synced": "Не синхр."
 }
@@ -338,5 +338,8 @@
  "Search in {{count}} Book(s)..._one": "{{count}} kitapta ara...",
  "Search in {{count}} Book(s)..._other": "{{count}} kitapta ara...",
  "No notes match your search": "Eşleşen not bulunamadı",
-  "Search notes and excerpts...": "Notlarda ara..."
+  "Search notes and excerpts...": "Notlarda ara...",
+  "Sign in to Sync": "Giriş yap",
+  "Synced at {{time}}": "{{time}}'de eşzlendi",
+  "Never synced": "Hiç eşzlenmedi"
 }
@@ -342,5 +342,8 @@
  "Search in {{count}} Book(s)..._many": "Шукати в {{count}} книгах...",
  "Search in {{count}} Book(s)..._other": "Шукати в {{count}} книгах...",
  "No notes match your search": "Нотаток не знайдено",
-  "Search notes and excerpts...": "Шукати нотатки..."
+  "Search notes and excerpts...": "Шукати нотатки...",
+  "Sign in to Sync": "Увійти",
+  "Synced at {{time}}": "Синхр. о {{time}}",
+  "Never synced": "Ніколи не синхр."
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "Sort Mục lục theo Trang",
  "Search in {{count}} Book(s)..._other": "Tìm kiếm trong {{count}} cuốn sách...",
  "No notes match your search": "Không tìm thấy ghi chú nào",
-  "Search notes and excerpts...": "Tìm ghi chú..."
+  "Search notes and excerpts...": "Tìm ghi chú...",
+  "Sign in to Sync": "Đăng nhập",
+  "Synced at {{time}}": "Đã đồng bộ lúc {{time}}",
+  "Never synced": "Chưa từng đồng bộ"
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "按页码排序目录",
  "Search in {{count}} Book(s)..._other": "在 {{count}} 本书籍中搜索...",
  "No notes match your search": "未找到匹配的笔记",
-  "Search notes and excerpts...": "搜索笔记..."
+  "Search notes and excerpts...": "搜索笔记...",
+  "Sign in to Sync": "登录后同步",
+  "Synced at {{time}}": "同步于：{{time}}",
+  "Never synced": "从未同步"
 }
@@ -336,5 +336,8 @@
  "Sort TOC by Page": "依頁碼排序目錄",
  "Search in {{count}} Book(s)..._other": "在 {{count}} 本書中搜索...",
  "No notes match your search": "找不到符合的筆記",
-  "Search notes and excerpts...": "搜尋筆記..."
+  "Search notes and excerpts...": "搜尋筆記...",
+  "Sign in to Sync": "登入以同步",
+  "Synced at {{time}}": "同步於：{{time}}",
+  "Never synced": "從未同步"
 }
@@ -1,16 +1,22 @@
 import clsx from 'clsx';
 import React, { useEffect } from 'react';
 import { useState } from 'react';
+import { useRouter } from 'next/navigation';
 import { BiMoon, BiSun } from 'react-icons/bi';
 import { TbSunMoon } from 'react-icons/tb';
 import { MdZoomOut, MdZoomIn, MdCheck } from 'react-icons/md';
+import { MdSync, MdSyncProblem } from 'react-icons/md';

 import { MAX_ZOOM_LEVEL, MIN_ZOOM_LEVEL, ZOOM_STEP } from '@/services/constants';
 import { useEnv } from '@/context/EnvContext';
+import { useAuth } from '@/context/AuthContext';
 import { useThemeStore } from '@/store/themeStore';
 import { useReaderStore } from '@/store/readerStore';
+import { useBookDataStore } from '@/store/bookDataStore';
 import { useTranslation } from '@/hooks/useTranslation';
 import { getStyles } from '@/utils/style';
+import { navigateToLogin } from '@/utils/nav';
+import { eventDispatcher } from '@/utils/event';
 import { getMaxInlineSize } from '@/utils/config';
 import { tauriHandleToggleFullScreen } from '@/utils/window';
 import { saveViewSettings } from '../utils/viewSettingsHelper';
@@ -28,8 +34,12 @@ const ViewMenu: React.FC<ViewMenuProps> = ({
  onSetSettingsDialogOpen,
 }) => {
  const _ = useTranslation();
+  const router = useRouter();
+  const { user } = useAuth();
  const { envConfig, appService } = useEnv();
+  const { getConfig } = useBookDataStore();
  const { getView, getViewSettings, setViewSettings } = useReaderStore();
+  const config = getConfig(bookKey)!;
  const viewSettings = getViewSettings(bookKey)!;

  const { themeMode, isDarkMode, setThemeMode } = useThemeStore();
@@ -59,6 +69,15 @@ const ViewMenu: React.FC<ViewMenuProps> = ({
    setIsDropdownOpen?.(false);
  };

+  const handleSync = () => {
+    if (!user) {
+      navigateToLogin(router);
+      setIsDropdownOpen?.(false);
+    } else {
+      eventDispatcher.dispatch('sync-book-progress', { bookKey });
+    }
+  };
+
  useEffect(() => {
    if (isScrolledMode === viewSettings!.scrolled) return;
    viewSettings!.scrolled = isScrolledMode;
@@ -83,10 +102,12 @@ const ViewMenu: React.FC<ViewMenuProps> = ({
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [invertImgColorInDark]);

+  const lastSyncTime = Math.max(config?.lastSyncedAtConfig || 0, config?.lastSyncedAtNotes || 0);
+
  return (
    <div
      tabIndex={0}
-      className='view-menu dropdown-content bgcolor-base-200 dropdown-right no-triangle border-base-200 z-20 mt-1 w-72 border shadow-2xl'
+      className='view-menu dropdown-content bgcolor-base-200 dropdown-right no-triangle border-base-200 z-20 mt-1 border shadow-2xl'
    >
      <div className={clsx('flex items-center justify-between rounded-md')}>
        <button
@@ -130,6 +151,22 @@ const ViewMenu: React.FC<ViewMenuProps> = ({

      <hr className='border-base-300 my-1' />

+      <MenuItem
+        label={
+          !user
+            ? _('Sign in to Sync')
+            : lastSyncTime
+              ? _('Synced at {{time}}', {
+                  time: new Date(lastSyncTime).toLocaleString(),
+                })
+              : _('Never synced')
+        }
+        Icon={user ? MdSync : MdSyncProblem}
+        onClick={handleSync}
+      />
+
+      <hr className='border-base-300 my-1' />
+
      {appService?.hasWindow && <MenuItem label={_('Fullscreen')} onClick={handleFullScreen} />}
      <MenuItem
        label={
@@ -1,4 +1,4 @@
-import { useEffect, useRef } from 'react';
+import { useCallback, useEffect, useRef } from 'react';
 import { useAuth } from '@/context/AuthContext';
 import { useSync } from '@/hooks/useSync';
 import { BookConfig } from '@/types/book';
@@ -8,6 +8,7 @@ import { useSettingsStore } from '@/store/settingsStore';
 import { useTranslation } from '@/hooks/useTranslation';
 import { serializeConfig } from '@/utils/serializer';
 import { CFI } from '@/libs/document';
+import { debounce } from '@/utils/debounce';
 import { eventDispatcher } from '@/utils/event';
 import { DEFAULT_BOOK_SEARCH_CONFIG, SYNC_PROGRESS_INTERVAL_SEC } from '@/services/constants';

@@ -21,9 +22,9 @@ export const useProgressSync = (bookKey: string) => {
  const view = getView(bookKey);
  const config = getConfig(bookKey);
  const progress = getProgress(bookKey);
-  // flag to prevent accidental sync without first pulling the config
-  const configSynced = useRef(false);
-  const firstPulled = useRef(false);
+
+  const configPulled = useRef(false);
+  const hasPulledConfigOnce = useRef(false);

  const pushConfig = (bookKey: string, config: BookConfig | null) => {
    if (!config || !user) return;
@@ -41,9 +42,10 @@ export const useProgressSync = (bookKey: string) => {
    syncConfigs([], bookHash, 'pull');
  };
  const syncConfig = () => {
-    if (!configSynced.current) {
+    if (!configPulled.current) {
      pullConfig(bookKey);
    } else {
+      const config = getConfig(bookKey);
      if (config && config.progress && config.progress[0] > 0) {
        pushConfig(bookKey, config);
      }
@@ -57,6 +59,7 @@ export const useProgressSync = (bookKey: string) => {
    }
  };

+  // Push: ad-hoc push when the book is closed
  useEffect(() => {
    eventDispatcher.on('sync-book-progress', handleSyncBookProgress);
    return () => {
@@ -65,45 +68,33 @@ export const useProgressSync = (bookKey: string) => {
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [bookKey]);

-  useEffect(() => {
-    if (!progress || firstPulled.current) return;
-    firstPulled.current = true;
-    pullConfig(bookKey);
-
-    return () => {
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  const debouncedAutoSync = useCallback(
+    debounce(() => {
      syncConfig();
-    };
+    }, SYNC_PROGRESS_INTERVAL_SEC * 1000),
+    [],
+  );
+
+  // Push: auto-push progress when progress changes with a debounce
+  useEffect(() => {
+    if (!progress?.location || !user) return;
+    debouncedAutoSync();
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [progress]);

-  const lastProgressSyncTime = useRef<number>(0);
-  const syncTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
+  // Pull: pull progress once when the book is opened
  useEffect(() => {
-    if (!config?.location || !user) return;
-
-    const now = Date.now();
-    const timeSinceLastSync = now - lastProgressSyncTime.current;
-    if (timeSinceLastSync > SYNC_PROGRESS_INTERVAL_SEC * 1000) {
-      lastProgressSyncTime.current = now;
-      syncConfig();
-    } else {
-      if (syncTimeoutRef.current) clearTimeout(syncTimeoutRef.current);
-      syncTimeoutRef.current = setTimeout(
-        () => {
-          lastProgressSyncTime.current = Date.now();
-          syncTimeoutRef.current = null;
-          syncConfig();
-        },
-        SYNC_PROGRESS_INTERVAL_SEC * 1000 - timeSinceLastSync,
-      );
-    }
+    if (!progress || hasPulledConfigOnce.current) return;
+    hasPulledConfigOnce.current = true;
+    pullConfig(bookKey);
    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [config]);
+  }, [progress]);

-  // sync progress once when the book is opened
+  // Pull: proccess the pulled progress
  useEffect(() => {
-    if (!configSynced.current && syncedConfigs) {
-      configSynced.current = true;
+    if (!configPulled.current && syncedConfigs) {
+      configPulled.current = true;
      const syncedConfig = syncedConfigs.filter((c) => c.bookHash === bookKey.split('-')[0])[0];
      if (syncedConfig) {
        const configCFI = config?.location;
@@ -515,7 +515,7 @@ export const READEST_UPDATER_FILE = `${GITHUB_LATEST_DOWNLOAD}/latest.json`;

 export const READEST_CHANGELOG_FILE = `${GITHUB_LATEST_DOWNLOAD}/release-notes.json`;

-export const SYNC_PROGRESS_INTERVAL_SEC = 60;
+export const SYNC_PROGRESS_INTERVAL_SEC = 3;
 export const SYNC_NOTES_INTERVAL_SEC = 10;
 export const SYNC_BOOKS_INTERVAL_SEC = 10;
 export const CHECK_UPDATE_INTERVAL_SEC = 24 * 60 * 60;