mozilla
/
gecko-dev
зеркало из https://github.com/mozilla/gecko-dev.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Bug 1410412 implement browser setting onChange event r=zombie 

Differential Revision: https://phabricator.services.mozilla.com/D51324

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Shane Caraveo 2019-11-19 17:26:13 +00:00
Родитель f17dad37f7
Коммит 4c534e5697
8 изменённых файлов: 383 добавлений и 248 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

20
browser/components/extensions/parent/ext-urlbar.js
Просмотреть файл

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

139
toolkit/components/extensions/ExtensionPreferencesManager.jsm
Просмотреть файл

@ -22,6 +22,8 @@
var EXPORTED_SYMBOLS = ["ExtensionPreferencesManager"];
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { Management } = ChromeUtils.import(
"resource://gre/modules/Extension.jsm",
null
@ -41,6 +43,17 @@ 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 });
@ -52,12 +65,12 @@ Management.on("uninstall", (type, { id }) => {
});
Management.on("disable", (type, id) => {
this.ExtensionPreferencesManager.disableAll(id);
ExtensionPreferencesManager.disableAll(id);
});
Management.on("startup", async (type, extension) => {
if (extension.startupReason == "ADDON_ENABLE") {
this.ExtensionPreferencesManager.enableAll(extension.id);
ExtensionPreferencesManager.enableAll(extension.id);
}
});
/* eslint-enable mozilla/balanced-listeners */
@ -115,6 +128,8 @@ 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
@ -123,7 +138,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(setting, item) {
function setPrefs(name, setting, item) {
let prefs = item.initialValue || setting.setCallback(item.value);
let changed = false;
for (let pref of setting.prefNames) {
@ -140,6 +155,7 @@ function setPrefs(setting, item) {
if (changed && typeof setting.onPrefsChanged == "function") {
setting.onPrefsChanged(item);
}
Management.emit(`extension-setting-changed:${name}`);
}
/**
@ -181,7 +197,7 @@ async function processSetting(id, name, action) {
) {
return false;
}
setPrefs(setting, item);
setPrefs(name, setting, item);
return true;
}
return false;
@ -243,7 +259,7 @@ this.ExtensionPreferencesManager = {
settingsUpdate.bind(setting)
);
if (item) {
setPrefs(setting, item);
setPrefs(name, setting, item);
return true;
}
return false;
@ -399,18 +415,18 @@ this.ExtensionPreferencesManager = {
/**
* Returns an API object with get/set/clear used for a setting.
*
* @param {string} extensionId
* @param {string|object} extensionId or params object
* @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
*/
@ -422,7 +438,70 @@ this.ExtensionPreferencesManager = {
readOnly = false,
validate = () => {}
) {
return {
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,
callback,
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 = {
async get(details) {
validate();
let levelOfControl = details.incognito
@ -443,6 +522,7 @@ this.ExtensionPreferencesManager = {
},
set(details) {
validate();
checkScope(details);
if (!readOnly) {
return ExtensionPreferencesManager.setSetting(
extensionId,
@ -454,11 +534,44 @@ 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;
},
};

257
toolkit/components/extensions/parent/ext-browserSettings.js
Просмотреть файл

@ -78,6 +78,14 @@ 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"],
@ -161,47 +169,53 @@ this.browserSettings = class extends ExtensionAPI {
let { extension } = context;
return {
browserSettings: {
allowPopupsForUserEvents: getSettingsAPI(
extension.id,
"allowPopupsForUserEvents",
() => {
allowPopupsForUserEvents: getSettingsAPI({
context,
name: "allowPopupsForUserEvents",
callback() {
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")
);
},
}),
closeTabsByDoubleClick: getSettingsAPI(
extension.id,
"closeTabsByDoubleClick",
() => {
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() {
return Services.prefs.getBoolPref(
"browser.tabs.closeTabByDblclick"
);
},
undefined,
false,
() => {
validate() {
if (AppConstants.platform == "android") {
throw new ExtensionError(
`android is not a supported platform for the closeTabsByDoubleClick setting.`
);
}
}
),
},
}),
contextMenuShowEvent: Object.assign(
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";
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";
},
}),
{
set: details => {
@ -227,94 +241,121 @@ this.browserSettings = class extends ExtensionAPI {
},
}
),
ftpProtocolEnabled: getSettingsAPI(
extension.id,
"ftpProtocolEnabled",
() => {
ftpProtocolEnabled: getSettingsAPI({
context,
name: "ftpProtocolEnabled",
callback() {
return Services.prefs.getBoolPref("network.ftp.enabled");
}
),
homepageOverride: getSettingsAPI(
extension.id,
HOMEPAGE_OVERRIDE_SETTING,
() => {
},
}),
homepageOverride: getSettingsAPI({
context,
name: HOMEPAGE_OVERRIDE_SETTING,
callback() {
return Services.prefs.getStringPref(HOMEPAGE_URL_PREF);
},
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";
readOnly: true,
}),
newTabPageOverride: getSettingsAPI(
extension.id,
NEW_TAB_OVERRIDE_SETTING,
() => {
imageAnimationBehavior: getSettingsAPI({
context,
name: "imageAnimationBehavior",
callback() {
return Services.prefs.getCharPref("image.animation_mode");
},
}),
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() {
return aboutNewTabService.newTabURL;
},
URL_STORE_TYPE,
true
),
openBookmarksInNewTabs: getSettingsAPI(
extension.id,
"openBookmarksInNewTabs",
() => {
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() {
return Services.prefs.getBoolPref(
"browser.tabs.loadBookmarksInTabs"
);
}
),
openSearchResultsInNewTabs: getSettingsAPI(
extension.id,
"openSearchResultsInNewTabs",
() => {
},
}),
openSearchResultsInNewTabs: getSettingsAPI({
context,
name: "openSearchResultsInNewTabs",
callback() {
return Services.prefs.getBoolPref("browser.search.openintab");
}
),
openUrlbarResultsInNewTabs: getSettingsAPI(
extension.id,
"openUrlbarResultsInNewTabs",
() => {
},
}),
openUrlbarResultsInNewTabs: getSettingsAPI({
context,
name: "openUrlbarResultsInNewTabs",
callback() {
return Services.prefs.getBoolPref("browser.urlbar.openintab");
}
),
webNotificationsDisabled: getSettingsAPI(
extension.id,
"webNotificationsDisabled",
() => {
},
}),
webNotificationsDisabled: getSettingsAPI({
context,
name: "webNotificationsDisabled",
callback() {
let prefValue = Services.prefs.getIntPref(
"permissions.default.desktop-notification",
null
);
return prefValue === PERM_DENY_ACTION;
}
),
},
}),
overrideDocumentColors: Object.assign(
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";
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";
},
}),
{
set: details => {
@ -344,12 +385,16 @@ this.browserSettings = class extends ExtensionAPI {
}
),
useDocumentFonts: Object.assign(
getSettingsAPI(extension.id, "useDocumentFonts", () => {
return (
Services.prefs.getIntPref(
"browser.display.use_document_fonts"
) !== 0
);
getSettingsAPI({
context,
name: "useDocumentFonts",
callback() {
return (
Services.prefs.getIntPref(
"browser.display.use_document_fonts"
) !== 0
);
},
}),
{
set: details => {

13
toolkit/components/extensions/parent/ext-captivePortal.js
Просмотреть файл

@ -104,15 +104,14 @@ this.captivePortal = class extends ExtensionAPI {
};
},
}).api(),
canonicalURL: getSettingsAPI(
context.extension.id,
"captiveURL",
() => {
canonicalURL: getSettingsAPI({
context,
name: "captiveURL",
callback() {
return Services.prefs.getStringPref("captivedetect.canonicalURL");
},
undefined,
true
),
readOnly: true,
}),
},
};
}

160
toolkit/components/extensions/parent/ext-privacy.js
Просмотреть файл

@ -15,8 +15,7 @@ ChromeUtils.defineModuleGetter(
var { ExtensionPreferencesManager } = ChromeUtils.import(
"resource://gre/modules/ExtensionPreferencesManager.jsm"
);
var { ExtensionError } = ExtensionUtils;
var { getSettingsAPI } = ExtensionPreferencesManager;
const cookieSvc = Ci.nsICookieService;
@ -28,42 +27,6 @@ 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: [
@ -217,14 +180,13 @@ ExtensionPreferencesManager.addSetting("websites.trackingProtectionMode", {
this.privacy = class extends ExtensionAPI {
getAPI(context) {
let { extension } = context;
return {
privacy: {
network: {
networkPredictionEnabled: getPrivacyAPI(
extension,
"network.networkPredictionEnabled",
() => {
networkPredictionEnabled: getSettingsAPI({
context,
name: "network.networkPredictionEnabled",
callback() {
return (
Preferences.get("network.predictor.enabled") &&
Preferences.get("network.prefetch-next") &&
@ -232,19 +194,19 @@ this.privacy = class extends ExtensionAPI {
0 &&
!Preferences.get("network.dns.disablePrefetch")
);
}
),
peerConnectionEnabled: getPrivacyAPI(
extension,
"network.peerConnectionEnabled",
() => {
},
}),
peerConnectionEnabled: getSettingsAPI({
context,
name: "network.peerConnectionEnabled",
callback() {
return Preferences.get("media.peerconnection.enabled");
}
),
webRTCIPHandlingPolicy: getPrivacyAPI(
extension,
"network.webRTCIPHandlingPolicy",
() => {
},
}),
webRTCIPHandlingPolicy: getSettingsAPI({
context,
name: "network.webRTCIPHandlingPolicy",
callback() {
if (Preferences.get("media.peerconnection.ice.proxy_only")) {
return "proxy_only";
}
@ -270,25 +232,25 @@ this.privacy = class extends ExtensionAPI {
}
return "default";
}
),
},
}),
},
services: {
passwordSavingEnabled: getPrivacyAPI(
extension,
"services.passwordSavingEnabled",
() => {
passwordSavingEnabled: getSettingsAPI({
context,
name: "services.passwordSavingEnabled",
callback() {
return Preferences.get("signon.rememberSignons");
}
),
},
}),
},
websites: {
cookieConfig: getPrivacyAPI(
extension,
"websites.cookieConfig",
() => {
cookieConfig: getSettingsAPI({
context,
name: "websites.cookieConfig",
callback() {
let prefValue = Preferences.get("network.cookie.cookieBehavior");
return {
behavior: Array.from(cookieBehaviorValues.entries()).find(
@ -298,40 +260,40 @@ this.privacy = class extends ExtensionAPI {
Preferences.get("network.cookie.lifetimePolicy") ===
cookieSvc.ACCEPT_SESSION,
};
}
),
firstPartyIsolate: getPrivacyAPI(
extension,
"websites.firstPartyIsolate",
() => {
},
}),
firstPartyIsolate: getSettingsAPI({
context,
name: "websites.firstPartyIsolate",
callback() {
return Preferences.get("privacy.firstparty.isolate");
}
),
hyperlinkAuditingEnabled: getPrivacyAPI(
extension,
"websites.hyperlinkAuditingEnabled",
() => {
},
}),
hyperlinkAuditingEnabled: getSettingsAPI({
context,
name: "websites.hyperlinkAuditingEnabled",
callback() {
return Preferences.get("browser.send_pings");
}
),
referrersEnabled: getPrivacyAPI(
extension,
"websites.referrersEnabled",
() => {
},
}),
referrersEnabled: getSettingsAPI({
context,
name: "websites.referrersEnabled",
callback() {
return Preferences.get("network.http.sendRefererHeader") !== 0;
}
),
resistFingerprinting: getPrivacyAPI(
extension,
"websites.resistFingerprinting",
() => {
},
}),
resistFingerprinting: getSettingsAPI({
context,
name: "websites.resistFingerprinting",
callback() {
return Preferences.get("privacy.resistFingerprinting");
}
),
trackingProtectionMode: getPrivacyAPI(
extension,
"websites.trackingProtectionMode",
() => {
},
}),
trackingProtectionMode: getSettingsAPI({
context,
name: "websites.trackingProtectionMode",
callback() {
if (Preferences.get("privacy.trackingprotection.enabled")) {
return "always";
} else if (
@ -340,8 +302,8 @@ this.privacy = class extends ExtensionAPI {
return "private_browsing";
}
return "never";
}
),
},
}),
},
},
};

16
toolkit/components/extensions/parent/ext-proxy.js
Просмотреть файл

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

1
toolkit/components/extensions/schemas/types.json
Просмотреть файл

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

25
toolkit/components/extensions/test/xpcshell/test_ext_browserSettings.js
Просмотреть файл

@ -40,8 +40,20 @@ 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.");
@ -79,6 +91,13 @@ 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,
@ -174,12 +193,12 @@ add_task(async function test_browser_settings() {
});
}
await testSetting("ftpProtocolEnabled", true, {
"network.ftp.enabled": true,
});
await testSetting("ftpProtocolEnabled", false, {
"network.ftp.enabled": false,
});
await testSetting("ftpProtocolEnabled", true, {
"network.ftp.enabled": true,
});
await testSetting("newTabPosition", "afterCurrent", {
"browser.tabs.insertRelatedAfterCurrent": false,