An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
:sparkles: Maximize PDF panes while preserving reading position https://github.com/siyuan-note/siyuan/issues/20701
Daniel09c153a7d53f
diff --git a/app/src/asset/pdf/viewer.js b/app/src/asset/pdf/viewer.jsindex 044d95fc7f..8a55cfb972 100644--- a/app/src/asset/pdf/viewer.js+++ b/app/src/asset/pdf/viewer.js@@ -21,6 +21,7 @@ import { PDFViewerApplication } from "./app.js";import {Constants} from "../../constants";import {destroyAnno, initAnno} from "../anno";import {registerPdfInstance} from "../annoRuntime";+import {bindPdfMaximize} from "../pdfMaximize";import {AnnotationEditorType} from "./pdfjs";/* eslint-disable-next-line no-unused-vars */@@ -284,6 +285,7 @@ function webViewerLoad(file, element, pdfPage, annoId, previewOnly = false) {}}const runPromise = pdf.run(config);+ const disposeMaximize = bindPdfMaximize(element, pdf, previewOnly);if (previewOnly) {// 未引用资源仅用于预览,不读取或写入批注文件。registerPdfInstance(element, pdf);@@ -299,6 +301,7 @@ function webViewerLoad(file, element, pdfPage, annoId, previewOnly = false) {}isDestroyed = true;pdf._destroyed = true;+ disposeMaximize();destroyAnno(element);try {await runPromise;diff --git a/app/src/asset/pdf/viewerTemplate.ts b/app/src/asset/pdf/viewerTemplate.tsindex a2fa338c69..0886182094 100644--- a/app/src/asset/pdf/viewerTemplate.ts+++ b/app/src/asset/pdf/viewerTemplate.ts@@ -180,6 +180,9 @@ export const getPdfViewerHTML = () => `<div class="pdf__outer" id="outerContaine<div class="pdf__toolbar"><div id="toolbarContainer"><div id="toolbarViewer">+ <button id="pdfMaximize" class="toolbarButton b3-tooltips b3-tooltips__se fn__none" aria-label="${window.siyuan.languages.max}" aria-pressed="false">+ <svg><use xlink:href="#iconFullscreen"></use></svg>+ </button><button id="sidebarToggleButton" class="toolbarButton b3-tooltips b3-tooltips__se" aria-expanded="false" aria-controls="sidebarContainer" aria-label="${window.siyuan.languages.toggleSidebarNotification2Title} ${updateHotkeyTip("F4")}"><svg><use xlink:href="#iconLayoutLeft"></use></svg></button>diff --git a/app/src/asset/pdfMaximize.ts b/app/src/asset/pdfMaximize.tsnew file mode 100644index 0000000000..ebbbf3f3ac--- /dev/null+++ b/app/src/asset/pdfMaximize.ts@@ -0,0 +1,110 @@+import {getTopBarHeight} from "../layout/getTopBarHeight";++interface PDFReadingPosition {+ pageNumber: number;+ left: number;+ top: number;+}++interface PDFPaneApplication {+ pdfViewer?: {+ _location?: PDFReadingPosition;+ scrollPageIntoView: (options: {+ pageNumber: number;+ destArray: unknown[];+ allowNegativeOffset: boolean;+ ignoreDestinationZoom: boolean;+ }) => void;+ };+ eventBus?: {dispatch: (name: string, data: {source: HTMLElement}) => void};+}++let activePane: {restore: () => void} | undefined;++export const bindPdfMaximize = (element: HTMLElement, pdf: PDFPaneApplication, previewOnly = false) => {+ const outer = element.querySelector<HTMLElement>(".pdf__outer");+ const button = element.querySelector<HTMLButtonElement>("#pdfMaximize");+ if (!outer || !button || previewOnly || element.classList.contains("pdf-viewer--mobile")) {+ return () => {};+ }+ button.classList.remove("fn__none");+ const controller = new AbortController();+ let maximized = false;+ let frame = 0;+ let pendingPosition: PDFReadingPosition | undefined;+ const resize = (position = pdf.pdfViewer?._location) => {+ if (!pendingPosition && position) {+ pendingPosition = {...position};+ }+ if (frame) {+ return;+ }+ frame = requestAnimationFrame(() => {+ frame = 0;+ const position = pendingPosition;+ pendingPosition = undefined;+ if (!element.isConnected || element.closest(".fn__none")) {+ return;+ }+ pdf.eventBus?.dispatch("resize", {source: outer});+ if (position) {+ pdf.pdfViewer?.scrollPageIntoView({+ pageNumber: position.pageNumber,+ destArray: [null, {name: "XYZ"}, position.left, position.top, null],+ allowNegativeOffset: true,+ ignoreDestinationZoom: true,+ });+ }+ });+ };+ const updateTop = () => {+ if (maximized) {+ outer.style.setProperty("--pdf-maximized-top", `${getTopBarHeight()}px`);+ }+ };+ const setMaximized = (enter: boolean) => {+ if (maximized === enter) {+ return;+ }+ if (enter) {+ activePane?.restore();+ }+ const position = pdf.pdfViewer?._location;+ maximized = enter;+ if (enter) {+ activePane = pane;+ updateTop();+ } else {+ outer.style.removeProperty("--pdf-maximized-top");+ if (activePane === pane) {+ activePane = undefined;+ }+ }+ outer.classList.toggle("pdf__outer--maximized", enter);+ button.setAttribute("aria-pressed", String(enter));+ button.setAttribute("aria-label", enter ? window.siyuan.languages.restore : window.siyuan.languages.max);+ button.querySelector("use").setAttribute("xlink:href", enter ? "#iconFullscreenExit" : "#iconFullscreen");+ resize(position);+ };+ const pane = {restore: () => setMaximized(false)};+ button.addEventListener("click", () => setMaximized(!maximized), {signal: controller.signal});+ window.addEventListener("resize", updateTop, {signal: controller.signal});+ // 也覆盖分屏拖动和横竖屏切换,且不触发其他 PDF 实例的重排。+ const observer = new ResizeObserver(() => resize());+ observer.observe(outer);+ const visibility = new MutationObserver(() => {+ if (maximized && element.closest(".fn__none")) {+ setMaximized(false);+ }+ });+ visibility.observe(element, {attributes: true, attributeFilter: ["class"]});+ return () => {+ setMaximized(false);+ controller.abort();+ observer.disconnect();+ visibility.disconnect();+ cancelAnimationFrame(frame);+ frame = 0;+ pendingPosition = undefined;+ };+};diff --git a/app/src/assets/scss/pdf/_pdf.scss b/app/src/assets/scss/pdf/_pdf.scssindex ac3ba67ee1..69d65211da 100644--- a/app/src/assets/scss/pdf/_pdf.scss+++ b/app/src/assets/scss/pdf/_pdf.scss@@ -38,6 +38,15 @@height: 100%;position: relative;+ &--maximized {+ position: fixed;+ inset: var(--pdf-maximized-top, 0px) 0 0;+ width: auto;+ height: auto;+ z-index: 8;+ background-color: var(--b3-theme-background);+ }+.textLayer {/* dark 蓝色、紫色背景显示不清楚,文档位于 https://github.com/siyuan-note/siyuan/issues/5351 */mix-blend-mode: multiply;diff --git a/app/src/boot/globalEvent/nativeBack.test.ts b/app/src/boot/globalEvent/nativeBack.test.tsindex 85ababa8ae..30ed1f5c31 100644--- a/app/src/boot/globalEvent/nativeBack.test.ts+++ b/app/src/boot/globalEvent/nativeBack.test.ts@@ -97,6 +97,24 @@ test("Android desktop back closes the highest menu, dialog and drawer one at a tassert.deepEqual(state.closed, ["menu", "top-dialog", "first-dialog", "drawer", "document-back"]);});+test("native back restores a maximized PDF after closing higher overlays and before document history", () => {+ const state = setup();+ state.setDrawer(false);+ const pdf = state.element("pdf", 8);+ const button = {click: () => {+ state.closed.push("pdf-restored");+ state.elements[".pdf__outer--maximized"] = [];+ }};+ Object.assign(pdf, {querySelector: () => button});+ state.elements[".pdf__outer--maximized"] = [pdf];+ state.addDialog("dialog", 100);+ state.api.registerDesktopBackNavigation(state.app);+ state.window.goBack();+ state.window.goBack();+ state.window.goBack();+ assert.deepEqual(state.closed, ["dialog", "pdf-restored", "document-back"]);+});+test("a higher dialog closes ahead of an older menu regardless of array order", () => {const state = setup();state.siyuan.menus.menu.element = state.element("menu", 120);diff --git a/app/src/boot/globalEvent/nativeBack.ts b/app/src/boot/globalEvent/nativeBack.tsindex 813d19b711..e5cb1a0f05 100644--- a/app/src/boot/globalEvent/nativeBack.ts+++ b/app/src/boot/globalEvent/nativeBack.ts@@ -44,6 +44,9 @@ export const closeDesktopBackLayer = () => {document.querySelectorAll<HTMLElement>(".protyle-img").forEach(element => {addLayer(element, () => element.remove());});+ document.querySelectorAll<HTMLElement>(".pdf__outer--maximized").forEach(element => {+ addLayer(element, () => element.querySelector<HTMLButtonElement>("#pdfMaximize")?.click());+ });document.querySelectorAll<HTMLElement>(".av__panel").forEach(element => {addLayer(element, () => {if ((element.querySelector('[data-type="goSearchRollupCol"]') && !element.querySelector(".b3-text-field")) ||diff --git a/app/tests/assetPreview.test.js b/app/tests/assetPreview.test.jsindex 83aaef978b..f43c647c27 100644--- a/app/tests/assetPreview.test.js+++ b/app/tests/assetPreview.test.js@@ -378,6 +378,7 @@ const runCases = async source => {"../../constants": {Constants: {PROTYLE_CDN: "/stage/protyle"}},"../anno": {initAnno: () => annotations++, destroyAnno: () => cleanup++},"../annoRuntime": {registerPdfInstance: () => registrations++},+ "../pdfMaximize": {bindPdfMaximize: () => () => {}},"./pdfjs": {AnnotationEditorType: {DISABLE: 0}},});const viewerElement = document.createElement("div");diff --git a/app/tests/pdfMaximize.test.js b/app/tests/pdfMaximize.test.jsnew file mode 100644index 0000000000..0f29847dea--- /dev/null+++ b/app/tests/pdfMaximize.test.js@@ -0,0 +1,145 @@+const assert = require("node:assert/strict");+const fs = require("node:fs");+const path = require("node:path");+const os = require("node:os");++async function runElectron() {+ const {app, BrowserWindow} = require("electron");+ app.setPath("userData", process.argv[2]);+ await app.whenReady();+ const win = new BrowserWindow({show: false, width: 1000, height: 900, webPreferences: {backgroundThrottling: false}});+ let code = 0;+ try {+ await win.loadURL("data:text/html,<html><body></body></html>");+ const moduleURL = source => "data:text/javascript;base64," + Buffer.from(source).toString("base64");+ const bundle = moduleURL(await require("./pdfViewerBundle.cjs")());+ const runtime = moduleURL(fs.readFileSync(path.join(__dirname, "../stage/protyle/js/pdf/pdf.min.mjs")));+ const worker = moduleURL(fs.readFileSync(path.join(__dirname, "../stage/protyle/js/pdf/pdf.worker.min.mjs")));+ const css = require("sass").compile(path.join(__dirname, "../src/assets/scss/pdf/_pdf.scss")).css;+ await win.webContents.insertCSS(css + ".fn__none,.hidden{display:none!important}.fn__hidden{visibility:hidden}svg{width:14px;height:14px}body{margin:0}.fn__flex-1{flex:1;min-height:0}");+ await win.webContents.executeJavaScript(`(async () => {+ window.pdfjsLib = await import(${JSON.stringify(runtime)});+ globalThis.pdfjsWorker = await import(${JSON.stringify(worker)});+ window.siyuan = {languages: new Proxy({}, {get: (_, key) => key}), storage: {}};+ const {getPdfViewerHTML, webViewerLoad} = await import(${JSON.stringify(bundle)});+ const check = (value, message) => {if (!value) throw new Error(message);};+ const wait = () => new Promise(resolve => setTimeout(resolve, 50));+ const toolbar = document.createElement("div");+ toolbar.id = "toolbar"; toolbar.style.height = "32px"; document.body.append(toolbar);+ const notes = document.createElement("div"); notes.textContent = "Keep notes and split";+ notes.style.cssText = "position:absolute;top:32px;left:0;width:400px;height:600px";+ document.body.append(notes);+ const element = document.createElement("div");+ element.style.cssText = "position:absolute;top:32px;left:400px;width:400px;height:600px";+ element.innerHTML = getPdfViewerHTML(); document.body.append(element);+ const stream = "BT /F1 12 Tf 25 300 Td (PDF pane text) Tj ET";+ const page = "<< /Type /Page /Parent 2 0 R /MediaBox [0 0 400 500] /Resources << /Font << /F1 7 0 R >> >> /Contents 6 0 R >>";+ const objects = ["<< /Type /Catalog /Pages 2 0 R >>",+ "<< /Type /Pages /Kids [3 0 R 4 0 R 5 0 R] /Count 3 >>", page, page, page,+ "<< /Length " + stream.length + " >>\\nstream\\n" + stream + "\\nendstream",+ "<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>"];+ let source = "%PDF-1.7\\n";+ const offsets = [0];+ objects.forEach((object, i) => {offsets.push(source.length); source += (i + 1) + " 0 obj\\n" + object + "\\nendobj\\n";});+ const xref = source.length;+ source += "xref\\n0 8\\n0000000000 65535 f \\n" ++ offsets.slice(1).map(offset => String(offset).padStart(10, "0") + " 00000 n \\n").join("") ++ "trailer\\n<< /Size 8 /Root 1 0 R >>\\nstartxref\\n" + xref + "\\n%%EOF";+ const url = URL.createObjectURL(new Blob([source], {type: "application/pdf"}));+ const pdf = webViewerLoad(url, element, 1);+ await pdf.initializedPromise;+ for (let i = 0; i < 160 && !pdf.pdfViewer.getPageView(0)?.textLayer?.div.textContent; i++) await wait();+ check(pdf.pdfViewer.getPageView(0)?.textLayer?.div.textContent.includes("PDF pane text"), "PDF did not render");+ const documentInstance = pdf.pdfDocument;+ const outer = element.querySelector(".pdf__outer");+ const button = element.querySelector("#pdfMaximize");+ const originalLayout = element.style.cssText;+ const originalNotes = notes.outerHTML;+ const position = () => ({...pdf.pdfViewer._location});+ const assertPosition = (expected, label) => {+ const actual = position();+ check(actual.pageNumber === expected.pageNumber && Math.abs(actual.top - expected.top) < 2,+ label + ": " + JSON.stringify({expected, actual}));+ };+ for (const scale of ["page-width", "1.5"]) {+ pdf.pdfViewer.currentScaleValue = scale;+ pdf.pdfViewer.scrollPageIntoView({pageNumber: 2, destArray: [null, {name: "XYZ"}, 0, 450, null],+ ignoreDestinationZoom: true});+ await wait();+ const before = position();+ for (let i = 0; i < 3; i++) {+ button.click(); await wait();+ check(outer.classList.contains("pdf__outer--maximized"), "maximize state missing");+ check(button.getAttribute("aria-label") === "restore" && button.getAttribute("aria-pressed") === "true", "restore entry missing");+ const rect = outer.getBoundingClientRect();+ check(rect.left === 0 && rect.top === 32 && rect.width === innerWidth, "pane did not fill available width");+ check(pdf.pdfDocument === documentInstance, "PDF was reloaded");+ assertPosition(before, "maximize");+ button.click(); await wait();+ assertPosition(before, "restore");+ check(outer.clientWidth === 400 && element.style.cssText === originalLayout && notes.outerHTML === originalNotes,+ "split layout changed");+ }+ }+ pdf.pdfViewer.currentScaleValue = "page-width";+ button.click(); await wait();+ const anchor = position();+ window.pdfPaneFixture = {pdf, element, outer, button, anchor, assertPosition, wait, check, url,+ getPdfViewerHTML, webViewerLoad};+ })()`);+ for (const [width, height] of [[480, 900], [1100, 600], [800, 800]]) {+ win.setSize(width, height);+ await win.webContents.executeJavaScript(`(async () => {+ const f = window.pdfPaneFixture;+ await f.wait(); await f.wait();+ f.assertPosition(f.anchor, "viewport resize");+ f.check(f.outer.clientWidth === innerWidth, "viewport width not followed");+ })()`);+ }+ await win.webContents.executeJavaScript(`(async () => {+ const f = window.pdfPaneFixture;+ f.element.classList.add("fn__none"); await f.wait();+ f.check(!f.outer.classList.contains("pdf__outer--maximized"), "hidden tab retained maximize state");+ f.element.classList.remove("fn__none"); await f.wait();+ f.button.click();+ await f.pdf.destroy();+ f.check(!f.outer.classList.contains("pdf__outer--maximized"), "destroy retained maximize state");+ for (const mobile of [false, true]) {+ const element = document.createElement("div");+ if (mobile) element.className = "pdf-viewer--mobile";+ element.innerHTML = f.getPdfViewerHTML(); document.body.append(element);+ const pdf = f.webViewerLoad(f.url, element, 1, undefined, !mobile);+ f.check(element.querySelector("#pdfMaximize").classList.contains("fn__none"),+ "preview or standalone mobile viewer exposed redundant maximize");+ await pdf.destroy(); element.remove();+ }+ URL.revokeObjectURL(f.url);+ })()`);+ } catch (error) {+ console.error(error);+ code = 1;+ } finally {+ win.destroy();+ app.exit(code);+ }+}++if (process.versions.electron && process.type === "browser") {+ runElectron().catch(error => {console.error(error); require("electron").app.exit(1);});+} else {+ require("node:test").it("PDF panes maximize and restore without losing reading position or split layout", {+ skip: process.platform === "linux" && !process.env.DISPLAY && !process.env.WAYLAND_DISPLAY,+ timeout: 60000,+ }, async () => {+ const profile = fs.mkdtempSync(path.join(os.tmpdir(), "siyuan-pdf-maximize-"));+ const env = {...process.env}; delete env.ELECTRON_RUN_AS_NODE;+ try {+ await require("node:util").promisify(require("node:child_process").execFile)(require("electron"),+ [__filename, profile], {env, timeout: 55000, windowsHide: true});+ } finally {+ assert.equal(path.dirname(path.resolve(profile)), path.resolve(os.tmpdir()));+ assert.ok(path.basename(profile).startsWith("siyuan-pdf-maximize-"));+ fs.rmSync(profile, {recursive: true, force: true});+ }+ });+}