547b8276e6
- Change (most) fields/methods into private ones, since that's now supported. - Tweak the constructor-parameters, and simplify the sandbox initialization w.r.t. the viewer components. - Remove some unused function/method parameters. - Slightly simplify the "updatefromsandbox"-handler by using local variables and inverting some conditions.
475 lines
13 KiB
JavaScript
475 lines
13 KiB
JavaScript
/* Copyright 2021 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.
|
|
*/
|
|
|
|
/** @typedef {import("./event_utils").EventBus} EventBus */
|
|
|
|
import { apiPageLayoutToViewerModes, RenderingStates } from "./ui_utils.js";
|
|
import { PromiseCapability, shadow } from "pdfjs-lib";
|
|
|
|
/**
|
|
* @typedef {Object} PDFScriptingManagerOptions
|
|
* @property {EventBus} eventBus - The application event bus.
|
|
* @property {string} sandboxBundleSrc - The path and filename of the scripting
|
|
* bundle.
|
|
* @property {Object} [externalServices] - The factory that is used when
|
|
* initializing scripting; must contain a `createScripting` method.
|
|
* PLEASE NOTE: Primarily intended for the default viewer use-case.
|
|
* @property {function} [docProperties] - The function that is used to lookup
|
|
* the necessary document properties.
|
|
*/
|
|
|
|
class PDFScriptingManager {
|
|
#closeCapability = null;
|
|
|
|
#destroyCapability = null;
|
|
|
|
#docProperties = null;
|
|
|
|
#eventBus = null;
|
|
|
|
#externalServices = null;
|
|
|
|
#pdfDocument = null;
|
|
|
|
#pdfViewer = null;
|
|
|
|
#ready = false;
|
|
|
|
#sandboxBundleSrc = null;
|
|
|
|
#scripting = null;
|
|
|
|
/**
|
|
* @param {PDFScriptingManagerOptions} options
|
|
*/
|
|
constructor({
|
|
eventBus,
|
|
sandboxBundleSrc = null,
|
|
externalServices = null,
|
|
docProperties = null,
|
|
}) {
|
|
this.#eventBus = eventBus;
|
|
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC || CHROME")) {
|
|
this.#sandboxBundleSrc = sandboxBundleSrc;
|
|
}
|
|
this.#externalServices = externalServices;
|
|
this.#docProperties = docProperties;
|
|
|
|
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("COMPONENTS")) {
|
|
const gs = require("./generic_scripting.js");
|
|
|
|
this.#externalServices ||= {
|
|
createScripting: options => {
|
|
return new gs.GenericScripting(options.sandboxBundleSrc);
|
|
},
|
|
};
|
|
this.#docProperties ||= pdfDocument => {
|
|
return gs.docProperties(pdfDocument);
|
|
};
|
|
|
|
// The default viewer already handles adding/removing of DOM events,
|
|
// hence limit this to only the viewer components.
|
|
if (!externalServices) {
|
|
window.addEventListener("updatefromsandbox", event => {
|
|
this.#eventBus.dispatch("updatefromsandbox", {
|
|
source: window,
|
|
detail: event.detail,
|
|
});
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
setViewer(pdfViewer) {
|
|
this.#pdfViewer = pdfViewer;
|
|
}
|
|
|
|
async setDocument(pdfDocument) {
|
|
if (this.#pdfDocument) {
|
|
await this.#destroyScripting();
|
|
}
|
|
this.#pdfDocument = pdfDocument;
|
|
|
|
if (!pdfDocument) {
|
|
return;
|
|
}
|
|
const [objects, calculationOrder, docActions] = await Promise.all([
|
|
pdfDocument.getFieldObjects(),
|
|
pdfDocument.getCalculationOrderIds(),
|
|
pdfDocument.getJSActions(),
|
|
]);
|
|
|
|
if (!objects && !docActions) {
|
|
// No FieldObjects or JavaScript actions were found in the document.
|
|
await this.#destroyScripting();
|
|
return;
|
|
}
|
|
if (pdfDocument !== this.#pdfDocument) {
|
|
return; // The document was closed while the data resolved.
|
|
}
|
|
try {
|
|
this.#scripting = this.#initScripting();
|
|
} catch (error) {
|
|
console.error(`setDocument: "${error.message}".`);
|
|
|
|
await this.#destroyScripting();
|
|
return;
|
|
}
|
|
|
|
this._internalEvents.set("updatefromsandbox", event => {
|
|
if (event?.source === window) {
|
|
this.#updateFromSandbox(event.detail);
|
|
}
|
|
});
|
|
this._internalEvents.set("dispatcheventinsandbox", event => {
|
|
this.#scripting?.dispatchEventInSandbox(event.detail);
|
|
});
|
|
|
|
this._internalEvents.set("pagechanging", ({ pageNumber, previous }) => {
|
|
if (pageNumber === previous) {
|
|
return; // The current page didn't change.
|
|
}
|
|
this.#dispatchPageClose(previous);
|
|
this.#dispatchPageOpen(pageNumber);
|
|
});
|
|
this._internalEvents.set("pagerendered", ({ pageNumber }) => {
|
|
if (!this._pageOpenPending.has(pageNumber)) {
|
|
return; // No pending "PageOpen" event for the newly rendered page.
|
|
}
|
|
if (pageNumber !== this.#pdfViewer.currentPageNumber) {
|
|
return; // The newly rendered page is no longer the current one.
|
|
}
|
|
this.#dispatchPageOpen(pageNumber);
|
|
});
|
|
this._internalEvents.set("pagesdestroy", async () => {
|
|
await this.#dispatchPageClose(this.#pdfViewer.currentPageNumber);
|
|
|
|
await this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "WillClose",
|
|
});
|
|
|
|
this.#closeCapability?.resolve();
|
|
});
|
|
|
|
for (const [name, listener] of this._internalEvents) {
|
|
this.#eventBus._on(name, listener);
|
|
}
|
|
|
|
try {
|
|
const docProperties = await this.#docProperties(pdfDocument);
|
|
if (pdfDocument !== this.#pdfDocument) {
|
|
return; // The document was closed while the properties resolved.
|
|
}
|
|
|
|
await this.#scripting.createSandbox({
|
|
objects,
|
|
calculationOrder,
|
|
appInfo: {
|
|
platform: navigator.platform,
|
|
language: navigator.language,
|
|
},
|
|
docInfo: {
|
|
...docProperties,
|
|
actions: docActions,
|
|
},
|
|
});
|
|
|
|
this.#eventBus.dispatch("sandboxcreated", { source: this });
|
|
} catch (error) {
|
|
console.error(`setDocument: "${error.message}".`);
|
|
|
|
await this.#destroyScripting();
|
|
return;
|
|
}
|
|
|
|
await this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "Open",
|
|
});
|
|
await this.#dispatchPageOpen(
|
|
this.#pdfViewer.currentPageNumber,
|
|
/* initialize = */ true
|
|
);
|
|
|
|
// Defer this slightly, to ensure that scripting is *fully* initialized.
|
|
Promise.resolve().then(() => {
|
|
if (pdfDocument === this.#pdfDocument) {
|
|
this.#ready = true;
|
|
}
|
|
});
|
|
}
|
|
|
|
async dispatchWillSave() {
|
|
return this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "WillSave",
|
|
});
|
|
}
|
|
|
|
async dispatchDidSave() {
|
|
return this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "DidSave",
|
|
});
|
|
}
|
|
|
|
async dispatchWillPrint() {
|
|
return this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "WillPrint",
|
|
});
|
|
}
|
|
|
|
async dispatchDidPrint() {
|
|
return this.#scripting?.dispatchEventInSandbox({
|
|
id: "doc",
|
|
name: "DidPrint",
|
|
});
|
|
}
|
|
|
|
get destroyPromise() {
|
|
return this.#destroyCapability?.promise || null;
|
|
}
|
|
|
|
get ready() {
|
|
return this.#ready;
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
get _internalEvents() {
|
|
return shadow(this, "_internalEvents", new Map());
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
get _pageOpenPending() {
|
|
return shadow(this, "_pageOpenPending", new Set());
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
get _visitedPages() {
|
|
return shadow(this, "_visitedPages", new Map());
|
|
}
|
|
|
|
async #updateFromSandbox(detail) {
|
|
const pdfViewer = this.#pdfViewer;
|
|
// Ignore some events, see below, that don't make sense in PresentationMode.
|
|
const isInPresentationMode =
|
|
pdfViewer.isInPresentationMode || pdfViewer.isChangingPresentationMode;
|
|
|
|
const { id, siblings, command, value } = detail;
|
|
if (!id) {
|
|
switch (command) {
|
|
case "clear":
|
|
console.clear();
|
|
break;
|
|
case "error":
|
|
console.error(value);
|
|
break;
|
|
case "layout":
|
|
if (!isInPresentationMode) {
|
|
const modes = apiPageLayoutToViewerModes(value);
|
|
pdfViewer.spreadMode = modes.spreadMode;
|
|
}
|
|
break;
|
|
case "page-num":
|
|
pdfViewer.currentPageNumber = value + 1;
|
|
break;
|
|
case "print":
|
|
await pdfViewer.pagesPromise;
|
|
this.#eventBus.dispatch("print", { source: this });
|
|
break;
|
|
case "println":
|
|
console.log(value);
|
|
break;
|
|
case "zoom":
|
|
if (!isInPresentationMode) {
|
|
pdfViewer.currentScaleValue = value;
|
|
}
|
|
break;
|
|
case "SaveAs":
|
|
this.#eventBus.dispatch("download", { source: this });
|
|
break;
|
|
case "FirstPage":
|
|
pdfViewer.currentPageNumber = 1;
|
|
break;
|
|
case "LastPage":
|
|
pdfViewer.currentPageNumber = pdfViewer.pagesCount;
|
|
break;
|
|
case "NextPage":
|
|
pdfViewer.nextPage();
|
|
break;
|
|
case "PrevPage":
|
|
pdfViewer.previousPage();
|
|
break;
|
|
case "ZoomViewIn":
|
|
if (!isInPresentationMode) {
|
|
pdfViewer.increaseScale();
|
|
}
|
|
break;
|
|
case "ZoomViewOut":
|
|
if (!isInPresentationMode) {
|
|
pdfViewer.decreaseScale();
|
|
}
|
|
break;
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (isInPresentationMode && detail.focus) {
|
|
return;
|
|
}
|
|
delete detail.id;
|
|
delete detail.siblings;
|
|
|
|
const ids = siblings ? [id, ...siblings] : [id];
|
|
for (const elementId of ids) {
|
|
const element = document.querySelector(
|
|
`[data-element-id="${elementId}"]`
|
|
);
|
|
if (element) {
|
|
element.dispatchEvent(new CustomEvent("updatefromsandbox", { detail }));
|
|
} else {
|
|
// The element hasn't been rendered yet, use the AnnotationStorage.
|
|
this.#pdfDocument?.annotationStorage.setValue(elementId, detail);
|
|
}
|
|
}
|
|
}
|
|
|
|
async #dispatchPageOpen(pageNumber, initialize = false) {
|
|
const pdfDocument = this.#pdfDocument,
|
|
visitedPages = this._visitedPages;
|
|
|
|
if (initialize) {
|
|
this.#closeCapability = new PromiseCapability();
|
|
}
|
|
if (!this.#closeCapability) {
|
|
return; // Scripting isn't fully initialized yet.
|
|
}
|
|
const pageView = this.#pdfViewer.getPageView(/* index = */ pageNumber - 1);
|
|
|
|
if (pageView?.renderingState !== RenderingStates.FINISHED) {
|
|
this._pageOpenPending.add(pageNumber);
|
|
return; // Wait for the page to finish rendering.
|
|
}
|
|
this._pageOpenPending.delete(pageNumber);
|
|
|
|
const actionsPromise = (async () => {
|
|
// Avoid sending, and thus serializing, the `actions` data more than once.
|
|
const actions = await (!visitedPages.has(pageNumber)
|
|
? pageView.pdfPage?.getJSActions()
|
|
: null);
|
|
if (pdfDocument !== this.#pdfDocument) {
|
|
return; // The document was closed while the actions resolved.
|
|
}
|
|
|
|
await this.#scripting?.dispatchEventInSandbox({
|
|
id: "page",
|
|
name: "PageOpen",
|
|
pageNumber,
|
|
actions,
|
|
});
|
|
})();
|
|
visitedPages.set(pageNumber, actionsPromise);
|
|
}
|
|
|
|
async #dispatchPageClose(pageNumber) {
|
|
const pdfDocument = this.#pdfDocument,
|
|
visitedPages = this._visitedPages;
|
|
|
|
if (!this.#closeCapability) {
|
|
return; // Scripting isn't fully initialized yet.
|
|
}
|
|
if (this._pageOpenPending.has(pageNumber)) {
|
|
return; // The page is still rendering; no "PageOpen" event dispatched.
|
|
}
|
|
const actionsPromise = visitedPages.get(pageNumber);
|
|
if (!actionsPromise) {
|
|
return; // The "PageClose" event must be preceded by a "PageOpen" event.
|
|
}
|
|
visitedPages.set(pageNumber, null);
|
|
|
|
// Ensure that the "PageOpen" event is dispatched first.
|
|
await actionsPromise;
|
|
if (pdfDocument !== this.#pdfDocument) {
|
|
return; // The document was closed while the actions resolved.
|
|
}
|
|
|
|
await this.#scripting?.dispatchEventInSandbox({
|
|
id: "page",
|
|
name: "PageClose",
|
|
pageNumber,
|
|
});
|
|
}
|
|
|
|
#initScripting() {
|
|
this.#destroyCapability = new PromiseCapability();
|
|
|
|
if (this.#scripting) {
|
|
throw new Error("#initScripting: Scripting already exists.");
|
|
}
|
|
return this.#externalServices.createScripting({
|
|
sandboxBundleSrc: this.#sandboxBundleSrc,
|
|
});
|
|
}
|
|
|
|
async #destroyScripting() {
|
|
if (!this.#scripting) {
|
|
this.#pdfDocument = null;
|
|
|
|
this.#destroyCapability?.resolve();
|
|
return;
|
|
}
|
|
if (this.#closeCapability) {
|
|
await Promise.race([
|
|
this.#closeCapability.promise,
|
|
new Promise(resolve => {
|
|
// Avoid the scripting/sandbox-destruction hanging indefinitely.
|
|
setTimeout(resolve, 1000);
|
|
}),
|
|
]).catch(() => {
|
|
// Ignore any errors, to ensure that the sandbox is always destroyed.
|
|
});
|
|
this.#closeCapability = null;
|
|
}
|
|
this.#pdfDocument = null;
|
|
|
|
try {
|
|
await this.#scripting.destroySandbox();
|
|
} catch {}
|
|
|
|
for (const [name, listener] of this._internalEvents) {
|
|
this.#eventBus._off(name, listener);
|
|
}
|
|
this._internalEvents.clear();
|
|
|
|
this._pageOpenPending.clear();
|
|
this._visitedPages.clear();
|
|
|
|
this.#scripting = null;
|
|
this.#ready = false;
|
|
|
|
this.#destroyCapability?.resolve();
|
|
}
|
|
}
|
|
|
|
export { PDFScriptingManager };
|