XFA - Add support to print XFA forms

Author: calixteman

web/base_viewer.js

@@ -581,21 +581,35 @@ class BaseViewer {
           if (pdfDocument.loadingParams.disableAutoFetch || pagesCount > 7500) {
             // XXX: Printing is semi-broken with auto fetch disabled.
             this._pagesCapability.resolve();
-            return;
+            return null;
           }
           let getPagesLeft = pagesCount - 1; // The first page was already loaded.
 
           if (getPagesLeft <= 0) {
             this._pagesCapability.resolve();
-            return;
+            return null;
           }
+
+          const xfaDrawPromises = [];
+
           for (let pageNum = 2; pageNum <= pagesCount; ++pageNum) {
             pdfDocument.getPage(pageNum).then(
               pdfPage => {
                 const pageView = this._pages[pageNum - 1];
                 if (!pageView.pdfPage) {
                   pageView.setPdfPage(pdfPage);
                 }
+                if (isPureXfa) {
+                  // Force the rendering of all pages (in case the pdf is
+                  // printed). It isn't really an issue since the document
+                  // has been fully layed out in worker in order to just
+                  // get the total page number. For now, in order to print
+                  // a filled form, we print the generated html as the user
+                  // can see it. It could lead to a memory issue in case
+                  // the document as a huge number of pages which is pretty
+                  // unlikely since normally XFA is used to render forms.
+                  xfaDrawPromises.push(pageView.draw());
+                }
                 this.linkService.cachePageRef(pageNum, pdfPage.ref);
                 if (--getPagesLeft === 0) {
                   this._pagesCapability.resolve();
@@ -612,6 +626,11 @@ class BaseViewer {
               }
             );
           }
+
+          if (isPureXfa) {
+            return Promise.all(xfaDrawPromises);
+          }
+          return null;
         });
 
         this.eventBus.dispatch("pagesinit", { source: this });

web/firefox_print_service.js

@@ -14,6 +14,7 @@
  */
 
 import { RenderingCancelledException, shadow } from "pdfjs-lib";
+import { cloneXfaPagesForPrinting } from "./ui_utils.js";
 import { PDFPrintServiceFactory } from "./app.js";
 
 // Creates a placeholder with div and canvas with right size for the page.
@@ -33,6 +34,7 @@ function composePage(
   canvas.height = Math.floor(size.height * PRINT_UNITS);
 
   const canvasWrapper = document.createElement("div");
+  canvasWrapper.setAttribute("class", "printedPage");
   canvasWrapper.appendChild(canvas);
   printContainer.appendChild(canvasWrapper);
 
@@ -130,15 +132,19 @@ FirefoxPrintService.prototype = {
     const body = document.querySelector("body");
     body.setAttribute("data-pdfjsprinting", true);
 
-    for (let i = 0, ii = pagesOverview.length; i < ii; ++i) {
-      composePage(
-        pdfDocument,
-        /* pageNumber = */ i + 1,
-        pagesOverview[i],
-        printContainer,
-        _printResolution,
-        _optionalContentConfigPromise
-      );
+    if (pdfDocument.isPureXfa && pagesOverview.length > 0) {
+      cloneXfaPagesForPrinting(printContainer, pagesOverview);
+    } else {
+      for (let i = 0, ii = pagesOverview.length; i < ii; ++i) {
+        composePage(
+          pdfDocument,
+          /* pageNumber = */ i + 1,
+          pagesOverview[i],
+          printContainer,
+          _printResolution,
+          _optionalContentConfigPromise
+        );
+      }
     }
   },
 

web/pdf_print_service.js

@@ -14,6 +14,7 @@
  */
 
 import { PDFPrintServiceFactory, PDFViewerApplication } from "./app.js";
+import { cloneXfaPagesForPrinting } from "./ui_utils.js";
 import { viewerCompatibilityParams } from "./viewer_compatibility.js";
 
 let activeService = null;
@@ -27,7 +28,8 @@ function renderPage(
   pageNumber,
   size,
   printResolution,
-  optionalContentConfigPromise
+  optionalContentConfigPromise,
+  printContainer
 ) {
   const scratchCanvas = activeService.scratchCanvas;
 
@@ -140,6 +142,15 @@ PDFPrintService.prototype = {
 
   renderPages() {
     const pageCount = this.pagesOverview.length;
+    if (pageCount === 0) {
+      return Promise.resolve();
+    }
+
+    if (this.pdfDocument.isPureXfa) {
+      cloneXfaPagesForPrinting(this.printContainer, this.pagesOverview[0]);
+      return Promise.resolve();
+    }
+
     const renderNextPage = (resolve, reject) => {
       this.throwIfInactive();
       if (++this.currentPage >= pageCount) {
@@ -155,7 +166,8 @@ PDFPrintService.prototype = {
         /* pageNumber = */ index + 1,
         this.pagesOverview[index],
         this._printResolution,
-        this._optionalContentConfigPromise
+        this._optionalContentConfigPromise,
+        this.printContainer
       )
         .then(this.useRenderedPage.bind(this))
         .then(function () {
@@ -181,6 +193,7 @@ PDFPrintService.prototype = {
     }
 
     const wrapper = document.createElement("div");
+    wrapper.setAttribute("class", "printedPage");
     wrapper.appendChild(img);
     this.printContainer.appendChild(wrapper);
 

web/ui_utils.js

@@ -994,6 +994,33 @@ function apiPageModeToSidebarView(mode) {
   return SidebarView.NONE; // Default value.
 }
 
+function cloneXfaPagesForPrinting(container, pagesOverview) {
+  const ratio = CSS_UNITS;
+  const viewer = document.getElementById("viewer");
+  let pageNumber = 0;
+
+  for (const element of viewer.getElementsByClassName("page")) {
+    const clone = element.cloneNode(true);
+    clone.setAttribute("class", "xfaPrintedPage");
+    let pageSize;
+    if (Array.isArray(pagesOverview)) {
+      pageSize = pagesOverview[pageNumber++];
+    } else {
+      pageSize = pagesOverview;
+    }
+    clone.style.width = `${pageSize.width * ratio}px`;
+    clone.style.height = `${pageSize.height * ratio}px`;
+    for (let i = 0; i < clone.childNodes.length; i++) {
+      const child = clone.childNodes[i];
+      if (!child.getAttribute("class").includes("xfaLayer")) {
+        continue;
+      }
+      child.style.transform = `scale(${ratio},${ratio})`;
+    }
+    container.appendChild(clone);
+  }
+}
+
 export {
   animationStarted,
   apiPageLayoutToSpreadMode,
@@ -1002,6 +1029,7 @@ export {
   AutoPrintRegExp,
   backtrackBeforeAllVisibleElements, // only exported for testing
   binarySearchFirstItem,
+  cloneXfaPagesForPrinting,
   CSS_UNITS,
   DEFAULT_SCALE,
   DEFAULT_SCALE_VALUE,

web/viewer.css

@@ -1772,7 +1772,8 @@ html[dir="rtl"] #documentPropertiesOverlay .row > * {
   .toolbar,
   #loadingBox,
   #errorWrapper,
-  .textLayer {
+  .textLayer,
+  .canvasWrapper {
     display: none;
   }
   #viewerContainer {
@@ -1816,7 +1817,7 @@ html[dir="rtl"] #documentPropertiesOverlay .row > * {
     height: 100%;
   }
   /* wrapper around (scaled) print canvas elements */
-  #printContainer > div {
+  #printContainer > .printedPage {
     page-break-after: always;
     page-break-inside: avoid;
 
@@ -1829,8 +1830,15 @@ html[dir="rtl"] #documentPropertiesOverlay .row > * {
     justify-content: center;
     align-items: center;
   }
-  #printContainer canvas,
-  #printContainer img {
+
+  #printContainer > .xfaPrintedPage {
+    page-break-after: always;
+    page-break-inside: avoid;
+    position: relative;
+  }
+
+  .printedPage canvas,
+  .printedPage img {
     /* The intrinsic canvas / image size will make sure that we fit the page. */
     max-width: 100%;
     max-height: 100%;