mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-22 17:55:50 +00:00
e930b89c34
*** Bug 1514594: Part 3a - Change ChromeUtils.import to return an exports object; not pollute global. r=mccr8 This changes the behavior of ChromeUtils.import() to return an exports object, rather than a module global, in all cases except when `null` is passed as a second argument, and changes the default behavior not to pollute the global scope with the module's exports. Thus, the following code written for the old model: ChromeUtils.import("resource://gre/modules/Services.jsm"); is approximately the same as the following, in the new model: var {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm"); Since the two behaviors are mutually incompatible, this patch will land with a scripted rewrite to update all existing callers to use the new model rather than the old. *** Bug 1514594: Part 3b - Mass rewrite all JS code to use the new ChromeUtils.import API. rs=Gijs This was done using the followng script: https://bitbucket.org/kmaglione/m-c-rewrites/src/tip/processors/cu-import-exports.jsm *** Bug 1514594: Part 3c - Update ESLint plugin for ChromeUtils.import API changes. r=Standard8 Differential Revision: https://phabricator.services.mozilla.com/D16747 *** Bug 1514594: Part 3d - Remove/fix hundreds of duplicate imports from sync tests. r=Gijs Differential Revision: https://phabricator.services.mozilla.com/D16748 *** Bug 1514594: Part 3e - Remove no-op ChromeUtils.import() calls. r=Gijs Differential Revision: https://phabricator.services.mozilla.com/D16749 *** Bug 1514594: Part 3f.1 - Cleanup various test corner cases after mass rewrite. r=Gijs *** Bug 1514594: Part 3f.2 - Cleanup various non-test corner cases after mass rewrite. r=Gijs Differential Revision: https://phabricator.services.mozilla.com/D16750 --HG-- extra : rebase_source : 359574ee3064c90f33bf36c2ebe3159a24cc8895 extra : histedit_source : b93c8f42808b1599f9122d7842d2c0b3e656a594%2C64a3a4e3359dc889e2ab2b49461bab9e27fc10a7
110 lines
4.2 KiB
JavaScript
110 lines
4.2 KiB
JavaScript
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
|
|
/* 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/. */
|
|
|
|
/* eslint no-unused-vars: ["error", {args: "none"}] */
|
|
|
|
var EXPORTED_SYMBOLS = ["WebChannelChild"];
|
|
|
|
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
|
|
const {ActorChild} = ChromeUtils.import("resource://gre/modules/ActorChild.jsm");
|
|
|
|
function getMessageManager(event) {
|
|
let window = Cu.getGlobalForObject(event.target);
|
|
|
|
return window.docShell.messageManager;
|
|
}
|
|
|
|
// Preference containing the list (space separated) of origins that are
|
|
// allowed to send non-string values through a WebChannel, mainly for
|
|
// backwards compatability. See bug 1238128 for more information.
|
|
const URL_WHITELIST_PREF = "webchannel.allowObject.urlWhitelist";
|
|
|
|
// Cached list of whitelisted principals, we avoid constructing this if the
|
|
// value in `_lastWhitelistValue` hasn't changed since we constructed it last.
|
|
let _cachedWhitelist = [];
|
|
let _lastWhitelistValue = "";
|
|
|
|
class WebChannelChild extends ActorChild {
|
|
handleEvent(event) {
|
|
if (event.type === "WebChannelMessageToChrome") {
|
|
return this._onMessageToChrome(event);
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
receiveMessage(msg) {
|
|
if (msg.name === "WebChannelMessageToContent") {
|
|
return this._onMessageToContent(msg);
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
_getWhitelistedPrincipals() {
|
|
let whitelist = Services.prefs.getCharPref(URL_WHITELIST_PREF);
|
|
if (whitelist != _lastWhitelistValue) {
|
|
let urls = whitelist.split(/\s+/);
|
|
_cachedWhitelist = urls.map(origin =>
|
|
Services.scriptSecurityManager.createCodebasePrincipalFromOrigin(origin));
|
|
}
|
|
return _cachedWhitelist;
|
|
}
|
|
|
|
_onMessageToChrome(e) {
|
|
// If target is window then we want the document principal, otherwise fallback to target itself.
|
|
let principal = e.target.nodePrincipal ? e.target.nodePrincipal : e.target.document.nodePrincipal;
|
|
|
|
if (e.detail) {
|
|
if (typeof e.detail != "string") {
|
|
// Check if the principal is one of the ones that's allowed to send
|
|
// non-string values for e.detail. They're whitelisted by site origin,
|
|
// so we compare on originNoSuffix in order to avoid other origin attributes
|
|
// that are not relevant here, such as containers or private browsing.
|
|
let objectsAllowed = this._getWhitelistedPrincipals().some(whitelisted =>
|
|
principal.originNoSuffix == whitelisted.originNoSuffix);
|
|
if (!objectsAllowed) {
|
|
Cu.reportError("WebChannelMessageToChrome sent with an object from a non-whitelisted principal");
|
|
return;
|
|
}
|
|
}
|
|
|
|
let mm = getMessageManager(e);
|
|
|
|
mm.sendAsyncMessage("WebChannelMessageToChrome", e.detail, { eventTarget: e.target }, principal);
|
|
} else {
|
|
Cu.reportError("WebChannel message failed. No message detail.");
|
|
}
|
|
}
|
|
|
|
_onMessageToContent(msg) {
|
|
if (msg.data) {
|
|
// msg.objects.eventTarget will be defined if sending a response to
|
|
// a WebChannelMessageToChrome event. An unsolicited send
|
|
// may not have an eventTarget defined, in this case send to the
|
|
// main content window.
|
|
let eventTarget = msg.objects.eventTarget || msg.target.content;
|
|
|
|
// Use nodePrincipal if available, otherwise fallback to document principal.
|
|
let targetPrincipal = eventTarget instanceof Ci.nsIDOMWindow ? eventTarget.document.nodePrincipal : eventTarget.nodePrincipal;
|
|
|
|
if (msg.principal.subsumes(targetPrincipal)) {
|
|
// If eventTarget is a window, use it as the targetWindow, otherwise
|
|
// find the window that owns the eventTarget.
|
|
let targetWindow = eventTarget instanceof Ci.nsIDOMWindow ? eventTarget : eventTarget.ownerGlobal;
|
|
|
|
eventTarget.dispatchEvent(new targetWindow.CustomEvent("WebChannelMessageToContent", {
|
|
detail: Cu.cloneInto({
|
|
id: msg.data.id,
|
|
message: msg.data.message,
|
|
}, targetWindow),
|
|
}));
|
|
} else {
|
|
Cu.reportError("WebChannel message failed. Principal mismatch.");
|
|
}
|
|
} else {
|
|
Cu.reportError("WebChannel message failed. No message data.");
|
|
}
|
|
}
|
|
}
|