Skip to content

Commit

Permalink
Merge pull request mozilla#15819 from calixteman/15815
Browse files Browse the repository at this point in the history 
[JS] Handle correctly choice widgets where the display and the export values are different (issue mozilla#15815)
  • Loading branch information
@calixteman
calixteman committed Dec 13, 2022
2 parents 64786b4 + 0c1ec94 commit 2d59604
Show file tree
Hide file tree
Showing 8 changed files with 155 additions and 30 deletions.
10 changes: 9 additions & 1 deletion src/core/annotation.js
View file
Expand Up @@ -1978,7 +1978,15 @@ class WidgetAnnotation extends Annotation {

assert(typeof value === "string", "Expected `value` to be a string.");

value = value.trim();
if (!this.data.combo) {
value = value.trim();
} else {
// The value is supposed to be one of the exportValue.
const option =
this.data.options.find(({ exportValue }) => value === exportValue) ||
this.data.options[0];
value = (option && option.displayValue) || "";
}

if (value === "") {
// the field is empty: nothing to render
Expand Down
35 changes: 22 additions & 13 deletions src/display/annotation_layer.js
View file
Expand Up @@ -1612,10 +1612,10 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
selectElement.addEventListener("input", removeEmptyEntry);
}

const getValue = (event, isExport) => {
const getValue = isExport => {
const name = isExport ? "value" : "textContent";
const options = event.target.options;
if (!event.target.multiple) {
const { options, multiple } = selectElement;
if (!multiple) {
return options.selectedIndex === -1
? null
: options[options.selectedIndex][name];
Expand All @@ -1625,6 +1625,8 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
.map(option => option[name]);
};

let selectedValues = getValue(/* isExport */ false);

const getItems = event => {
const options = event.target.options;
return Array.prototype.map.call(options, option => {
Expand All @@ -1643,8 +1645,9 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
option.selected = values.has(option.value);
}
storage.setValue(id, {
value: getValue(event, /* isExport */ true),
value: getValue(/* isExport */ true),
});
selectedValues = getValue(/* isExport */ false);
},
multipleSelection(event) {
selectElement.multiple = true;
Expand All @@ -1664,15 +1667,17 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
}
}
storage.setValue(id, {
value: getValue(event, /* isExport */ true),
value: getValue(/* isExport */ true),
items: getItems(event),
});
selectedValues = getValue(/* isExport */ false);
},
clear(event) {
while (selectElement.length !== 0) {
selectElement.remove(0);
}
storage.setValue(id, { value: null, items: [] });
selectedValues = getValue(/* isExport */ false);
},
insert(event) {
const { index, displayValue, exportValue } = event.detail.insert;
Expand All @@ -1687,9 +1692,10 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
selectElement.append(optionElement);
}
storage.setValue(id, {
value: getValue(event, /* isExport */ true),
value: getValue(/* isExport */ true),
items: getItems(event),
});
selectedValues = getValue(/* isExport */ false);
},
items(event) {
const { items } = event.detail;
Expand All @@ -1707,18 +1713,20 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
selectElement.options[0].selected = true;
}
storage.setValue(id, {
value: getValue(event, /* isExport */ true),
value: getValue(/* isExport */ true),
items: getItems(event),
});
selectedValues = getValue(/* isExport */ false);
},
indices(event) {
const indices = new Set(event.detail.indices);
for (const option of event.target.options) {
option.selected = indices.has(option.index);
}
storage.setValue(id, {
value: getValue(event, /* isExport */ true),
value: getValue(/* isExport */ true),
});
selectedValues = getValue(/* isExport */ false);
},
editable(event) {
event.target.disabled = !event.detail.editable;
Expand All @@ -1728,18 +1736,19 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
});

selectElement.addEventListener("input", event => {
const exportValue = getValue(event, /* isExport */ true);
const value = getValue(event, /* isExport */ false);
const exportValue = getValue(/* isExport */ true);
storage.setValue(id, { value: exportValue });

event.preventDefault();

this.linkService.eventBus?.dispatch("dispatcheventinsandbox", {
source: this,
detail: {
id,
name: "Keystroke",
value,
value: selectedValues,
changeEx: exportValue,
willCommit: true,
willCommit: false,
commitKey: 1,
keyDown: false,
},
Expand All @@ -1761,7 +1770,7 @@ class ChoiceWidgetAnnotationElement extends WidgetAnnotationElement {
);
} else {
selectElement.addEventListener("input", function (event) {
storage.setValue(id, { value: getValue(event, /* isExport */ true) });
storage.setValue(id, { value: getValue(/* isExport */ true) });
});
}

Expand Down
11 changes: 11 additions & 0 deletions src/scripting_api/event.js
View file
Expand Up @@ -137,6 +137,7 @@ class EventDispatcher {
case "Keystroke":
savedChange = {
value: event.value,
changeEx: event.changeEx,
change: event.change,
selStart: event.selStart,
selEnd: event.selEnd,
Expand Down Expand Up @@ -170,6 +171,16 @@ class EventDispatcher {
if (event.willCommit) {
this.runValidation(source, event);
} else {
if (source.obj._isChoice) {
source.obj.value = savedChange.changeEx;
source.obj._send({
id: source.obj._id,
siblings: source.obj._siblings,
value: source.obj.value,
});
return;
}

const value = (source.obj.value = this.mergeChange(event));
let selStart, selEnd;
if (
Expand Down
51 changes: 35 additions & 16 deletions src/scripting_api/field.js
View file
Expand Up @@ -242,6 +242,11 @@ class Field extends PDFObject {
}

set value(value) {
if (this._isChoice) {
this._setChoiceValue(value);
return;
}

if (value === "") {
this._value = "";
} else if (typeof value === "string") {
Expand All @@ -260,23 +265,37 @@ class Field extends PDFObject {
} else {
this._value = value;
}
if (this._isChoice) {
if (this.multipleSelection) {
const values = new Set(value);
if (Array.isArray(this._currentValueIndices)) {
this._currentValueIndices.length = 0;
} else {
this._currentValueIndices = [];
}
this._items.forEach(({ displayValue }, i) => {
if (values.has(displayValue)) {
this._currentValueIndices.push(i);
}
});
}

_setChoiceValue(value) {
if (this.multipleSelection) {
if (!Array.isArray(value)) {
value = [value];
}
const values = new Set(value);
if (Array.isArray(this._currentValueIndices)) {
this._currentValueIndices.length = 0;
this._value.length = 0;
} else {
this._currentValueIndices = this._items.findIndex(
({ displayValue }) => value === displayValue
);
this._currentValueIndices = [];
this._value = [];
}
this._items.forEach((item, i) => {
if (values.has(item.exportValue)) {
this._currentValueIndices.push(i);
this._value.push(item.exportValue);
}
});
} else {
if (Array.isArray(value)) {
value = value[0];
}
const index = this._items.findIndex(
({ exportValue }) => value === exportValue
);
if (index !== -1) {
this._currentValueIndices = index;
this._value = this._items[index].exportValue;
}
}
}
Expand Down
50 changes: 50 additions & 0 deletions test/integration/scripting_spec.js
View file
Expand Up @@ -1651,4 +1651,54 @@ describe("Interaction", () => {
);
});
});

describe("in issue15815.pdf", () => {
let pages;

beforeAll(async () => {
pages = await loadAndWait("issue15815.pdf", getSelector("24R"));
});

afterAll(async () => {
await closePages(pages);
});

it("must check field value is correctly updated when committed with ENTER key", async () => {
await Promise.all(
pages.map(async ([browserName, page]) => {
await page.waitForFunction(
"window.PDFViewerApplication.scriptingReady === true"
);

let value = "A";
for (const [displayValue, exportValue] of [
["B", "x2"],
["C", "x3"],
["A", "x1"],
]) {
await clearInput(page, getSelector("27R"));
await page.select(getSelector("24R"), exportValue);
await page.waitForFunction(
`${getQuerySelector("27R")}.value !== ""`
);
const text = await page.$eval(getSelector("27R"), el => el.value);
expect(text)
.withContext(`In ${browserName}`)
.toEqual(`value=${value}, changeEx=${exportValue}`);
value = displayValue;
}

for (const exportValue of ["x3", "x2", "x1"]) {
await clearInput(page, getSelector("27R"));
await page.type(getSelector("27R"), exportValue);
await page.click("[data-annotation-id='28R']");
await page.waitForTimeout(10);

value = await page.$eval(getSelector("24R"), el => el.value);
expect(value).withContext(`In ${browserName}`).toEqual(exportValue);
}
})
);
});
});
});
1 change: 1 addition & 0 deletions test/pdfs/.gitignore
View file
Expand Up @@ -561,3 +561,4 @@
!issue15753.pdf
!issue15789.pdf
!fields_order.pdf
!issue15815.pdf
Binary file added test/pdfs/issue15815.pdf
View file
Binary file not shown.
27 changes: 27 additions & 0 deletions test/test_manifest.json
View file
Expand Up @@ -7240,5 +7240,32 @@
"value": "مرحبا بالعالم"
}
}
},
{
"id": "issue15815-print",
"file": "pdfs/issue15815.pdf",
"md5": "48b8b057954d5b773421ac03b7fcd738",
"rounds": 1,
"type": "eq",
"print": true,
"annotationStorage": {
"24R": {
"value": "x3"
}
}
},
{
"id": "issue15815-save-print",
"file": "pdfs/issue15815.pdf",
"md5": "48b8b057954d5b773421ac03b7fcd738",
"rounds": 1,
"type": "eq",
"save": true,
"print": true,
"annotationStorage": {
"24R": {
"value": "x2"
}
}
}
]

0 comments on commit 2d59604

Please sign in to comment.