feat: pin recent documents, clear file caches and preserve zoom position

Author: reycn

electron/main.mjs

@@ -37,6 +37,15 @@ const recentContextMenuLabels={
  ja:{open:'開く',hide:'非表示',copy:'ファイルの場所をコピー',reveal:'Finder で表示',status:'翻訳状況を表示'},
  ko:{open:'열기',hide:'가리기',copy:'파일 위치 복사',reveal:'Finder에서 보기',status:'번역 상태 보기'},
 };
+const recentExtraLabels={
+ en:{pin:'Pin',unpin:'Unpin',clearCache:'Clear Translation Cache'},
+ 'zh-CN':{pin:'置顶',unpin:'取消置顶',clearCache:'清除翻译缓存'},
+ 'zh-TW':{pin:'置頂',unpin:'取消置頂',clearCache:'清除翻譯快取'},
+ ja:{pin:'ピン留め',unpin:'ピン留め解除',clearCache:'翻訳キャッシュを削除'},
+ ko:{pin:'고정',unpin:'고정 해제',clearCache:'번역 캐시 지우기'},
+ fr:{pin:'Épingler',unpin:'Désépingler',clearCache:'Effacer le cache de traduction'},
+ es:{pin:'Fijar',unpin:'Desfijar',clearCache:'Borrar caché de traducción'}
+};
 const recentContextMenuLabelsFor=locale=>recentContextMenuLabels[locale]||recentContextMenuLabels.en;
 const haptics=createHaptics({packaged:app.isPackaged});app.on('will-quit',()=>haptics.close());
 const pendingFiles=[];
@@ -368,17 +377,20 @@ else {
    if(action==='contextMenu'){
     const id=value,path=typeof id==='string'?recents.path(id):undefined;
     if(typeof id!=='string'||!id||typeof path!=='string'||!path)throw Error('Document no longer in history.');
-    const labels=recentContextMenuLabelsFor(preferences?.load?.().uiLanguage);
+    const locale=preferences?.load?.().uiLanguage,labels={...recentContextMenuLabelsFor(locale),...(recentExtraLabels[locale]||recentExtraLabels.en)},entry=recents.list().find(item=>item.id===id);
     return new Promise((resolve,reject)=>{
      let selected=null,pending=Promise.resolve();
      const template=[
       {label:labels.open,click:()=>{selected='open';}},
+      {label:entry?.pinned?labels.unpin:labels.pin,click:()=>{pending=recents.setPinned(id,!entry?.pinned).then(()=>{selected='pin';});}},
       {label:labels.hide,click:()=>{pending=recents.remove(id).then(()=>{selected='hide';});}},
       {type:'separator'},
       {label:labels.copy,click:()=>{pending=Promise.resolve().then(()=>clipboard.writeText(path));}},
       {label:labels.reveal,click:()=>{pending=Promise.resolve().then(()=>shell.showItemInFolder(path));}},
       {type:'separator'},
       {label:labels.status,click:()=>{selected='status';}},
+      {type:'separator'},
+      {label:labels.clearCache,click:()=>{pending=(async()=>{const document=await readSystemPDF(path);const response=await fetch(windows.get(window).backend.origin+'/api/translation-cache/clear',{method:'POST',headers:{'Content-Type':'application/pdf','X-Preview-Token':token},body:document.bytes});if(!response.ok)throw Error('Could not clear translation cache.');await recents.clearTranslationStatus(id);selected='clearCache';})();}},
      ];
      try{Menu.buildFromTemplate(template).popup({window,callback:()=>{pending.then(()=>resolve(selected),reject);}});}catch(error){reject(error);}
     });
@@ -389,7 +401,7 @@ else {
    if(action==='setThumbnail')return recents.setThumbnail(value?.id,value?.thumbnail);
    if(action==='setView')return recents.setView(value?.id,value?.view);
    if(action==='setTranslationStatus')return recents.setTranslationStatus(value?.id,value?.status);
-   const state=windows.get(window),path=value?.ticket?state.tickets.get(value.ticket):value?.path;if(!path){await documentSession.close(window.id);if(!state.unkeyedAnnotationSource?.preserveWithoutPath){state.unkeyedAnnotationSource=null;state.annotationSources.clear();}return {entries:recents.list(),recentId:null};}if(smoke&&!['A quieter way to read.pdf','Portrait and landscape.pdf'].includes(path.split(/[\\/]/).pop()))throw Error('Test document rejected.');await validateSystemPDF(path);if(value?.ticket)state.tickets.delete(value.ticket);if(!smoke)app.addRecentDocument(path);const entries=await recents.remember(path,value?.thumbnail),first=entries[0],source={path,reliable:true,preserveWithoutPath:false};state.annotationSources.set(first.id,source);state.unkeyedAnnotationSource=source;const restored=state.restoreView;state.restoreView=null;await documentSession.open(window.id,{path,view:restored||first?.view});return {entries,recentId:first?.id??null,view:restored||first?.view};
+   const state=windows.get(window),path=value?.ticket?state.tickets.get(value.ticket):value?.path;if(!path){await documentSession.close(window.id);if(!state.unkeyedAnnotationSource?.preserveWithoutPath){state.unkeyedAnnotationSource=null;state.annotationSources.clear();}return {entries:recents.list(),recentId:null};}if(smoke&&!['A quieter way to read.pdf','Portrait and landscape.pdf'].includes(path.split(/[\\/]/).pop()))throw Error('Test document rejected.');await validateSystemPDF(path);if(value?.ticket)state.tickets.delete(value.ticket);if(!smoke)app.addRecentDocument(path);const entries=await recents.remember(path,value?.thumbnail),first=entries.find(item=>recents.path(item.id)===path),source={path,reliable:true,preserveWithoutPath:false};state.annotationSources.set(first.id,source);state.unkeyedAnnotationSource=source;const restored=state.restoreView;state.restoreView=null;await documentSession.open(window.id,{path,view:restored||first?.view});return {entries,recentId:first?.id??null,view:restored||first?.view};
   });
   ipcMain.handle('documents:open',async(event,value)=>{const target=trustedWindow(event);if(typeof value?.path==='string'){await validateSystemPDF(value.path);await openDocumentWindow(value.path,target);}else{if(!value||typeof value.name!=='string'||!(value.bytes instanceof Uint8Array)||value.bytes.byteLength>50*1024*1024)throw Error('Invalid PDF.');await openDocumentWindow({name:value.name,bytes:value.bytes},target);}return true;});
   ipcMain.handle('window:new',async event=>{trustedWindow(event);await createWindow();});

electron/recents.mjs

@@ -2,6 +2,7 @@ import {readFile,writeFile,mkdir,rename} from 'node:fs/promises';
 import {dirname,basename} from 'node:path';
 import {randomUUID} from 'node:crypto';
 const maxThumbnailLength=200000;
+const maxUnpinnedRecents=10;
 const pngDataURL=/^data:image\/png;base64,[A-Za-z0-9+/]+={0,2}$/;
 const readingViewFields=['page','offsetX','offsetY','zoom','fit','direction','columns','sidebar','showTranslations'];
 const translationStatusFields=['totalPages','completedPages','partialPages','failedPages','engine','language','updatedAt'];
@@ -34,15 +35,20 @@ export function validateTranslationStatus(status){
 }
 function storedTranslationStatus(status){try{return validateTranslationStatus(status);}catch{return undefined;}}
 function cloneTranslationStatus(status){return status===undefined?undefined:{...status};}
+function normalizeEntries(entries){
+ const pinned=[],unpinned=[];
+ for(const entry of entries)(entry.pinned?pinned:unpinned).push(entry);
+ return [...pinned,...unpinned.slice(0,maxUnpinnedRecents)];
+}
 function listedEntry(entry){
- const result={id:entry.id,name:basename(entry.path),thumbnail:entry.thumbnail};
+ const result={id:entry.id,name:basename(entry.path),thumbnail:entry.thumbnail,pinned:entry.pinned===true};
  if(entry.view!==undefined)result.view=cloneReadingView(entry.view);
  if(entry.translationStatus!==undefined)result.translationStatus=cloneTranslationStatus(entry.translationStatus);
  return result;
 }
 export async function createRecents(path){
- let entries=[];try{entries=JSON.parse(await readFile(path,'utf8')).filter(e=>typeof e.id==='string'&&typeof e.path==='string').slice(0,10).map(e=>{const entry={id:e.id,path:e.path},thumbnail=storedThumbnail(e.thumbnail),view=storedReadingView(e.view),translationStatus=storedTranslationStatus(e.translationStatus);if(thumbnail!==undefined)entry.thumbnail=thumbnail;if(view!==undefined)entry.view=view;if(translationStatus!==undefined)entry.translationStatus=translationStatus;return entry;});}catch{}
+ let entries=[];try{const stored=JSON.parse(await readFile(path,'utf8'));entries=normalizeEntries((Array.isArray(stored)?stored:[]).filter(e=>e&&typeof e.id==='string'&&typeof e.path==='string').map(e=>{const entry={id:e.id,path:e.path,pinned:e.pinned===true},thumbnail=storedThumbnail(e.thumbnail),view=storedReadingView(e.view),translationStatus=storedTranslationStatus(e.translationStatus);if(thumbnail!==undefined)entry.thumbnail=thumbnail;if(view!==undefined)entry.view=view;if(translationStatus!==undefined)entry.translationStatus=translationStatus;return entry;}));}catch{}
  let writes=Promise.resolve();
  function persist(){const data=JSON.stringify(entries);writes=writes.catch(()=>{}).then(async()=>{await mkdir(dirname(path),{recursive:true});await writeFile(path+'.tmp',data);await rename(path+'.tmp',path);});return writes;}
- return {list:()=>entries.map(listedEntry),path:id=>entries.find(e=>e.id===id)?.path,async remember(file,thumbnail){const current=entries.find(e=>e.path===file),entry={id:current?.id||randomUUID(),path:file};if(thumbnail===undefined){if(current?.thumbnail!==undefined)entry.thumbnail=current.thumbnail;}else entry.thumbnail=validateThumbnail(thumbnail);if(current?.view!==undefined)entry.view=cloneReadingView(current.view);if(current?.translationStatus!==undefined)entry.translationStatus=cloneTranslationStatus(current.translationStatus);entries=[entry,...entries.filter(e=>e.path!==file)].slice(0,10);await persist();return this.list();},async setThumbnail(id,thumbnail){const entry=entries.find(e=>e.id===id);if(!entry)throw Error('Document no longer in history.');entry.thumbnail=validateThumbnail(thumbnail);await persist();return this.list();},async setView(id,view){const validated=validateReadingView(view),entry=entries.find(e=>e.id===id);if(!entry)return this.list();entry.view=validated;await persist();return this.list();},async setTranslationStatus(id,status){const validated=validateTranslationStatus(status),entry=entries.find(e=>e.id===id);if(!entry)return this.list();entry.translationStatus=validated;await persist();return this.list();},async remove(id){const index=entries.findIndex(e=>e.id===id);if(index<0)throw Error('Document no longer in history.');entries.splice(index,1);await persist();return this.list();},async clear(){entries=[];await persist();return [];},flush:()=>writes};
+ return {list:()=>entries.map(listedEntry),path:id=>entries.find(e=>e.id===id)?.path,async remember(file,thumbnail){const current=entries.find(e=>e.path===file),entry={id:current?.id||randomUUID(),path:file,pinned:current?.pinned===true};if(thumbnail===undefined){if(current?.thumbnail!==undefined)entry.thumbnail=current.thumbnail;}else entry.thumbnail=validateThumbnail(thumbnail);if(current?.view!==undefined)entry.view=cloneReadingView(current.view);if(current?.translationStatus!==undefined)entry.translationStatus=cloneTranslationStatus(current.translationStatus);entries=normalizeEntries([entry,...entries.filter(e=>e.path!==file)]);await persist();return this.list();},async setThumbnail(id,thumbnail){const entry=entries.find(e=>e.id===id);if(!entry)throw Error('Document no longer in history.');entry.thumbnail=validateThumbnail(thumbnail);await persist();return this.list();},async setView(id,view){const validated=validateReadingView(view),entry=entries.find(e=>e.id===id);if(!entry)return this.list();entry.view=validated;await persist();return this.list();},async setTranslationStatus(id,status){const validated=validateTranslationStatus(status),entry=entries.find(e=>e.id===id);if(!entry)return this.list();entry.translationStatus=validated;await persist();return this.list();},async clearTranslationStatus(id){const entry=entries.find(e=>e.id===id);if(!entry)return this.list();delete entry.translationStatus;await persist();return this.list();},async setPinned(id,pinned){if(typeof pinned!=='boolean')throw Error('Invalid recent document pinned state.');const entry=entries.find(e=>e.id===id);if(!entry)return this.list();entry.pinned=pinned;entries=normalizeEntries(entries);await persist();return this.list();},async remove(id){const index=entries.findIndex(e=>e.id===id);if(index<0)throw Error('Document no longer in history.');entries.splice(index,1);await persist();return this.list();},async clear(){entries=entries.filter(entry=>entry.pinned);await persist();return this.list();},flush:()=>writes};
 }

server/document-cache.mjs

@@ -0,0 +1,17 @@
+import {readFile,mkdir,writeFile,rename,rm} from 'node:fs/promises';
+import {join} from 'node:path';
+import {randomUUID} from 'node:crypto';
+export function createDocumentCache(directory){
+ const hashOf=hash=>hash.copy().digest('hex');
+ async function scope(hash){
+  const id=hashOf(hash);
+  try{return id+':'+(await readFile(join(directory,'documents',id+'.generation'),'utf8')).trim();}catch(error){if(error.code!=='ENOENT')throw error;return '';}
+ }
+ async function clear(hash){
+  const id=hashOf(hash),root=join(directory,'documents');await mkdir(root,{recursive:true});
+  const file=join(root,id+'.generation'),temp=file+'.'+randomUUID()+'.tmp';
+  await writeFile(temp,randomUUID());await rename(temp,file);
+  await rm(join(root,id),{recursive:true,force:true});
+ }
+ return {scope,clear};
+}

server/document-cache.test.mjs

@@ -0,0 +1,19 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import {mkdtemp,rm,mkdir,writeFile,stat} from 'node:fs/promises';
+import {tmpdir} from 'node:os';
+import {join} from 'node:path';
+import {createHash} from 'node:crypto';
+import {createDocumentCache} from './document-cache.mjs';
+test('clearing a document persists invalidation and leaves other documents unchanged',async()=>{
+ const root=await mkdtemp(join(tmpdir(),'reader-document-cache-'));
+ try{
+  const a=createHash('sha256').update('a'),b=createHash('sha256').update('b'),cache=createDocumentCache(root);
+  assert.equal(await cache.scope(a),'');assert.equal(await cache.scope(b),'');
+  const old=join(root,'documents',a.copy().digest('hex'));await mkdir(old,{recursive:true});await writeFile(join(old,'old.json'),'{}');
+  await cache.clear(a);const scope=await cache.scope(a);assert.ok(scope);
+  await assert.rejects(stat(old),{code:'ENOENT'});
+  assert.equal(await cache.scope(b),'');assert.equal(await createDocumentCache(root).scope(a),scope);
+  await cache.clear(a);assert.notEqual(await cache.scope(a),scope);
+ }finally{await rm(root,{recursive:true,force:true});}
+});