Merge pull request #13175 from Snuffleupagus/app-close-save

[GENERIC viewer] Avoid data loss in forms, by triggering saving when the document is closed (issue 12257)

web/app.js

@@ -802,7 +802,19 @@ const PDFViewerApplication = {
     }
 
     if (!this.pdfLoadingTask) {
-      return undefined;
+      return;
+    }
+    if (
+      (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) &&
+      this.pdfDocument?.annotationStorage.size > 0 &&
+      this._annotationStorageModified
+    ) {
+      try {
+        // Trigger saving, to prevent data loss in forms; see issue 12257.
+        await this.save({ sourceEventType: "save" });
+      } catch (reason) {
+        // Ignoring errors, to ensure that document closing won't break.
+      }
     }
     const promises = [];
 
@@ -851,8 +863,6 @@ const PDFViewerApplication = {
       PDFBug.cleanup();
     }
     await Promise.all(promises);
-
-    return undefined;
   },
 
   /**
@@ -949,62 +959,59 @@ const PDFViewerApplication = {
     );
   },
 
-  download({ sourceEventType = "download" } = {}) {
+  /**
-    function downloadByUrl() {
+   * @private
-      downloadManager.downloadUrl(url, filename);
+   */
-    }
+  _ensureDownloadComplete() {
-
+    if (this.pdfDocument && this.downloadComplete) {
-    const downloadManager = this.downloadManager,
-      url = this.baseUrl,
-      filename = this._docFilename;
-
-    // When the PDF document isn't ready, or the PDF file is still downloading,
-    // simply download using the URL.
-    if (!this.pdfDocument || !this.downloadComplete) {
-      downloadByUrl();
       return;
     }
+    throw new Error("PDF document not downloaded.");
+  },
 
-    this.pdfDocument
+  async download({ sourceEventType = "download" } = {}) {
-      .getData()
+    const url = this.baseUrl,
-      .then(function (data) {
+      filename = this._docFilename;
-        const blob = new Blob([data], { type: "application/pdf" });
+    try {
-        downloadManager.download(blob, url, filename, sourceEventType);
+      this._ensureDownloadComplete();
-      })
+
-      .catch(downloadByUrl); // Error occurred, try downloading with the URL.
+      const data = await this.pdfDocument.getData();
+      const blob = new Blob([data], { type: "application/pdf" });
+
+      await this.downloadManager.download(blob, url, filename, sourceEventType);
+    } catch (reason) {
+      // When the PDF document isn't ready, or the PDF file is still
+      // downloading, simply download using the URL.
+      await this.downloadManager.downloadUrl(url, filename);
+    }
   },
 
   async save({ sourceEventType = "download" } = {}) {
     if (this._saveInProgress) {
       return;
     }
-
-    const downloadManager = this.downloadManager,
-      url = this.baseUrl,
-      filename = this._docFilename;
-
-    // When the PDF document isn't ready, or the PDF file is still downloading,
-    // simply download using the URL.
-    if (!this.pdfDocument || !this.downloadComplete) {
-      this.download({ sourceEventType });
-      return;
-    }
     this._saveInProgress = true;
     await this.pdfScriptingManager.dispatchWillSave();
 
-    this.pdfDocument
+    const url = this.baseUrl,
-      .saveDocument(this.pdfDocument.annotationStorage)
+      filename = this._docFilename;
-      .then(data => {
+    try {
-        const blob = new Blob([data], { type: "application/pdf" });
+      this._ensureDownloadComplete();
-        downloadManager.download(blob, url, filename, sourceEventType);
+
-      })
+      const data = await this.pdfDocument.saveDocument(
-      .catch(() => {
+        this.pdfDocument.annotationStorage
-        this.download({ sourceEventType });
+      );
-      })
+      const blob = new Blob([data], { type: "application/pdf" });
-      .finally(async () => {
+
-        await this.pdfScriptingManager.dispatchDidSave();
+      await this.downloadManager.download(blob, url, filename, sourceEventType);
-        this._saveInProgress = false;
+    } catch (reason) {
-      });
+      // When the PDF document isn't ready, or the PDF file is still
+      // downloading, simply fallback to a "regular" download.
+      await this.download({ sourceEventType });
+    } finally {
+      await this.pdfScriptingManager.dispatchDidSave();
+      this._saveInProgress = false;
+    }
   },
 
   downloadOrSave(options) {
@@ -1710,11 +1717,19 @@ const PDFViewerApplication = {
     }
     const { annotationStorage } = pdfDocument;
 
-    annotationStorage.onSetModified = function () {
+    annotationStorage.onSetModified = () => {
       window.addEventListener("beforeunload", beforeUnload);
+
+      if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
+        this._annotationStorageModified = true;
+      }
     };
-    annotationStorage.onResetModified = function () {
+    annotationStorage.onResetModified = () => {
       window.removeEventListener("beforeunload", beforeUnload);
+
+      if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
+        delete this._annotationStorageModified;
+      }
     };
   },