firefox-main/toolkit/actors/AboutPDFParent.sys.mjs (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { PdfJsFeaturesNotification } from "resource://pdf.js/PdfJsFeaturesNotification.sys.mjs";
const PDF_HEADER = "%PDF-";
const NOTIFICATION_COUNT_PREF = PdfJsFeaturesNotification.IMPRESSION_COUNT_PREF;
let ShellService = null;
try {
({ ShellService } = ChromeUtils.importESModule(
// eslint-disable-next-line mozilla/no-browser-refs-in-toolkit
"moz-src:///browser/components/shell/ShellService.sys.mjs"
));
} catch {}
const lazy = {};
ChromeUtils.defineLazyGetter(
lazy,
"l10n",
() => new Localization(["toolkit/about/aboutPDF.ftl"])
);
export class AboutPDFParent extends JSWindowActorParent {
#filePickerOpenPromise = null;
#notificationObserver = null;
receiveMessage(message) {
switch (message.name) {
case "AboutPDF:CanSetDefaultPDFHandler":
return this.#canSetDefaultPDFHandler();
case "AboutPDF:GoBack":
return this.#goBack();
case "AboutPDF:PickFile":
return this.#pickFile();
case "AboutPDF:SetDefaultPDFHandler":
return this.#setDefaultPDFHandler();
case "AboutPDF:ObserveNotificationPref":
return this.#observeNotificationPref();
case "AboutPDF:NotificationEligible":
return this.#notificationEligible();
case "AboutPDF:DismissNotification":
return PdfJsFeaturesNotification.consume();
}
return undefined;
}
// Granting eligibility claims an impression.
#notificationEligible() {
if (!PdfJsFeaturesNotification.isEligible()) {
return false;
}
PdfJsFeaturesNotification.recordImpression();
return true;
}
// Return whether a Back navigation was requested.
#goBack() {
const { browsingContext } = this;
if (browsingContext !== browsingContext.top) {
return false;
}
const browser = browsingContext.embedderElement;
if (!browser?.canGoBack) {
return false;
}
browser.goBack();
return true;
}
#observeNotificationPref() {
if (!this.#notificationObserver) {
this.#notificationObserver = {
// addObserver also observes descendants of this preference.
observe: (_subject, _topic, prefName) => {
if (prefName === NOTIFICATION_COUNT_PREF) {
this.#hideNotificationIfConsumed();
}
},
};
Services.prefs.addObserver(
NOTIFICATION_COUNT_PREF,
this.#notificationObserver
);
}
this.#hideNotificationIfConsumed();
}
#hideNotificationIfConsumed() {
if (PdfJsFeaturesNotification.isConsumed()) {
this.sendAsyncMessage("PDF:HideFeaturesNotification");
}
}
didDestroy() {
if (this.#notificationObserver) {
Services.prefs.removeObserver(
NOTIFICATION_COUNT_PREF,
this.#notificationObserver
);
this.#notificationObserver = null;
}
}
#canSetDefaultPDFHandler() {
if (!ShellService) {
return false;
}
try {
// canSetAsDefaultPDFHandler gates the platform/OS-version support (e.g.
// macOS 12+); only offer when supported and we aren't already default.
return (
ShellService.canSetAsDefaultPDFHandler &&
!ShellService.isDefaultHandlerFor(".pdf")
);
} catch {
return false;
}
}
// Never accept a path from content: this load uses the system principal.
// Native drop handling separately verifies dropped links against the drag
// session.
// Returns "opened", "canceled", or "invalid".
async #pickFile() {
if (this.#filePickerOpenPromise) {
return "canceled";
}
let browsingContext = this.browsingContext.top;
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
fp.init(
this.browsingContext,
await lazy.l10n.formatValue("about-pdf-file-picker-title"),
Ci.nsIFilePicker.modeOpen
);
fp.appendFilters(Ci.nsIFilePicker.filterPDF);
fp.appendFilters(Ci.nsIFilePicker.filterAll);
let result;
const { promise, resolve } = Promise.withResolvers();
this.#filePickerOpenPromise = promise;
try {
fp.open(resolve);
result = await this.#filePickerOpenPromise;
} finally {
this.#filePickerOpenPromise = null;
}
if (result !== Ci.nsIFilePicker.returnOK) {
return "canceled";
}
let file = fp.file;
if (
!file?.leafName.toLowerCase().endsWith(".pdf") ||
!(await this.#looksLikePDF(file))
) {
return "invalid";
}
if (browsingContext.isDiscarded) {
return "canceled";
}
browsingContext.loadURI(fp.fileURL, {
triggeringPrincipal: Services.scriptSecurityManager.getSystemPrincipal(),
});
return "opened";
}
async #setDefaultPDFHandler() {
if (!this.#canSetDefaultPDFHandler()) {
return false;
}
// setAsDefaultPDFHandler only reports that the attempt was made (the user
// may decline the OS prompt), so query the actual state to tell the page
// whether Firefox is now the default.
await ShellService.setAsDefaultPDFHandler();
return ShellService.isDefaultHandlerFor(".pdf");
}
async #looksLikePDF(file) {
try {
let bytes = await IOUtils.read(file.path, {
maxBytes: PDF_HEADER.length,
});
return new TextDecoder().decode(bytes) === PDF_HEADER;
} catch {
return false;
}
}
}