5b94ed5487
Prior to PR 11601, the `disableCreateObjectURL` option was present on `getDocument` in the API, since it was (potentially) used when decoding JPEG images natively in the browser. Hence setting this option, which was done automatically using compatibility-code, were in some browsers necessary in order for e.g. JPEG images to be correctly rendered. The downside of the `disableCreateObjectURL` option is that memory usage increases significantly, since we're forced to build and use `data:` URIs (rather than `blob:` URLs). However, at this point in time the `disableCreateObjectURL` option is only necessary for *some* (non-essential) functionality in the default viewer; in particular: - The openfile functionality, used only when manually opening a new file in the default viewer. - The download functionality, used when downloading either the PDF document itself or its attached files (if such exists). - The print functionality, in the generic `PDFPrintService` implementation. Hence neither the general PDF.js library, nor the *basic* functionality of the default viewer, depends on the `disableCreateObjectURL` option any more; which is why I'm thus proposing that we remove the option since using it is a performance footgun. *Please note:* To not outright break currently "supported" browsers, which lack proper `URL.createObjectURL` support, this patch purposely keeps the compatibility-code to explicitly disable `URL.createObjectURL` usage *only* for browsers which are known to not work correctly.[1] While it's certainly possible that there's additional, likely older, browsers with broken `URL.createObjectURL` support, the last time that these types of problems were reported was over *three* years ago.[2] Hence in the *very* unlikely event that additional problems occur, as a result of these changes, we can either add a new case in the compatibility-code or simply declare the affected browser as unsupported. --- [1] Which are IE11 (see issue 3977), and Google Chrome on iOS (see PR 8081). [2] Given that `URL.createObjectURL` is used by default, you'd really expect more reports if these problems were widespread.
88 lines
2.6 KiB
JavaScript
88 lines
2.6 KiB
JavaScript
/* Copyright 2013 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 { createObjectURL, createValidAbsoluteUrl } from "pdfjs-lib";
|
|
import { viewerCompatibilityParams } from "./viewer_compatibility.js";
|
|
|
|
if (typeof PDFJSDev !== "undefined" && !PDFJSDev.test("CHROME || GENERIC")) {
|
|
throw new Error(
|
|
'Module "pdfjs-web/download_manager" shall not be used ' +
|
|
"outside CHROME and GENERIC builds."
|
|
);
|
|
}
|
|
|
|
function download(blobUrl, filename) {
|
|
const a = document.createElement("a");
|
|
if (!a.click) {
|
|
throw new Error('DownloadManager: "a.click()" is not supported.');
|
|
}
|
|
a.href = blobUrl;
|
|
a.target = "_parent";
|
|
// Use a.download if available. This increases the likelihood that
|
|
// the file is downloaded instead of opened by another PDF plugin.
|
|
if ("download" in a) {
|
|
a.download = filename;
|
|
}
|
|
// <a> must be in the document for IE and recent Firefox versions,
|
|
// otherwise .click() is ignored.
|
|
(document.body || document.documentElement).appendChild(a);
|
|
a.click();
|
|
a.remove();
|
|
}
|
|
|
|
class DownloadManager {
|
|
downloadUrl(url, filename) {
|
|
if (!createValidAbsoluteUrl(url, "http://example.com")) {
|
|
return; // restricted/invalid URL
|
|
}
|
|
download(url + "#pdfjs.action=download", filename);
|
|
}
|
|
|
|
downloadData(data, filename, contentType) {
|
|
if (navigator.msSaveBlob) {
|
|
// IE10 and above
|
|
navigator.msSaveBlob(new Blob([data], { type: contentType }), filename);
|
|
return;
|
|
}
|
|
const blobUrl = createObjectURL(
|
|
data,
|
|
contentType,
|
|
viewerCompatibilityParams.disableCreateObjectURL
|
|
);
|
|
download(blobUrl, filename);
|
|
}
|
|
|
|
download(blob, url, filename) {
|
|
if (navigator.msSaveBlob) {
|
|
// IE10 / IE11
|
|
if (!navigator.msSaveBlob(blob, filename)) {
|
|
this.downloadUrl(url, filename);
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (viewerCompatibilityParams.disableCreateObjectURL) {
|
|
// URL.createObjectURL is not supported
|
|
this.downloadUrl(url, filename);
|
|
return;
|
|
}
|
|
|
|
const blobUrl = URL.createObjectURL(blob);
|
|
download(blobUrl, filename);
|
|
}
|
|
}
|
|
|
|
export { DownloadManager };
|