WIP: FEAT(client): Add support to XDG Desktop Portal GlobalShortcuts by aleixpol · Pull Request #5976 · mumble-voip/mumble

aleixpol · 2022-11-25T18:57:35Z

This makes it possible to have global shortcuts on systems running the XDG Desktop Portal service. This is especially relevant on Wayland where we are not able to run a system-wide keylogger to get the global shortcuts triggers.

Fixes #5257

Checks

My commits follow the commit guidelines

WIP because I'm not very familiar because this is a codebase alien to me and I'm aware it's doing some nasty things. Still, I'd prefer to know how the maintainers want to do it rather than imagining myself what they want instead.

Note the GlobalShortcuts portal is merged to master but it still isn't released.

Krzmbrzl

Why is the implementation using the name "xdp" rather than "xdg"?

And I'm wondering: Given that this is such a new feature, do we want to keep the old wayland notice in-place and show, if on wayland and if the new impl is not available?

Krzmbrzl · 2022-11-27T18:23:04Z

+	qt_add_dbus_interface(mumble_xdp_SRCS org.freedesktop.portal.GlobalShortcuts.xml globalshortcuts_portal_interface)
+	find_file(PORTALSREQUEST_XML share/dbus-1/interfaces/org.freedesktop.portal.Request.xml PATH_SUFFIXES share PATHS /usr ${CMAKE_INSTALL_PREFIX})
+	qt_add_dbus_interface(mumble_xdp_SRCS ${PORTALSREQUEST_XML} portalsrequest_interface)
+	target_sources(mumble_client_object_lib PRIVATE ${mumble_xdp_SRCS})


I feel like this should be outsourced into a dedicated cmake function implemented in a file inside the cmake directory. Then this place here could simply call that function.

Plus, it seems that we currently don't handle the case when the searched for file can't be found.

I moved both files to auxiliary_files.

I am not sure what you mean by adding the function. Do you still want it if we are not looking it up?

Krzmbrzl · 2022-11-27T18:44:16Z

And out of curiosity: Will this be a flatpak-specific thing or will this (likely) solve the issue for Wayland users in general (also for non-flatpak apps)?

aleixpol · 2022-11-28T00:56:49Z

And out of curiosity: Will this be a flatpak-specific thing or will this (likely) solve the issue for Wayland users in general (also for non-flatpak apps)?

Yes, this should solve it for every Wayland system. Also it can work on X11 provided it's properly implemented in the backend like we are doing in KDE/Plasma and I expect others will too.

Krzmbrzl

Sorry for the long delay since my last review - I have been rather busy

Krzmbrzl · 2022-12-28T11:38:15Z

-#ifdef Q_OS_LINUX
-	if (EnvUtils::waylandIsUsed()) {
-		// Due to the issues we're currently having on Wayland, we disable shortcuts by default
-		bShortcutEnable = false;
-	}
-#endif


This should probably get the same treatment as the note in the settings UI

Krzmbrzl · 2022-12-28T11:47:34Z

+        // TODO
+        return {};


Just marking this so we don't lose track of this TODO

So to address this TODO we'll need to use an interface like this:
https://invent.kde.org/libraries/xdg-portal-test-kde/-/merge_requests/18

This means depending on Qt::GuiPrivate and libwaylandclient. If you are interested in this I can include it in this PR.

Hm. This seems rather hacky. What are the implications of simply leaving the implementation as it is? Aka: what exactly is the parent window ID being used for?
Will this perhaps only become relevant when dealing with multiple Mumble instances?

The parent window is simply to inform the portal who is calling this and which window the dialog should be on top.

The dialog will appear on top and focussed anyway, so it shouldn't be a big deal. FWIW, there will be public API for this in Qt 6 (6.5, if I'm not mistaken). If you don't want to depend on private API, just delaying until Qt 6 is a good option.

Okay in that case it indeed seems a good idea to simply delay this 👍

This makes it possible to have global shortcuts on systems running the XDG Desktop Portal service. This is especially relevant on Wayland where we are not able to run a system-wide keylogger to get the global shortcuts triggers. Fixes mumble-voip#5257

CounterPillow · 2023-02-16T19:17:23Z

Two awkward things I've noticed which may or may not be related to the implementation in this PR:

you can't bind mouse buttons to global shortcuts. I assume this is either a deficiency specifically with this PR or with KDE's GlobalShortcuts interface ignoring all mouse presses
pressing a modifier while pressing a key does not allow for that key to be picked up by the shortcut, so if I bind F13 (or as KDE calls it, "Tools") to push-to-talk, I also need to bind shift+Tools, shift+ctrl+Tools, ctrl+Tools, alt+tools, ... which may be a deficiency in the entire protocol.

aleixpol · 2023-02-18T02:19:45Z

you can't bind mouse buttons to global shortcuts.

Correct, we don't have global shortcuts triggered my mouse in Plasma. It should be supported by Plasma or the Desktop Environment of choice of the user anyway.

pressing a modifier while pressing a key does not allow for that key to be picked up by the shortcut,

Again, this is Plasma deciding that they are not the same shortcut and not triggering it. There's not much we can (or should) do from this side. I suggest we continue this discussion in the bug report you created: https://bugs.kde.org/show_bug.cgi?id=465867

I suggest explaining a bit more on the bug report why it's important for anymodifier to trigger the subject's shortcut. If we have clear use cases it will be easier to get it acted on.

SopaDeMacaco-UmaDelicia · 2023-05-28T01:47:35Z

What's the status of this PR? Can't wait to enjoy global shortcuts in Mumble using KDE Wayland.

k3d3 · 2024-07-31T23:21:32Z

Has any more progress been made on this?

her001 · 2025-06-26T02:23:02Z

Can this still be moved forward or salvaged? The most popular Wayland compositors now support the GlobalShortcuts XDG desktop portal, many distros default to Wayland, and xorg is no longer shipping by default in some distros.

One of the decisions from the code reviews was to wait for Qt 6. Mumble is now on Qt 6: #6516

Without intimate familiarity, it looks like this could move forward with relatively small changes. Is that accurate? Do we need volunteers to help move this forward?

Thanks!

distinctjuggle · 2025-10-12T22:20:59Z

I know I'm going to sound like, "that guy", however this has been the only thing keeping me on X11 for the past 2-3 years. I'd be great if it could finally be resolved as Wayland would fix several other bugs and shortcomings that I'm facing from unrelated applications.

k3d3 · 2025-10-12T22:31:42Z

You're definitely not the only one in that boat. Though I'm using a workaround that at least lets me use Wayland for everything else.

This is, of course, not an option for every DE, but I'm using Wayland KDE - what I do, is force mumble to use XWayland (just unsetting WAYLAND_DISPLAY in the startup shortcut), and then I enable the legacy X11 keyboard shortcuts in the KDE settings.

I personally don't feel uncomfortable with the idea that one window could see the keystrokes of another (just watch this end up biting me in the future), but at the very least this lets me not be completely stuck with X11 at a top level.

Of course, I would still much prefer this gets implemented properly for Wayland.

distinctjuggle · 2025-10-12T22:35:32Z

You're definitely not the only one in that boat. Though I'm using a workaround that at least lets me use Wayland for everything else.

This is, of course, not an option for every DE, but I'm using Wayland KDE - what I do, is force mumble to use XWayland (just unsetting WAYLAND_DISPLAY in the startup shortcut), and then I enable the legacy X11 keyboard shortcuts in the KDE settings.

I personally don't feel uncomfortable with the idea that one window could see the keystrokes of another (just watch this end up biting me in the future), but at the very least this lets me not be completely stuck with X11 at a top level.

Of course, I would still much prefer this gets implemented properly for Wayland.

Thanks, I wasn't aware of that option! I know there's workarounds for things like muting/deafening like mumble rpc togglemute / toggledeaf but that wasn't going to help me with push to talk / push to mute.

Does this workaround work even when system focus is given to Wayland applications?

k3d3 · 2025-10-12T22:38:16Z

It sure does! This is built into KDE, and since KDE is acting as the compositor, it has effectively raw access to the keyboard.

ThePastorJ · 2025-12-25T01:07:44Z

Is there any update on this?

KDE have announced they are moving towards a wayland only future, as is gnome and the whole linux desktop ecosystem. Currently the janky KDE x11 passthrough works for hotkeys whilst using an xwayland application, but wayland proton is also right around the corner. It's going to become very frustrating not have a PTT solution for mumble in the coming months if this doesn't get implemented soon.

Krzmbrzl · 2025-12-25T15:47:38Z

No updates. If there were any, they would be visible here.

davidebeatrici · 2025-12-26T20:51:25Z

Well, I do have an update: turns out the Desktop Portal GlobalShortcuts as it stands right now is not great. The idea itself is nice because hotkeys/shortcuts for applications should indeed be managed from a single place that is runs on the system, for both consistency and security.

However, the implementation is disappointing:

Only mouse/keyboard input appears to be detected.
You can not distinguish between multiple devices of the same type.
You can not distinguish between left/right modifiers on the keyboard.

Since we need a unified interface for other operating systems such as Windows and macOS anyway, I'm working on a service with a GUI configurator. Still in very early development, but the overall idea is there.

unraidcitadel · 2026-01-07T15:38:29Z

This would be a really nice to have. Recently started using mumble again and this is really the only pain point.

jadahl · 2026-01-07T15:51:16Z

Only mouse/keyboard input appears to be detected.

You can not distinguish between multiple devices of the same type.

You can not distinguish between left/right modifiers on the keyboard.

Note that the portal is designed to allow backends to bind any event from any input device, be it device class or specific device, distinguish between different variants of the same modifier, etc. What currently is relatively limiting is only the hint the application passes about the preferred binding, but whether there are more advanced binding actually used is up to the portal backend.

her001 · 2026-01-07T16:27:24Z

I personally feel that the global shortcuts portal is suitable for solving this, but that GNOME, Plasma, and other desktops need to improve their implementations. Implementing the portal in Mumble can show to the big desktops the use case for supporting things on their end that they currently don't.

davidebeatrici · 2026-01-08T02:21:37Z

Note that the portal is designed to allow backends to bind any event from any input device, be it device class or specific device, distinguish between different variants of the same modifier, etc. What currently is relatively limiting is only the hint the application passes about the preferred binding, but whether there are more advanced binding actually used is up to the portal backend.

Could you elaborate more on that, please?

jadahl · 2026-01-08T08:54:44Z

Could you elaborate more on that, please?

The passed binding preference is only a hint, and to just start somewhere, we defined https://specifications.freedesktop.org/shortcuts/latest/ for the basic keyboard shortcut hints. But the backend is free to let the user bind any action it prefers, be it mouse/keyboard/pedals/butter fly flap/.... The portal API is designed to let backends dynamically grow capabilities independently of what can actually be specified using some spec.

In other words, "I (user) want to bind this type of input action" feature requests can be routed to portal backends, and "I (developer) want to describe this hint" will typically go the route of first creating a specification how to describe such a hint, then amending the portal to allow passing such a hint.

davidebeatrici · 2026-01-08T18:51:12Z

Neat! Could you also point out which portal backend(s) can/should be enhanced?

jadahl · 2026-01-08T19:18:07Z

Neat! Could you also point out which portal backend(s) can/should be enhanced?

The ones I know of that appear to implement it are xdg-desktop-portal-kde, xdg-desktop-portal-gnome and xdg-desktop-portal-hyprland.

aleixpol force-pushed the work/xdp-support branch from e9f84da to c1fd93f Compare November 25, 2022 19:20

aleixpol mentioned this pull request Nov 27, 2022

global-shortcuts: Signal arguments are outputs flatpak/xdg-desktop-portal#917

Merged

Krzmbrzl added client linux feature-request This issue or PR deals with a new feature GlobalShortcuts labels Nov 27, 2022

Krzmbrzl requested changes Nov 27, 2022

View reviewed changes

Krzmbrzl marked this pull request as draft November 27, 2022 19:06

aleixpol force-pushed the work/xdp-support branch from e00c411 to a59e8f3 Compare November 28, 2022 00:54

aleixpol mentioned this pull request Dec 15, 2022

Global keyboard shortcut portal flatpak/xdg-desktop-portal#624

Closed

Krzmbrzl reviewed Dec 28, 2022

View reviewed changes

aleixpol force-pushed the work/xdp-support branch 2 times, most recently from 6fbe414 to 62bb6d9 Compare January 2, 2023 15:10

aleixpol force-pushed the work/xdp-support branch from 62bb6d9 to 0e0f075 Compare January 2, 2023 17:17

Aviana mentioned this pull request Apr 4, 2023

[WIP] Global Shortcuts impl hyprwm/xdg-desktop-portal-hyprland#35

Merged

5 tasks

Hartmnt mentioned this pull request Jun 13, 2023

Enable push to talk shortcut button settings in wayland session #6146

Closed

Aviana mentioned this pull request Dec 7, 2023

Global Shortcuts Portal silent propagation of shortcuts flatpak/xdg-desktop-portal#1101

Open

This was referenced May 25, 2024

Lets get org.freedesktop.portal.GlobalShortcuts off the ground Skycoder42/QHotkey#99

Closed

xdg-desktop-portal org.freedesktop.portal.GlobalShortcuts Skycoder42/QHotkey#89

Open

aleixpol mentioned this pull request Jun 21, 2024

Keyboard shortcuts don't work on Wayland #5257

Open

davidebeatrici self-assigned this Jun 27, 2025

c4llv07e mentioned this pull request Jan 13, 2026

[WIP] Unix display independent global shortcuts solution. #7048

Closed

1 task

davidebeatrici mentioned this pull request Feb 27, 2026

DOCS(client): Document how global shortcuts work on KDE Wayland #7081

Closed

1 task

Krzmbrzl added this to Review Queue Aug 13, 2026

github-project-automation Bot moved this to Todo in Review Queue Aug 13, 2026

Uh oh!

Uh oh!

Conversation

aleixpol commented Nov 25, 2022

Checks

Uh oh!

Krzmbrzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Krzmbrzl commented Nov 27, 2022

Uh oh!

aleixpol commented Nov 28, 2022

Uh oh!

Krzmbrzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CounterPillow commented Feb 16, 2023

Uh oh!

aleixpol commented Feb 18, 2023

Uh oh!

SopaDeMacaco-UmaDelicia commented May 28, 2023

Uh oh!

k3d3 commented Jul 31, 2024

Uh oh!

her001 commented Jun 26, 2025

Uh oh!

distinctjuggle commented Oct 12, 2025

Uh oh!

k3d3 commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

distinctjuggle commented Oct 12, 2025

Uh oh!

k3d3 commented Oct 12, 2025

Uh oh!

ThePastorJ commented Dec 25, 2025

Uh oh!

Krzmbrzl commented Dec 25, 2025

Uh oh!

davidebeatrici commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

unraidcitadel commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jadahl commented Jan 7, 2026

Uh oh!

k3d3 commented Oct 12, 2025 •

edited

Loading

davidebeatrici commented Dec 26, 2025 •

edited

Loading

unraidcitadel commented Jan 7, 2026 •

edited

Loading