Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[JS] Use beforeinput event to trigger a keystroke event in the sandbox

Browse Source 
- it aims to fix issue #14307;
 - this event has been added recently in Firefox and we can now use it;
 - fix few bugs in aform.js or in annotation_layer.js;
 - add some integration tests to test keystroke events (see `AFSpecial_Keystroke`);
 - make dispatchEvent in the quickjs sandbox async.
This commit is contained in:
Calixte Denizet 2022-01-08 17:57:06 +01:00
parent 922dac035c
commit 6ac296e48e
9 changed files with 254 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
out.pdf Normal file
View File

Binary file not shown.

44
src/display/annotation_layer.js
View File

@ -780,7 +780,7 @@ class WidgetAnnotationElement extends AnnotationElement {
detail: {
id: this.data.id,
name: eventName,
value: event.target.checked,
value: valueGetter(event),
},
});
});
@ -923,8 +923,6 @@ class TextWidgetAnnotationElement extends WidgetAnnotationElement {
const elementData = {
userValue: null,
formattedValue: null,
beforeInputSelectionRange: null,
beforeInputValue: null,
};
if (this.data.multiLine) {
@ -965,7 +963,6 @@ class TextWidgetAnnotationElement extends WidgetAnnotationElement {
}
// Reset the cursor position to the start of the field (issue 12359).
event.target.scrollLeft = 0;
elementData.beforeInputSelectionRange = null;
};
if (this.enableScripting && this.hasJSActions) {
@ -1007,7 +1004,6 @@ class TextWidgetAnnotationElement extends WidgetAnnotationElement {
// Even if the field hasn't any actions
// leaving it can still trigger some actions with Calculate
element.addEventListener("keydown", event => {
elementData.beforeInputValue = event.target.value;
// if the key is one of Escape, Enter or Tab
// then the data are committed
let commitKey = -1;
@ -1039,9 +1035,9 @@ class TextWidgetAnnotationElement extends WidgetAnnotationElement {
const _blurListener = blurListener;
blurListener = null;
element.addEventListener("blur", event => {
elementData.userValue = event.target.value;
if (this._mouseState.isDown) {
// Focus out using the mouse: data are committed
elementData.userValue = event.target.value;
this.linkService.eventBus?.dispatch("dispatcheventinsandbox", {
source: this,
detail: {
@ -1057,42 +1053,22 @@ class TextWidgetAnnotationElement extends WidgetAnnotationElement {
}
_blurListener(event);
});
element.addEventListener("mousedown", event => {
elementData.beforeInputValue = event.target.value;
elementData.beforeInputSelectionRange = null;
});
element.addEventListener("keyup", event => {
// keyup is triggered after input
if (event.target.selectionStart === event.target.selectionEnd) {
elementData.beforeInputSelectionRange = null;
}
});
element.addEventListener("select", event => {
elementData.beforeInputSelectionRange = [
event.target.selectionStart,
event.target.selectionEnd,
];
});
if (this.data.actions?.Keystroke) {
// We should use beforeinput but this
// event isn't available in Firefox
element.addEventListener("input", event => {
let selStart = -1;
let selEnd = -1;
if (elementData.beforeInputSelectionRange) {
[selStart, selEnd] = elementData.beforeInputSelectionRange;
}
element.addEventListener("beforeinput", event => {
elementData.formattedValue = "";
const { data, target } = event;
const { value, selectionStart, selectionEnd } = target;
this.linkService.eventBus?.dispatch("dispatcheventinsandbox", {
source: this,
detail: {
id,
name: "Keystroke",
value: elementData.beforeInputValue,
change: event.data,
value,
change: data,
willCommit: false,
selStart,
selEnd,
selStart: selectionStart,
selEnd: selectionEnd,
},
});
});

2
src/pdf.sandbox.js
View File

@ -103,7 +103,7 @@ class Sandbox {
}
dispatchEvent(event) {
this.support.callSandboxFunction("dispatchEvent", event);
this.support?.callSandboxFunction("dispatchEvent", event);
}
dumpMemoryUse() {

12
src/scripting_api/aform.js
View File

@ -466,6 +466,10 @@ class AForm {
const event = globalThis.event;
const value = this.AFMergeChange(event);
if (!value) {
return;
}
const checkers = new Map([
["9", char => char >= "0" && char <= "9"],
[
@ -498,10 +502,6 @@ class AForm {
return true;
}
if (!value) {
return;
}
const err = `${GlobalConstants.IDS_INVALID_VALUE} = "${cMask}"`;
if (value.length > cMask.length) {
@ -538,10 +538,6 @@ class AForm {
AFSpecial_Keystroke(psf) {
const event = globalThis.event;
if (!event.value) {
return;
}
psf = this.AFMakeNumber(psf);
let formatStr;

8
src/scripting_api/event.js
View File

@ -151,6 +151,14 @@ class EventDispatcher {
value: savedChange.value,
selRange: [savedChange.selStart, savedChange.selEnd],
});
} else {
// Entry is not valid (rc == false) and it's a commit
// so just clear the field.
source.obj._send({
id: source.obj._id,
value: "",
selRange: [0, 0],
});
}
}
}

230
test/integration/scripting_spec.js
View File

@ -102,6 +102,11 @@ describe("Interaction", () => {
pages.map(async ([browserName, page]) => {
await page.type("#\\34 16R", "3.14159", { delay: 200 });
await page.click("#\\34 19R");
await page.waitForFunction(
`document.querySelector("#\\\\34 16R").value !== "3.14159"`
);
const text = await page.$eval("#\\34 16R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("3,14");
@ -116,10 +121,20 @@ describe("Interaction", () => {
pages.map(async ([browserName, page]) => {
await page.type("#\\34 48R", "61803", { delay: 200 });
await page.click("#\\34 19R");
await page.waitForFunction(
`document.querySelector("#\\\\34 48R").value !== "61803"`
);
let text = await page.$eval("#\\34 48R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("61.803,00");
await page.click("#\\34 48R");
await page.waitForFunction(
`document.querySelector("#\\\\34 48R").value !== "61.803,00"`
);
text = await page.$eval("#\\34 48R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("61803");
@ -128,6 +143,11 @@ describe("Interaction", () => {
await page.type("#\\34 48R", "1.61803", { delay: 200 });
await page.click("#\\34 19R");
await page.waitForFunction(
`document.querySelector("#\\\\34 48R").value !== "1.61803"`
);
text = await page.$eval("#\\34 48R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("1,62");
})
@ -137,11 +157,22 @@ describe("Interaction", () => {
it("must format the field with 2 digits and leave field with a TAB", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
const prevSum = await page.$eval("#\\34 27R", el => el.value);
await page.type("#\\34 22R", "2.7182818", { delay: 200 });
await page.keyboard.press("Tab");
await page.waitForFunction(
`document.querySelector("#\\\\34 22R").value !== "2.7182818"`
);
const text = await page.$eval("#\\34 22R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("2,72");
await page.waitForFunction(
`document.querySelector("#\\\\34 27R").value !== "${prevSum}"`
);
const sum = await page.$eval("#\\34 27R", el => el.value);
expect(sum).withContext(`In ${browserName}`).toEqual("5,86");
})
@ -156,9 +187,14 @@ describe("Interaction", () => {
await page.type("#\\34 36R", "0.69314", { delay: 200 });
await page.keyboard.press("Escape");
const text = await page.$eval("#\\34 36R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("0.69314");
await page.waitForFunction(
`document.querySelector("#\\\\34 71R").value !== "${sum}"`
);
sum = await page.$eval("#\\34 71R", el => el.value);
expect(sum).withContext(`In ${browserName}`).toEqual("3,55");
})
@ -168,11 +204,17 @@ describe("Interaction", () => {
it("must format the field with 2 digits on key ENTER", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
const prevSum = await page.$eval("#\\34 27R", el => el.value);
await page.type("#\\34 19R", "0.577215", { delay: 200 });
await page.keyboard.press("Enter");
const text = await page.$eval("#\\34 19R", el => el.value);
expect(text).toEqual("0.577215");
await page.waitForFunction(
`document.querySelector("#\\\\34 27R").value !== "${prevSum}"`
);
const sum = await page.$eval("#\\34 27R", el => el.value);
expect(sum).toEqual("6,44");
})
@ -194,6 +236,14 @@ describe("Interaction", () => {
// click on reset button
await page.click("[data-annotation-id='402R']");
await Promise.all(
["16", "22", "19", "05", "27"].map(id =>
page.waitForFunction(
`document.querySelector("#\\\\34 ${id}R").value === ""`
)
)
);
let text = await page.$eval("#\\34 16R", el => el.value);
expect(text).toEqual("");
@ -451,6 +501,10 @@ describe("Interaction", () => {
"window.PDFViewerApplication.scriptingReady === true"
);
await page.waitForFunction(
`document.querySelector("#\\\\34 7R").value !== ""`
);
let text = await page.$eval("#\\34 7R", el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("PageOpen 1");
@ -642,6 +696,7 @@ describe("Interaction", () => {
}
for (const num of [6, 4, 2, 1]) {
await clearInput(page, "#\\33 3R");
await page.click(`option[value=Export${num}]`);
await page.waitForFunction(
`document.querySelector("#\\\\33 3R").value !== ""`
@ -747,7 +802,7 @@ describe("Interaction", () => {
await page.keyboard.press("Tab");
await page.waitForFunction(
`getComputedStyle(document.querySelector("#\\\\31 71R")).value !== "${prev}"`
`document.querySelector("#\\\\31 71R").value !== "${prev}"`
);
sum += val;
@ -909,4 +964,177 @@ describe("Interaction", () => {
);
});
});
describe("in issue14307.pdf (1)", () => {
let pages;
beforeAll(async () => {
pages = await loadAndWait("issue14307.pdf", "#\\33 0R");
pages.map(async ([, page]) => {
page.on("dialog", async dialog => {
await dialog.dismiss();
});
});
});
afterAll(async () => {
await closePages(pages);
});
it("must check input for US zip format", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
await page.waitForFunction(
"window.PDFViewerApplication.scriptingReady === true"
);
await clearInput(page, "#\\32 9R");
await clearInput(page, "#\\33 0R");
await page.focus("#\\32 9R");
await page.type("#\\32 9R", "12A");
await page.waitForFunction(
`document.querySelector("#\\\\32 9R").value !== "12A"`
);
let text = await page.$eval(`#\\32 9R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("12");
await page.focus("#\\32 9R");
await page.type("#\\32 9R", "34");
await page.click("[data-annotation-id='30R']");
await page.waitForFunction(
`document.querySelector("#\\\\32 9R").value !== "1234"`
);
text = await page.$eval(`#\\32 9R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("");
await page.focus("#\\32 9R");
await page.type("#\\32 9R", "12345");
await page.click("[data-annotation-id='30R']");
text = await page.$eval(`#\\32 9R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("12345");
})
);
});
});
describe("in issue14307.pdf (2)", () => {
let pages;
beforeAll(async () => {
pages = await loadAndWait("issue14307.pdf", "#\\33 0R");
pages.map(async ([, page]) => {
page.on("dialog", async dialog => {
await dialog.dismiss();
});
});
});
afterAll(async () => {
await closePages(pages);
});
it("must check input for US phone number (long) format", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
await page.waitForFunction(
"window.PDFViewerApplication.scriptingReady === true"
);
await clearInput(page, "#\\32 9R");
await clearInput(page, "#\\33 0R");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "(123) 456A");
await page.waitForFunction(
`document.querySelector("#\\\\33 0R").value !== "(123) 456A"`
);
let text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("(123) 456");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "-789");
await page.click("[data-annotation-id='29R']");
await page.waitForFunction(
`document.querySelector("#\\\\33 0R").value !== "(123) 456-789"`
);
text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "(123) 456-7890");
await page.click("[data-annotation-id='29R']");
text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text)
.withContext(`In ${browserName}`)
.toEqual("(123) 456-7890");
})
);
});
});
describe("in issue14307.pdf (3)", () => {
let pages;
beforeAll(async () => {
pages = await loadAndWait("issue14307.pdf", "#\\33 0R");
pages.map(async ([, page]) => {
page.on("dialog", async dialog => {
await dialog.dismiss();
});
});
});
afterAll(async () => {
await closePages(pages);
});
it("must check input for US phone number (short) format", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
await page.waitForFunction(
"window.PDFViewerApplication.scriptingReady === true"
);
await clearInput(page, "#\\32 9R");
await clearInput(page, "#\\33 0R");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "123A");
await page.waitForFunction(
`document.querySelector("#\\\\33 0R").value !== "123A"`
);
let text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("123");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "-456");
await page.click("[data-annotation-id='29R']");
await page.waitForFunction(
`document.querySelector("#\\\\33 0R").value !== "123-456"`
);
text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("");
await page.focus("#\\33 0R");
await page.type("#\\33 0R", "123-4567");
await page.click("[data-annotation-id='29R']");
text = await page.$eval(`#\\33 0R`, el => el.value);
expect(text).withContext(`In ${browserName}`).toEqual("123-4567");
})
);
});
});
});

1
test/pdfs/.gitignore vendored
View File

@ -504,3 +504,4 @@
!PDFBOX-3148-2-fuzzed.pdf
!poppler-90-0-fuzzed.pdf
!issue14415.pdf
!issue14307.pdf

BIN
test/pdfs/issue14307.pdf Normal file
View File

Binary file not shown.

2
web/generic_scripting.js
View File

@ -56,7 +56,7 @@ class GenericScripting {
async dispatchEventInSandbox(event) {
const sandbox = await this._ready;
sandbox.dispatchEvent(event);
setTimeout(() => sandbox.dispatchEvent(event), 0);
}
async destroySandbox() {