1835135 - gnome-search-provider: Configure application name in DBUS_BUS_NAME and DBUS_OBJECT_PATH

Status: RESOLVED FIXED

(Core :: Widget: Gtk, task, P3)

Description

[Darkspirit]

MOZ_APP_REMOTINGNAME can be firefox, firefox-beta, firefox-aurora, firefox-nightly, firefox-esr.

Current file: https://searchfox.org/mozilla-central/rev/ca52886e3b6051ca87861567e0c7628915f68780/browser/components/shell/nsGNOMEShellDBusHelper.h#18

DBUS_BUS_NAME "org.mozilla.Firefox.SearchProvider"
DBUS_OBJECT_PATH "/org/mozilla/Firefox/SearchProvider"

DBUS_BUS_NAME should be org.mozilla.MOZ_APP_REMOTINGNAME.SearchProvider
DBUS_OBJECT_PATH should be /org/mozilla/MOZ_APP_REMOTINGNAME/SearchProvider

MOZ_APP_REMOTINGNAME is already used here: https://searchfox.org/mozilla-central/rev/ca52886e3b6051ca87861567e0c7628915f68780/toolkit/xre/nsAppRunner.cpp#4637

g_set_prgname(gAppData->remotingName);

Comment 1

[Martin Stránský [:stransky] (ni? me)]

Attachment: Bug 1835135 [Linux] Set correct application name to Gnome search provider r?emilio

Comment 2

[Martin Stránský [:stransky] (ni? me)]

Unfortunately this doesn't work as DBus refuses to use interface/path names with '-' char.
As I see Bug 1805440 and Bug 1835141 it would be better to use env variable to set search provider DBus name.

Comment 3

[Martin Stránský [:stransky] (ni? me)]

Attachment: Bug 1835135 [Linux] Use MOZ_DBUS_APP_NAME env variable to set application name for Gnome search provider r?emilio

Depends on D179203

Comment 4

[Martin Stránský [:stransky] (ni? me)]

I wonder if we need such patch for other DBus code too - for instance remoting one:
https://searchfox.org/mozilla-central/rev/f4d3fe187cf7dffa4c13b354bbde9bc47b5ccd3f/toolkit/components/remote/nsDBusRemoteServer.cpp#96

Comment 5

[Darkspirit]

org.mozilla.firefox_nightly and org.mozilla.thunderbird are already used for dbus in snapcraft.yaml.

• DBUS:
  XRemote dbus name seems to contain base64(profilename) so that parallel running profiles would be fine.
  But the search provider dbus name couldn't contain base64(profilename) because search-provider.ini would need to know it which is not possible.

  XREAppData::GetDBusAppName returns MOZ_APP_REMOTINGNAME with "-" replaced with "_" .

  How it should probably be:
  XRemote: org.mozilla.<what GetDBusAppName returns>.<base64(profilename)>
  Search: org.mozilla.<what GetDBusAppName returns>.SearchProvider

  Snap doesn't support Gnome search providers yet: https://forum.snapcraft.io/t/gnome-shell-search-providers-in-snaps/5265

• bug 1826330:
  The terms DesktopId and Wayland app id refer to <DesktopId>.desktop.
  Call g_set_prgname() with desktopid that you get from a new method XREAppData::GetDesktopId which should return:

  • if IsRunningUnderFlatpak()
    org.mozilla.<MOZ_APP_REMOTINGNAME with "-" replaced with "_" > // to match org.mozilla.firefox.desktop, org.mozilla.thunderbird.desktop
    org.mozilla.<what GetDBusAppName returns>
  • else if SNAP_NAME env var is not empty:
    • If SNAP_INSTANCE_KEY env var is not empty:
      <SNAP_NAME>+<SNAP_INSTANCE_KEY>_<SNAP_NAME> // to match firefox+userdefinedaliasname_firefox.desktop, thunderbird+userdefinedaliasname_thunderbird.desktop
    • else
      <SNAP_NAME>_<SNAP_NAME> // to match firefox_firefox.desktop, thunderbird_thunderbird.desktop
  • else
    MOZ_APP_REMOTINGNAME // to match firefox-nightly.desktop, thunderbird.desktop

  Snap background:
  packagename can have multiple apps with desktop file. First app's name is usually the same as packagename.
  $ sudo snap install packagename
$ sudo snap install packagename_userdefinedaliasname
$ snap run packagename is possible if appname==packagename
  $ snap run packagename.appname (packagename_appname.desktop)
  $ snap run packagename_userdefinedaliasname is possible if appname==packagename
  $ snap run packagename_userdefinedaliasname.appname (packagename+userdefinedaliasname_appname.desktop)

  SNAP_NAME env var contains packagename.
  SNAP_INSTANCE_KEY env var contains userdefinedaliasname.
  SNAP_INSTANCE_NAME is packagename_userdefinedaliasname
  There is no env var for appname.

  $ cat /var/lib/snapd/desktop/applications/firefox+minefield_firefox.desktop

  [Desktop Entry]
  X-SnapInstanceName=firefox_minefield
  [...]
  Exec=env BAMF_DESKTOP_FILE_HINT=/var/lib/snapd/desktop/applications/firefox+minefield_firefox.desktop /snap/bin/firefox_minefield %u
  [...]

  I assume KDE Wayland ignores the BAMF_DESKTOP_FILE_HINT, otherwise it might have shown the correct icon.

• DBUS usage in https://searchfox.org/mozilla-central/rev/0c2945ad4769e2d4428c72e6ddd78d60eb920394/dom/system/linux/GeoclueLocationProvider.cpp#476
  At the moment, GetDBusAppName would just return firefox_nightly IIUC.
  https://www.freedesktop.org/software/geoclue/docs/gdbus-org.freedesktop.GeoClue2.Client.html#gdbus-property-org-freedesktop-GeoClue2-Client.DesktopId

  The desktop file id (the basename of the desktop file). This property must be set by applications for authorization to work.

  Maybe the call to GetDBusAppName
  a) should be replaced with new GetDesktopId
  b) or should stay because it might break in case the DesktopId is "firefox+userdefinedaliasname_firefox".

---

https://dbus.freedesktop.org/doc/dbus-specification.html

Note that the hyphen ('-') character is allowed in bus names but not in interface names. It is also problematic or not allowed in various specifications and APIs that refer to D-Bus, such as Flatpak application IDs, the DBusActivatable interface in the Desktop Entry Specification, and the convention that an application's "main" interface and object path resemble its bus name. To avoid situations that require special-case handling, it is recommended that new D-Bus names consistently replace hyphens with underscores.

• In case a Nightly flatpak package should ever be made, it should probably be named org.mozilla.firefox_nightly.
• Debian packages names require the opposite: "-" and not "_".
• These use "-" in Flatpak application ids:
  https://flathub.org/apps/org.gnome.font-viewer
  https://flathub.org/apps/com.github.bajoja.indicator-kdeconnect
• These use both:
  org.gnome.Evolution-alarm-notify.desktop
  org.kde.plasma.browser_integration.host.desktop (https://addons.mozilla.org/en-US/firefox/addon/plasma-integration/)

Comment 6

[Martin Stránský [:stransky] (ni? me)]

Thanks. I think we should use XREAppData::GetDBusAppName() then and add ability to override the app name there.

Comment 7

[Martin Stránský [:stransky] (ni? me)]

Attachment: Bug 1835135 [Linux] Use XREAppData::GetDBusAppName() to create Gnome shell search provider DBus name/path r?emilio

Depends on D179203

Comment 8

[Martin Stránský [:stransky] (ni? me)]

Attachment: Bug 1835135 [Linux] Allow to override DBus application name by MOZ_DBUS_APP_NAME env variable r?emilio

Depends on D179432

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/964b57d61881
[Linux] Set correct application name to Gnome search provider r=emilio
https://hg.mozilla.org/integration/autoland/rev/a7f56dd3c21c
[Linux] Use XREAppData::GetDBusAppName() to create Gnome shell search provider DBus name/path r=emilio
https://hg.mozilla.org/integration/autoland/rev/238468b1748e
[Linux] Allow to override DBus application name by MOZ_DBUS_APP_NAME env variable r=emilio

Comment 10

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/964b57d61881
https://hg.mozilla.org/mozilla-central/rev/a7f56dd3c21c
https://hg.mozilla.org/mozilla-central/rev/238468b1748e