diff options
Diffstat (limited to 'toolkit/mozapps/handling')
-rw-r--r-- | toolkit/mozapps/handling/ContentDispatchChooser.jsm | 595 | ||||
-rw-r--r-- | toolkit/mozapps/handling/components.conf | 14 | ||||
-rw-r--r-- | toolkit/mozapps/handling/content/appChooser.js | 387 | ||||
-rw-r--r-- | toolkit/mozapps/handling/content/appChooser.xhtml | 50 | ||||
-rw-r--r-- | toolkit/mozapps/handling/content/handler.css | 31 | ||||
-rw-r--r-- | toolkit/mozapps/handling/content/permissionDialog.js | 195 | ||||
-rw-r--r-- | toolkit/mozapps/handling/content/permissionDialog.xhtml | 41 | ||||
-rw-r--r-- | toolkit/mozapps/handling/jar.mn | 11 | ||||
-rw-r--r-- | toolkit/mozapps/handling/moz.build | 18 |
9 files changed, 1342 insertions, 0 deletions
diff --git a/toolkit/mozapps/handling/ContentDispatchChooser.jsm b/toolkit/mozapps/handling/ContentDispatchChooser.jsm new file mode 100644 index 0000000000..520189bbd5 --- /dev/null +++ b/toolkit/mozapps/handling/ContentDispatchChooser.jsm @@ -0,0 +1,595 @@ +/* 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/. */ + +// Constants + +const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm"); +const { XPCOMUtils } = ChromeUtils.import( + "resource://gre/modules/XPCOMUtils.jsm" +); + +const DIALOG_URL_APP_CHOOSER = + "chrome://mozapps/content/handling/appChooser.xhtml"; +const DIALOG_URL_PERMISSION = + "chrome://mozapps/content/handling/permissionDialog.xhtml"; + +var EXPORTED_SYMBOLS = [ + "nsContentDispatchChooser", + "ContentDispatchChooserTelemetry", +]; + +const PROTOCOL_HANDLER_OPEN_PERM_KEY = "open-protocol-handler"; +const PERMISSION_KEY_DELIMITER = "^"; + +let ContentDispatchChooserTelemetry = { + /** + * Maps protocol scheme to telemetry label. + */ + SCHEME_TO_LABEL: { + bingmaps: "BING", + bingweather: "BING", + fb: "FACEBOOK", + fbmessenger: "FACEBOOK", + findmy: "APPLE_FINDMY", + findmyfriends: "APPLE_FINDMY", + fmf1: "APPLE_FINDMY", + fmip1: "APPLE_FINDMY", + git: "GIT", + "git-client": "GIT", + grenada: "APPLE_FINDMY", + ichat: "IMESSAGE", + im: "INSTANT_MESSAGE", + imessage: "IMESSAGE", + ipp: "IPP", + ipps: "IPP", + irc: "IRC", + irc6: "IRC", + ircs: "IRC", + itals: "APPLE_LIVESTREAM", + italss: "APPLE_LIVESTREAM", + itls: "APPLE_LIVESTREAM", + itlss: "APPLE_LIVESTREAM", + itms: "APPLE_MUSIC", + itmss: "APPLE_MUSIC", + itsradio: "APPLE_MUSIC", + itunes: "APPLE_MUSIC", + itunesradio: "APPLE_MUSIC", + itvls: "APPLE_LIVESTREAM", + itvlss: "APPLE_LIVESTREAM", + macappstore: "MACAPPSTORE", + macappstores: "MACAPPSTORE", + map: "MAP", + mapitem: "MAP", + maps: "MAP", + message: "MESSAGE", + messages: "MESSAGE", + microsoftmusic: "MICROSOFT_APP", + microsoftvideo: "MICROSOFT_APP", + mswindowsmusic: "MICROSOFT_APP", + music: "MUSIC", + musics: "MUSIC", + onenote: "ONENOTE", + "onenote-cmd": "ONENOTE", + pcast: "PODCAST", + podcast: "PODCAST", + podcasts: "PODCAST", + search: "SEARCH", + "search-ms": "SEARCH", + sip: "SIP", + sips: "SIP", + skype: "SKYPE", + "skype-meetnow": "SKYPE", + skypewin: "SKYPE", + tg: "TELEGRAM", + tv: "TELEVISION", + zoommtg: "ZOOM", + zoompbx: "ZOOM", + zoomus: "ZOOM", + zune: "MICROSOFT_APP", + }, + + /** + * Maps protocol scheme prefix to telemetry label. + */ + SCHEME_PREFIX_TO_LABEL: { + apple: "APPLE", + "com.microsoft": "MICROSOFT_APP", + facetime: "FACETIME", + "fb-messenger": "FACEBOOK", + icloud: "ICLOUD", + "itms-": "APPLE_MUSIC", + microsoft: "MICROSOFT_APP", + "ms-": "MICROSOFT_APP", + outlook: "OUTLOOK", + photos: "PHOTOS", + "web+": "WEBHANDLER", + windows: "WINDOWS_PREFIX", + "x-apple": "APPLE", + xbox: "XBOX", + }, + + /** + * Sandbox flags for telemetry + * Copied from nsSandboxFlags.h + */ + SANDBOXED_AUXILIARY_NAVIGATION: 0x2, + SANDBOXED_TOPLEVEL_NAVIGATION: 0x4, + SANDBOXED_TOPLEVEL_NAVIGATION_USER_ACTIVATION: 0x20000, + + /** + * Lazy getter for labels of the external protocol navigation telemetry probe. + * @returns {string[]} - An array of histogram labels. + */ + get _telemetryLabels() { + if (!this._telemetryLabelArray) { + this._telemetryLabelArray = Services.telemetry.getCategoricalLabels().EXTERNAL_PROTOCOL_HANDLER_DIALOG_CONTEXT_SCHEME; + } + return this._telemetryLabelArray; + }, + + /** + * Get histogram label by protocol scheme. + * @param {string} aScheme - Protocol scheme to map to histogram label. + * @returns {string} - Label. + */ + _getTelemetryLabel(aScheme) { + if (!aScheme) { + throw new Error("Invalid scheme"); + } + let labels = this._telemetryLabels; + + // Custom scheme-to-label mappings + let mappedLabel = this.SCHEME_TO_LABEL[aScheme]; + if (mappedLabel) { + return mappedLabel; + } + + // Prefix mappings + for (let prefix of Object.keys(this.SCHEME_PREFIX_TO_LABEL)) { + if (aScheme.startsWith(prefix)) { + return this.SCHEME_PREFIX_TO_LABEL[prefix]; + } + } + + // Test if we have a label for the protocol scheme. + // If not, we use the "OTHER" label. + if (labels.includes(aScheme)) { + return aScheme; + } + + return "OTHER"; + }, + + /** + * Determine if a load was triggered from toplevel or an iframe + * (cross origin, same origin, sandboxed). + * + * @param {BrowsingContext} [aBrowsingContext] - Context of the load. + * @param {nsIPrincipal} [aTriggeringPrincipal] - Principal which triggered + * the load. + * @returns {string} - Histogram key. May return "UNKNOWN". + */ + _getTelemetryKey(aBrowsingContext, aTriggeringPrincipal) { + if (!aBrowsingContext) { + return "UNKNOWN"; + } + if (aBrowsingContext.top == aBrowsingContext) { + return "TOPLEVEL"; + } + + let { sandboxFlags } = aBrowsingContext; + if (sandboxFlags) { + // Iframe is sandboxed. Determine whether it sets allow flags relevant + // for the external protocol navigation. + if ( + !(sandboxFlags & this.SANDBOXED_TOPLEVEL_NAVIGATION) || + !(sandboxFlags & this.SANDBOXED_TOPLEVEL_NAVIGATION_USER_ACTIVATION) || + !(sandboxFlags & this.SANDBOXED_AUXILIARY_NAVIGATION) + ) { + return "SUB_SANDBOX_ALLOW"; + } + return "SUB_SANDBOX_NOALLOW"; + } + + // We're in a frame, check if the frame is cross origin with the top context. + if (!aTriggeringPrincipal) { + return "UNKNOWN"; + } + + let topLevelPrincipal = + aBrowsingContext.top.embedderElement?.contentPrincipal; + if (!topLevelPrincipal) { + return "UNKNOWN"; + } + + if (topLevelPrincipal.isThirdPartyPrincipal(aTriggeringPrincipal)) { + return "SUB_CROSSORIGIN"; + } + + return "SUB_SAMEORIGIN"; + }, + + /** + * Record telemetry for the external protocol handler dialog. + * @param {string} aScheme - Scheme of the protocol being loaded. + * @param {BrowsingContext} [aBrowsingContext] - Context of the load. + * @param {nsIPrincipal} [aTriggeringPrincipal] - Principal which triggered + * the load. + */ + recordTelemetry(aScheme, aBrowsingContext, aTriggeringPrincipal) { + let type = this._getTelemetryKey(aBrowsingContext, aTriggeringPrincipal); + let label = this._getTelemetryLabel(aScheme); + + Services.telemetry + .getKeyedHistogramById("EXTERNAL_PROTOCOL_HANDLER_DIALOG_CONTEXT_SCHEME") + .add(type, label); + }, +}; + +class nsContentDispatchChooser { + /** + * Prompt the user to open an external application. + * If the triggering principal doesn't have permission to open apps for the + * protocol of aURI, we show a permission prompt first. + * If the caller has permission and a preferred handler is set, we skip the + * dialogs and directly open the handler. + * @param {nsIHandlerInfo} aHandler - Info about protocol and handlers. + * @param {nsIURI} aURI - URI to be handled. + * @param {nsIPrincipal} [aPrincipal] - Principal which triggered the load. + * @param {BrowsingContext} [aBrowsingContext] - Context of the load. + */ + async handleURI(aHandler, aURI, aPrincipal, aBrowsingContext) { + let callerHasPermission = this._hasProtocolHandlerPermission( + aHandler.type, + aPrincipal + ); + + // Skip the dialog if a preferred application is set and the caller has + // permission. + if ( + callerHasPermission && + !aHandler.alwaysAskBeforeHandling && + (aHandler.preferredAction == Ci.nsIHandlerInfo.useHelperApp || + aHandler.preferredAction == Ci.nsIHandlerInfo.useSystemDefault) + ) { + try { + aHandler.launchWithURI(aURI, aBrowsingContext); + } catch (error) { + // We are not supposed to ask, but when file not found the user most likely + // uninstalled the application which handles the uri so we will continue + // by application chooser dialog. + if (error.result == Cr.NS_ERROR_FILE_NOT_FOUND) { + aHandler.alwaysAskBeforeHandling = true; + } else { + throw error; + } + } + } + + // We will show a prompt, record telemetry. + try { + ContentDispatchChooserTelemetry.recordTelemetry( + aHandler.type, + aBrowsingContext, + aPrincipal + ); + } catch (error) { + Cu.reportError(error); + } + + let shouldOpenHandler = false; + try { + shouldOpenHandler = await this._prompt( + aHandler, + aPrincipal, + callerHasPermission, + aBrowsingContext + ); + } catch (error) { + Cu.reportError(error.message); + } + + if (!shouldOpenHandler) { + return; + } + + // Site was granted permission and user chose to open application. + // Launch the external handler. + aHandler.launchWithURI(aURI, aBrowsingContext); + } + + /** + * Get the name of the application set to handle the the protocol. + * @param {nsIHandlerInfo} aHandler - Info about protocol and handlers. + * @returns {string|null} - Human readable handler name or null if the user + * is expected to set a handler. + */ + _getHandlerName(aHandler) { + if (aHandler.alwaysAskBeforeHandling) { + return null; + } + if ( + aHandler.preferredAction == Ci.nsIHandlerInfo.useSystemDefault && + aHandler.hasDefaultHandler + ) { + return aHandler.defaultDescription; + } + return aHandler.preferredApplicationHandler?.name; + } + + /** + * Show permission or/and app chooser prompt. + * @param {nsIHandlerInfo} aHandler - Info about protocol and handlers. + * @param {nsIPrincipal} aPrincipal - Principal which triggered the load. + * @param {boolean} aHasPermission - Whether the caller has permission to + * open the protocol. + * @param {BrowsingContext} [aBrowsingContext] - Context associated with the + * protocol navigation. + */ + async _prompt(aHandler, aPrincipal, aHasPermission, aBrowsingContext) { + let shouldOpenHandler = false; + let resetHandlerChoice = false; + + // If caller does not have permission, prompt the user. + if (!aHasPermission) { + let canPersistPermission = this._isSupportedPrincipal(aPrincipal); + + let outArgs = Cc["@mozilla.org/hash-property-bag;1"].createInstance( + Ci.nsIWritablePropertyBag + ); + // Whether the permission request was granted + outArgs.setProperty("granted", false); + // If the user wants to select a new application for the protocol. + // This will cause us to show the chooser dialog, even if an app is set. + outArgs.setProperty("resetHandlerChoice", null); + // If the we should store the permission and not prompt again for it. + outArgs.setProperty("remember", null); + + await this._openDialog( + DIALOG_URL_PERMISSION, + { + handler: aHandler, + principal: aPrincipal, + browsingContext: aBrowsingContext, + outArgs, + canPersistPermission, + preferredHandlerName: this._getHandlerName(aHandler), + }, + aBrowsingContext + ); + if (!outArgs.getProperty("granted")) { + // User denied request + return false; + } + + // Check if user wants to set a new application to handle the protocol. + resetHandlerChoice = outArgs.getProperty("resetHandlerChoice"); + + // If the user wants to select a new app we don't persist the permission. + if (!resetHandlerChoice && aPrincipal) { + let remember = outArgs.getProperty("remember"); + this._updatePermission(aPrincipal, aHandler.type, remember); + } + + shouldOpenHandler = true; + } + + // Prompt if the user needs to make a handler choice for the protocol. + if (aHandler.alwaysAskBeforeHandling || resetHandlerChoice) { + // User has not set a preferred application to handle this protocol scheme. + // Open the application chooser dialog + let outArgs = Cc["@mozilla.org/hash-property-bag;1"].createInstance( + Ci.nsIWritablePropertyBag + ); + outArgs.setProperty("openHandler", false); + outArgs.setProperty("preferredAction", aHandler.preferredAction); + outArgs.setProperty( + "preferredApplicationHandler", + aHandler.preferredApplicationHandler + ); + outArgs.setProperty( + "alwaysAskBeforeHandling", + aHandler.alwaysAskBeforeHandling + ); + let usePrivateBrowsing = aBrowsingContext?.usePrivateBrowsing; + await this._openDialog( + DIALOG_URL_APP_CHOOSER, + { + handler: aHandler, + outArgs, + usePrivateBrowsing, + enableButtonDelay: aHasPermission, + }, + aBrowsingContext + ); + + shouldOpenHandler = outArgs.getProperty("openHandler"); + + // If the user accepted the dialog, apply their selection. + if (shouldOpenHandler) { + for (let prop of [ + "preferredAction", + "preferredApplicationHandler", + "alwaysAskBeforeHandling", + ]) { + aHandler[prop] = outArgs.getProperty(prop); + } + + // Store handler data + Cc["@mozilla.org/uriloader/handler-service;1"] + .getService(Ci.nsIHandlerService) + .store(aHandler); + } + } + + return shouldOpenHandler; + } + + /** + * Test if a given principal has the open-protocol-handler permission for a + * specific protocol. + * @param {string} scheme - Scheme of the protocol. + * @param {nsIPrincipal} aPrincipal - Principal to test for permission. + * @returns {boolean} - true if permission is set, false otherwise. + */ + _hasProtocolHandlerPermission(scheme, aPrincipal) { + // Permission disabled by pref + if (!nsContentDispatchChooser.isPermissionEnabled) { + return true; + } + + // If a handler is set to open externally by default we skip the dialog. + if ( + Services.prefs.getBoolPref( + "network.protocol-handler.external." + scheme, + false + ) + ) { + return true; + } + + if (!aPrincipal) { + return false; + } + + if (aPrincipal.isAddonOrExpandedAddonPrincipal) { + return true; + } + + let key = this._getSkipProtoDialogPermissionKey(scheme); + return ( + Services.perms.testPermissionFromPrincipal(aPrincipal, key) === + Services.perms.ALLOW_ACTION + ); + } + + /** + * Get open-protocol-handler permission key for a protocol. + * @param {string} aProtocolScheme - Scheme of the protocol. + * @returns {string} - Permission key. + */ + _getSkipProtoDialogPermissionKey(aProtocolScheme) { + return ( + PROTOCOL_HANDLER_OPEN_PERM_KEY + + PERMISSION_KEY_DELIMITER + + aProtocolScheme + ); + } + + /** + * Opens a dialog as a SubDialog on tab level. + * If we don't have a BrowsingContext we will fallback to a standalone window. + * @param {string} aDialogURL - URL of the dialog to open. + * @param {Object} aDialogArgs - Arguments passed to the dialog. + * @param {BrowsingContext} [aBrowsingContext] - BrowsingContext associated + * with the tab the dialog is associated with. + */ + async _openDialog(aDialogURL, aDialogArgs, aBrowsingContext) { + // Make the app chooser dialog resizable + let resizable = `resizable=${ + aDialogURL == DIALOG_URL_APP_CHOOSER ? "yes" : "no" + }`; + + if (aBrowsingContext) { + if (!aBrowsingContext.topChromeWindow) { + throw new Error( + "Can't show external protocol dialog. BrowsingContext has no chrome window associated." + ); + } + + let window = aBrowsingContext.topChromeWindow; + let tabDialogBox = window.gBrowser.getTabDialogBox( + aBrowsingContext.embedderElement + ); + + return tabDialogBox.open( + aDialogURL, + { + features: resizable, + allowDuplicateDialogs: false, + keepOpenSameOriginNav: true, + }, + aDialogArgs + ); + } + + // If we don't have a BrowsingContext, we need to show a standalone window. + let win = Services.ww.openWindow( + null, + aDialogURL, + null, + `chrome,dialog=yes,centerscreen,${resizable}`, + aDialogArgs + ); + + // Wait until window is closed. + return new Promise(resolve => { + win.addEventListener("unload", function onUnload(event) { + if (event.target.location != aDialogURL) { + return; + } + win.removeEventListener("unload", onUnload); + resolve(); + }); + }); + } + + /** + * Update the open-protocol-handler permission for the site which triggered + * the dialog. Sites with this permission may skip this dialog. + * @param {nsIPrincipal} aPrincipal - subject to update the permission for. + * @param {string} aScheme - Scheme of protocol to allow. + * @param {boolean} aAllow - Whether to set / unset the permission. + */ + _updatePermission(aPrincipal, aScheme, aAllow) { + // If enabled, store open-protocol-handler permission for content principals. + if ( + !nsContentDispatchChooser.isPermissionEnabled || + aPrincipal.isSystemPrincipal || + !this._isSupportedPrincipal(aPrincipal) + ) { + return; + } + + let permKey = this._getSkipProtoDialogPermissionKey(aScheme); + if (aAllow) { + Services.perms.addFromPrincipal( + aPrincipal, + permKey, + Services.perms.ALLOW_ACTION, + Services.perms.EXPIRE_NEVER + ); + } else { + Services.perms.removeFromPrincipal(aPrincipal, permKey); + } + } + + /** + * Determine if we can use a principal to store permissions. + * @param {nsIPrincipal} aPrincipal - Principal to test. + * @returns {boolean} - true if we can store permissions, false otherwise. + */ + _isSupportedPrincipal(aPrincipal) { + return ( + aPrincipal && + ["http", "https", "moz-extension", "file"].some(scheme => + aPrincipal.schemeIs(scheme) + ) + ); + } +} + +nsContentDispatchChooser.prototype.classID = Components.ID( + "e35d5067-95bc-4029-8432-e8f1e431148d" +); +nsContentDispatchChooser.prototype.QueryInterface = ChromeUtils.generateQI([ + "nsIContentDispatchChooser", +]); + +XPCOMUtils.defineLazyPreferenceGetter( + nsContentDispatchChooser, + "isPermissionEnabled", + "security.external_protocol_requires_permission", + true +); diff --git a/toolkit/mozapps/handling/components.conf b/toolkit/mozapps/handling/components.conf new file mode 100644 index 0000000000..087c4cf7d2 --- /dev/null +++ b/toolkit/mozapps/handling/components.conf @@ -0,0 +1,14 @@ +# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*- +# vim: set filetype=python: +# 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/. + +Classes = [ + { + 'cid': '{e35d5067-95bc-4029-8432-e8f1e431148d}', + 'contract_ids': ['@mozilla.org/content-dispatch-chooser;1'], + 'jsm': 'resource://gre/modules/ContentDispatchChooser.jsm', + 'constructor': 'nsContentDispatchChooser', + }, +] diff --git a/toolkit/mozapps/handling/content/appChooser.js b/toolkit/mozapps/handling/content/appChooser.js new file mode 100644 index 0000000000..3c532d9285 --- /dev/null +++ b/toolkit/mozapps/handling/content/appChooser.js @@ -0,0 +1,387 @@ +/* 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/. */ + +const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm"); +const { PrivateBrowsingUtils } = ChromeUtils.import( + "resource://gre/modules/PrivateBrowsingUtils.jsm" +); +const { EnableDelayHelper } = ChromeUtils.import( + "resource://gre/modules/SharedPromptUtils.jsm" +); + +class MozHandler extends window.MozElements.MozRichlistitem { + static get markup() { + return ` + <vbox pack="center"> + <image height="32" width="32"/> + </vbox> + <vbox flex="1"> + <label class="name"/> + <label class="description"/> + </vbox> + `; + } + + connectedCallback() { + this.textContent = ""; + this.appendChild(this.constructor.fragment); + this.initializeAttributeInheritance(); + } + + static get inheritedAttributes() { + return { + image: "src=image,disabled", + ".name": "value=name,disabled", + ".description": "value=description,disabled", + }; + } + + get label() { + return `${this.getAttribute("name")} ${this.getAttribute("description")}`; + } +} + +customElements.define("mozapps-handler", MozHandler, { + extends: "richlistitem", +}); + +window.addEventListener("DOMContentLoaded", () => dialog.initialize(), { + once: true, +}); + +let loadPromise = new Promise(resolve => { + window.addEventListener("load", resolve, { once: true }); +}); + +let dialog = { + /** + * This function initializes the content of the dialog. + */ + initialize() { + let args = window.arguments[0].wrappedJSObject || window.arguments[0]; + let { handler, outArgs, usePrivateBrowsing, enableButtonDelay } = args; + + this._handlerInfo = handler.QueryInterface(Ci.nsIHandlerInfo); + this._outArgs = outArgs; + + this.isPrivate = + usePrivateBrowsing || + (window.opener && PrivateBrowsingUtils.isWindowPrivate(window.opener)); + + this._dialog = document.querySelector("dialog"); + this._itemChoose = document.getElementById("item-choose"); + this._rememberCheck = document.getElementById("remember"); + + // Register event listener for the checkbox hint. + this._rememberCheck.addEventListener("change", () => this.onCheck()); + + document.addEventListener("dialogaccept", () => { + this.onAccept(); + }); + + // UI is ready, lets populate our list + this.populateList(); + + document.mozSubdialogReady = this.initL10n().then(() => { + window.sizeToContent(); + }); + + if (enableButtonDelay) { + this._delayHelper = new EnableDelayHelper({ + disableDialog: () => { + this._acceptBtnDisabled = true; + this.updateAcceptButton(); + }, + enableDialog: () => { + this._acceptBtnDisabled = false; + this.updateAcceptButton(); + }, + focusTarget: window, + }); + } + }, + + async initL10n() { + document.l10n.pauseObserving(); + + let rememberLabel = document.getElementById("remember-label"); + document.l10n.setAttributes(rememberLabel, "chooser-dialog-remember", { + scheme: this._handlerInfo.type, + }); + + let description = document.getElementById("description"); + document.l10n.setAttributes(description, "chooser-dialog-description", { + scheme: this._handlerInfo.type, + }); + + document.l10n.resumeObserving(); + + await document.l10n.translateElements([rememberLabel, description]); + return document.l10n.ready; + }, + + /** + * Populates the list that a user can choose from. + */ + populateList: function populateList() { + var items = document.getElementById("items"); + var possibleHandlers = this._handlerInfo.possibleApplicationHandlers; + var preferredHandler = this._handlerInfo.preferredApplicationHandler; + for (let i = possibleHandlers.length - 1; i >= 0; --i) { + let app = possibleHandlers.queryElementAt(i, Ci.nsIHandlerApp); + let elm = document.createXULElement("richlistitem", { + is: "mozapps-handler", + }); + elm.setAttribute("name", app.name); + elm.obj = app; + + // We defer loading the favicon so it doesn't delay load. The dialog is + // opened in a SubDialog which will only show on window load. + if (app instanceof Ci.nsILocalHandlerApp) { + // See if we have an nsILocalHandlerApp and set the icon + let uri = Services.io.newFileURI(app.executable); + loadPromise.then(() => { + elm.setAttribute("image", "moz-icon://" + uri.spec + "?size=32"); + }); + } else if (app instanceof Ci.nsIWebHandlerApp) { + let uri = Services.io.newURI(app.uriTemplate); + if (/^https?$/.test(uri.scheme)) { + // Unfortunately we can't use the favicon service to get the favicon, + // because the service looks for a record with the exact URL we give + // it, and users won't have such records for URLs they don't visit, + // and users won't visit the handler's URL template, they'll only + // visit URLs derived from that template (i.e. with %s in the template + // replaced by the URL of the content being handled). + loadPromise.then(() => { + elm.setAttribute("image", uri.prePath + "/favicon.ico"); + }); + } + elm.setAttribute("description", uri.prePath); + + // Check for extensions needing private browsing access before + // creating UI elements. + if (this.isPrivate) { + let policy = WebExtensionPolicy.getByURI(uri); + if (policy && !policy.privateBrowsingAllowed) { + elm.setAttribute("disabled", true); + this.getPrivateBrowsingDisabledLabel().then(label => { + elm.setAttribute("description", label); + }); + if (app == preferredHandler) { + preferredHandler = null; + } + } + } + } else if (app instanceof Ci.nsIDBusHandlerApp) { + elm.setAttribute("description", app.method); + } else if (!(app instanceof Ci.nsIGIOMimeApp)) { + // We support GIO application handler, but no action required there + throw new Error("unknown handler type"); + } + + items.insertBefore(elm, this._itemChoose); + if (preferredHandler && app == preferredHandler) { + this.selectedItem = elm; + } + } + + if (this._handlerInfo.hasDefaultHandler) { + let elm = document.createXULElement("richlistitem", { + is: "mozapps-handler", + }); + elm.id = "os-default-handler"; + elm.setAttribute("name", this._handlerInfo.defaultDescription); + + items.insertBefore(elm, items.firstChild); + if ( + this._handlerInfo.preferredAction == Ci.nsIHandlerInfo.useSystemDefault + ) { + this.selectedItem = elm; + } + } + + // Add gio handlers + if (Cc["@mozilla.org/gio-service;1"]) { + let gIOSvc = Cc["@mozilla.org/gio-service;1"].getService( + Ci.nsIGIOService + ); + var gioApps = gIOSvc.getAppsForURIScheme(this._handlerInfo.type); + for (let handler of gioApps.enumerate(Ci.nsIHandlerApp)) { + // OS handler share the same name, it's most likely the same app, skipping... + if (handler.name == this._handlerInfo.defaultDescription) { + continue; + } + // Check if the handler is already in possibleHandlers + let appAlreadyInHandlers = false; + for (let i = possibleHandlers.length - 1; i >= 0; --i) { + let app = possibleHandlers.queryElementAt(i, Ci.nsIHandlerApp); + // nsGIOMimeApp::Equals is able to compare with nsILocalHandlerApp + if (handler.equals(app)) { + appAlreadyInHandlers = true; + break; + } + } + if (!appAlreadyInHandlers) { + let elm = document.createXULElement("richlistitem", { + is: "mozapps-handler", + }); + elm.setAttribute("name", handler.name); + elm.obj = handler; + items.insertBefore(elm, this._itemChoose); + } + } + } + + items.ensureSelectedElementIsVisible(); + }, + + /** + * Brings up a filepicker and allows a user to choose an application. + */ + async chooseApplication() { + let title = await this.getChooseAppWindowTitle(); + + var fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker); + fp.init(window, title, Ci.nsIFilePicker.modeOpen); + fp.appendFilters(Ci.nsIFilePicker.filterApps); + + fp.open(rv => { + if (rv == Ci.nsIFilePicker.returnOK && fp.file) { + let uri = Services.io.newFileURI(fp.file); + + let handlerApp = Cc[ + "@mozilla.org/uriloader/local-handler-app;1" + ].createInstance(Ci.nsILocalHandlerApp); + handlerApp.executable = fp.file; + + // if this application is already in the list, select it and don't add it again + let parent = document.getElementById("items"); + for (let i = 0; i < parent.childNodes.length; ++i) { + let elm = parent.childNodes[i]; + if ( + elm.obj instanceof Ci.nsILocalHandlerApp && + elm.obj.equals(handlerApp) + ) { + parent.selectedItem = elm; + parent.ensureSelectedElementIsVisible(); + return; + } + } + + let elm = document.createXULElement("richlistitem", { + is: "mozapps-handler", + }); + elm.setAttribute("name", fp.file.leafName); + elm.setAttribute("image", "moz-icon://" + uri.spec + "?size=32"); + elm.obj = handlerApp; + + parent.selectedItem = parent.insertBefore(elm, parent.firstChild); + parent.ensureSelectedElementIsVisible(); + } + }); + }, + + /** + * Function called when the OK button is pressed. + */ + onAccept() { + this.updateHandlerData(this._rememberCheck.checked); + this._outArgs.setProperty("openHandler", true); + }, + + /** + * Determines if the accept button should be disabled or not + */ + updateAcceptButton() { + this._dialog.setAttribute( + "buttondisabledaccept", + this._acceptBtnDisabled || this._itemChoose.selected + ); + }, + + /** + * Update the handler info to reflect the user choice. + * @param {boolean} skipAsk - Whether we should persist the application + * choice and skip asking next time. + */ + updateHandlerData(skipAsk) { + // We need to make sure that the default is properly set now + if (this.selectedItem.obj) { + // default OS handler doesn't have this property + this._outArgs.setProperty( + "preferredAction", + Ci.nsIHandlerInfo.useHelperApp + ); + this._outArgs.setProperty( + "preferredApplicationHandler", + this.selectedItem.obj + ); + } else { + this._outArgs.setProperty( + "preferredAction", + Ci.nsIHandlerInfo.useSystemDefault + ); + } + this._outArgs.setProperty("alwaysAskBeforeHandling", !skipAsk); + }, + + /** + * Updates the UI based on the checkbox being checked or not. + */ + onCheck() { + if (document.getElementById("remember").checked) { + document.getElementById("remember-text").setAttribute("visible", "true"); + } else { + document.getElementById("remember-text").removeAttribute("visible"); + } + }, + + /** + * Function called when the user double clicks on an item of the list + */ + onDblClick: function onDblClick() { + if (this.selectedItem == this._itemChoose) { + this.chooseApplication(); + } else { + this._dialog.acceptDialog(); + } + }, + + // Getters / Setters + + /** + * Returns/sets the selected element in the richlistbox + */ + get selectedItem() { + return document.getElementById("items").selectedItem; + }, + set selectedItem(aItem) { + document.getElementById("items").selectedItem = aItem; + }, + + /** + * Lazy l10n getter for the title of the app chooser window + */ + async getChooseAppWindowTitle() { + if (!this._chooseAppWindowTitle) { + this._chooseAppWindowTitle = await document.l10n.formatValues([ + "choose-other-app-window-title", + ]); + } + return this._chooseAppWindowTitle; + }, + + /** + * Lazy l10n getter for handler menu items which are disabled due to private + * browsing. + */ + async getPrivateBrowsingDisabledLabel() { + if (!this._privateBrowsingDisabledLabel) { + this._privateBrowsingDisabledLabel = await document.l10n.formatValues([ + "choose-dialog-privatebrowsing-disabled", + ]); + } + return this._privateBrowsingDisabledLabel; + }, +}; diff --git a/toolkit/mozapps/handling/content/appChooser.xhtml b/toolkit/mozapps/handling/content/appChooser.xhtml new file mode 100644 index 0000000000..c96362f1e4 --- /dev/null +++ b/toolkit/mozapps/handling/content/appChooser.xhtml @@ -0,0 +1,50 @@ +<?xml version="1.0"?> +<?xml-stylesheet href="chrome://global/skin/global.css"?> +<?xml-stylesheet href="chrome://mozapps/content/handling/handler.css"?> +<?xml-stylesheet href="chrome://mozapps/skin/handling/handling.css"?> +<!-- 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/. --> + +<!DOCTYPE window> + +<window persist="width height screenX screenY" + aria-describedby="description-text" + xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" + xmlns:html="http://www.w3.org/1999/xhtml" + data-l10n-id="chooser-window" + data-l10n-attrs="style"> +<dialog id="handling" + buttons="accept,cancel" + defaultButton="none" + data-l10n-id="chooser-dialog" + data-l10n-attrs="buttonlabelaccept, buttonaccesskeyaccept"> + <linkset> + <html:link rel="localization" href="branding/brand.ftl"/> + <html:link rel="localization" href="toolkit/global/handlerDialog.ftl"/> + </linkset> + + <script src="chrome://mozapps/content/handling/appChooser.js" + type="application/javascript"/> + + <description id="description"/> + + <vbox id="chooser" flex="1"> + <richlistbox id="items" flex="1" + ondblclick="dialog.onDblClick();" + onselect="dialog.updateAcceptButton();"> + <richlistitem id="item-choose" orient="horizontal" selected="true"> + <label data-l10n-id="choose-other-app-description" flex="1"/> + <button oncommand="dialog.chooseApplication();" + data-l10n-id="choose-app-btn"/> + </richlistitem> + </richlistbox> + </vbox> + + <hbox id="rememberContainer"> + <html:input type="checkbox" id="remember"/> + <html:label id="remember-label" for="remember"></html:label> + <description id="remember-text" data-l10n-id="chooser-dialog-remember-extra"/> + </hbox> +</dialog> +</window> diff --git a/toolkit/mozapps/handling/content/handler.css b/toolkit/mozapps/handling/content/handler.css new file mode 100644 index 0000000000..0d9cfc7b68 --- /dev/null +++ b/toolkit/mozapps/handling/content/handler.css @@ -0,0 +1,31 @@ +/* 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/. */ + +#description { + font-weight: bold; +} + +#description-box, #chooser { + margin-bottom: 0.5em; +} + +#rememberContainer { + margin-bottom: 1em; +} + +#remember-text:not([visible]) { + visibility: hidden; +} + +#remember-text { + margin-top: 0.5em; +} + +#remember { + margin-inline-start: 6px; +} + +#remember-label, #remember { + vertical-align: middle; +} diff --git a/toolkit/mozapps/handling/content/permissionDialog.js b/toolkit/mozapps/handling/content/permissionDialog.js new file mode 100644 index 0000000000..336852cb3d --- /dev/null +++ b/toolkit/mozapps/handling/content/permissionDialog.js @@ -0,0 +1,195 @@ +/* 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/. */ + +const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm"); +const { EnableDelayHelper } = ChromeUtils.import( + "resource://gre/modules/SharedPromptUtils.jsm" +); + +let dialog = { + /** + * This function initializes the content of the dialog. + */ + initialize() { + let args = window.arguments[0].wrappedJSObject || window.arguments[0]; + let { + handler, + principal, + outArgs, + canPersistPermission, + preferredHandlerName, + browsingContext, + } = args; + + this._handlerInfo = handler.QueryInterface(Ci.nsIHandlerInfo); + this._principal = principal?.QueryInterface(Ci.nsIPrincipal); + this._browsingContext = browsingContext; + this._outArgs = outArgs.QueryInterface(Ci.nsIWritablePropertyBag); + this._preferredHandlerName = preferredHandlerName; + + this._dialog = document.querySelector("dialog"); + this._checkRemember = document.getElementById("remember"); + this._checkRememberContainer = document.getElementById("rememberContainer"); + + if (!canPersistPermission) { + this._checkRememberContainer.hidden = true; + } + + let changeAppLink = document.getElementById("change-app"); + if (this._preferredHandlerName) { + changeAppLink.hidden = false; + + changeAppLink.addEventListener("click", () => this.onChangeApp()); + } + + document.addEventListener("dialogaccept", () => this.onAccept()); + document.mozSubdialogReady = this.initL10n().then(() => { + window.sizeToContent(); + }); + + this._delayHelper = new EnableDelayHelper({ + disableDialog: () => { + this._dialog.setAttribute("buttondisabledaccept", true); + }, + enableDialog: () => { + this._dialog.setAttribute("buttondisabledaccept", false); + }, + focusTarget: window, + }); + }, + + /** + * Checks whether the principal that triggered this dialog is top level + * (not embedded in a frame). + * @returns {boolean} - true if principal is top level, false otherwise. + * If the triggering principal is null this method always returns false. + */ + triggeringPrincipalIsTop() { + let topContentPrincipal = this._browsingContext?.top.embedderElement + ?.contentPrincipal; + if (!topContentPrincipal) { + return false; + } + return this._principal.equals(topContentPrincipal); + }, + + /** + * Determines the l10n ID to use for the dialog description, depending on + * the triggering principal and the preferred application handler. + */ + get l10nDescriptionId() { + if (this._principal?.schemeIs("file")) { + if (this._preferredHandlerName) { + return "permission-dialog-description-file-app"; + } + return "permission-dialog-description-file"; + } + + // We only show the website address if the request didn't come from the top + // level frame. + if (this._principal?.exposablePrePath && !this.triggeringPrincipalIsTop()) { + if (this._preferredHandlerName) { + return "permission-dialog-description-host-app"; + } + return "permission-dialog-description-host"; + } + + if (this._preferredHandlerName) { + return "permission-dialog-description-app"; + } + + return "permission-dialog-description"; + }, + + /** + * Determines the l10n ID to use for the "remember permission" checkbox, + * depending on the triggering principal and the preferred application + * handler. + */ + get l10nCheckboxId() { + if (!this._principal) { + return null; + } + + if (this._principal.schemeIs("file")) { + return "permission-dialog-remember-file"; + } + return "permission-dialog-remember"; + }, + + async initL10n() { + // The UI labels depend on whether we will show the application chooser next + // or directly open the assigned protocol handler. + + // Fluent id for dialog accept button + let idAcceptButton; + if (this._preferredHandlerName) { + idAcceptButton = "permission-dialog-btn-open-link"; + } else { + idAcceptButton = "permission-dialog-btn-choose-app"; + + let descriptionExtra = document.getElementById("description-extra"); + descriptionExtra.hidden = false; + } + + let description = document.getElementById("description"); + + document.l10n.pauseObserving(); + let pendingElements = [description]; + + let host = this._principal?.exposablePrePath; + let scheme = this._handlerInfo.type; + + document.l10n.setAttributes(description, this.l10nDescriptionId, { + host, + scheme, + appName: this._preferredHandlerName, + }); + + if (!this._checkRememberContainer.hidden) { + let checkboxLabel = document.getElementById("remember-label"); + document.l10n.setAttributes(checkboxLabel, this.l10nCheckboxId, { + host, + scheme, + }); + pendingElements.push(checkboxLabel); + } + + // Set the dialog button labels. + // Ideally we would do this via attributes, however the <dialog> element + // does not support changing l10n ids on the fly. + let acceptButton = this._dialog.getButton("accept"); + let [result] = await document.l10n.formatMessages([{ id: idAcceptButton }]); + result.attributes.forEach(attr => { + if (attr.name == "label") { + acceptButton.label = attr.value; + } else { + acceptButton.accessKey = attr.value; + } + }); + + document.l10n.resumeObserving(); + + await document.l10n.translateElements(pendingElements); + return document.l10n.ready; + }, + + onAccept() { + this._outArgs.setProperty("remember", this._checkRemember.checked); + this._outArgs.setProperty("granted", true); + }, + + onChangeApp() { + this._outArgs.setProperty("resetHandlerChoice", true); + + // We can't call the dialogs accept handler here. If the accept button is + // still disabled, it will prevent closing. + this.onAccept(); + window.close(); + }, +}; + +window.addEventListener("DOMContentLoaded", () => dialog.initialize(), { + once: true, +}); diff --git a/toolkit/mozapps/handling/content/permissionDialog.xhtml b/toolkit/mozapps/handling/content/permissionDialog.xhtml new file mode 100644 index 0000000000..086e825c8e --- /dev/null +++ b/toolkit/mozapps/handling/content/permissionDialog.xhtml @@ -0,0 +1,41 @@ +<?xml version="1.0"?> +<?xml-stylesheet href="chrome://global/skin/global.css"?> +<?xml-stylesheet href="chrome://mozapps/content/handling/handler.css"?> +<!-- 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/. --> + +<!DOCTYPE window> + +<window aria-describedby="description" + xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" + xmlns:html="http://www.w3.org/1999/xhtml"> +<dialog buttons="accept,cancel" + defaultButton="none" + data-l10n-attrs="buttonlabelaccept, buttonaccesskeyaccept"> + <linkset> + <html:link rel="localization" href="toolkit/global/handlerDialog.ftl"/> + </linkset> + + <script src="chrome://mozapps/content/handling/permissionDialog.js" + type="application/javascript"/> + + + <vbox id="description-box"> + <description id="description"></description> + <label id="change-app" + hidden="true" + is="text-link" + data-l10n-id="permission-dialog-set-change-app-link"></label> + <description id="description-extra" + hidden="true" + data-l10n-id="permission-dialog-unset-description"> + </description> + </vbox> + + <hbox id="rememberContainer"> + <html:input type="checkbox" id="remember"/> + <html:label id="remember-label" for="remember"></html:label> + </hbox> +</dialog> +</window> diff --git a/toolkit/mozapps/handling/jar.mn b/toolkit/mozapps/handling/jar.mn new file mode 100644 index 0000000000..769c757ed7 --- /dev/null +++ b/toolkit/mozapps/handling/jar.mn @@ -0,0 +1,11 @@ +# 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/. + +toolkit.jar: +% content mozapps %content/mozapps/ + content/mozapps/handling/handler.css (content/handler.css) + content/mozapps/handling/appChooser.xhtml (content/appChooser.xhtml) + content/mozapps/handling/appChooser.js (content/appChooser.js) + content/mozapps/handling/permissionDialog.xhtml (content/permissionDialog.xhtml) + content/mozapps/handling/permissionDialog.js (content/permissionDialog.js) diff --git a/toolkit/mozapps/handling/moz.build b/toolkit/mozapps/handling/moz.build new file mode 100644 index 0000000000..a13b9f3437 --- /dev/null +++ b/toolkit/mozapps/handling/moz.build @@ -0,0 +1,18 @@ +# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*- +# vim: set filetype=python: +# 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/. + +with Files("**"): + BUG_COMPONENT = ("Firefox", "File Handling") + +EXTRA_JS_MODULES += [ + "ContentDispatchChooser.jsm", +] + +XPCOM_MANIFESTS += [ + "components.conf", +] + +JAR_MANIFESTS += ["jar.mn"] |