mirror of
https://github.com/zen-browser/pdf.js.git
synced 2025-07-08 01:10:08 +02:00
[api-minor] Move the viewer scripting initialization/handling into a new PDFScriptingManager class
The *main* purpose of this patch is to allow scripting to be used together with the viewer components, note the updated "simpleviewer"/"singlepageviewer" examples, in addition to the full default viewer. Given how the scripting functionality is currently implemented in the default viewer, trying to re-use this with the standalone viewer components would be *very* hard and ideally you'd want it to work out-of-the-box. For an initial implementation, in the default viewer, of the scripting functionality it probably made sense to simply dump all of the code in the `app.js` file, however that cannot be used with the viewer components. To address this, the functionality is moved into a new `PDFScriptingManager` class which can thus be handled in the same way as all other viewer components (and e.g. be passed to the `BaseViewer`-implementations). Obviously the scripting functionality needs quite a lot of data, during its initialization, and for the default viewer we want to maintain the current way of doing the lookups since that helps avoid a number of redundant API-calls. To that end, the `PDFScriptingManager` implementation accepts (optional) factories/functions such that we can maintain the current behaviour for the default viewer. For the viewer components specifically, fallback code-paths are provided to ensure that scripting will "just work"[1]. Besides moving the viewer handling of the scripting code to its own file/class, this patch also takes the opportunity to re-factor the functionality into a number of helper methods to improve overall readability[2]. Note that it's definitely possible that the `PDFScriptingManager` class could be improved even further (e.g. for general re-use), since it's still heavily tailored to the default viewer use-case, however I believe that this patch is still a good step forward overall. --- [1] Obviously *all* the relevant document properties might not be available in the viewer components use-case (e.g. the various URLs), but most things should work just fine. [2] The old `PDFViewerApplication._initializeJavaScript` method, where everything was simply inlined, have over time (in my opinion) become quite large and somewhat difficult to *easily* reason about.
This commit is contained in:
Jonas Jenwald
parent
5b9638329c
commit
a6d1cba38c
8 changed files with 525 additions and 261 deletions
406
web/pdf_scripting_manager.js
Normal file
406
web/pdf_scripting_manager.js
Normal file
|
|
@ -0,0 +1,406 @@
|
|||
/* 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.
|
||||
*/
|
||||
|
||||
import { createPromiseCapability, shadow } from "pdfjs-lib";
|
||||
import { apiPageLayoutToSpreadMode } from "./ui_utils.js";
|
||||
|
||||
/**
|
||||
* @typedef {Object} PDFScriptingManagerOptions
|
||||
* @property {EventBus} eventBus - The application event bus.
|
||||
* @property {string} sandboxBundleSrc - The path and filename of the scripting
|
||||
* bundle.
|
||||
* @property {Object} [scriptingFactory] - 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} [docPropertiesLookup] - The function that is used to
|
||||
* lookup the necessary document properties.
|
||||
*/
|
||||
|
||||
class PDFScriptingManager {
|
||||
/**
|
||||
* @param {PDFScriptingManager} options
|
||||
*/
|
||||
constructor({
|
||||
eventBus,
|
||||
sandboxBundleSrc = null,
|
||||
scriptingFactory = null,
|
||||
docPropertiesLookup = null,
|
||||
}) {
|
||||
this._pdfDocument = null;
|
||||
this._pdfViewer = null;
|
||||
this._destroyCapability = null;
|
||||
|
||||
this._scripting = null;
|
||||
this._mouseState = Object.create(null);
|
||||
this._ready = false;
|
||||
|
||||
this._eventBus = eventBus;
|
||||
this._sandboxBundleSrc = sandboxBundleSrc;
|
||||
this._scriptingFactory = scriptingFactory;
|
||||
this._docPropertiesLookup = docPropertiesLookup;
|
||||
|
||||
// The default viewer already handles adding/removing of DOM events,
|
||||
// hence limit this to only the viewer components.
|
||||
if (
|
||||
typeof PDFJSDev !== "undefined" &&
|
||||
PDFJSDev.test("COMPONENTS") &&
|
||||
!this._scriptingFactory
|
||||
) {
|
||||
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.
|
||||
return;
|
||||
}
|
||||
if (pdfDocument !== this._pdfDocument) {
|
||||
return; // The document was closed while the data resolved.
|
||||
}
|
||||
this._scripting = this._createScripting();
|
||||
|
||||
this._internalEvents.set("updatefromsandbox", event => {
|
||||
this._updateFromSandbox(event.detail);
|
||||
});
|
||||
this._internalEvents.set("dispatcheventinsandbox", event => {
|
||||
this._scripting?.dispatchEventInSandbox(event.detail);
|
||||
});
|
||||
|
||||
this._internalEvents.set("pageopen", event => {
|
||||
this._pageOpen(event.pageNumber, event.actionsPromise);
|
||||
});
|
||||
this._internalEvents.set("pageclose", event => {
|
||||
this._pageClose(event.pageNumber);
|
||||
});
|
||||
|
||||
this._domEvents.set("mousedown", event => {
|
||||
this._mouseState.isDown = true;
|
||||
});
|
||||
this._domEvents.set("mouseup", event => {
|
||||
this._mouseState.isDown = false;
|
||||
});
|
||||
|
||||
for (const [name, listener] of this._internalEvents) {
|
||||
this._eventBus._on(name, listener);
|
||||
}
|
||||
for (const [name, listener] of this._domEvents) {
|
||||
window.addEventListener(name, listener);
|
||||
}
|
||||
|
||||
try {
|
||||
const docProperties = await this._getDocProperties();
|
||||
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(`PDFScriptingManager.setDocument: "${error?.message}".`);
|
||||
|
||||
await this._destroyScripting();
|
||||
return;
|
||||
}
|
||||
|
||||
await this._scripting?.dispatchEventInSandbox({
|
||||
id: "doc",
|
||||
name: "Open",
|
||||
});
|
||||
await this._pdfViewer.initializeScriptingEvents();
|
||||
|
||||
// Defer this slightly, to ensure that scripting is *fully* initialized.
|
||||
Promise.resolve().then(() => {
|
||||
if (pdfDocument === this._pdfDocument) {
|
||||
this._ready = true;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async dispatchWillSave(detail) {
|
||||
return this._scripting?.dispatchEventInSandbox({
|
||||
id: "doc",
|
||||
name: "WillSave",
|
||||
});
|
||||
}
|
||||
|
||||
async dispatchDidSave(detail) {
|
||||
return this._scripting?.dispatchEventInSandbox({
|
||||
id: "doc",
|
||||
name: "DidSave",
|
||||
});
|
||||
}
|
||||
|
||||
async dispatchWillPrint(detail) {
|
||||
return this._scripting?.dispatchEventInSandbox({
|
||||
id: "doc",
|
||||
name: "WillPrint",
|
||||
});
|
||||
}
|
||||
|
||||
async dispatchDidPrint(detail) {
|
||||
return this._scripting?.dispatchEventInSandbox({
|
||||
id: "doc",
|
||||
name: "DidPrint",
|
||||
});
|
||||
}
|
||||
|
||||
get mouseState() {
|
||||
return this._mouseState;
|
||||
}
|
||||
|
||||
get destroyPromise() {
|
||||
return this._destroyCapability?.promise || null;
|
||||
}
|
||||
|
||||
get ready() {
|
||||
return this._ready;
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
get _internalEvents() {
|
||||
return shadow(this, "_internalEvents", new Map());
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
get _domEvents() {
|
||||
return shadow(this, "_domEvents", new Map());
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
get _visitedPages() {
|
||||
return shadow(this, "_visitedPages", new Map());
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_updateFromSandbox(detail) {
|
||||
const { id, command, value } = detail;
|
||||
if (!id) {
|
||||
switch (command) {
|
||||
case "clear":
|
||||
console.clear();
|
||||
break;
|
||||
case "error":
|
||||
console.error(value);
|
||||
break;
|
||||
case "layout":
|
||||
this._pdfViewer.spreadMode = apiPageLayoutToSpreadMode(value);
|
||||
break;
|
||||
case "page-num":
|
||||
this._pdfViewer.currentPageNumber = value + 1;
|
||||
break;
|
||||
case "print":
|
||||
this._pdfViewer.pagesPromise.then(() => {
|
||||
this._eventBus.dispatch("print", { source: this });
|
||||
});
|
||||
break;
|
||||
case "println":
|
||||
console.log(value);
|
||||
break;
|
||||
case "zoom":
|
||||
this._pdfViewer.currentScaleValue = value;
|
||||
break;
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
const element = document.getElementById(id);
|
||||
if (element) {
|
||||
element.dispatchEvent(new CustomEvent("updatefromsandbox", { detail }));
|
||||
} else {
|
||||
if (value !== undefined && value !== null) {
|
||||
// The element hasn't been rendered yet, use the AnnotationStorage.
|
||||
this._pdfDocument?.annotationStorage.setValue(id, value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
async _pageOpen(pageNumber, actionsPromise) {
|
||||
const pdfDocument = this._pdfDocument,
|
||||
visitedPages = this._visitedPages;
|
||||
|
||||
visitedPages.set(
|
||||
pageNumber,
|
||||
(async () => {
|
||||
// Avoid sending, and thus serializing, the `actions` data when the
|
||||
// *same* page is opened several times.
|
||||
let actions = null;
|
||||
if (!visitedPages.has(pageNumber)) {
|
||||
actions = await actionsPromise;
|
||||
if (pdfDocument !== this._pdfDocument) {
|
||||
return; // The document was closed while the actions resolved.
|
||||
}
|
||||
}
|
||||
|
||||
await this._scripting?.dispatchEventInSandbox({
|
||||
id: "page",
|
||||
name: "PageOpen",
|
||||
pageNumber,
|
||||
actions,
|
||||
});
|
||||
})()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
async _pageClose(pageNumber) {
|
||||
const pdfDocument = this._pdfDocument,
|
||||
visitedPages = this._visitedPages;
|
||||
|
||||
const actionsPromise = visitedPages.get(pageNumber);
|
||||
if (!actionsPromise) {
|
||||
// Ensure that the "pageclose" event was preceded by a "pageopen" event.
|
||||
return;
|
||||
}
|
||||
visitedPages.set(pageNumber, null);
|
||||
|
||||
// Ensure that the "pageopen" event is handled 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,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @returns {Promise<Object>} A promise that is resolved with an {Object}
|
||||
* containing the necessary document properties; please find the expected
|
||||
* format in `PDFViewerApplication._scriptingDocProperties`.
|
||||
* @private
|
||||
*/
|
||||
async _getDocProperties() {
|
||||
// The default viewer use-case.
|
||||
if (this._docPropertiesLookup) {
|
||||
return this._docPropertiesLookup(this._pdfDocument);
|
||||
}
|
||||
// Fallback, to support the viewer components use-case.
|
||||
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("COMPONENTS")) {
|
||||
const { docPropertiesLookup } = require("./generic_scripting.js");
|
||||
|
||||
return docPropertiesLookup(this._pdfDocument);
|
||||
}
|
||||
throw new Error("_getDocProperties: Unable to lookup properties.");
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_createScripting() {
|
||||
this._destroyCapability = createPromiseCapability();
|
||||
|
||||
if (this._scripting) {
|
||||
throw new Error("_createScripting: Scripting already exists.");
|
||||
}
|
||||
if (this._scriptingFactory) {
|
||||
return this._scriptingFactory.createScripting({
|
||||
sandboxBundleSrc: this._sandboxBundleSrc,
|
||||
});
|
||||
}
|
||||
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("COMPONENTS")) {
|
||||
const { GenericScripting } = require("./generic_scripting.js");
|
||||
|
||||
return new GenericScripting(this._sandboxBundleSrc);
|
||||
}
|
||||
throw new Error("_createScripting: Cannot create scripting.");
|
||||
}
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
async _destroyScripting() {
|
||||
this._pdfDocument = null; // Ensure that it's *always* reset synchronously.
|
||||
|
||||
if (!this._scripting) {
|
||||
this._destroyCapability?.resolve();
|
||||
return;
|
||||
}
|
||||
try {
|
||||
await this._scripting.destroySandbox();
|
||||
} catch (ex) {}
|
||||
|
||||
for (const [name, listener] of this._internalEvents) {
|
||||
this._eventBus._off(name, listener);
|
||||
}
|
||||
this._internalEvents.clear();
|
||||
|
||||
for (const [name, listener] of this._domEvents) {
|
||||
window.removeEventListener(name, listener);
|
||||
}
|
||||
this._domEvents.clear();
|
||||
|
||||
this._visitedPages.clear();
|
||||
|
||||
this._scripting = null;
|
||||
delete this._mouseState.isDown;
|
||||
this._ready = false;
|
||||
|
||||
this._destroyCapability?.resolve();
|
||||
}
|
||||
}
|
||||
|
||||
export { PDFScriptingManager };
|
||||
Loading…
Add table
Add a link
Reference in a new issue