Save form data in XFA datasets when pdf is a mix of acroforms and xfa (#12344)

* Move display/xml_parser.js in shared to use it in worker

* Save form data in XFA datasets when pdf is a mix of acroforms and xfa

Co-authored-by: Brendan Dahl <brendan.dahl@gmail.com>

test/unit/clitests.json

@@ -37,6 +37,7 @@
     "ui_utils_spec.js",
     "unicode_spec.js",
     "util_spec.js",
-    "writer_spec.js"
+    "writer_spec.js",
+    "xml_spec.js"
   ]
 }

test/unit/jasmine-boot.js

@@ -81,6 +81,7 @@ function initializePDFJS(callback) {
       "pdfjs-test/unit/unicode_spec.js",
       "pdfjs-test/unit/util_spec.js",
       "pdfjs-test/unit/writer_spec.js",
+      "pdfjs-test/unit/xml_spec.js",
     ].map(function (moduleName) {
       // eslint-disable-next-line no-unsanitized/method
       return SystemJS.import(moduleName);

test/unit/util_spec.js

@@ -17,6 +17,7 @@ import {
   bytesToString,
   createPromiseCapability,
   createValidAbsoluteUrl,
+  encodeToXmlString,
   escapeString,
   getModificationDate,
   isArrayBuffer,
@@ -24,6 +25,7 @@ import {
   isNum,
   isSameOrigin,
   isString,
+  parseXFAPath,
   removeNullCharacters,
   string32,
   stringToBytes,
@@ -331,4 +333,32 @@ describe("util", function () {
       expect(getModificationDate(date)).toEqual("31410610020653");
     });
   });
+
+  describe("parseXFAPath", function () {
+    it("should get a correctly parsed path", function () {
+      const path = "foo.bar[12].oof[3].rab.FOO[123].BAR[456]";
+      expect(parseXFAPath(path)).toEqual([
+        { name: "foo", pos: 0 },
+        { name: "bar", pos: 12 },
+        { name: "oof", pos: 3 },
+        { name: "rab", pos: 0 },
+        { name: "FOO", pos: 123 },
+        { name: "BAR", pos: 456 },
+      ]);
+    });
+  });
+
+  describe("encodeToXmlString", function () {
+    it("should get a correctly encoded string with some entities", function () {
+      const str = "\"\u0397ell😂' & <W😂rld>";
+      expect(encodeToXmlString(str)).toEqual(
+        "&quot;&#x397;ell&#x1F602;&apos; &amp; &lt;W&#x1F602;rld&gt;"
+      );
+    });
+
+    it("should get a correctly encoded basic ascii string", function () {
+      const str = "hello world";
+      expect(encodeToXmlString(str)).toEqual(str);
+    });
+  });
 });

test/unit/writer_spec.js

@@ -37,7 +37,7 @@ describe("Writer", function () {
         info: {},
       };
 
-      let data = incrementalUpdate(originalData, xrefInfo, newRefs);
+      let data = incrementalUpdate(originalData, xrefInfo, newRefs, null, null);
       data = bytesToString(data);
 
       const expected =

test/unit/xml_spec.js

@@ -0,0 +1,110 @@
+/* Copyright 2020 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 { parseXFAPath } from "../../src/shared/util.js";
+import { SimpleXMLParser } from "../../src/shared/xml_parser.js";
+
+describe("XML", function () {
+  describe("searchNode", function () {
+    it("should search a node with a given path in xml tree", function () {
+      const xml = `
+      <a>
+          <b>
+              <c a="123"/>
+              <d/>
+              <e>
+                  <f>
+                      <g a="321"/>
+                  </f>
+              </e>
+              <c a="456"/>
+              <c a="789"/>
+              <h/>
+              <c a="101112"/>
+          </b>
+          <h>
+              <i/>
+              <j/>
+              <k>
+                  <g a="654"/>
+              </k>
+          </h>
+          <b>
+              <g a="987"/>
+              <h/>
+              <g a="121110"/>
+          </b>
+      </a>`;
+      const root = new SimpleXMLParser(true).parseFromString(xml)
+        .documentElement;
+      function getAttr(path) {
+        return root.searchNode(parseXFAPath(path), 0).attributes[0].value;
+      }
+
+      expect(getAttr("b.g")).toEqual("321");
+      expect(getAttr("e.f.g")).toEqual("321");
+      expect(getAttr("e.g")).toEqual("321");
+      expect(getAttr("g")).toEqual("321");
+      expect(getAttr("h.g")).toEqual("654");
+      expect(getAttr("b[0].g")).toEqual("321");
+      expect(getAttr("b[1].g")).toEqual("987");
+      expect(getAttr("b[1].g[0]")).toEqual("987");
+      expect(getAttr("b[1].g[1]")).toEqual("121110");
+      expect(getAttr("c")).toEqual("123");
+      expect(getAttr("c[1]")).toEqual("456");
+      expect(getAttr("c[2]")).toEqual("789");
+      expect(getAttr("c[3]")).toEqual("101112");
+    });
+
+    it("should dump a xml tree", function () {
+      let xml = `
+      <a>
+          <b>
+              <c a="123"/>
+              <d>hello</d>
+              <e>
+                  <f>
+                      <g a="321"/>
+                  </f>
+              </e>
+              <c a="456"/>
+              <c a="789"/>
+              <h/>
+              <c a="101112"/>
+          </b>
+          <h>
+              <i/>
+              <j/>
+              <k>
+                  W&#x1F602;rld
+                  <g a="654"/>
+              </k>
+          </h>
+          <b>
+              <g a="987"/>
+              <h/>
+              <g a="121110"/>
+          </b>
+      </a>`;
+      xml = xml.replace(/\s+/g, "");
+      const root = new SimpleXMLParser(true).parseFromString(xml)
+        .documentElement;
+      const buffer = [];
+      root.dump(buffer);
+
+      expect(buffer.join("").replace(/\s+/g, "")).toEqual(xml);
+    });
+  });
+});