gecko-dev/toolkit/modules/PermissionsUtils.jsm
Kris Maglione e930b89c34 Bug 1514594: Part 3 - Change ChromeUtils.import API.
***
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
2019-01-17 10:18:31 -08:00

93 lines
3.3 KiB
JavaScript

// 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/.
var EXPORTED_SYMBOLS = ["PermissionsUtils"];
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
var gImportedPrefBranches = new Set();
function importPrefBranch(aPrefBranch, aPermission, aAction) {
let list = Services.prefs.getChildList(aPrefBranch, {});
for (let pref of list) {
let origins = Services.prefs.getCharPref(pref, "");
if (!origins)
continue;
origins = origins.split(",");
for (let origin of origins) {
let principals = [];
try {
principals = [ Services.scriptSecurityManager.createCodebasePrincipalFromOrigin(origin) ];
} catch (e) {
// This preference used to contain a list of hosts. For back-compat
// reasons, we convert these hosts into http:// and https:// permissions
// on default ports.
try {
let httpURI = Services.io.newURI("http://" + origin);
let httpsURI = Services.io.newURI("https://" + origin);
principals = [
Services.scriptSecurityManager.createCodebasePrincipal(httpURI, {}),
Services.scriptSecurityManager.createCodebasePrincipal(httpsURI, {}),
];
} catch (e2) {}
}
for (let principal of principals) {
try {
Services.perms.addFromPrincipal(principal, aPermission, aAction);
} catch (e) {}
}
}
Services.prefs.setCharPref(pref, "");
}
}
var PermissionsUtils = {
/**
* Import permissions from perferences to the Permissions Manager. After being
* imported, all processed permissions will be set to an empty string.
* Perferences are only processed once during the application's
* lifetime - it's safe to call this multiple times without worrying about
* doing unnecessary work, as the preferences branch will only be processed
* the first time.
*
* @param aPrefBranch Preferences branch to import from. The preferences
* under this branch can specify whitelist (ALLOW_ACTION)
* or blacklist (DENY_ACTION) additions using perference
* names of the form:
* * <BRANCH>.whitelist.add.<ID>
* * <BRANCH>.blacklist.add.<ID>
* Where <ID> can be any valid preference name.
* The value is expected to be a comma separated list of
* host named. eg:
* * something.example.com
* * foo.exmaple.com,bar.example.com
*
* @param aPermission Permission name to be passsed to the Permissions
* Manager.
*/
importFromPrefs(aPrefBranch, aPermission) {
if (!aPrefBranch.endsWith("."))
aPrefBranch += ".";
// Ensure we only import this pref branch once.
if (gImportedPrefBranches.has(aPrefBranch))
return;
importPrefBranch(aPrefBranch + "whitelist.add", aPermission,
Services.perms.ALLOW_ACTION);
importPrefBranch(aPrefBranch + "blacklist.add", aPermission,
Services.perms.DENY_ACTION);
gImportedPrefBranches.add(aPrefBranch);
},
};