fix: use more stable GObject signal

fix: detect running Flatpak Steam correctly

dzgui/api/steam.py

@@ -6,6 +6,7 @@ import subprocess
 import vdf  # type: ignore
 
 from pathlib import Path
+from requests.exceptions import HTTPError
 from typing import Any, Union
 from warnings import deprecated
 
@@ -32,6 +33,7 @@ from dzgui.const.endpoints import (
     UNSUB_ENDPOINT,
 )
 from dzgui.strings import wizard
+from dzgui.strings.errors import api_validation_error, workshop_endpoint_error
 from dzgui.util.bash import concat_bash_args
 
 logger = logging.getLogger(APP_NAME)
@@ -262,6 +264,16 @@ def find_user_id_32(path: Path) -> int:
     return int(uid) & 0xFFFFFFFF
 
 
+class SteamAPIKeyError(Exception):
+    def __init__(self, msg=None):
+        super().__init__(msg or api_validation_error)
+
+
+class SteamWorkshopEndpointError(Exception):
+    def __init__(self, msg=None):
+        super().__init__(msg or workshop_endpoint_error)
+
+
 def update_workshop(key: str, mod: int, endpoint: str) -> None:
     payload: dict[str, Union[int, str]] = {
         "publishedfileid": mod,
@@ -273,8 +285,19 @@ def update_workshop(key: str, mod: int, endpoint: str) -> None:
     try:
         res = requests.post(endpoint, params=payload, timeout=REQUEST_TIMEOUT)
         res.raise_for_status()
+    except HTTPError as e:
+        logger.critical(e)
+        match res.status_code:
+            case 403:
+                raise SteamAPIKeyError()
+            case 404:
+                raise SteamWorkshopEndpointError()
+            case _:
+                # TODO: apply redaction filter
+                raise e
     except Exception as e:
         logger.critical(e)
+        raise e
 
 
 def subscribe(key: str, mod: int) -> None:

dzgui/controllers/mc.py

@@ -541,8 +541,8 @@ class Controller(GObject.GObject):
     def update_status(self) -> None:
         self.mediator.preconnect.mark_finished()
 
-    def get_steam_client_name(self) -> str:
-        return self.mediator.options.get_client_name()
+    def get_steam_client_name(self, cmd: str) -> str:
+        return self.mediator.options.get_client_name(cmd)
 
     def present_window(self) -> None:
         self.mediator.window.present_with_time(Gdk.CURRENT_TIME)

dzgui/init/proc.py

@@ -16,12 +16,15 @@ logger = logging.getLogger(APP_NAME)
 
 
 def is_steam_running(cmd: str) -> bool:
-    if cmd == STEAM_CMD:
+    is_flatpak_running = is_flatpak_steam_running()
+    if cmd in (FLATPAK_RUN_CMD, FLATPAK_SANDBOX):
+        return is_flatpak_running
+    elif cmd == STEAM_CMD:
+        if is_flatpak_running:
+            return False
         if has_cmd(STEAM_CMD) is False:
             return False
         return is_running(STEAM_CMD)
-    elif cmd == FLATPAK_RUN_CMD or FLATPAK_SANDBOX:
-        return is_flatpak_steam_running()
     else:
         raise TypeError("Not a valid Steam client selection")
 
@@ -31,7 +34,9 @@ def is_steam_running(cmd: str) -> bool:
 def is_flatpak_steam_running() -> bool:
     if has_cmd(FLATPAK_CMD) is False:
         return False
-    proc = subprocess.check_output([FLATPAK_CMD, "ps"], text=True)
+    proc = subprocess.check_output(
+        [FLATPAK_CMD, "ps", "--columns=application"], text=True
+    )
     lines = proc.splitlines()
     if FLATPAK_APPID in lines:
         return True

dzgui/managers/connection.py

@@ -48,7 +48,7 @@ from dzgui.strings.dialogs import (
 )
 from dzgui.strings import kb
 from dzgui.strings.server_mods import checkmark, resync
-from dzgui.util.format import format_mib
+from dzgui.util.format import format_exception, format_mib
 from dzgui.util.strings import dialog, server_timeout
 from dzgui.util.symlink import rebuild_symlinks
 from dzgui.views.dialogs.generic import ExceptionDialog
@@ -184,8 +184,8 @@ class ConnectionManager:
         else:
             allows_downloads = (True, "")
 
-        client_name = self.controller.get_steam_client_name()
         client = self.controller.query_config(Preferences.CLIENT)
+        client_name = self.controller.get_steam_client_name(client)
         running = is_steam_running(client)
         steam_proc = SteamProcess(client_name, running)
         self.client = client
@@ -300,6 +300,11 @@ class ConnectionManager:
         dialog = ServerDetailsDialog(self.controller, details)
         dialog.run()
 
+    def _workshop_timeout(self, msg: str) -> None:
+        dialog = ExceptionDialog(self.controller, msg)
+        dialog.show_all()
+        dialog.run()
+
     def _server_timeout(self) -> None:
         dialog = ExceptionDialog(self.controller, server_timeout)
         dialog.set_details_buffer(kb.DZG_006)
@@ -351,8 +356,14 @@ class ConnectionManager:
         for title, mod, stamp, size in self.missing_mods:
             if self.controller.is_cancel_pending():
                 return
-            subscribe(key, int(mod))
-            time.sleep(API_RATE_LIMIT)
+            try:
+                subscribe(key, int(mod))
+                time.sleep(API_RATE_LIMIT)
+            except Exception as e:
+                msg = format_exception(e)
+                func = StoredFunc(self._workshop_timeout, msg)
+                self.thread_man.set_cleanup_func(func, destroy_first=True)
+                return
 
         self.thread_man.update_dialog(waiting_for_directories)
         for title, mod, stamp, size in self.missing_mods:

dzgui/managers/mods.py

@@ -122,7 +122,11 @@ class ModManager:
     def unsub_atomic_mod(self, mod: str) -> None:
         config_man = self.controller.get_config_man()
         key = config_man.lookup(Preferences.STEAM)
-        unsubscribe(key, int(mod))
+        try:
+            unsubscribe(key, int(mod))
+        except Exception as e:
+            logger.critical(e)
+            return
 
         steam_path = Path(self.path)
         app_path = PeFile.get_nested_app_path(steam_path, APPID_DAYZ)

dzgui/strings/errors.py

@@ -4,3 +4,4 @@ api_validation_error = (
 
 api_popover = "API key validation failed."
 dayz_not_found = "Could not find a valid DayZ installation."
+workshop_endpoint_error = "Steam Workshop service unavailable, try again later."

dzgui/views/base.py

@@ -1,6 +1,5 @@
 import logging
 import signal
-import warnings
 
 from typing import TYPE_CHECKING, Literal, Self
 
@@ -47,10 +46,6 @@ if TYPE_CHECKING:
 
 logger = logging.getLogger(APP_NAME)
 
-# TODO: drop
-# https://bugzilla.gnome.org/show_bug.cgi?id=708676
-warnings.filterwarnings("ignore", ".*g_value_get_int", Warning)
-
 
 class OuterWindow(Gtk.ApplicationWindow):
     def __init__(self, app: Gtk.Application) -> None:
@@ -344,8 +339,6 @@ try:
     theme = Gtk.IconTheme.get_default()
     icons = theme.list_icons(None)
     if STEAM_ICON not in icons:
-        logger.warn(strings.steam_icon_missing)
-        warnings.warn(strings.steam_icon_missing, stacklevel=2)
+        logger.warning(strings.steam_icon_missing)
 except Exception as e:
     logger.warning(e)
-    warnings.warn(strings.gtk_theme_missing, stacklevel=2)

dzgui/views/components/misc.py

@@ -15,7 +15,7 @@ class ClientCombo(Gtk.ComboBox):
         super().__init__()
 
         self.client_store = Gtk.ListStore(str, str)
-        clients = (
+        self.clients = (
             (
                 options.steam_combo,
                 STEAM_CMD,
@@ -29,7 +29,7 @@ class ClientCombo(Gtk.ComboBox):
                 FLATPAK_SANDBOX,
             ),
         )
-        for client in clients:
+        for client in self.clients:
             self.client_store.append(client)
         self.set_model(self.client_store)
         renderer_text = Gtk.CellRendererText()
@@ -37,6 +37,13 @@ class ClientCombo(Gtk.ComboBox):
         self.add_attribute(renderer_text, "text", 0)
         self.set_active(0)
 
+    def get_client_human_readable(self, cmd: str) -> str:
+        for client in self.clients:
+            human, command = client
+            if command == cmd:
+                return human
+        raise TypeError("Not a valid Steam client selection")
+
 class ErrorPopover(Gtk.Popover):
     def __init__(self, relative_to: Gtk.Widget, position: Gtk.PositionType) -> None:
         super().__init__(relative_to=relative_to, position=position)

dzgui/views/pages/options.py

@@ -76,7 +76,7 @@ class SubmitField(Gtk.Box):
             self.button = Gtk.Button(label=options.save_button)
 
         self.button.connect("clicked", self._on_save_clicked)
-        self.entry.connect("insert-text", self._on_text_typed)
+        self.entry.connect("changed", self._on_text_typed)
         self.entry.connect("activate", self._on_field_activated)
         self.entry.get_property("buffer").connect("deleted-text", self._on_text_deleted)
 
@@ -113,13 +113,9 @@ class SubmitField(Gtk.Box):
     def _on_text_typed(
         self,
         entry: Gtk.Entry,
-        text: str,
-        length: int,
-        pos: int,
     ) -> None:
 
-        buffer = entry.get_property("buffer")
-        text = buffer.get_text() + text
+        text = entry.get_text()
         state = self._is_valid_text(text)
         self.button.set_sensitive(state)
 
@@ -371,10 +367,8 @@ class Options(ScrollableMixin, Gtk.ScrolledWindow):  # type: ignore
 
         self.connect("key-press-event", self._on_keypress)
 
-    def get_client_name(self) -> str:
-        model = self.client_combo.get_model()
-        ind = self.client_combo.get_active()
-        return str(model[ind][0])
+    def get_client_name(self, cmd: str) -> str:
+        return self.client_combo.get_client_human_readable(cmd)
 
     def block_text_entry(self) -> None:
         self.steam_box.block_text_entry()

pyproject.toml

@@ -4,7 +4,7 @@ description = "DayZ server browser and mod manager for Linux"
 authors = [
     {name = "aclist"}
 ]
-version = "7.0.0b25"
+version = "7.0.0b26"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 readme = "README.md"

tests/test_process_detection.py

@@ -0,0 +1,61 @@
+import unittest
+from unittest.mock import patch
+
+from dzgui.const.constants import (
+    FLATPAK_APPID,
+    FLATPAK_RUN_CMD,
+    FLATPAK_SANDBOX,
+    STEAM_CMD,
+)
+from dzgui.init import proc
+
+
+class TestSteamDetection(unittest.TestCase):
+    def test_flatpak_detection_with_multiple_running_apps(self):
+        def flatpak_output(args, *, text):
+            # Default `flatpak ps` includes instance, PID, app and runtime columns.
+            if args == ["flatpak", "ps", "--columns=application"]:
+                return f"com.spotify.Client\n{FLATPAK_APPID}\n{FLATPAK_APPID}\n"
+            return f"3904921611\t1257689\t{FLATPAK_APPID}\torg.freedesktop.Platform\n"
+
+        with (
+            patch.object(proc, "has_cmd", return_value=True),
+            patch.object(proc.subprocess, "check_output", side_effect=flatpak_output),
+        ):
+            for client in (FLATPAK_RUN_CMD, FLATPAK_SANDBOX):
+                with self.subTest(client=client):
+                    self.assertTrue(proc.is_steam_running(client))
+
+    def test_flatpak_not_running(self):
+        with patch.object(proc, "has_cmd", return_value=True):
+            for output in ("", "com.spotify.Client\n", f"{FLATPAK_APPID}Helper\n"):
+                with (
+                    self.subTest(output=output),
+                    patch.object(proc.subprocess, "check_output", return_value=output),
+                ):
+                    self.assertFalse(proc.is_flatpak_steam_running())
+
+    def test_flatpak_not_installed(self):
+        with (
+            patch.object(proc, "has_cmd", return_value=False),
+            patch.object(proc.subprocess, "check_output") as check_output,
+        ):
+            self.assertFalse(proc.is_flatpak_steam_running())
+            check_output.assert_not_called()
+
+    def test_native_steam(self):
+        with patch.object(proc, "has_cmd", return_value=True):
+            for running in (True, False):
+                with (
+                    self.subTest(running=running),
+                    patch.object(proc, "is_running", return_value=running),
+                ):
+                    self.assertEqual(proc.is_steam_running(STEAM_CMD), running)
+
+    def test_native_steam_while_flatpak_is_running(self):
+        with patch.object(proc, "is_flatpak_steam_running", return_value=True):
+            self.assertEqual(proc.is_steam_running(STEAM_CMD), False)
+
+    def test_invalid_client(self):
+        with self.assertRaises(TypeError):
+            proc.is_steam_running("invalid-client")

tests/test_server_time.py

@@ -14,7 +14,11 @@ from dzgui.views.dialogs.calc import (
 
 
 class DummyEmitter:
-    pass
+    def __init__(self) -> None:
+        pass
+
+    def connect(self, _, __) -> None:
+        pass
 
 
 @pytest.fixture(params=[("05:00", 10.0), ("15:30", 5.0)])