зеркало из https://github.com/mozilla/gecko-dev.git
1858 строки
64 KiB
JavaScript
1858 строки
64 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/.
|
|
|
|
"use strict";
|
|
|
|
this.EXPORTED_SYMBOLS = ["UITour"];
|
|
|
|
const {classes: Cc, interfaces: Ci, utils: Cu, results: Cr} = Components;
|
|
|
|
Cu.import("resource://gre/modules/AppConstants.jsm");
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
Cu.import("resource://gre/modules/TelemetryController.jsm");
|
|
Cu.import("resource://gre/modules/Timer.jsm");
|
|
|
|
Cu.importGlobalProperties(["URL"]);
|
|
|
|
XPCOMUtils.defineLazyModuleGetter(this, "LightweightThemeManager",
|
|
"resource://gre/modules/LightweightThemeManager.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "ResetProfile",
|
|
"resource://gre/modules/ResetProfile.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "CustomizableUI",
|
|
"resource:///modules/CustomizableUI.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "UITelemetry",
|
|
"resource://gre/modules/UITelemetry.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "BrowserUITelemetry",
|
|
"resource:///modules/BrowserUITelemetry.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "PrivateBrowsingUtils",
|
|
"resource://gre/modules/PrivateBrowsingUtils.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "ProfileAge",
|
|
"resource://gre/modules/ProfileAge.jsm");
|
|
XPCOMUtils.defineLazyModuleGetter(this, "ReaderParent",
|
|
"resource:///modules/ReaderParent.jsm");
|
|
|
|
// See LOG_LEVELS in Console.jsm. Common examples: "All", "Info", "Warn", & "Error".
|
|
const PREF_LOG_LEVEL = "browser.uitour.loglevel";
|
|
const PREF_SEENPAGEIDS = "browser.uitour.seenPageIDs";
|
|
|
|
const BACKGROUND_PAGE_ACTIONS_ALLOWED = new Set([
|
|
"forceShowReaderIcon",
|
|
"getConfiguration",
|
|
"getTreatmentTag",
|
|
"hideHighlight",
|
|
"hideInfo",
|
|
"hideMenu",
|
|
"ping",
|
|
"registerPageID",
|
|
"setConfiguration",
|
|
"setTreatmentTag",
|
|
]);
|
|
const MAX_BUTTONS = 4;
|
|
|
|
const BUCKET_NAME = "UITour";
|
|
const BUCKET_TIMESTEPS = [
|
|
1 * 60 * 1000, // Until 1 minute after tab is closed/inactive.
|
|
3 * 60 * 1000, // Until 3 minutes after tab is closed/inactive.
|
|
10 * 60 * 1000, // Until 10 minutes after tab is closed/inactive.
|
|
60 * 60 * 1000, // Until 1 hour after tab is closed/inactive.
|
|
];
|
|
|
|
// Time after which seen Page IDs expire.
|
|
const SEENPAGEID_EXPIRY = 8 * 7 * 24 * 60 * 60 * 1000; // 8 weeks.
|
|
|
|
// Prefix for any target matching a search engine.
|
|
const TARGET_SEARCHENGINE_PREFIX = "searchEngine-";
|
|
|
|
// Create a new instance of the ConsoleAPI so we can control the maxLogLevel with a pref.
|
|
XPCOMUtils.defineLazyGetter(this, "log", () => {
|
|
let ConsoleAPI = Cu.import("resource://gre/modules/Console.jsm", {}).ConsoleAPI;
|
|
let consoleOptions = {
|
|
maxLogLevelPref: PREF_LOG_LEVEL,
|
|
prefix: "UITour",
|
|
};
|
|
return new ConsoleAPI(consoleOptions);
|
|
});
|
|
|
|
this.UITour = {
|
|
url: null,
|
|
seenPageIDs: null,
|
|
// This map is not persisted and is used for
|
|
// building the content source of a potential tour.
|
|
pageIDsForSession: new Map(),
|
|
pageIDSourceBrowsers: new WeakMap(),
|
|
/* Map from browser chrome windows to a Set of <browser>s in which a tour is open (both visible and hidden) */
|
|
tourBrowsersByWindow: new WeakMap(),
|
|
// Menus opened by api users explictly through `Mozilla.UITour.showMenu` call
|
|
noautohideMenus: new Set(),
|
|
availableTargetsCache: new WeakMap(),
|
|
clearAvailableTargetsCache() {
|
|
this.availableTargetsCache = new WeakMap();
|
|
},
|
|
|
|
_annotationPanelMutationObservers: new WeakMap(),
|
|
|
|
highlightEffects: ["random", "wobble", "zoom", "color"],
|
|
targets: new Map([
|
|
["accountStatus", {
|
|
query: (aDocument) => {
|
|
// If the user is logged in, use the avatar element.
|
|
let fxAFooter = aDocument.getElementById("appMenu-fxa-container");
|
|
if (fxAFooter.getAttribute("fxastatus")) {
|
|
return aDocument.getElementById("appMenu-fxa-avatar");
|
|
}
|
|
|
|
// Otherwise use the sync setup icon.
|
|
let statusButton = aDocument.getElementById("appMenu-fxa-label");
|
|
return aDocument.getAnonymousElementByAttribute(statusButton,
|
|
"class",
|
|
"toolbarbutton-icon");
|
|
},
|
|
// This is a fake widgetName starting with the "appMenu-" prefix so we know
|
|
// to automatically open the appMenu when annotating this target.
|
|
widgetName: "appMenu-fxa-label",
|
|
}],
|
|
["addons", {query: "#appMenu-addons-button"}],
|
|
["appMenu", {
|
|
addTargetListener: (aDocument, aCallback) => {
|
|
let panelPopup = aDocument.defaultView.PanelUI.panel;
|
|
panelPopup.addEventListener("popupshown", aCallback);
|
|
},
|
|
query: "#PanelUI-button",
|
|
removeTargetListener: (aDocument, aCallback) => {
|
|
let panelPopup = aDocument.defaultView.PanelUI.panel;
|
|
panelPopup.removeEventListener("popupshown", aCallback);
|
|
},
|
|
}],
|
|
["backForward", {
|
|
query: "#back-button",
|
|
widgetName: "urlbar-container",
|
|
}],
|
|
["bookmarks", {query: "#bookmarks-menu-button"}],
|
|
["controlCenter-trackingUnblock", controlCenterTrackingToggleTarget(true)],
|
|
["controlCenter-trackingBlock", controlCenterTrackingToggleTarget(false)],
|
|
["customize", {
|
|
query: "#appMenu-customize-button",
|
|
widgetName: "appMenu-customize-button",
|
|
}],
|
|
["devtools", {
|
|
query: "#appMenu-developer-button",
|
|
widgetName: "appMenu-developer-button",
|
|
}],
|
|
["forget", {
|
|
allowAdd: true,
|
|
query: "#panic-button",
|
|
widgetName: "panic-button",
|
|
}],
|
|
["help", {query: "#appMenu-help-button"}],
|
|
["home", {query: "#home-button"}],
|
|
["library", {query: "#appMenu-library-button"}],
|
|
["pocket", {
|
|
allowAdd: true,
|
|
query: "#pocket-button",
|
|
widgetName: "pocket-button",
|
|
}],
|
|
["privateWindow", {query: "#appMenu-private-window-button"}],
|
|
["quit", {query: "#appMenu-quit-button"}],
|
|
["readerMode-urlBar", {query: "#reader-mode-button"}],
|
|
["search", {
|
|
infoPanelOffsetX: 18,
|
|
infoPanelPosition: "after_start",
|
|
query: "#searchbar",
|
|
widgetName: "search-container",
|
|
}],
|
|
["searchIcon", {
|
|
query: (aDocument) => {
|
|
let searchbar = aDocument.getElementById("searchbar");
|
|
return aDocument.getAnonymousElementByAttribute(searchbar,
|
|
"anonid",
|
|
"searchbar-search-button");
|
|
},
|
|
widgetName: "search-container",
|
|
}],
|
|
["searchPrefsLink", {
|
|
query: (aDocument) => {
|
|
let element = null;
|
|
let popup = aDocument.getElementById("PopupSearchAutoComplete");
|
|
if (popup.state != "open")
|
|
return null;
|
|
element = aDocument.getAnonymousElementByAttribute(popup,
|
|
"anonid",
|
|
"search-settings");
|
|
if (!element || !UITour.isElementVisible(element)) {
|
|
return null;
|
|
}
|
|
return element;
|
|
},
|
|
}],
|
|
["selectedTabIcon", {
|
|
query: (aDocument) => {
|
|
let selectedtab = aDocument.defaultView.gBrowser.selectedTab;
|
|
let element = aDocument.getAnonymousElementByAttribute(selectedtab,
|
|
"anonid",
|
|
"tab-icon-image");
|
|
if (!element || !UITour.isElementVisible(element)) {
|
|
return null;
|
|
}
|
|
return element;
|
|
},
|
|
}],
|
|
["trackingProtection", {
|
|
query: "#tracking-protection-icon",
|
|
}],
|
|
["urlbar", {
|
|
query: "#urlbar",
|
|
widgetName: "urlbar-container",
|
|
}],
|
|
["pageActionButton", {
|
|
query: "#pageActionButton"
|
|
}],
|
|
["pageAction-panel-bookmark", {
|
|
query: "#pageAction-panel-bookmark"
|
|
}],
|
|
["pageAction-panel-copyURL", {
|
|
query: "#pageAction-panel-copyURL"
|
|
}],
|
|
["pageAction-panel-emailLink", {
|
|
query: "#pageAction-panel-emailLink"
|
|
}],
|
|
["pageAction-panel-sendToDevice", {
|
|
query: "#pageAction-panel-sendToDevice"
|
|
}],
|
|
["bookmark-star-button", {
|
|
query: "#star-button"
|
|
}]
|
|
]),
|
|
|
|
init() {
|
|
log.debug("Initializing UITour");
|
|
// Lazy getter is initialized here so it can be replicated any time
|
|
// in a test.
|
|
delete this.seenPageIDs;
|
|
Object.defineProperty(this, "seenPageIDs", {
|
|
get: this.restoreSeenPageIDs.bind(this),
|
|
configurable: true,
|
|
});
|
|
|
|
delete this.url;
|
|
XPCOMUtils.defineLazyGetter(this, "url", function() {
|
|
return Services.urlFormatter.formatURLPref("browser.uitour.url");
|
|
});
|
|
|
|
// Clear the availableTargetsCache on widget changes.
|
|
let listenerMethods = [
|
|
"onWidgetAdded",
|
|
"onWidgetMoved",
|
|
"onWidgetRemoved",
|
|
"onWidgetReset",
|
|
"onAreaReset",
|
|
];
|
|
CustomizableUI.addListener(listenerMethods.reduce((listener, method) => {
|
|
listener[method] = () => this.clearAvailableTargetsCache();
|
|
return listener;
|
|
}, {}));
|
|
},
|
|
|
|
restoreSeenPageIDs() {
|
|
delete this.seenPageIDs;
|
|
|
|
if (UITelemetry.enabled) {
|
|
let dateThreshold = Date.now() - SEENPAGEID_EXPIRY;
|
|
|
|
try {
|
|
let data = Services.prefs.getCharPref(PREF_SEENPAGEIDS);
|
|
data = new Map(JSON.parse(data));
|
|
|
|
for (let [pageID, details] of data) {
|
|
|
|
if (typeof pageID != "string" ||
|
|
typeof details != "object" ||
|
|
typeof details.lastSeen != "number" ||
|
|
details.lastSeen < dateThreshold) {
|
|
|
|
data.delete(pageID);
|
|
}
|
|
}
|
|
|
|
this.seenPageIDs = data;
|
|
} catch (e) {}
|
|
}
|
|
|
|
if (!this.seenPageIDs)
|
|
this.seenPageIDs = new Map();
|
|
|
|
this.persistSeenIDs();
|
|
|
|
return this.seenPageIDs;
|
|
},
|
|
|
|
addSeenPageID(aPageID) {
|
|
if (!UITelemetry.enabled)
|
|
return;
|
|
|
|
this.seenPageIDs.set(aPageID, {
|
|
lastSeen: Date.now(),
|
|
});
|
|
|
|
this.persistSeenIDs();
|
|
},
|
|
|
|
persistSeenIDs() {
|
|
if (this.seenPageIDs.size === 0) {
|
|
Services.prefs.clearUserPref(PREF_SEENPAGEIDS);
|
|
return;
|
|
}
|
|
|
|
Services.prefs.setCharPref(PREF_SEENPAGEIDS,
|
|
JSON.stringify([...this.seenPageIDs]));
|
|
},
|
|
|
|
onPageEvent(aMessage, aEvent) {
|
|
let browser = aMessage.target;
|
|
let window = browser.ownerGlobal;
|
|
|
|
// Does the window have tabs? We need to make sure since windowless browsers do
|
|
// not have tabs.
|
|
if (!window.gBrowser) {
|
|
// When using windowless browsers we don't have a valid |window|. If that's the case,
|
|
// use the most recent window as a target for UITour functions (see Bug 1111022).
|
|
window = Services.wm.getMostRecentWindow("navigator:browser");
|
|
}
|
|
|
|
let messageManager = browser.messageManager;
|
|
|
|
log.debug("onPageEvent:", aEvent.detail, aMessage);
|
|
|
|
if (typeof aEvent.detail != "object") {
|
|
log.warn("Malformed event - detail not an object");
|
|
return false;
|
|
}
|
|
|
|
let action = aEvent.detail.action;
|
|
if (typeof action != "string" || !action) {
|
|
log.warn("Action not defined");
|
|
return false;
|
|
}
|
|
|
|
let data = aEvent.detail.data;
|
|
if (typeof data != "object") {
|
|
log.warn("Malformed event - data not an object");
|
|
return false;
|
|
}
|
|
|
|
if ((aEvent.pageVisibilityState == "hidden" ||
|
|
aEvent.pageVisibilityState == "unloaded") &&
|
|
!BACKGROUND_PAGE_ACTIONS_ALLOWED.has(action)) {
|
|
log.warn("Ignoring disallowed action from a hidden page:", action);
|
|
return false;
|
|
}
|
|
|
|
switch (action) {
|
|
case "registerPageID": {
|
|
if (typeof data.pageID != "string") {
|
|
log.warn("registerPageID: pageID must be a string");
|
|
break;
|
|
}
|
|
|
|
this.pageIDsForSession.set(data.pageID, {lastSeen: Date.now()});
|
|
|
|
// The rest is only relevant if Telemetry is enabled.
|
|
if (!UITelemetry.enabled) {
|
|
log.debug("registerPageID: Telemetry disabled, not doing anything");
|
|
break;
|
|
}
|
|
|
|
// We don't want to allow BrowserUITelemetry.BUCKET_SEPARATOR in the
|
|
// pageID, as it could make parsing the telemetry bucket name difficult.
|
|
if (data.pageID.includes(BrowserUITelemetry.BUCKET_SEPARATOR)) {
|
|
log.warn("registerPageID: Invalid page ID specified");
|
|
break;
|
|
}
|
|
|
|
this.addSeenPageID(data.pageID);
|
|
this.pageIDSourceBrowsers.set(browser, data.pageID);
|
|
this.setTelemetryBucket(data.pageID);
|
|
|
|
break;
|
|
}
|
|
|
|
case "showHighlight": {
|
|
let targetPromise = this.getTarget(window, data.target);
|
|
targetPromise.then(target => {
|
|
if (!target.node) {
|
|
log.error("UITour: Target could not be resolved: " + data.target);
|
|
return;
|
|
}
|
|
let effect = undefined;
|
|
if (this.highlightEffects.indexOf(data.effect) !== -1) {
|
|
effect = data.effect;
|
|
}
|
|
this.showHighlight(window, target, effect);
|
|
}).catch(log.error);
|
|
break;
|
|
}
|
|
|
|
case "hideHighlight": {
|
|
this.hideHighlight(window);
|
|
break;
|
|
}
|
|
|
|
case "showInfo": {
|
|
let targetPromise = this.getTarget(window, data.target, true);
|
|
targetPromise.then(target => {
|
|
if (!target.node) {
|
|
log.error("UITour: Target could not be resolved: " + data.target);
|
|
return;
|
|
}
|
|
|
|
let iconURL = null;
|
|
if (typeof data.icon == "string")
|
|
iconURL = this.resolveURL(browser, data.icon);
|
|
|
|
let buttons = [];
|
|
if (Array.isArray(data.buttons) && data.buttons.length > 0) {
|
|
for (let buttonData of data.buttons) {
|
|
if (typeof buttonData == "object" &&
|
|
typeof buttonData.label == "string" &&
|
|
typeof buttonData.callbackID == "string") {
|
|
let callback = buttonData.callbackID;
|
|
let button = {
|
|
label: buttonData.label,
|
|
callback: event => {
|
|
this.sendPageCallback(messageManager, callback);
|
|
},
|
|
};
|
|
|
|
if (typeof buttonData.icon == "string")
|
|
button.iconURL = this.resolveURL(browser, buttonData.icon);
|
|
|
|
if (typeof buttonData.style == "string")
|
|
button.style = buttonData.style;
|
|
|
|
buttons.push(button);
|
|
|
|
if (buttons.length == MAX_BUTTONS) {
|
|
log.warn("showInfo: Reached limit of allowed number of buttons");
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
let infoOptions = {};
|
|
if (typeof data.closeButtonCallbackID == "string") {
|
|
infoOptions.closeButtonCallback = () => {
|
|
this.sendPageCallback(messageManager, data.closeButtonCallbackID);
|
|
};
|
|
}
|
|
if (typeof data.targetCallbackID == "string") {
|
|
infoOptions.targetCallback = details => {
|
|
this.sendPageCallback(messageManager, data.targetCallbackID, details);
|
|
};
|
|
}
|
|
|
|
this.showInfo(window, target, data.title, data.text, iconURL, buttons, infoOptions);
|
|
}).catch(log.error);
|
|
break;
|
|
}
|
|
|
|
case "hideInfo": {
|
|
this.hideInfo(window);
|
|
break;
|
|
}
|
|
|
|
case "previewTheme": {
|
|
this.previewTheme(data.theme);
|
|
break;
|
|
}
|
|
|
|
case "resetTheme": {
|
|
this.resetTheme();
|
|
break;
|
|
}
|
|
|
|
case "showMenu": {
|
|
this.noautohideMenus.add(data.name);
|
|
this.showMenu(window, data.name, () => {
|
|
if (typeof data.showCallbackID == "string")
|
|
this.sendPageCallback(messageManager, data.showCallbackID);
|
|
});
|
|
break;
|
|
}
|
|
|
|
case "hideMenu": {
|
|
this.noautohideMenus.delete(data.name);
|
|
this.hideMenu(window, data.name);
|
|
break;
|
|
}
|
|
|
|
case "showNewTab": {
|
|
this.showNewTab(window, browser);
|
|
break;
|
|
}
|
|
|
|
case "getConfiguration": {
|
|
if (typeof data.configuration != "string") {
|
|
log.warn("getConfiguration: No configuration option specified");
|
|
return false;
|
|
}
|
|
|
|
this.getConfiguration(messageManager, window, data.configuration, data.callbackID);
|
|
break;
|
|
}
|
|
|
|
case "setConfiguration": {
|
|
if (typeof data.configuration != "string") {
|
|
log.warn("setConfiguration: No configuration option specified");
|
|
return false;
|
|
}
|
|
|
|
this.setConfiguration(window, data.configuration, data.value);
|
|
break;
|
|
}
|
|
|
|
case "openPreferences": {
|
|
if (typeof data.pane != "string" && typeof data.pane != "undefined") {
|
|
log.warn("openPreferences: Invalid pane specified");
|
|
return false;
|
|
}
|
|
|
|
let paneID = data.pane;
|
|
let extraArgs = { origin: "UITour" };
|
|
if (Services.prefs.getBoolPref("browser.preferences.useOldOrganization", true)) {
|
|
// We are heading to the old Preferences so
|
|
// let's map the new one to the old one if the `paneID` was for the new Preferences.
|
|
// Currently only the old advanced pane > dataChoicesTab has the mapping need,
|
|
// so here only do mapping for it right now.
|
|
// We could add another mapping when there is need.
|
|
if (paneID == "privacy-reports") {
|
|
paneID = "advanced";
|
|
extraArgs.advancedTab = "dataChoicesTab";
|
|
}
|
|
}
|
|
|
|
window.openPreferences(paneID, extraArgs);
|
|
break;
|
|
}
|
|
|
|
case "showFirefoxAccounts": {
|
|
// 'signup' is the only action that makes sense currently, so we don't
|
|
// accept arbitrary actions just to be safe...
|
|
let p = new URLSearchParams("action=signup&entrypoint=uitour");
|
|
// Call our helper to validate extraURLCampaignParams and populate URLSearchParams
|
|
if (!this._populateCampaignParams(p, data.extraURLCampaignParams)) {
|
|
log.warn("showFirefoxAccounts: invalid campaign args specified");
|
|
return false;
|
|
}
|
|
|
|
if (data.email) {
|
|
p.append("email", data.email);
|
|
}
|
|
// We want to replace the current tab.
|
|
browser.loadURI("about:accounts?" + p.toString());
|
|
break;
|
|
}
|
|
|
|
case "resetFirefox": {
|
|
// Open a reset profile dialog window.
|
|
if (ResetProfile.resetSupported()) {
|
|
ResetProfile.openConfirmationDialog(window);
|
|
}
|
|
break;
|
|
}
|
|
|
|
case "addNavBarWidget": {
|
|
// Add a widget to the toolbar
|
|
let targetPromise = this.getTarget(window, data.name);
|
|
targetPromise.then(target => {
|
|
this.addNavBarWidget(target, messageManager, data.callbackID);
|
|
}).catch(log.error);
|
|
break;
|
|
}
|
|
|
|
case "setDefaultSearchEngine": {
|
|
let enginePromise = this.selectSearchEngine(data.identifier);
|
|
enginePromise.catch(Cu.reportError);
|
|
break;
|
|
}
|
|
|
|
case "setTreatmentTag": {
|
|
let name = data.name;
|
|
let value = data.value;
|
|
Services.prefs.setStringPref("browser.uitour.treatment." + name, value);
|
|
// The notification is only meant to be used in tests.
|
|
UITourHealthReport.recordTreatmentTag(name, value)
|
|
.then(() => this.notify("TreatmentTag:TelemetrySent"));
|
|
break;
|
|
}
|
|
|
|
case "getTreatmentTag": {
|
|
let name = data.name;
|
|
let value;
|
|
try {
|
|
value = Services.prefs.getStringPref("browser.uitour.treatment." + name);
|
|
} catch (ex) {}
|
|
this.sendPageCallback(messageManager, data.callbackID, { value });
|
|
break;
|
|
}
|
|
|
|
case "setSearchTerm": {
|
|
let targetPromise = this.getTarget(window, "search");
|
|
targetPromise.then(target => {
|
|
let searchbar = target.node;
|
|
searchbar.value = data.term;
|
|
searchbar.updateGoButtonVisibility();
|
|
});
|
|
break;
|
|
}
|
|
|
|
case "openSearchPanel": {
|
|
let targetPromise = this.getTarget(window, "search");
|
|
targetPromise.then(target => {
|
|
let searchbar = target.node;
|
|
|
|
if (searchbar.textbox.open) {
|
|
this.sendPageCallback(messageManager, data.callbackID);
|
|
} else {
|
|
let onPopupShown = () => {
|
|
searchbar.textbox.popup.removeEventListener("popupshown", onPopupShown);
|
|
this.sendPageCallback(messageManager, data.callbackID);
|
|
};
|
|
|
|
searchbar.textbox.popup.addEventListener("popupshown", onPopupShown);
|
|
searchbar.openSuggestionsPanel();
|
|
}
|
|
}).catch(Cu.reportError);
|
|
break;
|
|
}
|
|
|
|
case "ping": {
|
|
if (typeof data.callbackID == "string")
|
|
this.sendPageCallback(messageManager, data.callbackID);
|
|
break;
|
|
}
|
|
|
|
case "forceShowReaderIcon": {
|
|
ReaderParent.forceShowReaderIcon(browser);
|
|
break;
|
|
}
|
|
|
|
case "toggleReaderMode": {
|
|
let targetPromise = this.getTarget(window, "readerMode-urlBar");
|
|
targetPromise.then(target => {
|
|
ReaderParent.toggleReaderMode({target: target.node});
|
|
});
|
|
break;
|
|
}
|
|
|
|
case "closeTab": {
|
|
// Find the <tabbrowser> element of the <browser> for which the event
|
|
// was generated originally. If the browser where the UI tour is loaded
|
|
// is windowless, just ignore the request to close the tab. The request
|
|
// is also ignored if this is the only tab in the window.
|
|
let tabBrowser = browser.ownerGlobal.gBrowser;
|
|
if (tabBrowser && tabBrowser.browsers.length > 1) {
|
|
tabBrowser.removeTab(tabBrowser.getTabForBrowser(browser));
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
// For performance reasons, only call initForBrowser if we did something
|
|
// that will require a teardownTourForBrowser call later.
|
|
// getConfiguration (called from about:home) doesn't require any future
|
|
// uninitialization.
|
|
if (action != "getConfiguration")
|
|
this.initForBrowser(browser, window);
|
|
|
|
return true;
|
|
},
|
|
|
|
initForBrowser(aBrowser, window) {
|
|
let gBrowser = window.gBrowser;
|
|
|
|
if (gBrowser) {
|
|
gBrowser.tabContainer.addEventListener("TabSelect", this);
|
|
}
|
|
|
|
if (!this.tourBrowsersByWindow.has(window)) {
|
|
this.tourBrowsersByWindow.set(window, new Set());
|
|
}
|
|
this.tourBrowsersByWindow.get(window).add(aBrowser);
|
|
|
|
Services.obs.addObserver(this, "message-manager-close");
|
|
|
|
window.addEventListener("SSWindowClosing", this);
|
|
},
|
|
|
|
handleEvent(aEvent) {
|
|
log.debug("handleEvent: type =", aEvent.type, "event =", aEvent);
|
|
switch (aEvent.type) {
|
|
case "TabSelect": {
|
|
let window = aEvent.target.ownerGlobal;
|
|
|
|
// Teardown the browser of the tab we just switched away from.
|
|
if (aEvent.detail && aEvent.detail.previousTab) {
|
|
let previousTab = aEvent.detail.previousTab;
|
|
let openTourWindows = this.tourBrowsersByWindow.get(window);
|
|
if (openTourWindows.has(previousTab.linkedBrowser)) {
|
|
this.teardownTourForBrowser(window, previousTab.linkedBrowser, false);
|
|
}
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
case "SSWindowClosing": {
|
|
let window = aEvent.target;
|
|
this.teardownTourForWindow(window);
|
|
break;
|
|
}
|
|
}
|
|
},
|
|
|
|
observe(aSubject, aTopic, aData) {
|
|
log.debug("observe: aTopic =", aTopic);
|
|
switch (aTopic) {
|
|
// The browser message manager is disconnected when the <browser> is
|
|
// destroyed and we want to teardown at that point.
|
|
case "message-manager-close": {
|
|
let winEnum = Services.wm.getEnumerator("navigator:browser");
|
|
while (winEnum.hasMoreElements()) {
|
|
let window = winEnum.getNext();
|
|
if (window.closed)
|
|
continue;
|
|
|
|
let tourBrowsers = this.tourBrowsersByWindow.get(window);
|
|
if (!tourBrowsers)
|
|
continue;
|
|
|
|
for (let browser of tourBrowsers) {
|
|
let messageManager = browser.messageManager;
|
|
if (aSubject != messageManager) {
|
|
continue;
|
|
}
|
|
|
|
this.teardownTourForBrowser(window, browser, true);
|
|
return;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
},
|
|
|
|
// Given a string that is a JSONified represenation of an object with
|
|
// additional utm_* URL params that should be appended, validate and append
|
|
// them to the passed URLSearchParams object. Returns true if the params
|
|
// were validated and appended, and false if the request should be ignored.
|
|
_populateCampaignParams(urlSearchParams, extraURLCampaignParams) {
|
|
// We are extra paranoid about what params we allow to be appended.
|
|
if (typeof extraURLCampaignParams == "undefined") {
|
|
// no params, so it's all good.
|
|
return true;
|
|
}
|
|
if (typeof extraURLCampaignParams != "string") {
|
|
log.warn("_populateCampaignParams: extraURLCampaignParams is not a string");
|
|
return false;
|
|
}
|
|
let campaignParams;
|
|
try {
|
|
if (extraURLCampaignParams) {
|
|
campaignParams = JSON.parse(extraURLCampaignParams);
|
|
if (typeof campaignParams != "object") {
|
|
log.warn("_populateCampaignParams: extraURLCampaignParams is not a stringified object");
|
|
return false;
|
|
}
|
|
}
|
|
} catch (ex) {
|
|
log.warn("_populateCampaignParams: extraURLCampaignParams is not a JSON object");
|
|
return false;
|
|
}
|
|
if (campaignParams) {
|
|
// The regex that the name of each param must match - there's no
|
|
// character restriction on the value - they will be escaped as necessary.
|
|
let reSimpleString = /^[-_a-zA-Z0-9]*$/;
|
|
for (let name in campaignParams) {
|
|
let value = campaignParams[name];
|
|
if (typeof name != "string" || typeof value != "string" ||
|
|
!name.startsWith("utm_") ||
|
|
value.length == 0 ||
|
|
!reSimpleString.test(name)) {
|
|
log.warn("_populateCampaignParams: invalid campaign param specified");
|
|
return false;
|
|
}
|
|
urlSearchParams.append(name, value);
|
|
}
|
|
}
|
|
return true;
|
|
},
|
|
|
|
setTelemetryBucket(aPageID) {
|
|
let bucket = BUCKET_NAME + BrowserUITelemetry.BUCKET_SEPARATOR + aPageID;
|
|
BrowserUITelemetry.setBucket(bucket);
|
|
},
|
|
|
|
setExpiringTelemetryBucket(aPageID, aType) {
|
|
let bucket = BUCKET_NAME + BrowserUITelemetry.BUCKET_SEPARATOR + aPageID +
|
|
BrowserUITelemetry.BUCKET_SEPARATOR + aType;
|
|
|
|
BrowserUITelemetry.setExpiringBucket(bucket,
|
|
BUCKET_TIMESTEPS);
|
|
},
|
|
|
|
// This is registered with UITelemetry by BrowserUITelemetry, so that UITour
|
|
// can remain lazy-loaded on-demand.
|
|
getTelemetry() {
|
|
return {
|
|
seenPageIDs: [...this.seenPageIDs.keys()],
|
|
};
|
|
},
|
|
|
|
/**
|
|
* Tear down a tour from a tab e.g. upon switching/closing tabs.
|
|
*/
|
|
async teardownTourForBrowser(aWindow, aBrowser, aTourPageClosing = false) {
|
|
log.debug("teardownTourForBrowser: aBrowser = ", aBrowser, aTourPageClosing);
|
|
|
|
if (this.pageIDSourceBrowsers.has(aBrowser)) {
|
|
let pageID = this.pageIDSourceBrowsers.get(aBrowser);
|
|
this.setExpiringTelemetryBucket(pageID, aTourPageClosing ? "closed" : "inactive");
|
|
}
|
|
|
|
let openTourBrowsers = this.tourBrowsersByWindow.get(aWindow);
|
|
if (aTourPageClosing && openTourBrowsers) {
|
|
openTourBrowsers.delete(aBrowser);
|
|
}
|
|
|
|
this.hideHighlight(aWindow);
|
|
this.hideInfo(aWindow);
|
|
|
|
let panels = [
|
|
{
|
|
name: "appMenu",
|
|
node: aWindow.PanelUI.panel,
|
|
events: [
|
|
[ "popuphidden", this.onPanelHidden ],
|
|
[ "popuphiding", this.hideAppMenuAnnotations ],
|
|
[ "ViewShowing", this.hideAppMenuAnnotations ]
|
|
]
|
|
},
|
|
{
|
|
name: "pageActionPanel",
|
|
node: aWindow.BrowserPageActions.panelNode,
|
|
events: [
|
|
[ "popuphidden", this.onPanelHidden ],
|
|
[ "popuphiding", this.hidePageActionPanelAnnotations ],
|
|
[ "ViewShowing", this.hidePageActionPanelAnnotations ]
|
|
]
|
|
},
|
|
{
|
|
name: "controlCenter",
|
|
node: aWindow.gIdentityHandler._identityPopup,
|
|
events: [
|
|
[ "popuphidden", this.onPanelHidden ],
|
|
[ "popuphiding", this.hideControlCenterAnnotations ]
|
|
]
|
|
},
|
|
];
|
|
for (let panel of panels) {
|
|
// Ensure the menu panel is hidden and clean up panel listeners after calling hideMenu.
|
|
if (panel.node.state != "closed") {
|
|
await new Promise(resolve => {
|
|
panel.node.addEventListener("popuphidden", resolve, { once: true });
|
|
this.hideMenu(aWindow, panel.name);
|
|
});
|
|
}
|
|
for (let [ name, listener ] of panel.events) {
|
|
panel.node.removeEventListener(name, listener);
|
|
}
|
|
}
|
|
|
|
this.noautohideMenus.clear();
|
|
this.resetTheme();
|
|
|
|
// If there are no more tour tabs left in the window, teardown the tour for the whole window.
|
|
if (!openTourBrowsers || openTourBrowsers.size == 0) {
|
|
this.teardownTourForWindow(aWindow);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Tear down all tours for a ChromeWindow.
|
|
*/
|
|
teardownTourForWindow(aWindow) {
|
|
log.debug("teardownTourForWindow");
|
|
aWindow.gBrowser.tabContainer.removeEventListener("TabSelect", this);
|
|
aWindow.removeEventListener("SSWindowClosing", this);
|
|
|
|
let openTourBrowsers = this.tourBrowsersByWindow.get(aWindow);
|
|
if (openTourBrowsers) {
|
|
for (let browser of openTourBrowsers) {
|
|
if (this.pageIDSourceBrowsers.has(browser)) {
|
|
let pageID = this.pageIDSourceBrowsers.get(browser);
|
|
this.setExpiringTelemetryBucket(pageID, "closed");
|
|
}
|
|
}
|
|
}
|
|
|
|
this.tourBrowsersByWindow.delete(aWindow);
|
|
},
|
|
|
|
// This function is copied to UITourListener.
|
|
isSafeScheme(aURI) {
|
|
let allowedSchemes = new Set(["https", "about"]);
|
|
if (!Services.prefs.getBoolPref("browser.uitour.requireSecure"))
|
|
allowedSchemes.add("http");
|
|
|
|
if (!allowedSchemes.has(aURI.scheme)) {
|
|
log.error("Unsafe scheme:", aURI.scheme);
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
},
|
|
|
|
resolveURL(aBrowser, aURL) {
|
|
try {
|
|
let uri = Services.io.newURI(aURL, null, aBrowser.currentURI);
|
|
|
|
if (!this.isSafeScheme(uri))
|
|
return null;
|
|
|
|
return uri.spec;
|
|
} catch (e) {}
|
|
|
|
return null;
|
|
},
|
|
|
|
sendPageCallback(aMessageManager, aCallbackID, aData = {}) {
|
|
let detail = {data: aData, callbackID: aCallbackID};
|
|
log.debug("sendPageCallback", detail);
|
|
aMessageManager.sendAsyncMessage("UITour:SendPageCallback", detail);
|
|
},
|
|
|
|
isElementVisible(aElement) {
|
|
let targetStyle = aElement.ownerGlobal.getComputedStyle(aElement);
|
|
return !aElement.ownerDocument.hidden &&
|
|
targetStyle.display != "none" &&
|
|
targetStyle.visibility == "visible";
|
|
},
|
|
|
|
getTarget(aWindow, aTargetName, aSticky = false) {
|
|
log.debug("getTarget:", aTargetName);
|
|
if (typeof aTargetName != "string" || !aTargetName) {
|
|
log.warn("getTarget: Invalid target name specified");
|
|
return Promise.reject("Invalid target name specified");
|
|
}
|
|
|
|
let targetObject = this.targets.get(aTargetName);
|
|
if (!targetObject) {
|
|
log.warn("getTarget: The specified target name is not in the allowed set");
|
|
return Promise.reject("The specified target name is not in the allowed set");
|
|
}
|
|
|
|
return new Promise(resolve => {
|
|
let targetQuery = targetObject.query;
|
|
aWindow.PanelUI.ensureReady().then(() => {
|
|
let node;
|
|
if (typeof targetQuery == "function") {
|
|
try {
|
|
node = targetQuery(aWindow.document);
|
|
} catch (ex) {
|
|
log.warn("getTarget: Error running target query:", ex);
|
|
node = null;
|
|
}
|
|
} else {
|
|
node = aWindow.document.querySelector(targetQuery);
|
|
}
|
|
|
|
resolve({
|
|
addTargetListener: targetObject.addTargetListener,
|
|
infoPanelOffsetX: targetObject.infoPanelOffsetX,
|
|
infoPanelOffsetY: targetObject.infoPanelOffsetY,
|
|
infoPanelPosition: targetObject.infoPanelPosition,
|
|
node,
|
|
removeTargetListener: targetObject.removeTargetListener,
|
|
targetName: aTargetName,
|
|
widgetName: targetObject.widgetName,
|
|
allowAdd: targetObject.allowAdd,
|
|
});
|
|
}).catch(log.error);
|
|
});
|
|
},
|
|
|
|
targetIsInAppMenu(aTarget) {
|
|
let targetElement = aTarget.node;
|
|
// Use the widget for filtering if it exists since the target may be the icon inside.
|
|
if (aTarget.widgetName) {
|
|
targetElement = aTarget.node.ownerDocument.getElementById(aTarget.widgetName);
|
|
}
|
|
|
|
return targetElement.id.startsWith("appMenu-");
|
|
},
|
|
|
|
targetIsInPageActionPanel(aTarget) {
|
|
return aTarget.node.id.startsWith("pageAction-panel-");
|
|
},
|
|
|
|
/**
|
|
* Called before opening or after closing a highlight or an info tooltip to see if
|
|
* we need to open or close the menu to see the annotation's anchor.
|
|
*
|
|
* @param {ChromeWindow} aWindow the chrome window
|
|
* @param {bool} aShouldOpen true means we should open the menu, otherwise false
|
|
* @param {String} aMenuName "appMenu" or "pageActionPanel"
|
|
*/
|
|
_setMenuStateForAnnotation(aWindow, aShouldOpen, aMenuName) {
|
|
log.debug("_setMenuStateForAnnotation: Menu is ", aMenuName);
|
|
log.debug("_setMenuStateForAnnotation: Menu is expected to be:", aShouldOpen ? "open" : "closed");
|
|
let menu = aMenuName == "appMenu" ? aWindow.PanelUI.panel : aWindow.BrowserPageActions.panelNode;
|
|
|
|
// If the panel is in the desired state, we're done.
|
|
let panelIsOpen = menu.state != "closed";
|
|
if (aShouldOpen == panelIsOpen) {
|
|
log.debug("_setMenuStateForAnnotation: Menu already in expected state");
|
|
return Promise.resolve();
|
|
}
|
|
|
|
// Actually show or hide the menu
|
|
let promise = null;
|
|
if (aShouldOpen) {
|
|
log.debug("_setMenuStateForAnnotation: Opening the menu");
|
|
promise = new Promise(resolve => {
|
|
this.showMenu(aWindow, aMenuName, resolve);
|
|
});
|
|
} else if (!this.noautohideMenus.has(aMenuName)) {
|
|
// If the menu was opened explictly by api user through `Mozilla.UITour.showMenu`,
|
|
// it should be closed explictly by api user through `Mozilla.UITour.hideMenu`.
|
|
// So we shouldn't get to here to close it for the highlight/info annotation.
|
|
log.debug("_setMenuStateForAnnotation: Closing the menu");
|
|
promise = new Promise(resolve => {
|
|
menu.addEventListener("popuphidden", resolve, { once: true });
|
|
this.hideMenu(aWindow, aMenuName);
|
|
});
|
|
}
|
|
return promise;
|
|
},
|
|
|
|
/**
|
|
* Ensure the target's visibility and the open/close states of menus for the target.
|
|
*
|
|
* @param {ChromeWindow} aChromeWindow The chrome window
|
|
* @param {Object} aTarget The target on which we show highlight or show info.
|
|
*/
|
|
async _ensureTarget(aChromeWindow, aTarget) {
|
|
let shouldOpenAppMenu = false;
|
|
let shouldOpenPageActionPanel = false;
|
|
if (this.targetIsInAppMenu(aTarget)) {
|
|
shouldOpenAppMenu = true;
|
|
} else if (this.targetIsInPageActionPanel(aTarget)) {
|
|
shouldOpenPageActionPanel = true;
|
|
// Ensure the panel visibility so as to ensure the visibility of
|
|
// the target element inside the panel otherwise
|
|
// we would be rejected in the below `isElementVisible` checking.
|
|
aChromeWindow.BrowserPageActions.panelNode.hidden = false;
|
|
}
|
|
|
|
// Prevent showing a panel at an undefined position.
|
|
if (!this.isElementVisible(aTarget.node)) {
|
|
return Promise.reject(`_ensureTarget: Reject the ${aTarget.name} target since it isn't visible.`);
|
|
}
|
|
|
|
let menuToOpen = null;
|
|
let menuClosePromises = [];
|
|
if (shouldOpenAppMenu) {
|
|
menuToOpen = "appMenu";
|
|
menuClosePromises.push(this._setMenuStateForAnnotation(aChromeWindow, false, "pageActionPanel"));
|
|
} else if (shouldOpenPageActionPanel) {
|
|
menuToOpen = "pageActionPanel";
|
|
menuClosePromises.push(this._setMenuStateForAnnotation(aChromeWindow, false, "appMenu"));
|
|
} else {
|
|
menuClosePromises.push(this._setMenuStateForAnnotation(aChromeWindow, false, "appMenu"));
|
|
menuClosePromises.push(this._setMenuStateForAnnotation(aChromeWindow, false, "pageActionPanel"));
|
|
}
|
|
|
|
let promise = Promise.all(menuClosePromises);
|
|
await promise;
|
|
if (menuToOpen) {
|
|
promise = this._setMenuStateForAnnotation(aChromeWindow, true, menuToOpen);
|
|
}
|
|
return promise;
|
|
},
|
|
|
|
previewTheme(aTheme) {
|
|
let origin = Services.prefs.getCharPref("browser.uitour.themeOrigin");
|
|
let data = LightweightThemeManager.parseTheme(aTheme, origin);
|
|
if (data)
|
|
LightweightThemeManager.previewTheme(data);
|
|
},
|
|
|
|
resetTheme() {
|
|
LightweightThemeManager.resetPreview();
|
|
},
|
|
|
|
/**
|
|
* The node to which a highlight or notification(-popup) is anchored is sometimes
|
|
* obscured because it may be inside an overflow menu. This function should figure
|
|
* that out and offer the overflow chevron as an alternative.
|
|
*
|
|
* @param {ChromeWindow} aChromeWindow The chrome window
|
|
* @param {Object} aTarget The target object whose node is supposed to be the anchor
|
|
* @type {Node}
|
|
*/
|
|
async _correctAnchor(aChromeWindow, aTarget) {
|
|
// PanelMultiView's like the AppMenu might shuffle the DOM, which might result
|
|
// in our anchor being invalidated if it was anonymous content (since the XBL
|
|
// binding it belonged to got destroyed). We work around this by re-querying for
|
|
// the node and stuffing it into the old anchor structure.
|
|
let refreshedTarget = await this.getTarget(aChromeWindow, aTarget.targetName);
|
|
let node = aTarget.node = refreshedTarget.node;
|
|
// If the target is in the overflow panel, just return the overflow button.
|
|
if (node.closest("#widget-overflow-mainView")) {
|
|
return CustomizableUI.getWidget(node.id).forWindow(aChromeWindow).anchor;
|
|
}
|
|
return node;
|
|
},
|
|
|
|
/**
|
|
* @param aChromeWindow The chrome window that the highlight is in. Necessary since some targets
|
|
* are in a sub-frame so the defaultView is not the same as the chrome
|
|
* window.
|
|
* @param aTarget The element to highlight.
|
|
* @param aEffect (optional) The effect to use from UITour.highlightEffects or "none".
|
|
* @see UITour.highlightEffects
|
|
*/
|
|
async showHighlight(aChromeWindow, aTarget, aEffect = "none") {
|
|
let showHighlightPanel = (aAnchorEl) => {
|
|
let highlighter = aChromeWindow.document.getElementById("UITourHighlight");
|
|
|
|
let effect = aEffect;
|
|
if (effect == "random") {
|
|
// Exclude "random" from the randomly selected effects.
|
|
let randomEffect = 1 + Math.floor(Math.random() * (this.highlightEffects.length - 1));
|
|
if (randomEffect == this.highlightEffects.length)
|
|
randomEffect--; // On the order of 1 in 2^62 chance of this happening.
|
|
effect = this.highlightEffects[randomEffect];
|
|
}
|
|
// Toggle the effect attribute to "none" and flush layout before setting it so the effect plays.
|
|
highlighter.setAttribute("active", "none");
|
|
aChromeWindow.getComputedStyle(highlighter).animationName;
|
|
highlighter.setAttribute("active", effect);
|
|
highlighter.parentElement.setAttribute("targetName", aTarget.targetName);
|
|
highlighter.parentElement.hidden = false;
|
|
|
|
let highlightAnchor = aAnchorEl;
|
|
let targetRect = highlightAnchor.getBoundingClientRect();
|
|
let highlightHeight = targetRect.height;
|
|
let highlightWidth = targetRect.width;
|
|
|
|
if (this.targetIsInAppMenu(aTarget)) {
|
|
highlighter.classList.remove("rounded-highlight");
|
|
} else {
|
|
highlighter.classList.add("rounded-highlight");
|
|
}
|
|
if (highlightAnchor.classList.contains("toolbarbutton-1") &&
|
|
highlightAnchor.getAttribute("cui-areatype") === "toolbar" &&
|
|
highlightAnchor.getAttribute("overflowedItem") !== "true") {
|
|
// A toolbar button in navbar has its clickable area an
|
|
// inner-contained square while the button component itself is a tall
|
|
// rectangle. We adjust the highlight area to a square as well.
|
|
highlightHeight = highlightWidth;
|
|
}
|
|
|
|
highlighter.style.height = highlightHeight + "px";
|
|
highlighter.style.width = highlightWidth + "px";
|
|
|
|
// Close a previous highlight so we can relocate the panel.
|
|
if (highlighter.parentElement.state == "showing" || highlighter.parentElement.state == "open") {
|
|
log.debug("showHighlight: Closing previous highlight first");
|
|
highlighter.parentElement.hidePopup();
|
|
}
|
|
/* The "overlap" position anchors from the top-left but we want to centre highlights at their
|
|
minimum size. */
|
|
let highlightWindow = aChromeWindow;
|
|
let highlightStyle = highlightWindow.getComputedStyle(highlighter);
|
|
let highlightHeightWithMin = Math.max(highlightHeight, parseFloat(highlightStyle.minHeight));
|
|
let highlightWidthWithMin = Math.max(highlightWidth, parseFloat(highlightStyle.minWidth));
|
|
let offsetX = (targetRect.width - highlightWidthWithMin) / 2;
|
|
let offsetY = (targetRect.height - highlightHeightWithMin) / 2;
|
|
this._addAnnotationPanelMutationObserver(highlighter.parentElement);
|
|
highlighter.parentElement.openPopup(highlightAnchor, "overlap", offsetX, offsetY);
|
|
};
|
|
|
|
try {
|
|
await this._ensureTarget(aChromeWindow, aTarget);
|
|
let anchorEl = await this._correctAnchor(aChromeWindow, aTarget);
|
|
showHighlightPanel(anchorEl);
|
|
} catch (e) {
|
|
log.warn(e);
|
|
}
|
|
},
|
|
|
|
hideHighlight(aWindow) {
|
|
let highlighter = aWindow.document.getElementById("UITourHighlight");
|
|
this._removeAnnotationPanelMutationObserver(highlighter.parentElement);
|
|
highlighter.parentElement.hidePopup();
|
|
highlighter.removeAttribute("active");
|
|
this._setMenuStateForAnnotation(aWindow, false, "appMenu");
|
|
this._setMenuStateForAnnotation(aWindow, false, "pageActionPanel");
|
|
},
|
|
|
|
/**
|
|
* Show an info panel.
|
|
*
|
|
* @param {ChromeWindow} aChromeWindow
|
|
* @param {Node} aAnchor
|
|
* @param {String} [aTitle=""]
|
|
* @param {String} [aDescription=""]
|
|
* @param {String} [aIconURL=""]
|
|
* @param {Object[]} [aButtons=[]]
|
|
* @param {Object} [aOptions={}]
|
|
* @param {String} [aOptions.closeButtonCallback]
|
|
* @param {String} [aOptions.targetCallback]
|
|
*/
|
|
async showInfo(aChromeWindow, aAnchor, aTitle = "", aDescription = "",
|
|
aIconURL = "", aButtons = [], aOptions = {}) {
|
|
let showInfoPanel = (aAnchorEl) => {
|
|
aAnchorEl.focus();
|
|
|
|
let document = aChromeWindow.document;
|
|
let tooltip = document.getElementById("UITourTooltip");
|
|
let tooltipTitle = document.getElementById("UITourTooltipTitle");
|
|
let tooltipDesc = document.getElementById("UITourTooltipDescription");
|
|
let tooltipIcon = document.getElementById("UITourTooltipIcon");
|
|
let tooltipButtons = document.getElementById("UITourTooltipButtons");
|
|
|
|
if (tooltip.state == "showing" || tooltip.state == "open") {
|
|
tooltip.hidePopup();
|
|
}
|
|
|
|
tooltipTitle.textContent = aTitle || "";
|
|
tooltipDesc.textContent = aDescription || "";
|
|
tooltipIcon.src = aIconURL || "";
|
|
tooltipIcon.hidden = !aIconURL;
|
|
|
|
while (tooltipButtons.firstChild)
|
|
tooltipButtons.firstChild.remove();
|
|
|
|
for (let button of aButtons) {
|
|
let isButton = button.style != "text";
|
|
let el = document.createElement(isButton ? "button" : "label");
|
|
el.setAttribute(isButton ? "label" : "value", button.label);
|
|
|
|
if (isButton) {
|
|
if (button.iconURL)
|
|
el.setAttribute("image", button.iconURL);
|
|
|
|
if (button.style == "link")
|
|
el.setAttribute("class", "button-link");
|
|
|
|
if (button.style == "primary")
|
|
el.setAttribute("class", "button-primary");
|
|
|
|
// Don't close the popup or call the callback for style=text as they
|
|
// aren't links/buttons.
|
|
let callback = button.callback;
|
|
el.addEventListener("command", event => {
|
|
tooltip.hidePopup();
|
|
callback(event);
|
|
});
|
|
}
|
|
|
|
tooltipButtons.appendChild(el);
|
|
}
|
|
|
|
tooltipButtons.hidden = !aButtons.length;
|
|
|
|
let tooltipClose = document.getElementById("UITourTooltipClose");
|
|
let closeButtonCallback = (event) => {
|
|
this.hideInfo(document.defaultView);
|
|
if (aOptions && aOptions.closeButtonCallback) {
|
|
aOptions.closeButtonCallback();
|
|
}
|
|
};
|
|
tooltipClose.addEventListener("command", closeButtonCallback);
|
|
|
|
let targetCallback = (event) => {
|
|
let details = {
|
|
target: aAnchor.targetName,
|
|
type: event.type,
|
|
};
|
|
aOptions.targetCallback(details);
|
|
};
|
|
if (aOptions.targetCallback && aAnchor.addTargetListener) {
|
|
aAnchor.addTargetListener(document, targetCallback);
|
|
}
|
|
|
|
tooltip.addEventListener("popuphiding", function(event) {
|
|
tooltipClose.removeEventListener("command", closeButtonCallback);
|
|
if (aOptions.targetCallback && aAnchor.removeTargetListener) {
|
|
aAnchor.removeTargetListener(document, targetCallback);
|
|
}
|
|
}, {once: true});
|
|
|
|
tooltip.setAttribute("targetName", aAnchor.targetName);
|
|
tooltip.hidden = false;
|
|
let alignment = "bottomcenter topright";
|
|
if (aAnchor.infoPanelPosition) {
|
|
alignment = aAnchor.infoPanelPosition;
|
|
}
|
|
|
|
let { infoPanelOffsetX: xOffset, infoPanelOffsetY: yOffset } = aAnchor;
|
|
|
|
this._addAnnotationPanelMutationObserver(tooltip);
|
|
tooltip.openPopup(aAnchorEl, alignment, xOffset || 0, yOffset || 0);
|
|
if (tooltip.state == "closed") {
|
|
document.defaultView.addEventListener("endmodalstate", function() {
|
|
tooltip.openPopup(aAnchorEl, alignment);
|
|
}, {once: true});
|
|
}
|
|
};
|
|
|
|
try {
|
|
await this._ensureTarget(aChromeWindow, aAnchor);
|
|
let anchorEl = await this._correctAnchor(aChromeWindow, aAnchor);
|
|
showInfoPanel(anchorEl);
|
|
} catch (e) {
|
|
log.warn(e);
|
|
}
|
|
},
|
|
|
|
isInfoOnTarget(aChromeWindow, aTargetName) {
|
|
let document = aChromeWindow.document;
|
|
let tooltip = document.getElementById("UITourTooltip");
|
|
return tooltip.getAttribute("targetName") == aTargetName && tooltip.state != "closed";
|
|
},
|
|
|
|
hideInfo(aWindow) {
|
|
let document = aWindow.document;
|
|
let tooltip = document.getElementById("UITourTooltip");
|
|
this._removeAnnotationPanelMutationObserver(tooltip);
|
|
tooltip.hidePopup();
|
|
this._setMenuStateForAnnotation(aWindow, false, "appMenu");
|
|
this._setMenuStateForAnnotation(aWindow, false, "pageActionPanel");
|
|
|
|
let tooltipButtons = document.getElementById("UITourTooltipButtons");
|
|
while (tooltipButtons.firstChild)
|
|
tooltipButtons.firstChild.remove();
|
|
},
|
|
|
|
showMenu(aWindow, aMenuName, aOpenCallback = null) {
|
|
log.debug("showMenu:", aMenuName);
|
|
function openMenuButton(aMenuBtn) {
|
|
if (!aMenuBtn || !aMenuBtn.boxObject || aMenuBtn.open) {
|
|
if (aOpenCallback)
|
|
aOpenCallback();
|
|
return;
|
|
}
|
|
if (aOpenCallback)
|
|
aMenuBtn.addEventListener("popupshown", aOpenCallback, { once: true });
|
|
aMenuBtn.boxObject.openMenu(true);
|
|
}
|
|
|
|
if (aMenuName == "appMenu" || aMenuName == "pageActionPanel") {
|
|
let menu = {
|
|
onPanelHidden: this.onPanelHidden
|
|
};
|
|
if (aMenuName == "appMenu") {
|
|
menu.node = aWindow.PanelUI.panel;
|
|
menu.hideMenuAnnotations = this.hideAppMenuAnnotations;
|
|
menu.show = () => aWindow.PanelUI.show();
|
|
} else {
|
|
menu.node = aWindow.BrowserPageActions.panelNode;
|
|
menu.hideMenuAnnotations = this.hidePageActionPanelAnnotations;
|
|
menu.show = () => aWindow.BrowserPageActions.showPanel();
|
|
}
|
|
|
|
menu.node.setAttribute("noautohide", "true");
|
|
// If the popup is already opened, don't recreate the widget as it may cause a flicker.
|
|
if (menu.node.state != "open") {
|
|
this.recreatePopup(menu.node);
|
|
}
|
|
if (aOpenCallback) {
|
|
menu.node.addEventListener("popupshown", aOpenCallback, { once: true });
|
|
}
|
|
menu.node.addEventListener("popuphidden", menu.onPanelHidden);
|
|
menu.node.addEventListener("popuphiding", menu.hideMenuAnnotations);
|
|
menu.node.addEventListener("ViewShowing", menu.hideMenuAnnotations);
|
|
menu.show();
|
|
} else if (aMenuName == "bookmarks") {
|
|
let menuBtn = aWindow.document.getElementById("bookmarks-menu-button");
|
|
openMenuButton(menuBtn);
|
|
} else if (aMenuName == "controlCenter") {
|
|
let popup = aWindow.gIdentityHandler._identityPopup;
|
|
|
|
// Add the listener even if the panel is already open since it will still
|
|
// only get registered once even if it was UITour that opened it.
|
|
popup.addEventListener("popuphiding", this.hideControlCenterAnnotations);
|
|
popup.addEventListener("popuphidden", this.onPanelHidden);
|
|
|
|
popup.setAttribute("noautohide", "true");
|
|
this.clearAvailableTargetsCache();
|
|
|
|
if (popup.state == "open") {
|
|
if (aOpenCallback) {
|
|
aOpenCallback();
|
|
}
|
|
return;
|
|
}
|
|
|
|
this.recreatePopup(popup);
|
|
|
|
// Open the control center
|
|
if (aOpenCallback) {
|
|
popup.addEventListener("popupshown", aOpenCallback, { once: true });
|
|
}
|
|
aWindow.document.getElementById("identity-box").click();
|
|
} else if (aMenuName == "pocket") {
|
|
this.getTarget(aWindow, "pocket").then(async function onPocketTarget(target) {
|
|
let widgetGroupWrapper = CustomizableUI.getWidget(target.widgetName);
|
|
if (widgetGroupWrapper.type != "view" || !widgetGroupWrapper.viewId) {
|
|
log.error("Can't open the pocket menu without a view");
|
|
return;
|
|
}
|
|
let placement = CustomizableUI.getPlacementOfWidget(target.widgetName);
|
|
if (!placement || !placement.area) {
|
|
log.error("Can't open the pocket menu without a placement");
|
|
return;
|
|
}
|
|
|
|
if (placement.area == CustomizableUI.AREA_PANEL) {
|
|
// Open the appMenu and wait for it if it's not already opened or showing a subview.
|
|
await new Promise((resolve, reject) => {
|
|
if (aWindow.PanelUI.panel.state != "closed") {
|
|
if (aWindow.PanelUI.multiView.showingSubView) {
|
|
reject("A subview is already showing");
|
|
return;
|
|
}
|
|
|
|
resolve();
|
|
return;
|
|
}
|
|
|
|
aWindow.PanelUI.panel.addEventListener("popupshown", function() {
|
|
resolve();
|
|
}, {once: true});
|
|
|
|
aWindow.PanelUI.show();
|
|
});
|
|
}
|
|
|
|
let widgetWrapper = widgetGroupWrapper.forWindow(aWindow);
|
|
aWindow.PanelUI.showSubView(widgetGroupWrapper.viewId,
|
|
widgetWrapper.anchor,
|
|
placement.area);
|
|
}).catch(log.error);
|
|
} else if (aMenuName == "urlbar") {
|
|
this.getTarget(aWindow, "urlbar").then(target => {
|
|
let urlbar = target.node;
|
|
if (aOpenCallback) {
|
|
urlbar.popup.addEventListener("popupshown", aOpenCallback, { once: true });
|
|
}
|
|
urlbar.focus();
|
|
// To demonstrate the ability of searching, we type "Firefox" in advance
|
|
// for URLBar's dropdown. To limit the search results on browser-related
|
|
// items, we use "Firefox" hard-coded rather than l10n brandShortName
|
|
// entity to avoid unrelated or unpredicted results for, like, Nightly
|
|
// or translated entites.
|
|
const SEARCH_STRING = "Firefox";
|
|
urlbar.value = SEARCH_STRING;
|
|
urlbar.select();
|
|
urlbar.controller.startSearch(SEARCH_STRING);
|
|
}).catch(Cu.reportError);
|
|
}
|
|
},
|
|
|
|
hideMenu(aWindow, aMenuName) {
|
|
log.debug("hideMenu:", aMenuName);
|
|
function closeMenuButton(aMenuBtn) {
|
|
if (aMenuBtn && aMenuBtn.boxObject)
|
|
aMenuBtn.boxObject.openMenu(false);
|
|
}
|
|
|
|
if (aMenuName == "appMenu") {
|
|
aWindow.PanelUI.hide();
|
|
} else if (aMenuName == "bookmarks") {
|
|
let menuBtn = aWindow.document.getElementById("bookmarks-menu-button");
|
|
closeMenuButton(menuBtn);
|
|
} else if (aMenuName == "controlCenter") {
|
|
let panel = aWindow.gIdentityHandler._identityPopup;
|
|
panel.hidePopup();
|
|
} else if (aMenuName == "urlbar") {
|
|
aWindow.gURLBar.closePopup();
|
|
} else if (aMenuName == "pageActionPanel") {
|
|
aWindow.BrowserPageActions.panelNode.hidePopup();
|
|
}
|
|
},
|
|
|
|
showNewTab(aWindow, aBrowser) {
|
|
aWindow.openLinkIn("about:newtab", "current", {targetBrowser: aBrowser});
|
|
},
|
|
|
|
_hideAnnotationsForPanel(aEvent, aTargetPositionCallback) {
|
|
let win = aEvent.target.ownerGlobal;
|
|
let annotationElements = new Map([
|
|
// [annotationElement (panel), method to hide the annotation]
|
|
[win.document.getElementById("UITourHighlightContainer"), UITour.hideHighlight.bind(UITour)],
|
|
[win.document.getElementById("UITourTooltip"), UITour.hideInfo.bind(UITour)],
|
|
]);
|
|
annotationElements.forEach((hideMethod, annotationElement) => {
|
|
if (annotationElement.state != "closed") {
|
|
let targetName = annotationElement.getAttribute("targetName");
|
|
UITour.getTarget(win, targetName).then((aTarget) => {
|
|
// Since getTarget is async, we need to make sure that the target hasn't
|
|
// changed since it may have just moved to somewhere outside of the app menu.
|
|
if (annotationElement.getAttribute("targetName") != aTarget.targetName ||
|
|
annotationElement.state == "closed" ||
|
|
!aTargetPositionCallback(aTarget)) {
|
|
return;
|
|
}
|
|
hideMethod(win);
|
|
}).catch(log.error);
|
|
}
|
|
});
|
|
},
|
|
|
|
hideAppMenuAnnotations(aEvent) {
|
|
UITour._hideAnnotationsForPanel(aEvent, UITour.targetIsInAppMenu);
|
|
},
|
|
|
|
hidePageActionPanelAnnotations(aEvent) {
|
|
UITour._hideAnnotationsForPanel(aEvent, UITour.targetIsInPageActionPanel);
|
|
},
|
|
|
|
hideControlCenterAnnotations(aEvent) {
|
|
UITour._hideAnnotationsForPanel(aEvent, (aTarget) => {
|
|
return aTarget.targetName.startsWith("controlCenter-");
|
|
});
|
|
},
|
|
|
|
onPanelHidden(aEvent) {
|
|
aEvent.target.removeAttribute("noautohide");
|
|
UITour.recreatePopup(aEvent.target);
|
|
UITour.clearAvailableTargetsCache();
|
|
},
|
|
|
|
recreatePopup(aPanel) {
|
|
// After changing popup attributes that relate to how the native widget is created
|
|
// (e.g. @noautohide) we need to re-create the frame/widget for it to take effect.
|
|
if (aPanel.hidden) {
|
|
// If the panel is already hidden, we don't need to recreate it but flush
|
|
// in case someone just hid it.
|
|
aPanel.clientWidth; // flush
|
|
return;
|
|
}
|
|
aPanel.hidden = true;
|
|
aPanel.clientWidth; // flush
|
|
aPanel.hidden = false;
|
|
},
|
|
|
|
getConfiguration(aMessageManager, aWindow, aConfiguration, aCallbackID) {
|
|
switch (aConfiguration) {
|
|
case "appinfo":
|
|
this.getAppInfo(aMessageManager, aWindow, aCallbackID);
|
|
break;
|
|
case "availableTargets":
|
|
this.getAvailableTargets(aMessageManager, aWindow, aCallbackID);
|
|
break;
|
|
case "search":
|
|
case "selectedSearchEngine":
|
|
Services.search.init(rv => {
|
|
let data;
|
|
if (Components.isSuccessCode(rv)) {
|
|
let engines = Services.search.getVisibleEngines();
|
|
data = {
|
|
searchEngineIdentifier: Services.search.defaultEngine.identifier,
|
|
engines: engines.filter((engine) => engine.identifier)
|
|
.map((engine) => TARGET_SEARCHENGINE_PREFIX + engine.identifier)
|
|
};
|
|
} else {
|
|
data = {engines: [], searchEngineIdentifier: ""};
|
|
}
|
|
this.sendPageCallback(aMessageManager, aCallbackID, data);
|
|
});
|
|
break;
|
|
case "sync":
|
|
this.sendPageCallback(aMessageManager, aCallbackID, {
|
|
setup: Services.prefs.prefHasUserValue("services.sync.username"),
|
|
desktopDevices: Services.prefs.getIntPref("services.sync.clients.devices.desktop", 0),
|
|
mobileDevices: Services.prefs.getIntPref("services.sync.clients.devices.mobile", 0),
|
|
totalDevices: Services.prefs.getIntPref("services.sync.numClients", 0),
|
|
});
|
|
break;
|
|
case "canReset":
|
|
this.sendPageCallback(aMessageManager, aCallbackID, ResetProfile.resetSupported());
|
|
break;
|
|
default:
|
|
log.error("getConfiguration: Unknown configuration requested: " + aConfiguration);
|
|
break;
|
|
}
|
|
},
|
|
|
|
setConfiguration(aWindow, aConfiguration, aValue) {
|
|
switch (aConfiguration) {
|
|
case "defaultBrowser":
|
|
// Ignore aValue in this case because the default browser can only
|
|
// be set, not unset.
|
|
try {
|
|
let shell = aWindow.getShellService();
|
|
if (shell) {
|
|
shell.setDefaultBrowser(true, false);
|
|
}
|
|
} catch (e) {}
|
|
break;
|
|
default:
|
|
log.error("setConfiguration: Unknown configuration requested: " + aConfiguration);
|
|
break;
|
|
}
|
|
},
|
|
|
|
getAppInfo(aMessageManager, aWindow, aCallbackID) {
|
|
(async() => {
|
|
let props = ["defaultUpdateChannel", "version"];
|
|
let appinfo = {};
|
|
props.forEach(property => appinfo[property] = Services.appinfo[property]);
|
|
|
|
// Identifier of the partner repack, as stored in preference "distribution.id"
|
|
// and included in Firefox and other update pings. Note this is not the same as
|
|
// Services.appinfo.distributionID (value of MOZ_DISTRIBUTION_ID is set at build time).
|
|
let distribution =
|
|
Services.prefs.getDefaultBranch("distribution.").getCharPref("id", "default");
|
|
appinfo.distribution = distribution;
|
|
|
|
let isDefaultBrowser = null;
|
|
try {
|
|
let shell = aWindow.getShellService();
|
|
if (shell) {
|
|
isDefaultBrowser = shell.isDefaultBrowser(false);
|
|
}
|
|
} catch (e) {}
|
|
appinfo.defaultBrowser = isDefaultBrowser;
|
|
|
|
let canSetDefaultBrowserInBackground = true;
|
|
if (AppConstants.isPlatformAndVersionAtLeast("win", "6.2") ||
|
|
AppConstants.isPlatformAndVersionAtLeast("macosx", "10.10")) {
|
|
canSetDefaultBrowserInBackground = false;
|
|
} else if (AppConstants.platform == "linux") {
|
|
// The ShellService may not exist on some versions of Linux.
|
|
try {
|
|
aWindow.getShellService();
|
|
} catch (e) {
|
|
canSetDefaultBrowserInBackground = null;
|
|
}
|
|
}
|
|
|
|
appinfo.canSetDefaultBrowserInBackground =
|
|
canSetDefaultBrowserInBackground;
|
|
|
|
// Expose Profile creation and last reset dates in weeks.
|
|
const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
|
|
let profileAge = new ProfileAge(null, null);
|
|
let createdDate = await profileAge.created;
|
|
let resetDate = await profileAge.reset;
|
|
let createdWeeksAgo = Math.floor((Date.now() - createdDate) / ONE_WEEK);
|
|
let resetWeeksAgo = null;
|
|
if (resetDate) {
|
|
resetWeeksAgo = Math.floor((Date.now() - resetDate) / ONE_WEEK);
|
|
}
|
|
appinfo.profileCreatedWeeksAgo = createdWeeksAgo;
|
|
appinfo.profileResetWeeksAgo = resetWeeksAgo;
|
|
|
|
this.sendPageCallback(aMessageManager, aCallbackID, appinfo);
|
|
})().catch(err => {
|
|
log.error(err);
|
|
this.sendPageCallback(aMessageManager, aCallbackID, {});
|
|
})
|
|
},
|
|
|
|
getAvailableTargets(aMessageManager, aChromeWindow, aCallbackID) {
|
|
(async () => {
|
|
let window = aChromeWindow;
|
|
let data = this.availableTargetsCache.get(window);
|
|
if (data) {
|
|
log.debug("getAvailableTargets: Using cached targets list", data.targets.join(","));
|
|
this.sendPageCallback(aMessageManager, aCallbackID, data);
|
|
return;
|
|
}
|
|
|
|
let promises = [];
|
|
for (let targetName of this.targets.keys()) {
|
|
promises.push(this.getTarget(window, targetName));
|
|
}
|
|
let targetObjects = await Promise.all(promises);
|
|
|
|
let targetNames = [];
|
|
for (let targetObject of targetObjects) {
|
|
if (targetObject.node)
|
|
targetNames.push(targetObject.targetName);
|
|
}
|
|
|
|
data = {
|
|
targets: targetNames,
|
|
};
|
|
this.availableTargetsCache.set(window, data);
|
|
this.sendPageCallback(aMessageManager, aCallbackID, data);
|
|
})().catch(err => {
|
|
log.error(err);
|
|
this.sendPageCallback(aMessageManager, aCallbackID, {
|
|
targets: [],
|
|
});
|
|
});
|
|
},
|
|
|
|
addNavBarWidget(aTarget, aMessageManager, aCallbackID) {
|
|
if (aTarget.node) {
|
|
log.error("addNavBarWidget: can't add a widget already present:", aTarget);
|
|
return;
|
|
}
|
|
if (!aTarget.allowAdd) {
|
|
log.error("addNavBarWidget: not allowed to add this widget:", aTarget);
|
|
return;
|
|
}
|
|
if (!aTarget.widgetName) {
|
|
log.error("addNavBarWidget: can't add a widget without a widgetName property:", aTarget);
|
|
return;
|
|
}
|
|
|
|
CustomizableUI.addWidgetToArea(aTarget.widgetName, CustomizableUI.AREA_NAVBAR);
|
|
this.sendPageCallback(aMessageManager, aCallbackID);
|
|
},
|
|
|
|
_addAnnotationPanelMutationObserver(aPanelEl) {
|
|
if (AppConstants.platform == "linux") {
|
|
let observer = this._annotationPanelMutationObservers.get(aPanelEl);
|
|
if (observer) {
|
|
return;
|
|
}
|
|
let win = aPanelEl.ownerGlobal;
|
|
observer = new win.MutationObserver(this._annotationMutationCallback);
|
|
this._annotationPanelMutationObservers.set(aPanelEl, observer);
|
|
let observerOptions = {
|
|
attributeFilter: ["height", "width"],
|
|
attributes: true,
|
|
};
|
|
observer.observe(aPanelEl, observerOptions);
|
|
}
|
|
},
|
|
|
|
_removeAnnotationPanelMutationObserver(aPanelEl) {
|
|
if (AppConstants.platform == "linux") {
|
|
let observer = this._annotationPanelMutationObservers.get(aPanelEl);
|
|
if (observer) {
|
|
observer.disconnect();
|
|
this._annotationPanelMutationObservers.delete(aPanelEl);
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Workaround for Ubuntu panel craziness in bug 970788 where incorrect sizes get passed to
|
|
* nsXULPopupManager::PopupResized and lead to incorrect width and height attributes getting
|
|
* set on the panel.
|
|
*/
|
|
_annotationMutationCallback(aMutations) {
|
|
for (let mutation of aMutations) {
|
|
// Remove both attributes at once and ignore remaining mutations to be proccessed.
|
|
mutation.target.removeAttribute("width");
|
|
mutation.target.removeAttribute("height");
|
|
return;
|
|
}
|
|
},
|
|
|
|
selectSearchEngine(aID) {
|
|
return new Promise((resolve, reject) => {
|
|
Services.search.init((rv) => {
|
|
if (!Components.isSuccessCode(rv)) {
|
|
reject("selectSearchEngine: search service init failed: " + rv);
|
|
return;
|
|
}
|
|
|
|
let engines = Services.search.getVisibleEngines();
|
|
for (let engine of engines) {
|
|
if (engine.identifier == aID) {
|
|
Services.search.defaultEngine = engine;
|
|
resolve();
|
|
return;
|
|
}
|
|
}
|
|
reject("selectSearchEngine could not find engine with given ID");
|
|
});
|
|
});
|
|
},
|
|
|
|
notify(eventName, params) {
|
|
let winEnum = Services.wm.getEnumerator("navigator:browser");
|
|
while (winEnum.hasMoreElements()) {
|
|
let window = winEnum.getNext();
|
|
if (window.closed)
|
|
continue;
|
|
|
|
let openTourBrowsers = this.tourBrowsersByWindow.get(window);
|
|
if (!openTourBrowsers)
|
|
continue;
|
|
|
|
for (let browser of openTourBrowsers) {
|
|
let messageManager = browser.messageManager;
|
|
if (!messageManager) {
|
|
log.error("notify: Trying to notify a browser without a messageManager", browser);
|
|
continue;
|
|
}
|
|
let detail = {
|
|
event: eventName,
|
|
params,
|
|
};
|
|
messageManager.sendAsyncMessage("UITour:SendPageNotification", detail);
|
|
}
|
|
}
|
|
},
|
|
};
|
|
|
|
function controlCenterTrackingToggleTarget(aUnblock) {
|
|
return {
|
|
infoPanelPosition: "rightcenter topleft",
|
|
query(aDocument) {
|
|
let popup = aDocument.defaultView.gIdentityHandler._identityPopup;
|
|
if (popup.state != "open") {
|
|
return null;
|
|
}
|
|
let buttonId = null;
|
|
if (aUnblock) {
|
|
if (PrivateBrowsingUtils.isWindowPrivate(aDocument.defaultView)) {
|
|
buttonId = "tracking-action-unblock-private";
|
|
} else {
|
|
buttonId = "tracking-action-unblock";
|
|
}
|
|
} else {
|
|
buttonId = "tracking-action-block";
|
|
}
|
|
let element = aDocument.getElementById(buttonId);
|
|
return UITour.isElementVisible(element) ? element : null;
|
|
},
|
|
};
|
|
}
|
|
|
|
this.UITour.init();
|
|
|
|
/**
|
|
* UITour Health Report
|
|
*/
|
|
/**
|
|
* Public API to be called by the UITour code
|
|
*/
|
|
const UITourHealthReport = {
|
|
recordTreatmentTag(tag, value) {
|
|
return TelemetryController.submitExternalPing("uitour-tag",
|
|
{
|
|
version: 1,
|
|
tagName: tag,
|
|
tagValue: value,
|
|
},
|
|
{
|
|
addClientId: true,
|
|
addEnvironment: true,
|
|
});
|
|
}
|
|
};
|