Source code
Revision control
Copy as Markdown
Other Tools
/* 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
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
const AVAILABLE_PREF = "app.backgroundNotifications.helper.available";
const ENABLED_PREF = "app.backgroundNotifications.helper.enabled";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
WindowsPushNotificationHelper:
"resource://gre/modules/WindowsPushNotificationHelper.sys.mjs",
});
ChromeUtils.defineLazyGetter(lazy, "gImpl", () => {
// This is currently gated to just windows - but we'd
// like to expand to other platforms later.
if (AppConstants.platform == "win") {
return lazy.WindowsPushNotificationHelper;
}
// Stubs for unsupported platforms
return {
start() {},
stop() {},
};
});
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"available",
AVAILABLE_PREF,
false,
() => PushNotificationHelper.update()
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"enabled",
ENABLED_PREF,
false,
(_pref, _previous, latest) =>
PushNotificationHelper.onEnabledPrefChanged(latest)
);
/**
* Interface to a helper process that delivers push notifications while Firefox
* is closed, run per profile and outliving the session that started it.
*/
export const PushNotificationHelper = {
/**
* Brings the helper in line with the prefs. Called once at startup from the
* browser-idle-startup category, and again whenever either pref changes.
*/
init() {
this.update();
},
/**
* Records a change to the user's own switch, and then brings the helper in
* line with it. Only a change of value gets here: libpref leaves its
* observers alone for a write that lands on the value the pref already has.
*
* @param {boolean} enabled - The value the switch was turned to.
*/
onEnabledPrefChanged(enabled) {
Glean.backgroundNotificationHelper.toggled[
enabled ? "enabled" : "disabled"
].add(1);
this.update();
},
update() {
if (lazy.available && lazy.enabled) {
this.start();
} else {
this.stop();
}
},
/**
* Turns closed-browser web notifications on or off on the user's behalf.
* This writes the user-owned pref.
*
* @param {boolean} value - Whether the helper should run.
*/
setEnabled(value) {
Services.prefs.setBoolPref(ENABLED_PREF, value);
},
/**
* Launches the helper detached, so it survives this session.
*/
start() {
lazy.gImpl.start();
},
/**
* Asks every helper in this profile's group to exit, including any left
* behind by an earlier Firefox session. Safe to call when none are running.
*/
stop() {
lazy.gImpl.stop();
},
};