Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run AnnotationStorage.resetModified when destroying the PDFDocumentLoadingTask/PDFDocumentProxy #12758

Merged
merged 3 commits into from
Dec 19, 2020
Merged

Run AnnotationStorage.resetModified when destroying the PDFDocumentLoadingTask/PDFDocumentProxy #12758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
958ea2b
Move the functionality of the `webViewerDownloadOrSave` function into…
Snuffleupagus Dec 19, 2020
517af6b
Delay initialization of the `AnnotationStorage` callbacks slightly in…
Snuffleupagus Dec 19, 2020
f9530e5
Run `AnnotationStorage.resetModified` when destroying the `PDFDocumen…
Snuffleupagus Dec 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/display/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,10 @@ class WorkerTransport {
this.setupMessageHandler();
}

get loadingTaskSettled() {
return this.loadingTask._capability.settled;
}

destroy() {
if (this.destroyCapability) {
return this.destroyCapability.promise;
Expand Down Expand Up @@ -2154,6 +2158,18 @@ class WorkerTransport {
// We also need to wait for the worker to finish its long running tasks.
const terminated = this.messageHandler.sendWithPromise("Terminate", null);
waitOn.push(terminated);
// Allow `AnnotationStorage`-related clean-up when destroying the document.
if (this.loadingTaskSettled) {
const annotationStorageResetModified = this.loadingTask.promise
.then(pdfDocument => {
// Avoid initializing the `annotationStorage` if it doesn't exist.
if (pdfDocument.hasOwnProperty("annotationStorage")) {
pdfDocument.annotationStorage.resetModified();
}
})
.catch(() => {});
waitOn.push(annotationStorageResetModified);
}
Promise.all(waitOn).then(() => {
this.commonObjs.clear();
this.fontLoader.clear();
Expand Down
48 changes: 28 additions & 20 deletions web/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1060,6 +1060,14 @@ const PDFViewerApplication = {
});
},

downloadOrSave(options) {
if (this.pdfDocument?.annotationStorage.size > 0) {
this.save(options);
} else {
this.download(options);
}
},

/**
* For PDF documents that contain e.g. forms and javaScript, we should only
* trigger the fallback bar once the user has interacted with the page.
Expand Down Expand Up @@ -1279,14 +1287,6 @@ const PDFViewerApplication = {
this.pdfLinkService.setDocument(pdfDocument, baseDocumentUrl);
this.pdfDocumentProperties.setDocument(pdfDocument, this.url);

const annotationStorage = pdfDocument.annotationStorage;
annotationStorage.onSetModified = function () {
window.addEventListener("beforeunload", beforeUnload);
};
annotationStorage.onResetModified = function () {
window.removeEventListener("beforeunload", beforeUnload);
};

const pdfViewer = this.pdfViewer;
pdfViewer.setDocument(pdfDocument);
const { firstPagePromise, onePageRendered, pagesPromise } = pdfViewer;
Expand Down Expand Up @@ -1314,6 +1314,7 @@ const PDFViewerApplication = {

firstPagePromise.then(pdfPage => {
this.loadingBar.setWidth(this.appConfig.viewerContainer);
this._initializeAnnotationStorageCallbacks(pdfDocument);

Promise.all([
animationStarted,
Expand Down Expand Up @@ -1870,6 +1871,23 @@ const PDFViewerApplication = {
}
},

/**
* @private
*/
_initializeAnnotationStorageCallbacks(pdfDocument) {
if (pdfDocument !== this.pdfDocument) {
return;
}
const { annotationStorage } = pdfDocument;

annotationStorage.onSetModified = function () {
window.addEventListener("beforeunload", beforeUnload);
};
annotationStorage.onResetModified = function () {
window.removeEventListener("beforeunload", beforeUnload);
};
},

setInitialView(
storedHash,
{ rotation, sidebarView, scrollMode, spreadMode } = {}
Expand Down Expand Up @@ -2712,21 +2730,11 @@ function webViewerPresentationMode() {
function webViewerPrint() {
PDFViewerApplication.triggerPrinting();
}
function webViewerDownloadOrSave(sourceEventType) {
if (
PDFViewerApplication.pdfDocument &&
PDFViewerApplication.pdfDocument.annotationStorage.size > 0
) {
PDFViewerApplication.save({ sourceEventType });
} else {
PDFViewerApplication.download({ sourceEventType });
}
}
function webViewerDownload() {
webViewerDownloadOrSave("download");
PDFViewerApplication.downloadOrSave({ sourceEventType: "download" });
}
function webViewerSave() {
webViewerDownloadOrSave("save");
PDFViewerApplication.downloadOrSave({ sourceEventType: "save" });
}
function webViewerFirstPage() {
if (PDFViewerApplication.pdfDocument) {
Expand Down