xavierk/voculinux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Fix: IBus engine restore uses wrong fallback on GNOME/Wayland (#497) (#500)

Browse Source 
* Fix: IBus engine restore uses wrong fallback on GNOME/Wayland (#497)

On GNOME/Wayland, when IBus has no global engine (common when Mutter
manages input sources), 'ibus engine' can return a misleading
'xkb:us::eng' default that doesn't match the user's actual keyboard
layout. When Vocalinux restores this wrong value after text injection,
Electron apps switch to US layout.

Root cause: get_current_engine() trusted the output of 'ibus engine'
without checking whether IBus actually had a global engine set, and
had no fallback to discover the real keyboard layout.

Fix:
- Add get_current_engine_gnome_fallback() that reads the actual
  keyboard layout from org.gnome.desktop.input-sources via gsettings
- Modify get_current_engine() to detect 'No global engine' in stderr
  and to detect the suspicious 'xkb:us::eng' default on GNOME/Wayland,
  falling back to gsettings in both cases
- Modify stop() to log a message when skipping engine restoration
  because no valid engine was captured (None means don't restore)
- Modify inject_text() to log when skipping restoration after
  injection for the same reason
- Backward compatible: if gsettings is unavailable, falls back to
  current behavior (returning None or the IBus-reported value)

Tests: 12 new tests covering GNOME fallback, 'No global engine'
detection, suspicious default detection, gsettings parsing, and
edge cases.

* ponytail: simplify gsettings uint32 parsing

gsettings prints 'uint32 N' or just 'N' — split()[-1] handles both,
no need for separate branches

---------

Co-authored-by: Jatin K Malik <jatinkrmalik@users.noreply.github.com>
This commit is contained in:
Jatin K Malik
2026-07-11 05:42:00 +05:30
committed by GitHub
co-authored by Jatin K Malik
parent 3303d075a6
commit 4e3637dfb5
2 changed files with 335 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/vocalinux/text_injection/ibus_engine.py
+148 -6
View File
@@ -309,20 +309,150 @@ def is_engine_active() -> bool:
return False
def get_current_engine() -> Optional[str]:
"""Get the currently active IBus engine name."""
try:
import subprocess
def _is_gnome_session() -> bool:
"""Check if the current session is running under GNOME."""
desktop = os.environ.get("XDG_CURRENT_DESKTOP", "")
return "GNOME" in desktop.upper()
def get_current_engine_gnome_fallback() -> Optional[str]:
"""
Get the current keyboard layout as an IBus engine name via GNOME settings.
On GNOME/Wayland, IBus may have no global engine (input sources are managed
by Mutter, not ibus-daemon). In that case ``ibus engine`` returns nothing
or a misleading ``xkb:us::eng`` default. This function reads the actual
keyboard layout from ``org.gnome.desktop.input-sources`` via gsettings.
Returns:
IBus-format engine name (e.g. ``xkb:br::``) or None if not GNOME
or if gsettings fails.
"""
if not _is_gnome_session():
return None
try:
sources_result = subprocess.run(
["gsettings", "get", "org.gnome.desktop.input-sources", "sources"],
capture_output=True,
text=True,
timeout=5,
)
if sources_result.returncode != 0:
logger.debug("gsettings get sources failed; not using GNOME fallback")
return None
import ast
sources = ast.literal_eval(sources_result.stdout.strip())
if not sources:
logger.debug("GNOME input-sources list is empty")
return None
# Get the current index
current_result = subprocess.run(
["gsettings", "get", "org.gnome.desktop.input-sources", "current"],
capture_output=True,
text=True,
timeout=5,
)
if current_result.returncode != 0:
current_idx = 0
else:
# ponytail: gsettings prints "uint32 N" or just "N" — split()[-1] handles both
current_idx = int(current_result.stdout.strip().split()[-1])
if current_idx < 0 or current_idx >= len(sources):
current_idx = 0
source_type, source_id = sources[current_idx]
# GNOME uses ('xkb', 'br+dyn') or ('ibus', 'anthy') tuples.
# For xkb sources, build an IBus engine name like xkb:<layout>::<variant>
if source_type == "xkb":
layout, _, variant = source_id.partition("+")
if variant:
engine_name = f"xkb:{layout}::{variant}"
else:
engine_name = f"xkb:{layout}::"
logger.debug(
f"GNOME fallback: current source index {current_idx}, "
f"engine name: {engine_name}"
)
return engine_name
elif source_type == "ibus":
# IBus IM engine — return the engine ID directly
logger.debug(f"GNOME fallback: current source is IBus engine '{source_id}'")
return source_id
logger.debug(f"GNOME fallback: unknown source type '{source_type}'")
return None
except (
subprocess.SubprocessError,
FileNotFoundError,
ValueError,
SyntaxError,
) as e:
logger.debug(f"GNOME fallback via gsettings failed: {e}")
return None
def get_current_engine() -> Optional[str]:
"""
Get the currently active IBus engine name.
On GNOME/Wayland, IBus may have no global engine set (Mutter manages input
sources). In that case ``ibus engine`` can return a misleading
``xkb:us::eng`` default that doesn't match the user's actual keyboard
layout. We detect this and fall back to reading the layout from GNOME's
gsettings so the real layout is preserved during engine restore.
Returns:
The IBus engine name, or None if it cannot be determined.
"""
try:
result = subprocess.run(
["ibus", "engine"],
capture_output=True,
text=True,
timeout=5,
)
# Check for "No global engine" in stderr (ibus-daemon has no
# global engine set — common on GNOME/Wayland where Mutter manages
# input sources).
stderr_lower = result.stderr.lower() if result.stderr else ""
if "no global engine" in stderr_lower:
logger.debug(
"ibus engine reports 'No global engine'; " "attempting GNOME gsettings fallback"
)
return get_current_engine_gnome_fallback()
if result.returncode == 0:
engine = result.stdout.strip()
return engine if engine else None
if not engine:
return None
# On GNOME/Wayland, ``ibus engine`` can return ``xkb:us::eng``
# as a default fallback even when the user's actual layout is
# different (e.g. Brazilian ABNT2). Detect this suspicious
# default and try the GNOME gsettings fallback for the real
# layout before trusting the IBus output (see issue #497).
if engine == "xkb:us::eng" and _is_gnome_session() and _is_wayland_session():
logger.debug(
"ibus engine returned 'xkb:us::eng' on GNOME/Wayland; "
"attempting GNOME gsettings fallback (see #497)"
)
gnome_engine = get_current_engine_gnome_fallback()
if gnome_engine and gnome_engine != engine:
logger.debug(
f"GNOME gsettings reports different engine: "
f"{gnome_engine} (was {engine})"
)
return gnome_engine
return engine
except (subprocess.SubprocessError, FileNotFoundError):
pass
return None
@@ -996,12 +1126,19 @@ class IBusTextInjector:
"""
Stop the IBus text injector and restore previous engine and XKB layout.
Call this when Vocalinux is shutting down.
Call this when Vocalinux is shutting down. If no valid engine was
captured before injection (e.g. on GNOME/Wayland with no global IBus
engine), restoration is skipped to avoid switching the user to a
wrong layout (see issue #497).
"""
if self._previous_engine:
logger.info(f"Restoring previous engine: {self._previous_engine}")
switch_engine(self._previous_engine)
self._previous_engine = None
else:
logger.info(
"Skipping engine restoration — " "no valid engine was captured before injection"
)
# Restore the XKB layout that was captured during setup
# This ensures the user's original keyboard layout is preserved
@@ -1146,6 +1283,11 @@ class IBusTextInjector:
if restore_engine:
logger.debug(f"Restoring IBus engine after injection: {restore_engine}")
switch_engine(restore_engine)
else:
logger.debug(
"Skipping engine restoration after injection — "
"no valid engine was captured (see #497)"
)
return False