f560fe6875
- Use `PDFManager.ensureDoc`, rather than `PDFManager.ensure`, in a couple of spots in the code. If there exists a short-hand format, we should obviously use it whenever possible. - Fix a unit-test helper, to account for the previous changes. (Also, converts a function to be `async` instead.) - Add one more exists-check in `PDFDocument.loadXfaFonts`, which I missed to suggest in PR 13146, to prevent any possible errors if the method is ever called in a situation where it shouldn't be. Also, print a warning if the actual font-loading fails since that could help future debugging. (Finally, reduce overall indentation in the loop.) - Slightly unrelated, but make a small tweak of a comment in `src/core/fonts.js` to reduce possible confusion.
318 lines
11 KiB
JavaScript
318 lines
11 KiB
JavaScript
/* Copyright 2017 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 { createIdFactory, XRefMock } from "./test_utils.js";
|
|
import { Dict, Name, Ref } from "../../src/core/primitives.js";
|
|
import { PDFDocument } from "../../src/core/document.js";
|
|
import { StringStream } from "../../src/core/stream.js";
|
|
|
|
describe("document", function () {
|
|
describe("Page", function () {
|
|
it("should create correct objId/fontId using the idFactory", function () {
|
|
const idFactory1 = createIdFactory(/* pageIndex = */ 0);
|
|
const idFactory2 = createIdFactory(/* pageIndex = */ 1);
|
|
|
|
expect(idFactory1.createObjId()).toEqual("p0_1");
|
|
expect(idFactory1.createObjId()).toEqual("p0_2");
|
|
expect(idFactory1.createFontId()).toEqual("f1");
|
|
expect(idFactory1.createFontId()).toEqual("f2");
|
|
expect(idFactory1.getDocId()).toEqual("g_d0");
|
|
|
|
expect(idFactory2.createObjId()).toEqual("p1_1");
|
|
expect(idFactory2.createObjId()).toEqual("p1_2");
|
|
expect(idFactory2.createFontId()).toEqual("f1");
|
|
expect(idFactory2.createFontId()).toEqual("f2");
|
|
expect(idFactory2.getDocId()).toEqual("g_d0");
|
|
|
|
expect(idFactory1.createObjId()).toEqual("p0_3");
|
|
expect(idFactory1.createObjId()).toEqual("p0_4");
|
|
expect(idFactory1.createFontId()).toEqual("f3");
|
|
expect(idFactory1.createFontId()).toEqual("f4");
|
|
expect(idFactory1.getDocId()).toEqual("g_d0");
|
|
});
|
|
});
|
|
|
|
describe("PDFDocument", function () {
|
|
const stream = new StringStream("Dummy_PDF_data");
|
|
|
|
function getDocument(acroForm, xref = new XRefMock()) {
|
|
const catalog = { acroForm };
|
|
const pdfManager = {
|
|
get docId() {
|
|
return "d0";
|
|
},
|
|
ensureDoc(prop, args) {
|
|
return pdfManager.ensure(pdfDocument, prop, args);
|
|
},
|
|
ensureCatalog(prop, args) {
|
|
return pdfManager.ensure(catalog, prop, args);
|
|
},
|
|
async ensure(obj, prop, args) {
|
|
const value = obj[prop];
|
|
if (typeof value === "function") {
|
|
return value.apply(obj, args);
|
|
}
|
|
return value;
|
|
},
|
|
};
|
|
const pdfDocument = new PDFDocument(pdfManager, stream);
|
|
pdfDocument.xref = xref;
|
|
pdfDocument.catalog = catalog;
|
|
return pdfDocument;
|
|
}
|
|
|
|
it("should get form info when no form data is present", function () {
|
|
const pdfDocument = getDocument(null);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: false,
|
|
});
|
|
});
|
|
|
|
it("should get form info when XFA is present", function () {
|
|
const acroForm = new Dict();
|
|
|
|
// The `XFA` entry can only be a non-empty array or stream.
|
|
acroForm.set("XFA", []);
|
|
let pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: false,
|
|
});
|
|
|
|
acroForm.set("XFA", ["foo", "bar"]);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: true,
|
|
hasFields: false,
|
|
});
|
|
|
|
acroForm.set("XFA", new StringStream(""));
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: false,
|
|
});
|
|
|
|
acroForm.set("XFA", new StringStream("non-empty"));
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: true,
|
|
hasFields: false,
|
|
});
|
|
});
|
|
|
|
it("should get form info when AcroForm is present", function () {
|
|
const acroForm = new Dict();
|
|
|
|
// The `Fields` entry can only be a non-empty array.
|
|
acroForm.set("Fields", []);
|
|
let pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: false,
|
|
});
|
|
|
|
acroForm.set("Fields", ["foo", "bar"]);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: true,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: true,
|
|
});
|
|
|
|
// If the first bit of the `SigFlags` entry is set and the `Fields` array
|
|
// only contains document signatures, then there is no AcroForm data.
|
|
acroForm.set("Fields", ["foo", "bar"]);
|
|
acroForm.set("SigFlags", 2);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: true,
|
|
hasSignatures: false,
|
|
hasXfa: false,
|
|
hasFields: true,
|
|
});
|
|
|
|
const annotationDict = new Dict();
|
|
annotationDict.set("FT", Name.get("Sig"));
|
|
annotationDict.set("Rect", [0, 0, 0, 0]);
|
|
const annotationRef = Ref.get(11, 0);
|
|
|
|
const kidsDict = new Dict();
|
|
kidsDict.set("Kids", [annotationRef]);
|
|
const kidsRef = Ref.get(10, 0);
|
|
|
|
const xref = new XRefMock([
|
|
{ ref: annotationRef, data: annotationDict },
|
|
{ ref: kidsRef, data: kidsDict },
|
|
]);
|
|
|
|
acroForm.set("Fields", [kidsRef]);
|
|
acroForm.set("SigFlags", 3);
|
|
pdfDocument = getDocument(acroForm, xref);
|
|
expect(pdfDocument.formInfo).toEqual({
|
|
hasAcroForm: false,
|
|
hasSignatures: true,
|
|
hasXfa: false,
|
|
hasFields: true,
|
|
});
|
|
});
|
|
|
|
it("should get calculation order array or null", function () {
|
|
const acroForm = new Dict();
|
|
|
|
let pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.calculationOrderIds).toEqual(null);
|
|
|
|
acroForm.set("CO", [Ref.get(1, 0), Ref.get(2, 0), Ref.get(3, 0)]);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.calculationOrderIds).toEqual(["1R", "2R", "3R"]);
|
|
|
|
acroForm.set("CO", []);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.calculationOrderIds).toEqual(null);
|
|
|
|
acroForm.set("CO", ["1", "2"]);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.calculationOrderIds).toEqual(null);
|
|
|
|
acroForm.set("CO", ["1", Ref.get(1, 0), "2"]);
|
|
pdfDocument = getDocument(acroForm);
|
|
expect(pdfDocument.calculationOrderIds).toEqual(["1R"]);
|
|
});
|
|
|
|
it("should get field objects array or null", async function () {
|
|
const acroForm = new Dict();
|
|
|
|
let pdfDocument = getDocument(acroForm);
|
|
let fields = await pdfDocument.fieldObjects;
|
|
expect(fields).toEqual(null);
|
|
|
|
acroForm.set("Fields", []);
|
|
pdfDocument = getDocument(acroForm);
|
|
fields = await pdfDocument.fieldObjects;
|
|
expect(fields).toEqual(null);
|
|
|
|
const kid1Ref = Ref.get(314, 0);
|
|
const kid11Ref = Ref.get(159, 0);
|
|
const kid2Ref = Ref.get(265, 0);
|
|
const kid2BisRef = Ref.get(266, 0);
|
|
const parentRef = Ref.get(358, 0);
|
|
|
|
const allFields = Object.create(null);
|
|
for (const name of ["parent", "kid1", "kid2", "kid11"]) {
|
|
const buttonWidgetDict = new Dict();
|
|
buttonWidgetDict.set("Type", Name.get("Annot"));
|
|
buttonWidgetDict.set("Subtype", Name.get("Widget"));
|
|
buttonWidgetDict.set("FT", Name.get("Btn"));
|
|
buttonWidgetDict.set("T", name);
|
|
allFields[name] = buttonWidgetDict;
|
|
}
|
|
|
|
allFields.kid1.set("Kids", [kid11Ref]);
|
|
allFields.parent.set("Kids", [kid1Ref, kid2Ref, kid2BisRef]);
|
|
|
|
const xref = new XRefMock([
|
|
{ ref: parentRef, data: allFields.parent },
|
|
{ ref: kid1Ref, data: allFields.kid1 },
|
|
{ ref: kid11Ref, data: allFields.kid11 },
|
|
{ ref: kid2Ref, data: allFields.kid2 },
|
|
{ ref: kid2BisRef, data: allFields.kid2 },
|
|
]);
|
|
|
|
acroForm.set("Fields", [parentRef]);
|
|
pdfDocument = getDocument(acroForm, xref);
|
|
fields = await pdfDocument.fieldObjects;
|
|
|
|
for (const [name, objs] of Object.entries(fields)) {
|
|
fields[name] = objs.map(obj => obj.id);
|
|
}
|
|
|
|
expect(fields["parent.kid1"]).toEqual(["314R"]);
|
|
expect(fields["parent.kid1.kid11"]).toEqual(["159R"]);
|
|
expect(fields["parent.kid2"]).toEqual(["265R", "266R"]);
|
|
expect(fields.parent).toEqual(["358R"]);
|
|
});
|
|
|
|
it("should check if fields have any actions", async function () {
|
|
const acroForm = new Dict();
|
|
|
|
let pdfDocument = getDocument(acroForm);
|
|
let hasJSActions = await pdfDocument.hasJSActions;
|
|
expect(hasJSActions).toEqual(false);
|
|
|
|
acroForm.set("Fields", []);
|
|
pdfDocument = getDocument(acroForm);
|
|
hasJSActions = await pdfDocument.hasJSActions;
|
|
expect(hasJSActions).toEqual(false);
|
|
|
|
const kid1Ref = Ref.get(314, 0);
|
|
const kid11Ref = Ref.get(159, 0);
|
|
const kid2Ref = Ref.get(265, 0);
|
|
const parentRef = Ref.get(358, 0);
|
|
|
|
const allFields = Object.create(null);
|
|
for (const name of ["parent", "kid1", "kid2", "kid11"]) {
|
|
const buttonWidgetDict = new Dict();
|
|
buttonWidgetDict.set("Type", Name.get("Annot"));
|
|
buttonWidgetDict.set("Subtype", Name.get("Widget"));
|
|
buttonWidgetDict.set("FT", Name.get("Btn"));
|
|
buttonWidgetDict.set("T", name);
|
|
allFields[name] = buttonWidgetDict;
|
|
}
|
|
|
|
allFields.kid1.set("Kids", [kid11Ref]);
|
|
allFields.parent.set("Kids", [kid1Ref, kid2Ref]);
|
|
|
|
const xref = new XRefMock([
|
|
{ ref: parentRef, data: allFields.parent },
|
|
{ ref: kid1Ref, data: allFields.kid1 },
|
|
{ ref: kid11Ref, data: allFields.kid11 },
|
|
{ ref: kid2Ref, data: allFields.kid2 },
|
|
]);
|
|
|
|
acroForm.set("Fields", [parentRef]);
|
|
pdfDocument = getDocument(acroForm, xref);
|
|
hasJSActions = await pdfDocument.hasJSActions;
|
|
expect(hasJSActions).toEqual(false);
|
|
|
|
const JS = Name.get("JavaScript");
|
|
const additionalActionsDict = new Dict();
|
|
const eDict = new Dict();
|
|
eDict.set("JS", "hello()");
|
|
eDict.set("S", JS);
|
|
additionalActionsDict.set("E", eDict);
|
|
allFields.kid2.set("AA", additionalActionsDict);
|
|
|
|
pdfDocument = getDocument(acroForm, xref);
|
|
hasJSActions = await pdfDocument.hasJSActions;
|
|
expect(hasJSActions).toEqual(true);
|
|
});
|
|
});
|
|
});
|