Backed out changeset 4d11ccc12529 (bug 1410412) on mixedpuppy's request

This commit is contained in:
Bogdan Tara 2019-11-19 06:01:46 +02:00
Родитель de916ceae2
Коммит de1f6c0c3c
7 изменённых файлов: 240 добавлений и 375 удалений

Просмотреть файл

@ -225,17 +225,17 @@ this.urlbar = class extends ExtensionAPI {
},
}).api(),
openViewOnFocus: getSettingsAPI({
context,
name: "openViewOnFocus",
callback: () => UrlbarPrefs.get("openViewOnFocus"),
}),
openViewOnFocus: getSettingsAPI(
context.extension.id,
"openViewOnFocus",
() => UrlbarPrefs.get("openViewOnFocus")
),
engagementTelemetry: getSettingsAPI({
context,
name: "engagementTelemetry",
callback: () => UrlbarPrefs.get("eventTelemetry.enabled"),
}),
engagementTelemetry: getSettingsAPI(
context.extension.id,
"engagementTelemetry",
() => UrlbarPrefs.get("eventTelemetry.enabled")
),
contextualTip: {
/**

Просмотреть файл

@ -22,8 +22,6 @@
var EXPORTED_SYMBOLS = ["ExtensionPreferencesManager"];
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { Management } = ChromeUtils.import(
"resource://gre/modules/Extension.jsm",
null
@ -43,17 +41,6 @@ ChromeUtils.defineModuleGetter(
"Preferences",
"resource://gre/modules/Preferences.jsm"
);
ChromeUtils.defineModuleGetter(
this,
"ExtensionCommon",
"resource://gre/modules/ExtensionCommon.jsm"
);
const { ExtensionUtils } = ChromeUtils.import(
"resource://gre/modules/ExtensionUtils.jsm"
);
const { ExtensionError } = ExtensionUtils;
XPCOMUtils.defineLazyGetter(this, "defaultPreferences", function() {
return new Preferences({ defaultBranch: true });
@ -65,12 +52,12 @@ Management.on("uninstall", (type, { id }) => {
});
Management.on("disable", (type, id) => {
ExtensionPreferencesManager.disableAll(id);
this.ExtensionPreferencesManager.disableAll(id);
});
Management.on("startup", async (type, extension) => {
if (extension.startupReason == "ADDON_ENABLE") {
ExtensionPreferencesManager.enableAll(extension.id);
this.ExtensionPreferencesManager.enableAll(extension.id);
}
});
/* eslint-enable mozilla/balanced-listeners */
@ -128,8 +115,6 @@ function settingsUpdate(initialValue) {
/**
* Loops through a set of prefs, either setting or resetting them.
*
* @param {string} name
* The api name of the setting.
* @param {Object} setting
* An object that represents a setting, which will have a setCallback
* property. If a onPrefsChanged function is provided it will be called
@ -138,7 +123,7 @@ function settingsUpdate(initialValue) {
* An object that represents an item handed back from the setting store
* from which the new pref values can be calculated.
*/
function setPrefs(name, setting, item) {
function setPrefs(setting, item) {
let prefs = item.initialValue || setting.setCallback(item.value);
let changed = false;
for (let pref of setting.prefNames) {
@ -155,7 +140,6 @@ function setPrefs(name, setting, item) {
if (changed && typeof setting.onPrefsChanged == "function") {
setting.onPrefsChanged(item);
}
Management.emit(`extension-setting-changed:${name}`);
}
/**
@ -197,7 +181,7 @@ async function processSetting(id, name, action) {
) {
return false;
}
setPrefs(name, setting, item);
setPrefs(setting, item);
return true;
}
return false;
@ -259,7 +243,7 @@ this.ExtensionPreferencesManager = {
settingsUpdate.bind(setting)
);
if (item) {
setPrefs(name, setting, item);
setPrefs(setting, item);
return true;
}
return false;
@ -415,18 +399,18 @@ this.ExtensionPreferencesManager = {
/**
* Returns an API object with get/set/clear used for a setting.
*
* @param {string|object} extensionId or params object
* @param {string} extensionId
* @param {string} name
* The unique id of the setting.
* The unique id of the setting.
* @param {Function} callback
* The function that retreives the current setting from prefs.
* The function that retreives the current setting from prefs.
* @param {string} storeType
* The name of the store in ExtensionSettingsStore.
* Defaults to STORE_TYPE.
* The name of the store in ExtensionSettingsStore.
* Defaults to STORE_TYPE.
* @param {boolean} readOnly
* @param {Function} validate
* Utility function for any specific validation, such as checking
* for supported platform. Function should throw an error if necessary.
* Utility function for any specific validation, such as checking
* for supported platform. Function should throw an error if necessary.
*
* @returns {object} API object with get/set/clear methods
*/
@ -438,69 +422,7 @@ this.ExtensionPreferencesManager = {
readOnly = false,
validate = () => {}
) {
if (arguments.length > 1) {
Services.console.logStringMessage(
`ExtensionPreferencesManager.getSettingsAPI for ${name} should be updated to use a single paramater object.`
);
}
return ExtensionPreferencesManager._getSettingsAPI(
arguments.length === 1
? extensionId
: {
extensionId,
name,
storeType,
readOnly,
validate,
}
);
},
/**
* Returns an API object with get/set/clear used for a setting.
*
* @param {object} params The params object contains the following:
* {BaseContext} context
* {string} extensionId, optional to support old API
* {string} name
* The unique id of the setting.
* {Function} callback
* The function that retreives the current setting from prefs.
* {string} storeType
* The name of the store in ExtensionSettingsStore.
* Defaults to STORE_TYPE.
* {boolean} readOnly
* {Function} validate
* Utility function for any specific validation, such as checking
* for supported platform. Function should throw an error if necessary.
*
* @returns {object} API object with get/set/clear methods
*/
_getSettingsAPI(params) {
let {
extensionId,
context,
name,
callback,
storeType,
readOnly = false,
onChange,
validate = () => {},
} = params;
if (!extensionId) {
extensionId = context.extension.id;
}
const checkScope = details => {
let { scope } = details;
if (scope && scope !== "regular") {
throw new ExtensionError(
`Firefox does not support the ${scope} settings scope.`
);
}
};
let settingsAPI = {
return {
async get(details) {
validate();
let levelOfControl = details.incognito
@ -521,7 +443,6 @@ this.ExtensionPreferencesManager = {
},
set(details) {
validate();
checkScope(details);
if (!readOnly) {
return ExtensionPreferencesManager.setSetting(
extensionId,
@ -533,44 +454,11 @@ this.ExtensionPreferencesManager = {
},
clear(details) {
validate();
checkScope(details);
if (!readOnly) {
return ExtensionPreferencesManager.removeSetting(extensionId, name);
}
return false;
},
onChange,
};
// Any caller using the old call signature will not have passed
// context to us. This should only be experimental addons in the
// wild.
if (onChange === undefined && context) {
// Some settings that are read-only may not have called addSetting, in
// which case we have no way to listen on the pref changes.
let setting = settingsMap.get(name);
if (!setting) {
Services.console.logStringMessage(
`ExtensionPreferencesManager API ${name} created but addSetting was not called.`
);
return settingsAPI;
}
settingsAPI.onChange = new ExtensionCommon.EventManager({
context,
name: `${name}.onChange`,
register: fire => {
let listener = async () => {
fire.async({
details: await settingsAPI.get({}),
});
};
Management.on(`extension-setting-changed:${name}`, listener);
return () => {
Management.off(`extension-setting-changed:${name}`, listener);
};
},
}).api();
}
return settingsAPI;
},
};

Просмотреть файл

@ -78,14 +78,6 @@ ExtensionPreferencesManager.addSetting("contextMenuShowEvent", {
},
});
ExtensionPreferencesManager.addSetting(HOMEPAGE_OVERRIDE_SETTING, {
prefNames: [HOMEPAGE_URL_PREF],
setCallback() {
throw new Error("Unable to set read-only setting");
},
});
ExtensionPreferencesManager.addSetting("ftpProtocolEnabled", {
prefNames: ["network.ftp.enabled"],
@ -169,53 +161,47 @@ this.browserSettings = class extends ExtensionAPI {
let { extension } = context;
return {
browserSettings: {
allowPopupsForUserEvents: getSettingsAPI({
context,
name: "allowPopupsForUserEvents",
callback() {
allowPopupsForUserEvents: getSettingsAPI(
extension.id,
"allowPopupsForUserEvents",
() => {
return Services.prefs.getCharPref("dom.popup_allowed_events") != "";
},
}
),
cacheEnabled: getSettingsAPI(extension.id, "cacheEnabled", () => {
return (
Services.prefs.getBoolPref("browser.cache.disk.enable") &&
Services.prefs.getBoolPref("browser.cache.memory.enable")
);
}),
cacheEnabled: getSettingsAPI({
context,
name: "cacheEnabled",
callback() {
return (
Services.prefs.getBoolPref("browser.cache.disk.enable") &&
Services.prefs.getBoolPref("browser.cache.memory.enable")
);
},
}),
closeTabsByDoubleClick: getSettingsAPI({
context,
name: "closeTabsByDoubleClick",
callback() {
closeTabsByDoubleClick: getSettingsAPI(
extension.id,
"closeTabsByDoubleClick",
() => {
return Services.prefs.getBoolPref(
"browser.tabs.closeTabByDblclick"
);
},
validate() {
undefined,
false,
() => {
if (AppConstants.platform == "android") {
throw new ExtensionError(
`android is not a supported platform for the closeTabsByDoubleClick setting.`
);
}
},
}),
}
),
contextMenuShowEvent: Object.assign(
getSettingsAPI({
context,
name: "contextMenuShowEvent",
callback() {
if (AppConstants.platform === "win") {
return "mouseup";
}
let prefValue = Services.prefs.getBoolPref(
"ui.context_menus.after_mouseup",
null
);
return prefValue ? "mouseup" : "mousedown";
},
getSettingsAPI(extension.id, "contextMenuShowEvent", () => {
if (AppConstants.platform === "win") {
return "mouseup";
}
let prefValue = Services.prefs.getBoolPref(
"ui.context_menus.after_mouseup",
null
);
return prefValue ? "mouseup" : "mousedown";
}),
{
set: details => {
@ -241,121 +227,94 @@ this.browserSettings = class extends ExtensionAPI {
},
}
),
ftpProtocolEnabled: getSettingsAPI({
context,
name: "ftpProtocolEnabled",
callback() {
ftpProtocolEnabled: getSettingsAPI(
extension.id,
"ftpProtocolEnabled",
() => {
return Services.prefs.getBoolPref("network.ftp.enabled");
},
}),
homepageOverride: getSettingsAPI({
context,
name: HOMEPAGE_OVERRIDE_SETTING,
callback() {
}
),
homepageOverride: getSettingsAPI(
extension.id,
HOMEPAGE_OVERRIDE_SETTING,
() => {
return Services.prefs.getStringPref(HOMEPAGE_URL_PREF);
},
readOnly: true,
}),
imageAnimationBehavior: getSettingsAPI({
context,
name: "imageAnimationBehavior",
callback() {
undefined,
true
),
imageAnimationBehavior: getSettingsAPI(
extension.id,
"imageAnimationBehavior",
() => {
return Services.prefs.getCharPref("image.animation_mode");
},
}
),
newTabPosition: getSettingsAPI(extension.id, "newTabPosition", () => {
if (Services.prefs.getBoolPref("browser.tabs.insertAfterCurrent")) {
return "afterCurrent";
}
if (
Services.prefs.getBoolPref("browser.tabs.insertRelatedAfterCurrent")
) {
return "relatedAfterCurrent";
}
return "atEnd";
}),
newTabPosition: getSettingsAPI({
context,
name: "newTabPosition",
callback() {
if (Services.prefs.getBoolPref("browser.tabs.insertAfterCurrent")) {
return "afterCurrent";
}
if (
Services.prefs.getBoolPref(
"browser.tabs.insertRelatedAfterCurrent"
)
) {
return "relatedAfterCurrent";
}
return "atEnd";
},
}),
newTabPageOverride: getSettingsAPI({
context,
name: NEW_TAB_OVERRIDE_SETTING,
callback() {
newTabPageOverride: getSettingsAPI(
extension.id,
NEW_TAB_OVERRIDE_SETTING,
() => {
return aboutNewTabService.newTabURL;
},
storeType: URL_STORE_TYPE,
readOnly: true,
onChange: new ExtensionCommon.EventManager({
context,
name: `${NEW_TAB_OVERRIDE_SETTING}.onChange`,
register: fire => {
let listener = (text, id) => {
fire.async({
details: {
levelOfControl: "not_controllable",
value: aboutNewTabService.newTabURL,
},
});
};
Services.obs.addObserver(listener, "newtab-url-changed");
return () => {
Services.obs.removeObserver(listener, "newtab-url-changed");
};
},
}).api(),
}),
openBookmarksInNewTabs: getSettingsAPI({
context,
name: "openBookmarksInNewTabs",
callback() {
URL_STORE_TYPE,
true
),
openBookmarksInNewTabs: getSettingsAPI(
extension.id,
"openBookmarksInNewTabs",
() => {
return Services.prefs.getBoolPref(
"browser.tabs.loadBookmarksInTabs"
);
},
}),
openSearchResultsInNewTabs: getSettingsAPI({
context,
name: "openSearchResultsInNewTabs",
callback() {
}
),
openSearchResultsInNewTabs: getSettingsAPI(
extension.id,
"openSearchResultsInNewTabs",
() => {
return Services.prefs.getBoolPref("browser.search.openintab");
},
}),
openUrlbarResultsInNewTabs: getSettingsAPI({
context,
name: "openUrlbarResultsInNewTabs",
callback() {
}
),
openUrlbarResultsInNewTabs: getSettingsAPI(
extension.id,
"openUrlbarResultsInNewTabs",
() => {
return Services.prefs.getBoolPref("browser.urlbar.openintab");
},
}),
webNotificationsDisabled: getSettingsAPI({
context,
name: "webNotificationsDisabled",
callback() {
}
),
webNotificationsDisabled: getSettingsAPI(
extension.id,
"webNotificationsDisabled",
() => {
let prefValue = Services.prefs.getIntPref(
"permissions.default.desktop-notification",
null
);
return prefValue === PERM_DENY_ACTION;
},
}),
}
),
overrideDocumentColors: Object.assign(
getSettingsAPI({
context,
name: "overrideDocumentColors",
callback() {
let prefValue = Services.prefs.getIntPref(
"browser.display.document_color_use"
);
if (prefValue === 1) {
return "never";
} else if (prefValue === 2) {
return "always";
}
return "high-contrast-only";
},
getSettingsAPI(extension.id, "overrideDocumentColors", () => {
let prefValue = Services.prefs.getIntPref(
"browser.display.document_color_use"
);
if (prefValue === 1) {
return "never";
} else if (prefValue === 2) {
return "always";
}
return "high-contrast-only";
}),
{
set: details => {
@ -385,16 +344,12 @@ this.browserSettings = class extends ExtensionAPI {
}
),
useDocumentFonts: Object.assign(
getSettingsAPI({
context,
name: "useDocumentFonts",
callback() {
return (
Services.prefs.getIntPref(
"browser.display.use_document_fonts"
) !== 0
);
},
getSettingsAPI(extension.id, "useDocumentFonts", () => {
return (
Services.prefs.getIntPref(
"browser.display.use_document_fonts"
) !== 0
);
}),
{
set: details => {

Просмотреть файл

@ -15,7 +15,8 @@ ChromeUtils.defineModuleGetter(
var { ExtensionPreferencesManager } = ChromeUtils.import(
"resource://gre/modules/ExtensionPreferencesManager.jsm"
);
var { getSettingsAPI } = ExtensionPreferencesManager;
var { ExtensionError } = ExtensionUtils;
const cookieSvc = Ci.nsICookieService;
@ -27,6 +28,42 @@ const cookieBehaviorValues = new Map([
["reject_trackers", cookieSvc.BEHAVIOR_REJECT_TRACKER],
]);
const checkScope = scope => {
if (scope && scope !== "regular") {
throw new ExtensionError(
`Firefox does not support the ${scope} settings scope.`
);
}
};
const getPrivacyAPI = (extension, name, callback) => {
return {
async get(details) {
return {
levelOfControl: details.incognito
? "not_controllable"
: await ExtensionPreferencesManager.getLevelOfControl(
extension.id,
name
),
value: await callback(),
};
},
set(details) {
checkScope(details.scope);
return ExtensionPreferencesManager.setSetting(
extension.id,
name,
details.value
);
},
clear(details) {
checkScope(details.scope);
return ExtensionPreferencesManager.removeSetting(extension.id, name);
},
};
};
// Add settings objects for supported APIs to the preferences manager.
ExtensionPreferencesManager.addSetting("network.networkPredictionEnabled", {
prefNames: [
@ -180,13 +217,14 @@ ExtensionPreferencesManager.addSetting("websites.trackingProtectionMode", {
this.privacy = class extends ExtensionAPI {
getAPI(context) {
let { extension } = context;
return {
privacy: {
network: {
networkPredictionEnabled: getSettingsAPI({
context,
name: "network.networkPredictionEnabled",
callback() {
networkPredictionEnabled: getPrivacyAPI(
extension,
"network.networkPredictionEnabled",
() => {
return (
Preferences.get("network.predictor.enabled") &&
Preferences.get("network.prefetch-next") &&
@ -194,19 +232,19 @@ this.privacy = class extends ExtensionAPI {
0 &&
!Preferences.get("network.dns.disablePrefetch")
);
},
}),
peerConnectionEnabled: getSettingsAPI({
context,
name: "network.peerConnectionEnabled",
callback() {
}
),
peerConnectionEnabled: getPrivacyAPI(
extension,
"network.peerConnectionEnabled",
() => {
return Preferences.get("media.peerconnection.enabled");
},
}),
webRTCIPHandlingPolicy: getSettingsAPI({
context,
name: "network.webRTCIPHandlingPolicy",
callback() {
}
),
webRTCIPHandlingPolicy: getPrivacyAPI(
extension,
"network.webRTCIPHandlingPolicy",
() => {
if (Preferences.get("media.peerconnection.ice.proxy_only")) {
return "proxy_only";
}
@ -232,25 +270,25 @@ this.privacy = class extends ExtensionAPI {
}
return "default";
},
}),
}
),
},
services: {
passwordSavingEnabled: getSettingsAPI({
context,
name: "services.passwordSavingEnabled",
callback() {
passwordSavingEnabled: getPrivacyAPI(
extension,
"services.passwordSavingEnabled",
() => {
return Preferences.get("signon.rememberSignons");
},
}),
}
),
},
websites: {
cookieConfig: getSettingsAPI({
context,
name: "websites.cookieConfig",
callback() {
cookieConfig: getPrivacyAPI(
extension,
"websites.cookieConfig",
() => {
let prefValue = Preferences.get("network.cookie.cookieBehavior");
return {
behavior: Array.from(cookieBehaviorValues.entries()).find(
@ -260,40 +298,40 @@ this.privacy = class extends ExtensionAPI {
Preferences.get("network.cookie.lifetimePolicy") ===
cookieSvc.ACCEPT_SESSION,
};
},
}),
firstPartyIsolate: getSettingsAPI({
context,
name: "websites.firstPartyIsolate",
callback() {
}
),
firstPartyIsolate: getPrivacyAPI(
extension,
"websites.firstPartyIsolate",
() => {
return Preferences.get("privacy.firstparty.isolate");
},
}),
hyperlinkAuditingEnabled: getSettingsAPI({
context,
name: "websites.hyperlinkAuditingEnabled",
callback() {
}
),
hyperlinkAuditingEnabled: getPrivacyAPI(
extension,
"websites.hyperlinkAuditingEnabled",
() => {
return Preferences.get("browser.send_pings");
},
}),
referrersEnabled: getSettingsAPI({
context,
name: "websites.referrersEnabled",
callback() {
}
),
referrersEnabled: getPrivacyAPI(
extension,
"websites.referrersEnabled",
() => {
return Preferences.get("network.http.sendRefererHeader") !== 0;
},
}),
resistFingerprinting: getSettingsAPI({
context,
name: "websites.resistFingerprinting",
callback() {
}
),
resistFingerprinting: getPrivacyAPI(
extension,
"websites.resistFingerprinting",
() => {
return Preferences.get("privacy.resistFingerprinting");
},
}),
trackingProtectionMode: getSettingsAPI({
context,
name: "websites.trackingProtectionMode",
callback() {
}
),
trackingProtectionMode: getPrivacyAPI(
extension,
"websites.trackingProtectionMode",
() => {
if (Preferences.get("privacy.trackingprotection.enabled")) {
return "always";
} else if (
@ -302,8 +340,8 @@ this.privacy = class extends ExtensionAPI {
return "private_browsing";
}
return "never";
},
}),
}
),
},
},
};

Просмотреть файл

@ -173,10 +173,10 @@ this.proxy = class extends ExtensionAPI {
}).api(),
settings: Object.assign(
getSettingsAPI({
context,
name: "proxy.settings",
callback() {
getSettingsAPI(
extension.id,
"proxy.settings",
() => {
let prefValue = Services.prefs.getIntPref("network.proxy.type");
let proxyConfig = {
proxyType: Array.from(PROXY_TYPES_MAP.entries()).find(
@ -214,14 +214,16 @@ this.proxy = class extends ExtensionAPI {
return proxyConfig;
},
// proxy.settings is unsupported on android.
validate() {
undefined,
false,
() => {
if (AppConstants.platform == "android") {
throw new ExtensionError(
`proxy.settings is not supported on android.`
);
}
},
}),
}
),
{
set: details => {
if (AppConstants.platform === "android") {

Просмотреть файл

@ -133,6 +133,7 @@
"name": "onChange",
"type": "function",
"description": "Fired after the setting changes.",
"unsupported": true,
"parameters": [
{
"type": "object",

Просмотреть файл

@ -40,20 +40,8 @@ add_task(async function test_browser_settings() {
};
async function background() {
let listeners = new Set([]);
browser.test.onMessage.addListener(async (msg, apiName, value) => {
let apiObj = browser.browserSettings[apiName];
// Don't add more than one listner per apiName. We leave the
// listener to ensure we do not get more calls than we expect.
if (!listeners.has(apiName)) {
apiObj.onChange.addListener(details => {
browser.test.sendMessage("onChange", {
details: details.details,
setting: apiName,
});
});
listeners.add(apiName);
}
let result = await apiObj.set({ value });
if (msg === "set") {
browser.test.assertTrue(result, "set returns true.");
@ -91,13 +79,6 @@ add_task(async function test_browser_settings() {
async function testSetting(setting, value, expected, expectedValue = value) {
extension.sendMessage("set", setting, value);
let data = await extension.awaitMessage("settingData");
let dataChange = await extension.awaitMessage("onChange");
equal(setting, dataChange.setting, "onChange fired");
equal(
data.value,
dataChange.details.value,
"onChange fired with correct value"
);
deepEqual(
data.value,
expectedValue,
@ -193,12 +174,12 @@ add_task(async function test_browser_settings() {
});
}
await testSetting("ftpProtocolEnabled", false, {
"network.ftp.enabled": false,
});
await testSetting("ftpProtocolEnabled", true, {
"network.ftp.enabled": true,
});
await testSetting("ftpProtocolEnabled", false, {
"network.ftp.enabled": false,
});
await testSetting("newTabPosition", "afterCurrent", {
"browser.tabs.insertRelatedAfterCurrent": false,