5729c0b32f
This implementation is inspired by the behaviour in (recent versions of) Adobe Reader, since it leads to reasonably simple and straightforward code as far as I'm concerned. *Specifically:* We'll only consider *one* destination per page when finding/highlighting the current outline item, which is similar to e.g. Adobe Reader, and we choose the *first* outline item at the *lowest* level of the outline tree. Given that this functionality requires not only parsing of the `outline`, but looking up *all* of the destinations in the document, this feature can when initialized have a non-trivial performance overhead for larger PDF documents. In an attempt to reduce the performance impact, the following steps are taken here: - The "find current outline item"-functionality will only be enabled once *one* page has rendered and *all* the pages have been loaded[1], to prevent it interfering with data regular fetching/parsing early on during document loading and viewer initialization. - With the exception of a couple of small and simple `eventBus`-listeners, in `PDFOutlineViewer`, this new functionality is initialized *lazily* the first time that the user clicks on the `currentOutlineItem`-button. - The entire "find current outline item"-functionality is disabled when `disableAutoFetch = true` is set, since it can easily lead to the setting becoming essentially pointless[2] by triggering *a lot* of data fetching from a relatively minor viewer-feature. - Fetch the destinations *individually*, since that's generally more efficient than using `PDFDocumentProxy.getDestinations` to fetch them all at once. Despite making the overall parsing code *more* asynchronous, and leading to a lot more main/worker-thread message passing, in practice this seems faster for larger documents. Finally, we'll now always highlight an outline item that the user manually clicked on, since only highlighting when the new "find current outline item"-functionality is used seemed inconsistent. --- [1] Keep in mind that the `outline` itself already isn't fetched/parsed until at least *one* page has been rendered in the viewer. [2] And also quite slow, since it can take a fair amount of time to fetch all of the necessary `destinations` data when `disableAutoFetch = true` is set.
249 lines
11 KiB
JavaScript
249 lines
11 KiB
JavaScript
/* Copyright 2016 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { AppOptions } from "./app_options.js";
|
|
import { PDFViewerApplication } from "./app.js";
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const pdfjsVersion =
|
|
typeof PDFJSDev !== "undefined" ? PDFJSDev.eval("BUNDLE_VERSION") : void 0;
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const pdfjsBuild =
|
|
typeof PDFJSDev !== "undefined" ? PDFJSDev.eval("BUNDLE_BUILD") : void 0;
|
|
|
|
window.PDFViewerApplication = PDFViewerApplication;
|
|
window.PDFViewerApplicationOptions = AppOptions;
|
|
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("CHROME")) {
|
|
var defaultUrl; // eslint-disable-line no-var
|
|
|
|
(function rewriteUrlClosure() {
|
|
// Run this code outside DOMContentLoaded to make sure that the URL
|
|
// is rewritten as soon as possible.
|
|
const queryString = document.location.search.slice(1);
|
|
const m = /(^|&)file=([^&]*)/.exec(queryString);
|
|
defaultUrl = m ? decodeURIComponent(m[2]) : "";
|
|
|
|
// Example: chrome-extension://.../http://example.com/file.pdf
|
|
const humanReadableUrl = "/" + defaultUrl + location.hash;
|
|
history.replaceState(history.state, "", humanReadableUrl);
|
|
if (top === window) {
|
|
// eslint-disable-next-line no-undef
|
|
chrome.runtime.sendMessage("showPageAction");
|
|
}
|
|
})();
|
|
}
|
|
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("MOZCENTRAL")) {
|
|
require("./firefoxcom.js");
|
|
require("./firefox_print_service.js");
|
|
}
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("GENERIC")) {
|
|
require("./genericcom.js");
|
|
}
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("CHROME")) {
|
|
require("./chromecom.js");
|
|
}
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("CHROME || GENERIC")) {
|
|
require("./pdf_print_service.js");
|
|
}
|
|
|
|
function getViewerConfiguration() {
|
|
return {
|
|
appContainer: document.body,
|
|
mainContainer: document.getElementById("viewerContainer"),
|
|
viewerContainer: document.getElementById("viewer"),
|
|
eventBus: null,
|
|
toolbar: {
|
|
container: document.getElementById("toolbarViewer"),
|
|
numPages: document.getElementById("numPages"),
|
|
pageNumber: document.getElementById("pageNumber"),
|
|
scaleSelectContainer: document.getElementById("scaleSelectContainer"),
|
|
scaleSelect: document.getElementById("scaleSelect"),
|
|
customScaleOption: document.getElementById("customScaleOption"),
|
|
previous: document.getElementById("previous"),
|
|
next: document.getElementById("next"),
|
|
zoomIn: document.getElementById("zoomIn"),
|
|
zoomOut: document.getElementById("zoomOut"),
|
|
viewFind: document.getElementById("viewFind"),
|
|
openFile: document.getElementById("openFile"),
|
|
print: document.getElementById("print"),
|
|
presentationModeButton: document.getElementById("presentationMode"),
|
|
download: document.getElementById("download"),
|
|
viewBookmark: document.getElementById("viewBookmark"),
|
|
},
|
|
secondaryToolbar: {
|
|
toolbar: document.getElementById("secondaryToolbar"),
|
|
toggleButton: document.getElementById("secondaryToolbarToggle"),
|
|
toolbarButtonContainer: document.getElementById(
|
|
"secondaryToolbarButtonContainer"
|
|
),
|
|
presentationModeButton: document.getElementById(
|
|
"secondaryPresentationMode"
|
|
),
|
|
openFileButton: document.getElementById("secondaryOpenFile"),
|
|
printButton: document.getElementById("secondaryPrint"),
|
|
downloadButton: document.getElementById("secondaryDownload"),
|
|
viewBookmarkButton: document.getElementById("secondaryViewBookmark"),
|
|
firstPageButton: document.getElementById("firstPage"),
|
|
lastPageButton: document.getElementById("lastPage"),
|
|
pageRotateCwButton: document.getElementById("pageRotateCw"),
|
|
pageRotateCcwButton: document.getElementById("pageRotateCcw"),
|
|
cursorSelectToolButton: document.getElementById("cursorSelectTool"),
|
|
cursorHandToolButton: document.getElementById("cursorHandTool"),
|
|
scrollVerticalButton: document.getElementById("scrollVertical"),
|
|
scrollHorizontalButton: document.getElementById("scrollHorizontal"),
|
|
scrollWrappedButton: document.getElementById("scrollWrapped"),
|
|
spreadNoneButton: document.getElementById("spreadNone"),
|
|
spreadOddButton: document.getElementById("spreadOdd"),
|
|
spreadEvenButton: document.getElementById("spreadEven"),
|
|
documentPropertiesButton: document.getElementById("documentProperties"),
|
|
},
|
|
fullscreen: {
|
|
contextFirstPage: document.getElementById("contextFirstPage"),
|
|
contextLastPage: document.getElementById("contextLastPage"),
|
|
contextPageRotateCw: document.getElementById("contextPageRotateCw"),
|
|
contextPageRotateCcw: document.getElementById("contextPageRotateCcw"),
|
|
},
|
|
sidebar: {
|
|
// Divs (and sidebar button)
|
|
outerContainer: document.getElementById("outerContainer"),
|
|
viewerContainer: document.getElementById("viewerContainer"),
|
|
toggleButton: document.getElementById("sidebarToggle"),
|
|
// Buttons
|
|
thumbnailButton: document.getElementById("viewThumbnail"),
|
|
outlineButton: document.getElementById("viewOutline"),
|
|
attachmentsButton: document.getElementById("viewAttachments"),
|
|
layersButton: document.getElementById("viewLayers"),
|
|
// Views
|
|
thumbnailView: document.getElementById("thumbnailView"),
|
|
outlineView: document.getElementById("outlineView"),
|
|
attachmentsView: document.getElementById("attachmentsView"),
|
|
layersView: document.getElementById("layersView"),
|
|
// View-specific options
|
|
outlineOptionsContainer: document.getElementById(
|
|
"outlineOptionsContainer"
|
|
),
|
|
currentOutlineItemButton: document.getElementById("currentOutlineItem"),
|
|
},
|
|
sidebarResizer: {
|
|
outerContainer: document.getElementById("outerContainer"),
|
|
resizer: document.getElementById("sidebarResizer"),
|
|
},
|
|
findBar: {
|
|
bar: document.getElementById("findbar"),
|
|
toggleButton: document.getElementById("viewFind"),
|
|
findField: document.getElementById("findInput"),
|
|
highlightAllCheckbox: document.getElementById("findHighlightAll"),
|
|
caseSensitiveCheckbox: document.getElementById("findMatchCase"),
|
|
entireWordCheckbox: document.getElementById("findEntireWord"),
|
|
findMsg: document.getElementById("findMsg"),
|
|
findResultsCount: document.getElementById("findResultsCount"),
|
|
findPreviousButton: document.getElementById("findPrevious"),
|
|
findNextButton: document.getElementById("findNext"),
|
|
},
|
|
passwordOverlay: {
|
|
overlayName: "passwordOverlay",
|
|
container: document.getElementById("passwordOverlay"),
|
|
label: document.getElementById("passwordText"),
|
|
input: document.getElementById("password"),
|
|
submitButton: document.getElementById("passwordSubmit"),
|
|
cancelButton: document.getElementById("passwordCancel"),
|
|
},
|
|
documentProperties: {
|
|
overlayName: "documentPropertiesOverlay",
|
|
container: document.getElementById("documentPropertiesOverlay"),
|
|
closeButton: document.getElementById("documentPropertiesClose"),
|
|
fields: {
|
|
fileName: document.getElementById("fileNameField"),
|
|
fileSize: document.getElementById("fileSizeField"),
|
|
title: document.getElementById("titleField"),
|
|
author: document.getElementById("authorField"),
|
|
subject: document.getElementById("subjectField"),
|
|
keywords: document.getElementById("keywordsField"),
|
|
creationDate: document.getElementById("creationDateField"),
|
|
modificationDate: document.getElementById("modificationDateField"),
|
|
creator: document.getElementById("creatorField"),
|
|
producer: document.getElementById("producerField"),
|
|
version: document.getElementById("versionField"),
|
|
pageCount: document.getElementById("pageCountField"),
|
|
pageSize: document.getElementById("pageSizeField"),
|
|
linearized: document.getElementById("linearizedField"),
|
|
},
|
|
},
|
|
errorWrapper: {
|
|
container: document.getElementById("errorWrapper"),
|
|
errorMessage: document.getElementById("errorMessage"),
|
|
closeButton: document.getElementById("errorClose"),
|
|
errorMoreInfo: document.getElementById("errorMoreInfo"),
|
|
moreInfoButton: document.getElementById("errorShowMore"),
|
|
lessInfoButton: document.getElementById("errorShowLess"),
|
|
},
|
|
printContainer: document.getElementById("printContainer"),
|
|
openFileInputName: "fileInput",
|
|
debuggerScriptPath: "./debugger.js",
|
|
};
|
|
}
|
|
|
|
function webViewerLoad() {
|
|
const config = getViewerConfiguration();
|
|
if (typeof PDFJSDev === "undefined" || !PDFJSDev.test("PRODUCTION")) {
|
|
Promise.all([
|
|
import("pdfjs-web/genericcom.js"),
|
|
import("pdfjs-web/pdf_print_service.js"),
|
|
]).then(function ([genericCom, pdfPrintService]) {
|
|
PDFViewerApplication.run(config);
|
|
});
|
|
} else {
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("CHROME")) {
|
|
AppOptions.set("defaultUrl", defaultUrl);
|
|
}
|
|
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("GENERIC")) {
|
|
// Give custom implementations of the default viewer a simpler way to
|
|
// set various `AppOptions`, by dispatching an event once all viewer
|
|
// files are loaded but *before* the viewer initialization has run.
|
|
const event = document.createEvent("CustomEvent");
|
|
event.initCustomEvent("webviewerloaded", true, true, {
|
|
source: window,
|
|
});
|
|
try {
|
|
// Attempt to dispatch the event at the embedding `document`,
|
|
// in order to support cases where the viewer is embedded in
|
|
// a *dynamically* created <iframe> element.
|
|
parent.document.dispatchEvent(event);
|
|
} catch (ex) {
|
|
// The viewer could be in e.g. a cross-origin <iframe> element,
|
|
// fallback to dispatching the event at the current `document`.
|
|
console.error(`webviewerloaded: ${ex}`);
|
|
document.dispatchEvent(event);
|
|
}
|
|
}
|
|
|
|
PDFViewerApplication.run(config);
|
|
}
|
|
}
|
|
|
|
if (
|
|
document.readyState === "interactive" ||
|
|
document.readyState === "complete"
|
|
) {
|
|
webViewerLoad();
|
|
} else {
|
|
document.addEventListener("DOMContentLoaded", webViewerLoad, true);
|
|
}
|
|
|
|
export { PDFViewerApplication, AppOptions as PDFViewerApplicationOptions };
|