summaryrefslogtreecommitdiffstats
path: root/mobile/android/components/extensions/ext-browserAction.js
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /mobile/android/components/extensions/ext-browserAction.js
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'mobile/android/components/extensions/ext-browserAction.js')
-rw-r--r--mobile/android/components/extensions/ext-browserAction.js191
1 files changed, 191 insertions, 0 deletions
diff --git a/mobile/android/components/extensions/ext-browserAction.js b/mobile/android/components/extensions/ext-browserAction.js
new file mode 100644
index 0000000000..f8c3c3ce74
--- /dev/null
+++ b/mobile/android/components/extensions/ext-browserAction.js
@@ -0,0 +1,191 @@
+/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* vim: set sts=2 sw=2 et tw=80: */
+/* 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";
+
+ChromeUtils.defineESModuleGetters(this, {
+ GeckoViewWebExtension: "resource://gre/modules/GeckoViewWebExtension.sys.mjs",
+ ExtensionActionHelper: "resource://gre/modules/GeckoViewWebExtension.sys.mjs",
+});
+
+const { BrowserActionBase } = ChromeUtils.importESModule(
+ "resource://gre/modules/ExtensionActions.sys.mjs"
+);
+
+const BROWSER_ACTION_PROPERTIES = [
+ "title",
+ "icon",
+ "popup",
+ "badgeText",
+ "badgeBackgroundColor",
+ "badgeTextColor",
+ "enabled",
+ "patternMatching",
+];
+
+class BrowserAction extends BrowserActionBase {
+ constructor(extension, clickDelegate) {
+ const tabContext = new TabContext(tabId => this.getContextData(null));
+ super(tabContext, extension);
+ this.clickDelegate = clickDelegate;
+ this.helper = new ExtensionActionHelper({
+ extension,
+ tabTracker,
+ windowTracker,
+ tabContext,
+ properties: BROWSER_ACTION_PROPERTIES,
+ });
+ }
+
+ updateOnChange(tab) {
+ const tabId = tab ? tab.id : null;
+ const action = tab
+ ? this.getContextData(tab)
+ : this.helper.extractProperties(this.globals);
+ this.helper.sendRequest(tabId, {
+ action,
+ type: "GeckoView:BrowserAction:Update",
+ });
+ }
+
+ openPopup(tab, openPopupWithoutUserInteraction = false) {
+ const popupUri = openPopupWithoutUserInteraction
+ ? this.getPopupUrl(tab)
+ : this.triggerClickOrPopup(tab);
+ const actionObject = this.getContextData(tab);
+ const action = this.helper.extractProperties(actionObject);
+ this.helper.sendRequest(tab.id, {
+ action,
+ type: "GeckoView:BrowserAction:OpenPopup",
+ popupUri,
+ });
+ }
+
+ triggerClickOrPopup(tab = tabTracker.activeTab) {
+ return super.triggerClickOrPopup(tab);
+ }
+
+ getTab(tabId) {
+ return this.helper.getTab(tabId);
+ }
+
+ getWindow(windowId) {
+ return this.helper.getWindow(windowId);
+ }
+
+ dispatchClick() {
+ this.clickDelegate.onClick();
+ }
+}
+
+this.browserAction = class extends ExtensionAPIPersistent {
+ static for(extension) {
+ return GeckoViewWebExtension.browserActions.get(extension);
+ }
+
+ async onManifestEntry(entryName) {
+ const { extension } = this;
+ this.action = new BrowserAction(extension, this);
+ await this.action.loadIconData();
+
+ GeckoViewWebExtension.browserActions.set(extension, this.action);
+
+ // Notify the embedder of this action
+ this.action.updateOnChange(null);
+ }
+
+ onShutdown() {
+ const { extension } = this;
+ this.action.onShutdown();
+ GeckoViewWebExtension.browserActions.delete(extension);
+ }
+
+ onClick() {
+ this.emit("click", tabTracker.activeTab);
+ }
+
+ PERSISTENT_EVENTS = {
+ onClicked({ context, fire }) {
+ const { extension } = this;
+ const { tabManager } = extension;
+ async function listener(_event, tab) {
+ if (fire.wakeup) {
+ await fire.wakeup();
+ }
+ // TODO: we should double-check if the tab is already being closed by the time
+ // the background script got started and we converted the primed listener.
+ fire.sync(tabManager.convert(tab));
+ }
+ this.on("click", listener);
+ return {
+ unregister: () => {
+ this.off("click", listener);
+ },
+ convert(newFire, extContext) {
+ fire = newFire;
+ context = extContext;
+ },
+ };
+ },
+ };
+
+ getAPI(context) {
+ const { extension } = context;
+ const { action } = this;
+ const namespace =
+ extension.manifestVersion < 3 ? "browserAction" : "action";
+
+ return {
+ [namespace]: {
+ ...action.api(context),
+
+ onClicked: new EventManager({
+ context,
+ // module name is "browserAction" because it the name used in the
+ // ext-browser.json, independently from the manifest version.
+ module: "browserAction",
+ event: "onClicked",
+ // NOTE: Firefox Desktop event has inputHandling set to true here.
+ // inputHandling: true,
+ extensionApi: this,
+ }).api(),
+
+ openPopup: options => {
+ const isHandlingUserInput =
+ context.callContextData?.isHandlingUserInput;
+
+ if (
+ !Services.prefs.getBoolPref(
+ "extensions.openPopupWithoutUserGesture.enabled"
+ ) &&
+ !isHandlingUserInput
+ ) {
+ throw new ExtensionError("openPopup requires a user gesture");
+ }
+
+ const currentWindow = windowTracker.getCurrentWindow(context);
+
+ const window =
+ typeof options?.windowId === "number"
+ ? windowTracker.getWindow(options.windowId, context)
+ : currentWindow;
+
+ if (window !== currentWindow) {
+ throw new ExtensionError(
+ "Only the current window is supported on Android."
+ );
+ }
+
+ if (this.action.getPopupUrl(window.tab, true)) {
+ action.openPopup(window.tab, !isHandlingUserInput);
+ }
+ },
+ },
+ };
+ }
+};
+
+global.browserActionFor = this.browserAction.for;