firefox-main/browser/components/customizableui/SearchWidgetTracker.sys.mjs (file symbol)

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
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
import { CustomizableUI } from "moz-src:///browser/components/customizableui/CustomizableUI.sys.mjs";
const WIDGET_ID = "search-container";
/**
* Updates persisted widths when the search bar is removed from any
* customizable area and put into the palette. Also automatically removes the
* search bar if it has not been used in a long time.
*/
export const SearchWidgetTracker = {
/**
* Main entrypoint to initializing the SearchWidgetTracker.
*/
init() {
CustomizableUI.addListener(this);
this._removeWidgetIfUnused();
},
/**
* The callback for when a widget is moved via CustomizableUI. We use this
* to detect movement of the search bar.
*
* @param {Element} node
* The DOM node that was acted upon.
* @param {Element|null} _nextNode
* The DOM node (if any) that the widget was inserted before.
* @param {Element} _container
* The *actual* DOM container for the widget (could be an overflow panel in
* case of an overflowable toolbar).
* @param {boolean} wasRemoval
* True iff the action that happened was the removal of the DOM node.
*/
onWidgetAfterDOMChange(node, _nextNode, _container, wasRemoval) {
if (node.id == WIDGET_ID && wasRemoval) {
this._removePersistedWidths();
}
},
onCustomizeStart() {
this._widgetWasInNavBar = this._widgetIsInNavBar;
},
onCustomizeEnd() {
if (!this._widgetWasInNavBar && this._widgetIsInNavBar) {
// We consider the widget "used" when manually placing it, so that
// restarting without searching first won't automatically remove it again.
Services.prefs.setStringPref(
"browser.search.widget.lastUsed",
new Date().toISOString()
);
}
delete this._widgetWasInNavBar;
},
/**
* If the search bar is in the navigation toolbar, this method will check
* the lastUsed preference to see when the last time the search bar was
* actually used. If the number of days since it was last used exceeds a
* certain threshold, the widget is moved back into the customization
* palette.
*/
_removeWidgetIfUnused() {
if (!this._widgetIsInNavBar) {
return;
}
let searchBarLastUsed = Services.prefs.getStringPref(
"browser.search.widget.lastUsed",
""
);
if (searchBarLastUsed) {
const removeAfterDaysUnused = Services.prefs.getIntPref(
"browser.search.widget.removeAfterDaysUnused"
);
let saerchBarUnusedThreshold =
removeAfterDaysUnused * 24 * 60 * 60 * 1000;
if (new Date() - new Date(searchBarLastUsed) > saerchBarUnusedThreshold) {
CustomizableUI.removeWidgetFromArea(WIDGET_ID);
// BrowserUsageTelemetry may silently do nothing when called too early
// during startup, so we call Glean directly instead. This means that we
// can't leverage BrowserUsageTelemetry to record the previous position
// of the search bar, so we use `na`; for this particular short-lived
// probe, we're only interested in recording that the auto-removal
// happened.
Glean.browserUi.customizedWidgets[
"search-container_remove_na_na_auto-unused"
].add(1);
}
}
},
/**
* Removes any widget customization on the search bar (which can be created
* with the resizer that appears if the search bar is placed immediately after
* the URL bar). Goes through each open browser window and removes the width
* property / style on each existant search bar.
*/
_removePersistedWidths() {
Services.xulStore.removeValue(
AppConstants.BROWSER_CHROME_URL,
WIDGET_ID,
"width"
);
for (let win of CustomizableUI.windows) {
let searchbar =
win.document.getElementById(WIDGET_ID) ||
win.gNavToolbox.palette.querySelector("#" + WIDGET_ID);
searchbar.removeAttribute("width");
searchbar.style.removeProperty("width");
}
},
/**
* True if the search bar is currently in the navigation toolbar area.
*
* @type {boolean}
*/
get _widgetIsInNavBar() {
let placement = CustomizableUI.getPlacementOfWidget(WIDGET_ID);
return placement?.area == CustomizableUI.AREA_NAVBAR;
},
};