Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-factor the PDFScriptingManager-class for the viewer-components #16687

Merged
merged 3 commits into from
Jul 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions gulpfile.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import * as builder from "./external/builder/builder.mjs";
import { exec, spawn, spawnSync } from "child_process";
import autoprefixer from "autoprefixer";
import { createRequire } from "module";
import babel from "@babel/core";
import crypto from "crypto";
import { fileURLToPath } from "url";
import fs from "fs";
Expand All @@ -41,7 +41,6 @@ import webpackStream from "webpack-stream";
import zip from "gulp-zip";

const __dirname = path.dirname(fileURLToPath(import.meta.url));
const require = createRequire(import.meta.url);

const BUILD_DIR = "build/";
const L10N_DIR = "l10n/";
Expand Down Expand Up @@ -1528,14 +1527,14 @@ function buildLibHelper(bundleDefines, inputStream, outputDir) {
// __non_webpack_require__ has to be used.
// In this target, we don't create a bundle, so we have to replace the
// occurrences of __non_webpack_require__ ourselves.
function babelPluginReplaceNonWebpackImports(babel) {
function babelPluginReplaceNonWebpackImports(b) {
return {
visitor: {
Identifier(curPath, state) {
if (curPath.node.name === "__non_webpack_require__") {
curPath.replaceWith(babel.types.identifier("require"));
curPath.replaceWith(b.types.identifier("require"));
} else if (curPath.node.name === "__non_webpack_import__") {
curPath.replaceWith(babel.types.identifier("import"));
curPath.replaceWith(b.types.identifier("import"));
}
},
},
Expand All @@ -1562,7 +1561,6 @@ function buildLibHelper(bundleDefines, inputStream, outputDir) {
);
return licenseHeaderLibre + content;
}
const babel = require("@babel/core");
const ctx = {
rootPath: __dirname,
saveComments: false,
Expand Down
2 changes: 1 addition & 1 deletion test/unit/pdf_viewer.component_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { GenericL10n } from "../../web/genericl10n.js";
import { NullL10n } from "../../web/l10n_utils.js";
import { PDFHistory } from "../../web/pdf_history.js";
import { PDFPageView } from "../../web/pdf_page_view.js";
import { PDFScriptingManager } from "../../web/pdf_scripting_manager.js";
import { PDFScriptingManager } from "../../web/pdf_scripting_manager.component.js";
import { PDFSinglePageViewer } from "../../web/pdf_single_page_viewer.js";
import { PDFViewer } from "../../web/pdf_viewer.js";
import { StructTreeLayerBuilder } from "../../web/struct_tree_layer_builder.js";
Expand Down
44 changes: 44 additions & 0 deletions web/pdf_scripting_manager.component.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/* 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 { docProperties, GenericScripting } from "./generic_scripting.js";
import { PDFScriptingManager } from "./pdf_scripting_manager.js";

class PDFScriptingManagerComponents extends PDFScriptingManager {
constructor(options) {
// The default viewer already handles adding/removing of DOM events,
// hence limit this to only the viewer components.
if (!options.externalServices) {
window.addEventListener("updatefromsandbox", event => {
options.eventBus.dispatch("updatefromsandbox", {
source: window,
detail: event.detail,
});
});
}

options.externalServices ||= {
createScripting: ({ sandboxBundleSrc }) => {
return new GenericScripting(sandboxBundleSrc);
},
};
options.docProperties ||= pdfDocument => {
return docProperties(pdfDocument);
};
super(options);
}
}

export { PDFScriptingManagerComponents as PDFScriptingManager };
24 changes: 0 additions & 24 deletions web/pdf_scripting_manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,30 +66,6 @@ class PDFScriptingManager {
}
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) {
Expand Down
2 changes: 1 addition & 1 deletion web/pdf_viewer.component.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { GenericL10n } from "./genericl10n.js";
import { NullL10n } from "./l10n_utils.js";
import { PDFHistory } from "./pdf_history.js";
import { PDFPageView } from "./pdf_page_view.js";
import { PDFScriptingManager } from "./pdf_scripting_manager.js";
import { PDFScriptingManager } from "./pdf_scripting_manager.component.js";
import { PDFSinglePageViewer } from "./pdf_single_page_viewer.js";
import { PDFViewer } from "./pdf_viewer.js";
import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
Expand Down
10 changes: 2 additions & 8 deletions web/pdfjs.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* globals module, __non_webpack_require__ */
/* globals module */

"use strict";

let pdfjsLib;
if (typeof window !== "undefined" && window["pdfjs-dist/build/pdf"]) {
pdfjsLib = window["pdfjs-dist/build/pdf"];
} else {
pdfjsLib = __non_webpack_require__("../build/pdf.js");
}
module.exports = pdfjsLib;
module.exports = globalThis.pdfjsLib;