chore: simplify control flow

chore: restore maximize logic

CHANGELOG.md

@@ -44,6 +44,7 @@
 - Play offline (load mods directly)
 - Generate Steam shortcuts and cover art
 - Warn user if background downloads are disabled
+- Dynamic copy button
 
 ### Changed
 - Conform to PEP 440 versioning for beta versions
@@ -63,6 +64,7 @@
 - Propagate subscribed mods to Steam client
 
 ### Dropped
+- Battlemetrics API support
 - Debug mode
 - Branch switching
 - Manual mod install mode (describe rationale)
@@ -73,6 +75,7 @@
 - Center server title text on server dialogs
 - Rare segfaults when changing maps (threading)
 - Moved dialogs out of threads
+- History table not being in lock-step with state file
 
 ### Unreleased
 - Load offline mods

dzgui/api/bm.py

@@ -1,40 +0,0 @@
-import logging
-import requests
-from typing import Any, Optional, TYPE_CHECKING
-
-from dzgui.const.constants import APP_NAME
-from dzgui.const.endpoints import BM_SERVERS
-
-logger = logging.getLogger(APP_NAME)
-
-if TYPE_CHECKING:
-    from dzgui.api.servers import Record
-
-
-def get_attributes(key: str, uid: int) -> Any:
-    # TODO: handle if key is not set
-    # TODO: tests for malformed IDs/values
-
-    hdr = {"Authorization": "Bearer " + key}
-    payload: dict[str, str] = {
-        "filter[game]": "dayz",
-        "sort": "-players",
-        "filter[ids][whitelist]": str(uid),
-    }
-    res = requests.get(BM_SERVERS, params=payload, headers=hdr)
-    res.raise_for_status()
-    j = res.json()["data"][0]["attributes"]
-    return j
-
-
-def map_id_to_record(key: str, uid: int) -> Optional["Record"]:
-    from dzgui.api.servers import Record
-
-    try:
-        record = get_attributes(key, uid)
-        ip = record["ip"]
-        port = int(record["port"])
-        qport = int(record["portQuery"])
-        return Record(ip, port, qport)
-    except Exception:
-        return None

dzgui/api/probe.py

@@ -41,21 +41,6 @@ def test_ipdb() -> bool:
         return False
 
 
-def test_bm_api(key: str) -> bool:
-    payload: dict[str, str] = {
-        "filter[game]": "dayz",
-    }
-    hdr = {"Authorization": "Bearer " + key}
-    try:
-        res = requests.get(
-            endpoints.BM_SERVERS, params=payload, headers=hdr, timeout=REQUEST_TIMEOUT
-        )
-        return is_remote_up(res)
-    except Exception as e:
-        logger.critical(e)
-        return False
-
-
 def is_remote_up(res: "Response") -> bool:
     if res.status_code == 200:
         return True

dzgui/api/servers.py

@@ -11,7 +11,6 @@ import threading
 from dataclasses import dataclass
 from typing import Any, Optional, TYPE_CHECKING, Union
 
-from dzgui.api.bm import map_id_to_record
 from dzgui.const.constants import APP_NAME, REQUEST_TIMEOUT
 from dzgui.const.endpoints import STEAM_SERVERS
 from dzgui.util.format import format_exception
@@ -478,16 +477,6 @@ def query_by_ip(addr: str) -> A2SInfo:
     return query_by_record(record, update_gameport=True)
 
 
-def query_by_id(server_id: int, key: str) -> A2SInfo:
-    """
-    Used with numeric Battlemetrics IDs
-    """
-    record = map_id_to_record(key, server_id)
-    if record is None:
-        return A2SInfo(Record("0", 0, 0), None)
-    return query_by_record(record)
-
-
 def query_by_record(record: Record, update_gameport: bool = False) -> A2SInfo:
     try:
         info = a2s.info((record.ip, record.qport), 3.0)

dzgui/api/shortcuts.py

@@ -12,6 +12,7 @@ from typing import Any
 from dzgui.api.steam import find_user_id_32
 from dzgui.const.constants import APP_NAME, APP_NAME_LOWER, IMAGES_PATH
 from dzgui.util.dirs import copy_dzgui_to_xdg_data
+from dzgui.util.strings import unknown
 
 logger = logging.getLogger(APP_NAME)
 
@@ -46,6 +47,25 @@ class Shortcuts:
         wrapped_exe = f'"{exe}"'
         return appname + wrapped_exe
 
+    def find_appname_by_unsigned_id(self, appid: int) -> str:
+        # NOTE: bitmask signed int back to 32-bit CRC
+        # varying client versions treat case sensitivity differently
+        try:
+            for key in self.shortcuts["shortcuts"].keys():
+                if self.shortcuts["shortcuts"][key]["appid"] & 0xFFFFFFFF == appid:
+                    try:
+                        return str(self.shortcuts["shortcuts"][key]["appname"])
+                    except Exception as e:
+                        logger.debug(e)
+                    try:
+                        return str(self.shortcuts["shortcuts"][key]["AppName"])
+                    except Exception as e:
+                        logger.debug(e)
+                    return unknown
+        except Exception as e:
+            logger.debug(e)
+        return unknown
+
     def get_shortcuts(self) -> Any:
         return self.shortcuts
 
@@ -111,22 +131,18 @@ class Shortcuts:
         https://developer.valvesoftware.com/wiki/Add_Non-Steam_Game
         https://developer.valvesoftware.com/wiki/Steam_Library_Shortcuts
 
-        Wiki variously lists keys with title case and lowercase, but keys actually do
+        Key case is not internally consistent and varies between client versions
-        not seem to be case-sensitive. Some entries generated by Steam do not match the wiki
+        Most keys use Pascal case, but some do not
-
-        Keys are entered into the dictionary in a linear insertion order
-
-        # TODO: try to replicate key case sensitivity as it is created by Steam with generic shortcut
 
         appid: signed int CRC
-        exe: absolute path to the executable, must be wrapped in literal quotes
+        Exe: absolute path to the executable, must be wrapped in literal quotes
         StartDir: directory the executable starts in, generally the parent
         """
 
         NEW_ENTRY: dict[str, Any] = {}
         NEW_ENTRY["appid"] = meta.appid
-        NEW_ENTRY["appname"] = meta.appname
+        NEW_ENTRY["AppName"] = meta.appname
-        NEW_ENTRY["exe"] = f'"{meta.exe_path}"'
+        NEW_ENTRY["Exe"] = f'"{meta.exe_path}"'
         NEW_ENTRY["StartDir"] = f"{meta.start_dir}"
         NEW_ENTRY["icon"] = meta.icon
         NEW_ENTRY["ShortcutPath"] = ""
@@ -134,7 +150,7 @@ class Shortcuts:
         NEW_ENTRY["IsHidden"] = 0
         NEW_ENTRY["AllowDesktopConfig"] = 1
         NEW_ENTRY["AllowOverlay"] = 1
-        NEW_ENTRY["openvr"] = 0
+        NEW_ENTRY["OpenVR"] = 0
         NEW_ENTRY["Devkit"] = 0
         NEW_ENTRY["DevkitGameID"] = ""
         NEW_ENTRY["DevkitOverrideAppID"] = 0

dzgui/api/steam.py

@@ -32,23 +32,25 @@ from dzgui.const.endpoints import (
 )
 from dzgui.strings import wizard
 from dzgui.util.bash import concat_bash_args
-from dzgui.util.strings import unknown
 
 logger = logging.getLogger(APP_NAME)
 
 
 class AppNotInstalledError(Exception):
     """App not present in user's libraryfolders"""
+
     pass
 
 
 class AppMovedError(Exception):
     """VDF points to a nonexistent location on disk"""
+
     pass
 
 
 class VDFLoadError(Exception):
     """Malformed VDF or JSON conversion"""
+
     pass
 
 
@@ -137,6 +139,9 @@ def get_remote_signatures(mods: list[str]) -> list[tuple[str, str, int, int]]:
     j = r.json()
     rows = j["response"]["publishedfiledetails"]
     for row in rows:
+        # NOTE: not a valid published file
+        if row["result"] == 9:
+            continue
         title = str(row["title"])
         _id = str(row["publishedfileid"])
         time = int(row["time_updated"])
@@ -204,17 +209,25 @@ def launch_offline(
     return proc.returncode
 
 
+def find_loginusers(path: Path) -> Path:
+    return path / "config" / "loginusers.vdf"
+
+
 def find_user_id(path: Path) -> str | None:
-    resolved_path = path / "config" / "loginusers.vdf"
+    resolved_path = find_loginusers(path)
     try:
         with open(resolved_path, "r") as f:
             v = vdf.load(f)
+            # NOTE: beta client
+            # /package/beta
+            if len(v["users"]) == 1:
+                return str(list(v["users"].keys())[0])
             for user in v["users"]:
                 if v["users"][user]["MostRecent"] == "1":
                     return str(user)
             return None
     except Exception as e:
-        logger.warn(e)
+        logger.debug(e)
         return None
 
 
@@ -322,9 +335,12 @@ def get_running_app() -> int | None:
 
 
 def get_app_allows_downloads(path: Path, appid: int) -> bool:
-    root_path = get_app_path(path, appid)
+    try:
-    acf = root_path.joinpath(f"steamapps/appmanifest_{appid}.acf")
+        root_path = get_app_path(path, appid)
-    flag = ACF(acf).get_allows_downloads()
+        acf = root_path.joinpath(f"steamapps/appmanifest_{appid}.acf")
+        flag = ACF(acf).get_allows_downloads()
+    except AppNotInstalledError:
+        flag = 0
     match flag:
         # NOTE: adheres to global client setting
         case 0:
@@ -403,13 +419,13 @@ def get_app_path(folders_path: Path, appid: int) -> Path:
     return Path(app_path)
 
 
-def get_app_name(appid: int) -> str:
+def get_app_name(appid: int) -> str | None:
     payload = {"appids": [appid]}
     res = requests.get(APP_DETAILS, params=payload)
     if res.status_code != 200:
-        return unknown
+        return None
     try:
         return str(res.json()[str(appid)]["data"]["name"])
     except Exception as e:
         logger.debug(e)
-        return unknown
+        return None

dzgui/app_init.py

@@ -18,10 +18,10 @@ from dzgui.init.flock import lock_acquire
 from dzgui.init.prereqs import has_steam_client
 from dzgui.strings import boot
 
-# from dzgui.util.map_count import get_map_count
 from dzgui.util.deck import is_steam_deck, is_game_mode
 from dzgui.util.dirs import make_parents
 from dzgui.util.localize import set_locale
+from dzgui.util.map_count import test_map_count
 from dzgui.util.redact import RedactionFilter, REDACTION_PATTERNS
 from dzgui.util.strings import init
 
@@ -119,6 +119,7 @@ def load_gui(version: str, is_debug: bool) -> None:
         del os.environ["GTK_IM_MODULE"]
 
     if has_new_config(XDG.config) is False:
+        test_map_count()
         migrate_cols_file(XDG.columns)
         copy_state_files(xdg_paths["XDG_STATE_HOME"])
         # TODO: add logging inside wizard

dzgui/config/convert.py

@@ -42,6 +42,7 @@ def rc2json(file: Path) -> str:
 
     toggles = ["fullscreen"]
     deprecated = [
+        "api_key",
         "staging_dir",
         "src_path",
         "steam_path",
@@ -66,8 +67,6 @@ def rc2json(file: Path) -> str:
                 value = str2bool(ntok)
         elif tok == "preferred_client":
             tok = "client"
-        elif tok == "api_key":
-            tok = "bm_api"
         elif tok == "ip_list":
             while True:
                 ntok = lex.get_token()

dzgui/config/freedesktop.py

@@ -3,7 +3,6 @@ import textwrap
 
 from pathlib import Path
 
-from dzgui.const.constants import APP_NAME
 from dzgui.util.dirs import copy_dzgui_to_xdg_data, find_icon_resource, make_parents
 
 
@@ -21,7 +20,7 @@ def write_desktop_file(exe_path: Path) -> Path:
     Terminal=false
     Exec={exe_path}
     Name=DZGUI
-    Comment=dzgui
+    Comment=DayZ server browser and mod manager
     Icon={icon}
     Categories=Game"""
 
@@ -37,7 +36,8 @@ def write_desktop_file(exe_path: Path) -> Path:
 
 def write_desktop_shortcut(desktop_file: Path) -> None:
     # NOTE: necessarily depends on the above (UI blocks creation without XDG entry first)
-    link = Path.home().joinpath(f"Desktop/{APP_NAME}.desktop")
+    link = Path.home().joinpath("Desktop/dzgui.desktop")
+    make_parents(link)
     if link.exists():
         link.unlink()
     link.symlink_to(desktop_file)

dzgui/const/boilerplate.py

@@ -2,7 +2,6 @@
 Generic defaults used when initializing a config file from scratch
 """
 config_boilerplate = {
-    "bm_api": "",
     "fav_server": "",
     "fav_label": "",
     "name": "",

dzgui/const/constants.py

@@ -38,6 +38,7 @@ HEX_ORANGE = "#FFAC1C"
 CARET_DOWN = "go-down-symbolic"
 CARET_UP = "go-up-symbolic"
 CLIPBOARD = "edit-copy-symbolic"
+CLOSE = "window-close-symbolic"
 FOLDER = "folder-symbolic"
 EDIT_DELETE = "edit-delete-symbolic"
 ERROR = "dialog-error-symbolic"

dzgui/const/endpoints.py

@@ -7,7 +7,6 @@ SUB_ENDPOINT = "https://api.steampowered.com/IPublishedFileService/Subscribe/v1"
 UNSUB_ENDPOINT = "https://api.steampowered.com/IPublishedFileService/Unsubscribe/v1"
 APP_DETAILS = "https://store.steampowered.com/api/appdetails?"
 
-BM_SERVERS = "https://api.battlemetrics.com/servers?"
 GITHUB = "https://github.com/aclist"
 GITHUB_RELEASES = "https://api.github.com/repos/aclist/dztui/releases/latest"
 CODEBERG_RELEASES = "https://codeberg.org/api/v1/repos/aclist/dzgui/releases/latest"
@@ -27,5 +26,3 @@ GITHUB_ISSUES = "https://github.com/aclist/dzgui/issues"
 FORUM = "https://old.reddit.com/r/dzgui"
 SPONSORS = "https://github.com/sponsors/aclist"
 STEAM_API_SETUP = "https://steamcommunity.com/dev/apikey"
-BM_API_SETUP = "https://www.battlemetrics.com/developers"
-BM_BROWSE = "https://www.battlemetrics.com/servers/dayz"

dzgui/const/enum.py

@@ -61,9 +61,6 @@ class Preferences(EnumWithAttrs):
     STEAM = {
         "key": "steam_api",
     }
-    BM = {
-        "key": "bm_api",
-    }
     CLIENT = {
         "key": "client",
     }

dzgui/controllers/mc.py

@@ -402,6 +402,9 @@ class Controller(GObject.GObject):
     def get_menu(self) -> "MenuTreeView":
         return self.mediator.menu
 
+    def unset_fav(self) -> None:
+        self.config_man.unset_fav()
+
     def has_favorites(self) -> bool:
         favs = self.config_man.get_favorites()
         if len(favs) < 1:
@@ -413,7 +416,7 @@ class Controller(GObject.GObject):
 
     def add_by_str(self, addr: str) -> None:
         saved_tree = self.get_servers().get_saved()
-        ServerModelManager(self, saved_tree).add_by_str(addr)
+        ServerModelManager(self, saved_tree).add_by_ip(addr)
 
     def add_by_record(self, record: "Record") -> None:
         saved_tree = self.get_servers().get_saved()
@@ -437,14 +440,8 @@ class Controller(GObject.GObject):
         ServerModelManager(self, tv).remove_from_history(record)
 
     def connect_by_str(self, addr: str) -> None:
-        if addr.isdigit():
+        self.connection_man = ConnectionManager(self)
-            config_man = self.get_config_man()
+        self.connection_man.connect_by_ip(addr)
-            key = config_man.lookup(Preferences.BM)
-            self.connection_man = ConnectionManager(self)
-            self.connection_man.connect_by_id(int(addr), key)
-        else:
-            self.connection_man = ConnectionManager(self)
-            self.connection_man.connect_by_ip(addr)
 
     def connect_by_record(self, record: "Record") -> None:
         self.connection_man = ConnectionManager(self)
@@ -465,6 +462,9 @@ class Controller(GObject.GObject):
         open_workshop_page(mod, cmd)
 
     def has_note(self) -> bool:
+        # TODO: get record string, store in memory
+        # get note by record, get is in favs, etc. store as a block
+        # this is only used by context mixin
         note = self.get_note()
         if len(note) > 0:
             return True
@@ -479,11 +479,13 @@ class Controller(GObject.GObject):
         return self.notes_man.get_note(record)
 
     def add_note(self, note: str) -> None:
+        # TODO: record should be cached upon creation of dialog
         tv = self.get_active_treeview()
         record = tv.get_record_string()
         self.notes_man.add_note(record, note)
 
     def delete_note(self) -> None:
+        # TODO: record should be cached upon creation of dialog
         tv = self.get_active_treeview()
         record = tv.get_record_string()
         self.notes_man.delete_note(record)

dzgui/main.py

@@ -5,12 +5,14 @@ import warnings
 from dzgui.const.constants import APP_NAME
 from dzgui.init.libgi import test_libgi_missing
 from dzgui.init.prefix import get_version
+from dzgui.util.map_count import set_map_count
 from dzgui.util.strings import flags
 
 parser = argparse.ArgumentParser(description=flags.description)
-parser.add_argument("-v", "--version", action="store_true", help=flags.version)
-parser.add_argument("-u", "--uninstall", action="store_true", help=flags.uninstall)
 parser.add_argument("-d", "--debug", action="store_true", help=flags.debug)
+parser.add_argument("-m", "--map", action="store_true", help=flags.map_count)
+parser.add_argument("-u", "--uninstall", action="store_true", help=flags.uninstall)
+parser.add_argument("-v", "--version", action="store_true", help=flags.version)
 args = parser.parse_args()
 
 
@@ -24,6 +26,7 @@ def uninstall() -> None:
 
 
 def main() -> None:
+    # TODO: isolate single flags
     if args.version is True:
         print(get_version())
         sys.exit(0)
@@ -32,6 +35,9 @@ def main() -> None:
         sys.exit(0)
     if args.debug is True:
         warnings.filterwarnings("default", category=DeprecationWarning)
+    if args.map is True:
+        set_map_count()
+        sys.exit(0)
 
     version = get_version()
 

dzgui/managers/config.py

@@ -12,7 +12,7 @@ from dzgui.const.constants import (
     WINDOW_DEFAULT_X,
     WINDOW_DEFAULT_Y,
 )
-from dzgui.api.probe import test_steam_api, test_bm_api
+from dzgui.api.probe import test_steam_api
 from dzgui.const.enum import Preferences
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
 from dzgui.views.dialogs.generic import ExceptionDialog
@@ -102,8 +102,6 @@ class ConfigManager:
     def update_api_key(self, key: Preferences, text: str) -> None:
         if key is Preferences.STEAM:
             res = test_steam_api(text)
-        else:
-            res = test_bm_api(text)
         if res is True:
             self.update_config(key, text)
         else:
@@ -162,6 +160,13 @@ class ConfigManager:
         except Exception:
             return
 
+    def unset_fav(self) -> None:
+        try:
+            self.write_config(Preferences.FAV_LBL, "")
+            self.write_config(Preferences.FAV_SRV, "")
+        except Exception:
+            return
+
     def write_config(self, key: Preferences, value: str) -> None:
         try:
             real_key = self.enum_to_key(key)

dzgui/managers/connection.py

@@ -9,6 +9,7 @@ from typing import TYPE_CHECKING
 
 import dzgui.api.pefile as PeFile
 import dzgui.api.servers as Servers
+from dzgui.api.shortcuts import Shortcuts
 
 from dzgui.api.steam import (
     connect,
@@ -85,6 +86,7 @@ class Prerequisites:
     mods: list[list[str]]
     game_mode: bool
     is_last_server: bool
+    invalid_mods: list[tuple[str, str]]
     allows_downloads: tuple[bool, str]
 
 
@@ -102,11 +104,6 @@ class ConnectionManager:
         self.remote_mod_ids: list[str] = []
         self.missing_mods: list[tuple[str, str, int, int]] = []
 
-    @call_on_thread(dialog.querying)
-    def connect_by_id(self, _id: int, key: str) -> None:
-        res = Servers.query_by_id(_id, key)
-        self._prepare_connection(res)
-
     @call_on_thread(dialog.querying)
     def connect_by_ip(self, addr: str) -> None:
         res = Servers.query_by_ip(addr)
@@ -175,11 +172,16 @@ class ConnectionManager:
         if running_app is not None:
             allows_dl = get_app_allows_downloads(steam_path, running_app)
             running_app_name = get_app_name(running_app)
+            # NOTE: for out-of-range appid, assume NSG.
+            # dzgui.api.steam.get_app_name() will return None
+            if running_app_name is None:
+                s = Shortcuts(steam_path)
+                # NOTE: returns "Unknown" if unparseable
+                running_app_name = s.find_appname_by_unsigned_id(running_app)
             allows_downloads = (allows_dl, running_app_name)
         else:
             allows_downloads = (True, "")
 
-
         client_name = self.controller.get_steam_client_name()
         client = self.controller.query_config(Preferences.CLIENT)
         running = is_steam_running(client)
@@ -190,6 +192,9 @@ class ConnectionManager:
 
         is_last = self.is_last_server()
 
+        # TODO: strings
+        invalid_mods = [(mod[0], mod[1]) for mod in remote_mods if mod[2] == "Invalid mod"]
+
         prereqs = Prerequisites(
             name=info.server_name,
             appid=info.game_id,
@@ -205,6 +210,7 @@ class ConnectionManager:
             mods=remote_mods,
             game_mode=game_mode,
             is_last_server=is_last,
+            invalid_mods=invalid_mods,
             allows_downloads=allows_downloads,
         )
 
@@ -260,6 +266,11 @@ class ConnectionManager:
         for mod in alpha_mods:
             if any(mod[1] in tuple for tuple in missing_mods):
                 mod[2] = resync
+        for mod in alpha_mods:
+            # NOTE: if the mod is neither synched or out of date, it is a malformed mod
+            if mod[2] == "":
+                # TODO: strings
+                mod[2] = "Invalid mod"
 
         return alpha_mods, missing_mods
 

dzgui/managers/filter.py

@@ -21,11 +21,11 @@ class FilterManager:
             strings.filter_3pp: True,
             strings.filter_night: True,
             strings.filter_full: show_full,
-            strings.filter_lowpop: True,
-            strings.filter_nonascii: False,
-            strings.filter_duplicate: False,
             strings.filter_official: True,
+            strings.filter_nonascii: False,
+            strings.filter_lowpop: True,
             strings.filter_unofficial: True,
+            strings.filter_duplicate: False,
             strings.filter_modded: True,
         }
 

dzgui/model/proxy_model.py

@@ -1,7 +1,6 @@
 import re
 
 from typing import Any, TYPE_CHECKING, Union
-from warnings import deprecated
 
 from dzgui.const.enum import FilterMode
 from dzgui.model.model_factory import ModelFactory
@@ -86,8 +85,8 @@ class ProxyModelManager:
         if found is False:
             self.control_model.append(history)
 
-        # if len(self.control_model) == 11:
+        if len(self.control_model) == 11:
-        #    del self.control_model[0]
+            del self.control_model[0]
 
         self.filter(FilterMode.INITIAL, skip_cache=True)
 
@@ -259,7 +258,7 @@ class ProxyModelManager:
     def set_cache(self, filters: tuple[str], filtered_rows: list[tuple]) -> None:
         self.filter_cache[filters] = filtered_rows
 
-    @deprecated("Currently unused")
+    # @deprecated("Currently unused")
     # def convert_model_to_list(self, model: "FastInsertListStore") -> list:
     #    return [[el for el in row] for row in model]
 

dzgui/model/servers.py

@@ -15,7 +15,7 @@ from dzgui.const.constants import (
 from dzgui.const.enum import FilterMode, Preferences, ServerTab
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
 from dzgui.strings import dialogs
-from dzgui.util.strings import api_warn_msg, dialog
+from dzgui.util.strings import server_timeout, dialog
 from dzgui.views.dialogs.generic import ExceptionDialog
 
 import gi
@@ -175,29 +175,29 @@ class ServerModelManager:
                 # TODO: wrap except
                 if self.controller.get_exit_event().is_set():
                     return
-                res = future.result(timeout=API_TIMEOUT)
                 self.thread_man.increment_dialog()
-                # NOTE: failing entries are culled
+
-                if res is None:
+        """
-                    # TODO: log which servers failed
+        Collects futures in linear order after completion
-                    continue
+        for lock-step representation of the state file
-                servers.append(res)
+        """
-                if len(servers) == 0:
+        for future in futures:
-                    self.thread_man.set_cleanup_func(
+            res = future.result(timeout=API_TIMEOUT)
-                        StoredFunc(self._cleanup_on_failure), destroy_first=True
+            # NOTE: failing entries are culled
-                    )
+            if res is None:
-                    return
+                # TODO: log which servers failed
+                # query_direct() currently does not return enough information
+                continue
+            servers.append(res)
+            if len(servers) == 0:
+                self.thread_man.set_cleanup_func(
+                    StoredFunc(self._cleanup_on_failure), destroy_first=True
+                )
+                return
 
         parsed = Servers.parse_json(servers)
         self._push_data(parsed)
 
-    @call_on_thread(dialog.querying)
-    def add_by_id(self, _id: str) -> None:
-        config_man = self.controller.get_config_man()
-        key = config_man.lookup(Preferences.BM)
-        res = Servers.query_by_id(int(_id), key)
-        self._parse_single_record(res)
-
     @call_on_thread(dialog.querying)
     def add_by_ip(self, addr: str) -> None:
         res = Servers.query_by_ip(addr)
@@ -241,7 +241,6 @@ class ServerModelManager:
 
         self.first_iteration = False
         self.emitter.emit("load_maps", store)
-        # self.emitter.emit("servers_loaded_init")
 
     # TODO: dataclass for record rows; check for other dict annotations
     def add_to_history(self, data: tuple[dict[str, Any], "Record"]) -> None:
@@ -263,12 +262,6 @@ class ServerModelManager:
         proxy_man.remove_row_from_control(record)
         self.update_history()
 
-    def add_by_str(self, addr: str) -> None:
-        if addr.isdigit():
-            self.add_by_id(addr)
-        else:
-            self.add_by_ip(addr)
-
     @call_on_thread(dialog.querying)
     def update_playercount(
         self, treeiter: Gtk.TreeIter, record: Servers.Record
@@ -426,7 +419,7 @@ class ServerModelManager:
         # TODO: distinguish signals, e.g. "servers_failed_to_load", "servers_loaded_empty"
         # customize statusbar and dialog accordingly
         if show_dialog:
-            dialog = ExceptionDialog(self.controller, api_warn_msg)
+            dialog = ExceptionDialog(self.controller, server_timeout)
             dialog.run()
 
     def _push_data(self, data: list[Any]) -> None:

dzgui/strings/connect_panel.py

@@ -5,10 +5,9 @@ add_tooltip="Add to Saved Servers"
 connect_button="Connect"
 connect_tooltip="Connect to this server"
 connect_entry_tooltip=(
-    "- IP: format as IP:Query port\ne.g. 192.168.1.1:27016\n"
+    "- IP: format as IP:Query port\ne.g. 192.168.1.1:27016"
-    "- Battlemetrics: numeric server ID\ne.g. 123456"
 )
-connect_entry_placeholder="Enter IP (IP:Query port) or Battlemetrics ID (numerical id)"
+connect_entry_placeholder="Enter IP (IP:Query port)"
 
 fav_heading="Favorite server"
 favs_empty="None set. Right click a server and select 'Set favorite' to set."

dzgui/strings/map_count.py

@@ -0,0 +1,16 @@
+exit_msg = (
+    "System map count is not high enough to run DayZ. "
+    "Please exit and run 'dzgui -m' to update map count."
+)
+failed_to_parse = (
+    "Failed to parse system map count.\n"
+    "This usually indicates that systemd is not installed."
+)
+failed_to_update = (
+    "Failed to update system map count.\n"
+    "Please report the issue upstream and provide the following traceback.\n\n"
+    "{0}"
+)
+meets_minimum = "System map count of {0} already meets the minimum."
+prompt = "Updated map count will be written to the file {0}."
+user_exit = "User exit"

dzgui/strings/offline.py

@@ -1,4 +1,7 @@
 heading = "Play offline"
+heading_disclaimer = (
+    "Not all mod combinations will function offline. Use at your own discretion."
+)
 
 mission_button = "Select mission folder"
 mission_frame = "Mission"

dzgui/strings/wizard.py

@@ -46,11 +46,6 @@ You must set up a Steam Web API key in order to browse the global server list.
 \nIf you don't have one already, it can be set up via the page below.
 \nPlease refer to the DZGUI documentation for more instructions.
 """
-heading_bm_api = "Battlemetrics Web API key"
-blurb_bm_api = """A Battlemetrics key is <b>optional</b>, but allows you to add/search for servers\n
-by numeric ID on the web. For example, in the URL https://www.battlemetrics.net/servers/dayz/24819107,\n
-the ID would be <b>24819107</b>.
-"""
 
 ### PreferencesPage
 heading_prefs = "User preferences"

dzgui/util/diag.py

@@ -54,8 +54,6 @@ def write_diagnostic(config: Path, outfile: Path) -> None:
     cpu = get_cpu_model()
     version = get_version()
 
-    debug = lookup(config, Preferences.DEBUG)
-    install = lookup(config, Preferences.INSTALL)
     default = lookup(config, Preferences.DEFAULT)
 
     steam_path = Path(default)
@@ -79,8 +77,6 @@ def write_diagnostic(config: Path, outfile: Path) -> None:
     Kernel: {kernel}
     CPU: {cpu}
 
-    Debug: {debug}
-    Auto-install: {install}
     Steam path: {steam_redacted}
     Workshop path: {workshop_redacted}
 

dzgui/util/map_count.py

@@ -1,28 +1,71 @@
+import logging
 import subprocess
+import sys
+import tempfile
+import traceback
 
 from pathlib import Path
-from dzgui.const.constants import VM_FILE, MIN_COUNT
+from dzgui.const.constants import APP_NAME, VM_FILE, MIN_COUNT
+from dzgui.util.bash import concat_bash_args
+from dzgui.strings import map_count
+from dzgui.views.dialogs.early_alert import EarlyIgnoreDialog
+
+logger = logging.getLogger(APP_NAME)
+
+
+def is_map_count_valid(count: int | None) -> bool:
+    if count is None:
+        # NOTE: permit if count was unreadable
+        return True
+    return count >= MIN_COUNT
+
 
 def get_map_count() -> int | None:
     path = Path(VM_FILE)
-    if path.is_file() is False:
+    try:
+        count = int(path.read_text())
+    except Exception as e:
+        logger.debug(e)
         return None
-    count = int(path.read_text())
     return count
 
-    # TODO: unfinished
-    #if count < MIN_COUNT:
-    #    print("needs sudo escalation")
-    #    # pop prompt
-    #    # get response
-    #    set_map_count()
-    #return count
 
-# TODO: unfinished
+def test_map_count() -> None:
+    count = get_map_count()
+    if is_map_count_valid(count):
+        return
+    msg = map_count.exit_msg
+    EarlyIgnoreDialog(msg)
+
+
 def set_map_count() -> None:
+    count = get_map_count()
+    if count is None:
+        print(map_count.failed_to_parse)
+        return
+    if is_map_count_valid(count):
+        msg = map_count.meets_minimum.format(count)
+        print(msg)
+        return
+
     conf = "/etc/sysctl.d/dayz.conf"
-    count = f"vm.max_map_count={MIN_COUNT}"
+    value = f"vm.max_map_count={MIN_COUNT}"
-    with open(conf, "w") as f:
+    try:
-        f.write(count)
+        msg = map_count.prompt.format(conf)
-    # TODO: use concat_bash_args()
+        print(msg)
-    subprocess.run(["/usr/bin/sudo", "sysctl", "-p", conf])
+        with tempfile.NamedTemporaryFile(delete=False) as f:
+            tmp = f.name
+        Path(tmp).write_text(value)
+
+        mv_cmd = f"sudo mv {tmp} {conf}"
+        reload_cmd = f"sudo sysctl -p {conf}"
+        for cmd in mv_cmd, reload_cmd:
+            args = concat_bash_args(cmd)
+            subprocess.run([*args])
+    except Exception as e:
+        logger.debug(e)
+        trace = traceback.format_exc()
+        print(map_count.failed_to_update.format(trace))
+    except KeyboardInterrupt:
+        print(map_count.user_exit)
+        sys.exit(0)

dzgui/util/redact.py

@@ -4,8 +4,9 @@ from typing import Literal
 
 api_filter = r"(.*&key=)([^&]*)(.*)"
 home_filter = r"(/home/)([^\s'\/]*)(.*)"
+user_filter = r"(.*Steam/userdata/)([^/]*)(.*)"
 REDACTED = r"\1REDACTED\3"
-REDACTION_PATTERNS = [api_filter, home_filter]
+REDACTION_PATTERNS = [api_filter, home_filter, user_filter]
 
 
 def redact_home(text: str) -> str:

dzgui/util/strings.py

@@ -100,10 +100,7 @@ steam_missing = "Local Steam installation is not set, possibly malformed config
 build_corrupted = (
     "Steam settings or DayZ installation may be corrupted. Try restarting Steam."
 )
-api_warn_msg = """No servers returned. Please wait and try again.
+server_timeout = "Timed out when querying server(s). Check IP or try again later."
-This usually indicates a transitory network timeout. If this issue persists, your API key or network may be malfunctioning.
-"""
-server_timeout = "Timed out when querying server, check IP or try again later."
 server_error = (
     "Error while contacting server, possibly timed out. Please wait and try again."
 )
@@ -286,11 +283,8 @@ class Thanks:
 class Options:
     header: str
     steam_web: str
-    bm_web: str
     enter_steam: str
-    enter_bm: str
     steam_placeholder: str
-    bm_placeholder: str
     name_placeholder: str
     last_used: str
     always_fs: str
@@ -311,7 +305,7 @@ class Options:
     force_eventbox: str
     self_update: str
     no_self_update: str
-    api_keys: str
+    api_key: str
     prefs: str
     mods: str
     version: str
@@ -333,8 +327,8 @@ mod_panel = ModPanelStrings(
     unhighlight_stale_tooltip="Clears highlight from stale mods",
     highlight_stale="Highlight stale",
     highlight_stale_tooltip=(
-        "Shows locally-installed mods which are not used by any server "
+        "Shows locally-installed mods which are not \n"
-        "in your Saved Servers"
+        "used by any server in your Saved Servers"
     ),
     unsub_selected="Unsubscribe selected",
     unsub_selected_tooltip="Unsubscribes from selected mods",
@@ -378,11 +372,8 @@ thanks = Thanks(
 options = Options(
     header="Options",
     steam_web="Steam API page",
-    bm_web="Battlemetrics API page",
     enter_steam="Enter your Steam API key",
-    enter_bm="Enter your Battlemetrics API key",
     steam_placeholder="Steam API key",
-    bm_placeholder="Battlemetrics API key",
     name_placeholder="Identifies you to other players in-game",
     last_used="Last used dimensions",
     always_fs="Always fullscreen",
@@ -411,7 +402,7 @@ options = Options(
         "In-app updates are disabled when DZGUI is "
         "installed globally (e.g., via package manager)."
     ),
-    api_keys="API Keys",
+    api_key="API Key",
     prefs="Preferences",
     mods="Mods",
     version="Version",
@@ -476,13 +467,15 @@ class Flags:
     version: str
     uninstall: str
     debug: str
+    map_count: str
 
 
 flags = Flags(
     description="DayZ server browser and mod manager",
-    version="Print version information",
+    version="print version information",
-    uninstall="Uninstall data files (use prior to 'pip uninstall')",
+    uninstall="clean up state/config files",
-    debug="Enables developer debugging features",
+    debug="enable developer debugging features",
+    map_count="check and update system map count value",
 )
 
 
@@ -549,11 +542,8 @@ connect_panel = ConnectPanel(
     connect="Connect",
     add="Add",
     add_con="Add/connect",
-    placeholder="Enter IP (IP:Query port) or Battlemetrics ID (numerical id)",
+    placeholder="Enter IP (IP:Query port)",
-    entry_tooltip=(
+    entry_tooltip=("- IP: format as IP:Query port\ne.g. 192.168.1.1:27016"),
-        "- IP: format as IP:Query port\ne.g. 192.168.1.1:27016\n"
-        "- Battlemetrics: numeric server ID\ne.g. 123456"
-    ),
     add_tooltip="Add to Saved Servers",
     connect_tooltip="Connect to this server",
 )

dzgui/views/base.py

@@ -54,7 +54,10 @@ class OuterWindow(Gtk.Window):
         MainController.register_widget("window", self)
 
         # NOTE: steam deck taskbar may occlude elements
-        if MainController.get_prefs().is_steam_deck is False:
+        is_deck = MainController.get_prefs().is_steam_deck
+        if is_deck:
+            self.maximize()
+        else:
             self.set_titlebar(self.hb)
 
         self.connect("delete-event", self._on_delete_event)

dzgui/views/components/box.py

@@ -23,3 +23,10 @@ class HBox(GenericBox):
 class VBox(GenericBox):
     def __init__(self, spacing: int = 0) -> None:
         super().__init__(orientation=Gtk.Orientation.VERTICAL, spacing=spacing)
+
+class ShortHBox(HBox):
+    def __init__(self, widget: Gtk.Widget) -> None:
+        super().__init__(spacing=5)
+
+        self.set_halign(Gtk.Align.START)
+        self.pack_start(widget, expand=False, fill=False, padding=0)

dzgui/views/components/buttons.py

@@ -1,4 +1,4 @@
-from typing import Callable, Self, TYPE_CHECKING, Union
+from typing import Callable, Literal, Self, TYPE_CHECKING, Union
 
 from dzgui.util.clip import copy_clipboard
 from dzgui.util.format import pluralize
@@ -10,6 +10,7 @@ from dzgui.util.strings import (
 )
 from dzgui.const.constants import (
     CLIPBOARD,
+    CLOSE,
     INPUT_KEYBOARD,
     LIST_ADD,
     REFRESH_ICON,
@@ -66,6 +67,15 @@ class IconButton(Gtk.Button):
         # self.set_image_position(Gtk.PositionType.RIGHT)
         self.set_focus_on_click(False)
 
+    def swap_icon(self, icon: str) -> None:
+        start = self.icon.get_margin_start()
+        end = self.icon.get_margin_end()
+        alt_icon = Icon(icon, margin_start=start, margin_end=end)
+        self.set_image(alt_icon)
+
+    def revert_icon(self) -> None:
+        self.set_image(self.icon)
+
 
 class IconTextButton(IconButton):
     def __init__(
@@ -96,11 +106,18 @@ class ClipboardButton(IconTextButton):
         self.controller = controller
         self.connect("clicked", self._on_button_clicked, func)
 
+        # TODO: strings
         self.set_tooltip_text("Copy to clipboard")
 
     def _on_button_clicked(self, button: Self, func: Callable) -> None:
+        def revert() -> Literal[False]:
+            self.revert_icon()
+            return False
+
+        self.swap_icon("object-select-symbolic")
         data = func()
         copy_clipboard(data)
+        GLib.timeout_add(600, revert)
 
 
 # TODO: determine when controller would be passed to this button or drop
@@ -108,9 +125,18 @@ class CopyIpButton(ClipboardButton):
     def __init__(self, controller: Union["Controller", None], func: Callable) -> None:
         super().__init__(controller, func)
 
+        # TODO: strings
         self.set_tooltip_text("Copy IP to clipboard")
 
 
+class CloseButton(IconTextButton):
+    def __init__(self, label: str) -> None:
+        super().__init__(icon=CLOSE, label=label)
+
+        # TODO: strings
+        self.set_tooltip_text("Unset this server as favorite")
+
+
 class WebButton(IconTextButton):
     def __init__(self, label: str) -> None:
         super().__init__(icon=WEB_BROWSER, label=label)

dzgui/views/components/connect_panel.py

@@ -6,6 +6,7 @@ from dzgui.strings import connect_panel
 from dzgui.util.keys import is_ctrl_mask
 from dzgui.views.components.buttons import (
     AddButton,
+    CloseButton,
     CopyIpButton,
     Icon,
     IconButton,
@@ -187,17 +188,27 @@ class FavPanel(Gtk.Frame):
         self.fav_button = SteamConnectButton()
         self.fav_button.connect("clicked", self._on_connect_clicked)
         self.copy_button = CopyIpButton(self.controller, self.get_fav_ip)
+
+        # TODO: strings
+        self.unset_button = CloseButton("Unset")
+        self.unset_button.connect("clicked", self._on_unset_clicked)
+
         if favorite is None:
             self.toggle_buttons(False)
 
         # NOTE: disable vscrollbar to prevent layout jumping behavior
-        scrollable_label = Gtk.ScrolledWindow(vscrollbar_policy=Gtk.PolicyType.NEVER)
+        self.scrollable_label = Gtk.ScrolledWindow(
-        scrollable_label.add(self.fav_label)
+            vscrollbar_policy=Gtk.PolicyType.NEVER, overlay_scrolling=False
+        )
+        self.scrollable_label.add(self.fav_label)
 
         grid = Gtk.Grid(margin=10, vexpand=False, column_spacing=15, row_spacing=5)
-        grid.attach(scrollable_label, 0, 0, 3, ROWS)
+        grid.attach(self.scrollable_label, 0, 0, 3, ROWS)
         grid.attach_next_to(
-            self.copy_button, scrollable_label, Gtk.PositionType.RIGHT, COLS, ROWS
+            self.unset_button, self.scrollable_label, Gtk.PositionType.RIGHT, COLS, ROWS
+        )
+        grid.attach_next_to(
+            self.copy_button, self.unset_button, Gtk.PositionType.RIGHT, COLS, ROWS
         )
         grid.attach_next_to(
             self.fav_button, self.copy_button, Gtk.PositionType.RIGHT, COLS, ROWS
@@ -205,8 +216,16 @@ class FavPanel(Gtk.Frame):
 
         self.add(grid)
 
+    def _on_unset_clicked(self, button: Gtk.Button) -> None:
+        try:
+            self.controller.unset_fav()
+        except Exception:
+            return
+        self.fav_label.set_text(connect_panel.favs_empty)
+        self.toggle_buttons(False)
+
     def toggle_buttons(self, state: bool) -> None:
-        for button in self.fav_button, self.copy_button:
+        for button in self.fav_button, self.copy_button, self.unset_button:
             button.set_sensitive(state)
 
     def _on_connect_clicked(self, button: Gtk.Button) -> None:

dzgui/views/components/entry.py

@@ -26,15 +26,12 @@ def validate_port(text: str) -> bool:
         return False
 
 
-def validate_ip_or_id(text: str) -> bool:
+def validate_ip_truthy(text: str) -> bool:
     try:
         validate_ip(text)
         return True
     except Exception:
-        if text.isdigit():
+        return False
-            return True
-        else:
-            return False
 
 
 class ValidatedEntry(Gtk.Entry):
@@ -124,7 +121,7 @@ class IpEntry(ValidatedEntry):
     def __init__(self, controller: "Controller") -> None:
         super().__init__(
             controller,
-            func=validate_ip_or_id,
+            func=validate_ip_truthy,
             placeholder_text=connect_panel.placeholder,
             tooltip_text=connect_panel.entry_tooltip,
         )
@@ -162,7 +159,8 @@ class APIEntry(Gtk.Box):
         self.entry.connect("icon-release", self._on_icon_release)
         self.entry.connect("activate", self._on_field_activated)
 
-        self.submit = Gtk.Button(label="Submit")
+        # TODO: strings
+        self.submit = Gtk.Button(label="Validate")
         self.submit.set_sensitive(False)
         self.submit.connect("clicked", self._on_submit)
 

dzgui/views/components/eventbox.py

@@ -30,6 +30,9 @@ class InfoEventBox(Gtk.EventBox):
         self.connect("leave-notify-event", self._on_leave_tooltip)
         self.add(box)
 
+    def set_icon_yalign(self, offset: float) -> None:
+        self.icon.set_property("yalign", offset)
+
     def _on_enter_tooltip(
         self, eventbox: Gtk.EventBox, eventcrossing: Gdk.EventCrossing
     ) -> None:

dzgui/views/components/filter_panel.py

@@ -33,15 +33,15 @@ class ButtonGrid(Gtk.Grid):
         super().__init__(
             halign=Gtk.Align.CENTER, column_spacing=5, column_homogeneous=True
         )
-        row = 1
-        col = 0
-
         self.controller = controller
         self.emitter = controller.get_emitter()
 
         self.checks: list[Gtk.CheckButton] = []
 
-        # TODO: use enumerated checks
+        flowbox = Gtk.FlowBox(
+            halign=Gtk.Align.CENTER, min_children_per_line=3, max_children_per_line=3
+        )
+
         for check in defaults.keys():
             checkbox = Gtk.CheckButton(label=check)
             label = checkbox.get_child()
@@ -51,14 +51,12 @@ class ButtonGrid(Gtk.Grid):
             if defaults[check]:
                 checkbox.set_active(True)
 
-            col = col + 1
-            if col > 3:
-                row += 1
-                col = 1
-            self.attach(checkbox, col, row, 1, 1)
             checkbox.connect("toggled", self._on_check_toggled)
+            flowbox.add(checkbox)
             self.checks.append(checkbox)
 
+        self.add(flowbox)
+
     def block_toggles(self, state: bool) -> None:
         for check in self.checks:
             self.controller.suppress_signal(

dzgui/views/components/right_panel.py

@@ -131,6 +131,7 @@ class RightPanel(Gtk.Box):
             return
         self.copying = True
         version = self.version_label.get_text()
+        # TODO: strings
         self.version_label.set_text("Copied!")
         copy_clipboard(version)
         GLib.timeout_add_seconds(1, revert)

dzgui/views/dialogs/boot.py

@@ -41,7 +41,7 @@ class BootDialog(Gtk.Dialog):
     def __init__(self, parent: "BootWindow", xdg: "Xdg", version: str) -> None:
         super().__init__(
             title=dialog_header,
-            parent=parent,
+            transient_for=parent,
             modal=True,
         )
 

dzgui/views/dialogs/early_alert.py

@@ -10,21 +10,26 @@ gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk  # noqa E402
 
 
-class EarlyAlertDialog(Gtk.MessageDialog):
+class AbortDialog(Gtk.MessageDialog):
-    def __init__(self, string: str) -> None:
+    def __init__(self, string: str, buttons: Gtk.ButtonsType) -> None:
         super().__init__(
             title=dialog_header,
             text=dialog_error,
             transient_for=None,
-            buttons=Gtk.ButtonsType.OK,
+            buttons=buttons,
         )
 
         msg = textwrap.fill(string, 50)
         self.format_secondary_text(msg)
 
+        ma = self.get_message_area()
+        label = ma.get_children()[1]  # type: ignore
+        label.set_justify(Gtk.Justification.CENTER)
+
         aa = self.get_action_area()
         aa.set_margin_bottom(20)
-        # self.action_area.set_margin_bottom(20)
+        aa.set_layout(Gtk.ButtonBoxStyle.CENTER)  # type: ignore
+
         self.outer = self.get_content_area()
         self.outer.set_margin_start(30)
         self.outer.set_margin_end(30)
@@ -32,26 +37,30 @@ class EarlyAlertDialog(Gtk.MessageDialog):
         self.set_default_size(250, 100)
 
         abort = self.get_widget_for_response(Gtk.ResponseType.OK)
+        ignore = self.get_widget_for_response(Gtk.ResponseType.CANCEL)
         if abort is not None and hasattr(abort, "set_label"):
             abort.set_label("Exit")
+        if ignore is not None and hasattr(ignore, "set_label"):
+            ignore.set_label("Ignore")
 
         self.connect("response", self._on_response)
+
         self.run()
         self.destroy()
 
     def _on_response(self, dialog: Self, response: Gtk.ResponseType) -> None:
         match response:
-            case Gtk.ResponseType.OK:
+            case Gtk.ResponseType.OK | Gtk.ResponseType.DELETE_EVENT:
                 sys.exit(1)
             case Gtk.ResponseType.CANCEL:
                 return
 
 
-class EarlyIgnoreDialog(EarlyAlertDialog):
+class EarlyAlertDialog(AbortDialog):
     def __init__(self, string: str) -> None:
-        super().__init__(string=string)
+        super().__init__(string=string, buttons=Gtk.ButtonsType.OK)
 
-        # TODO: reverse order
-        self.add_button("Ignore", Gtk.ResponseType.CANCEL)
 
-        # TODO: if exit, sys.exit(1), else pass
+class EarlyIgnoreDialog(AbortDialog):
+    def __init__(self, string: str) -> None:
+        super().__init__(string=string, buttons=Gtk.ButtonsType.OK_CANCEL)

dzgui/views/dialogs/filepicker.py

@@ -13,7 +13,7 @@ class FilePicker(Gtk.FileChooserDialog):
         super().__init__(
             title=picker.title,
             action=Gtk.FileChooserAction.SAVE,
-            parent=parent,
+            transient_for=parent,
             resizable=True,
         )
         self.add_buttons("_Cancel", Gtk.ResponseType.CANCEL)

dzgui/views/dialogs/generic.py

@@ -107,23 +107,26 @@ class WaitDialog(GenericDialog):
         self.cur_job = 1
 
         self.cancel = Gtk.Button(label="Cancel", halign=Gtk.Align.CENTER)
-        self.cancel.connect("clicked", lambda _: self.controller.set_cancel_event())
+        self.cancel.connect("clicked", self._on_cancel_clicked)
 
         self.connect("delete-event", lambda widget, event: True)
         content = self.get_content_area()
-        spinner = Gtk.Spinner()
         self.prog = Gtk.ProgressBar()
 
-        content.pack_end(self.cancel, NO_EXPAND, NO_FILL, 0)
+        spinner_box = Gtk.Box(
-        content.pack_end(spinner, NO_EXPAND, NO_FILL, 0)
+            orientation=Gtk.Orientation.HORIZONTAL, halign=Gtk.Align.CENTER
+        )
+        spinner = Gtk.Spinner()
+        spinner_box.add(spinner)
 
         if self.jobs > 1:
-            content.pack_end(self.prog, NO_EXPAND, NO_FILL, 0)
+            content.pack_start(self.prog, NO_EXPAND, NO_FILL, 0)
         else:
+            content.pack_start(spinner_box, NO_EXPAND, NO_FILL, 0)
             spinner.start()
 
-        if show_cancel is False:
+        if show_cancel is True:
-            self.connect("realize", lambda _: self.cancel.set_visible(False))
+            content.pack_start(self.cancel, NO_EXPAND, NO_FILL, 0)
 
     def update_text(self, msg: str) -> None:
         self.format_secondary_text(msg)
@@ -135,6 +138,11 @@ class WaitDialog(GenericDialog):
         self.prog.set_fraction(fraction)
         self.cur_job += 1
 
+    def _on_cancel_clicked(self, button: Gtk.Button) -> None:
+        # TODO: strings
+        GLib.idle_add(self.update_text, "Caught cancel signal, cleaning up")
+        self.controller.set_cancel_event()
+
     def show_cancel(self, state: bool) -> None:
         self.cancel.set_visible(state)
 
@@ -153,6 +161,7 @@ class QuitDialog(GenericDialog):
         self.add_button(strings.exit_app, Gtk.ResponseType.OK)
 
         self.connect("response", self._on_response)
+        # TODO: superfluous with the above
         self.connect("delete-event", self._on_response)
 
     def _on_response(self, dialog: Self, response: Gtk.ResponseType) -> None:

dzgui/views/dialogs/servers.py

@@ -1,3 +1,4 @@
+import html
 from typing import Self, TYPE_CHECKING
 
 from dzgui.const.constants import EXPAND, FILL
@@ -65,6 +66,7 @@ class ServerDialog(GenericDialog):
 
 class ServerDetailsDialog(ServerDialog):
     def __init__(self, controller: "Controller", details: "Details"):
+        # TODO: server name should also be packed in details struct
         name = controller.get_server_name()
         super().__init__(controller, strings.server_details, name, menu=None)
 
@@ -109,7 +111,7 @@ class ServerDetailsDialog(ServerDialog):
         self.view.set_model(self.store)
         text = details.description
         text = format_hyperlinks(text)
-        self.description.set_markup(text)
+        self.description.set_markup(html.escape(text))
 
         self.show_all()
 

dzgui/views/dialogs/wizard.py

@@ -6,7 +6,7 @@ from importlib import resources
 from pathlib import Path
 from typing import Any, Callable, Self, TYPE_CHECKING
 
-from dzgui.api.probe import test_steam_api, test_bm_api
+from dzgui.api.probe import test_steam_api
 from dzgui.api.shortcuts import add_steam_shortcut
 from dzgui.api.steam import get_steam_paths
 from dzgui.const.constants import (
@@ -16,7 +16,7 @@ from dzgui.const.constants import (
     LEGACY_CONFIG_PATH,
 )
 from dzgui.const.boilerplate import config_boilerplate
-from dzgui.const.endpoints import BM_API_SETUP, STEAM_API_SETUP
+from dzgui.const.endpoints import STEAM_API_SETUP
 from dzgui.const.enum import Preferences
 from dzgui.config import freedesktop
 from dzgui.config.query import lookup
@@ -44,10 +44,16 @@ class PageNum(Enum):
     HAS_CONFIG = 2
     STEAM_PATH = 3
     STEAM_API = 4
-    BM_API = 5
+    USER_PREFS = 5
-    USER_PREFS = 6
+    SHORTCUTS = 6
-    SHORTCUTS = 7
+    FINAL = 7
-    FINAL = 8
+
+
+class OptionalPageMixin:
+    """Marks optional pages as advanceable"""
+
+    def _on_map(self, page: "ScrolledWizardPage") -> None:
+        EMITTER.emit("step_complete")
 
 
 class DescriptionArea(Gtk.Box):
@@ -91,6 +97,7 @@ class ScrolledWizardPage(Gtk.ScrolledWindow):
             margin_top=50,
             spacing=20,
         )
+
         self.add(self.box)
         self.prog = Progress()
         self.box.pack_end(self.prog, expand=False, fill=False, padding=0)
@@ -215,23 +222,6 @@ class APIValidationPage(ScrolledWizardPage):
         self.spinner.stop()
 
 
-class BMValidationPage(APIValidationPage):
-    def __init__(self) -> None:
-        super().__init__(
-            enum=PageNum.BM_API,
-            heading=wizard.heading_bm_api,
-            description=wizard.blurb_bm_api,
-            link=BM_API_SETUP,
-            func=self._validate,
-        )
-
-    @call_on_thread("", show_dialog=False)
-    def _validate(self, key: str) -> None:
-        is_valid = test_bm_api(key.strip())
-        cleanup = StoredFunc(self._cleanup, is_valid, key)
-        self.thread_man.set_cleanup_func(cleanup)
-
-
 class SteamValidationPage(APIValidationPage):
     def __init__(self) -> None:
         super().__init__(
@@ -440,10 +430,12 @@ class Assistant(Gtk.Assistant):
     def __init__(self, is_deck: bool, XDG: "Xdg"):
         super().__init__()
         if is_deck:
-            self.fullscreen()
+            # NOTE: deemed to be "safe" dimensions that exclude taskbar size
+            self.set_default_size(1085, 670)
         else:
             self.set_default_size(1500, 900)
 
+        self.is_binary = False if os.getenv("PYAPP") is None else True
         self.config_path = XDG.config
 
         self.config_values: dict[str, Any] = config_boilerplate
@@ -454,10 +446,9 @@ class Assistant(Gtk.Assistant):
         self.page2 = ConfigMigrationPage(XDG.config)
         self.page3 = SteamPathPage()
         self.page4 = SteamValidationPage()
-        self.page5 = BMValidationPage()
+        self.page5 = PreferencesPage()
-        self.page6 = PreferencesPage()
+        self.page6 = ShortcutCreationPage(XDG.shortcut)
-        self.page7 = ShortcutCreationPage(XDG.shortcut)
+        self.page7 = CompletionPage()
-        self.page8 = CompletionPage()
 
         self.set_forward_page_func(self._advance_page)
 
@@ -475,7 +466,6 @@ class Assistant(Gtk.Assistant):
             self.page5,
             self.page6,
             self.page7,
-            self.page8,
         ):
             # NOTE: skip config migration page if no legacy config file
             if (
@@ -484,7 +474,7 @@ class Assistant(Gtk.Assistant):
             ):
                 continue
             # NOTE: disabled for now on system-provided packages
-            if isinstance(page, ShortcutCreationPage) and os.getenv("PYAPP") is None:
+            if isinstance(page, ShortcutCreationPage) and not self.is_binary:
                 continue
             self._add_page(page, page.get_page_type())
 
@@ -499,32 +489,31 @@ class Assistant(Gtk.Assistant):
 
     def _advance_page(self, index: int) -> int:
         page = self.get_nth_page(index)
-        # TODO: use enums/isinstance
         match page:
-            case self.page1:
+            case IntroductionPage():
                 pass
-            case self.page2:
+            case ConfigMigrationPage():
-                if self.page2.is_migrated():
+                if page.is_migrated():
                     steam_path = lookup(self.config_path, Preferences.DEFAULT)
-                    self.page7.set_steam_path(steam_path)
+                    self.page6.set_steam_path(steam_path)
-                    return self.get_n_pages() - 2
+                    offset = 1 if not self.is_binary else 2
-            case self.page3:
+                    self.setup_complete = True
+                    return self.get_n_pages() - offset
+            case SteamPathPage():
                 self.config_values["default_steam_path"] = page.get_path_from_radio()
-            case self.page4:
+            case SteamValidationPage():
                 self.config_values["steam_api"] = page.get_api_key()
-            case self.page5:
+            case PreferencesPage():
-                self.config_values["bm_api"] = page.get_api_key()
+                # NOTE: collects config values before advancing to last page
-            # NOTE: collects config values before advancing to last page
+                name, use_miles, client = self.page5.get_prefs()
-            case self.page6:
-                name, use_miles, client = self.page6.get_prefs()
                 self.config_values["name"] = name
                 self.config_values["use_miles"] = use_miles
                 self.config_values["client"] = client
                 self.write_config()
-                self.page7.set_steam_path(self.config_values["default_steam_path"])
+                self.page6.set_steam_path(self.config_values["default_steam_path"])
-            case self.page7:
-                self.page7.create_shortcuts()
                 self.setup_complete = True
+            case ShortcutCreationPage():
+                page.create_shortcuts()
             case _:
                 raise AttributeError("Trying to advance a non-canonical page")
         return index + 1
@@ -568,11 +557,7 @@ class Assistant(Gtk.Assistant):
         bar.set_fraction(fraction)
         bar.set_text(f"{page_num}/{total}")
 
-        # NOTE: disable forward action
+        if not isinstance(page, IntroductionPage):
-        # TODO: use page enums
-        if page == self.page5:
-            return
-        if page != self.page1:
             EMITTER.emit("step_pending")
 
 
@@ -599,7 +584,7 @@ class CheckboxWithLabel(Gtk.Box):
         self.button.set_active(state)
 
 
-class ShortcutCreationPage(ScrolledWizardPage):
+class ShortcutCreationPage(OptionalPageMixin, ScrolledWizardPage):  # type: ignore
     def __init__(self, shortcut: Path) -> None:
         super().__init__(
             enum=PageNum.SHORTCUTS,
@@ -642,9 +627,6 @@ class ShortcutCreationPage(ScrolledWizardPage):
             self.desktop_checkbox.set_active(state)
         self.desktop_checkbox.set_sensitive(state)
 
-    def _on_map(self, page: "ScrolledWizardPage") -> None:
-        EMITTER.emit("step_complete")
-
     def set_steam_path(self, path: Path) -> None:
         self.steam_path = path
 

dzgui/views/mixins/cursor_mixin.py

@@ -37,7 +37,11 @@ class CursorMixin:
             end = len(model) - 1
         else:
             return False
-        cur_row = self.get_focused_row_index()  # type: ignore
+
+        try:
+            cur_row = self.get_focused_row_index()  # type: ignore
+        except Exception:
+            return False
 
         if position == CursorPosition.DOWN:
             if cur_row == end:

dzgui/views/pages/changelog.py

@@ -33,7 +33,9 @@ class Changelog(HelpMenuMixin, ScrollableMixin, Gtk.ScrolledWindow):  # type: ig
 
         # TODO: should long text be wrapped?
         self.controller = controller
-        self.box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=5, margin_top=10)
+        self.box = Gtk.Box(
+            orientation=Gtk.Orientation.VERTICAL, spacing=5, margin_top=10
+        )
         self.add(self.box)
 
         self.connect("key-press-event", self._on_keypress)
@@ -55,7 +57,6 @@ class Changelog(HelpMenuMixin, ScrollableMixin, Gtk.ScrolledWindow):  # type: ig
             return version, date
         raise ValueError("Changelog parse error")
 
-
     def _generate_nodes(self, releases: list[tuple[str, list[str]]]) -> None:
         for header, changes in releases:
             for ind in (0, -1):
@@ -64,8 +65,12 @@ class Changelog(HelpMenuMixin, ScrollableMixin, Gtk.ScrolledWindow):  # type: ig
             text = "\n".join(changes)
             formatted = format_pango(text)
 
-            label = Gtk.Label(valign=Gtk.Align.START, margin=15, halign=Gtk.Align.START)
+            container = Gtk.Box(
+                valign=Gtk.Align.START, halign=Gtk.Align.START
+            )
+            label = Gtk.Label()
             label.set_markup(formatted)
+            container.add(label)
 
             version, date = self._parse_version(header)
             button_text = f"{version} ({date})"
@@ -73,9 +78,20 @@ class Changelog(HelpMenuMixin, ScrollableMixin, Gtk.ScrolledWindow):  # type: ig
 
             expander = Gtk.Expander()
             expander.set_label_widget(button)
-            expander.add(label)
+            expander.add(container)
+            expander.connect("activate", self._on_expand, container)
             self.box.add(expander)
 
+    def _on_expand(self, expander: Gtk.Box, container: Gtk.Box) -> None:
+        """
+        Wayland/some themes do not expect widgets to have a size allocation until expanded.
+        Trying to set margins a priori may cause negative allocation,
+        as the margins are subtracted from zero. In effect, the widget is not realized
+        until it is expanded for the first time.
+        """
+        container.set_margin_start(15)
+        container.set_margin_top(15)
+        container.set_margin_bottom(15)
 
     def _parse(self, changelog: str) -> list[tuple[str, list[str]]]:
         release = ""

dzgui/views/pages/keys.py

@@ -103,4 +103,4 @@ class Keybindings(ScrollableMixin, Gtk.ScrolledWindow):  # type: ignore
         return grid
 
     def grab_content_area(self) -> None:
-        self.box.grab_focus()
+        self.grab_focus()

dzgui/views/pages/offline.py

@@ -41,9 +41,18 @@ class FolderError(Enum):
     FOLDER_CHANGED = 3
 
 
-class PageHeading(Gtk.Label):
+class PageHeading(Gtk.Box):
-    def __init__(self, label: str) -> None:
+    def __init__(self, label: str, controller: "Controller") -> None:
-        super().__init__(label=label, halign=Gtk.Align.CENTER)
+        super().__init__(
+            halign=Gtk.Align.CENTER, orientation=Gtk.Orientation.HORIZONTAL
+        )
+
+        self.label = Gtk.Label(label=label)
+        self.eb = InfoEventBox(offline.heading_disclaimer, controller)
+        self.eb.set_icon_yalign(0.7)
+
+        for el in self.label, self.eb:
+            self.add(el)
 
         css.add_class(self, "page-heading")
 
@@ -434,7 +443,8 @@ class OfflineLoader(Gtk.Box):
         self.emitter = controller.get_emitter()
         self.offline_man = OfflineManager(controller)
 
-        self.add(PageHeading(offline.heading))
+        heading = PageHeading(offline.heading, controller)
+        self.add(heading)
 
         self.local_frame = ModFrame(self, controller, offline.local_frame)
         self.custom_frame = CustomModFrame(self, controller, offline.custom_frame)
@@ -511,3 +521,6 @@ class OfflineLoader(Gtk.Box):
             self.mission_frame.present_folder_changed(mission)
             return
         self.offline_man.launch(appid, mission, local_mods, custom_folder, custom_mods)
+
+    def grab_content_area(self) -> None:
+        self.local_frame.tree.grab_focus()

dzgui/views/pages/options.py

@@ -15,16 +15,19 @@ from dzgui.const.constants import (
     VIEW_CONCEAL,
     VIEW_REVEAL,
 )
-from dzgui.const.endpoints import STEAM_API_SETUP, BM_API_SETUP
+from dzgui.const.endpoints import STEAM_API_SETUP
 from dzgui.const.enum import Preferences, ServerTab
 from dzgui.strings import errors, options
 from dzgui.util import strings, css, open_links
 
+from dzgui.views.components.box import ShortHBox, VBox
+from dzgui.views.components.eventbox import InfoEventBox
 from dzgui.views.components.labels import LeftLabel
 from dzgui.views.components.buttons import WebButton
 from dzgui.views.components.frame import HeadingFrame
 from dzgui.views.components.misc import ClientCombo
 from dzgui.views.dialogs.generic import ExceptionDialog
+from dzgui.views.mixins.scrollable_mixin import ScrollableMixin
 
 
 import gi
@@ -37,17 +40,40 @@ if TYPE_CHECKING:
     from dzgui.controllers.emitter import Emitter
 
 
-class ShortHBox(Gtk.Box):
+class ToggleField(Gtk.Box):
-    def __init__(self, widget: Gtk.Widget) -> None:
+    def __init__(
+        self,
+        controller: "Controller",
+        first_option: str,
+        second_option: str,
+        context: Preferences,
+    ) -> None:
         super().__init__(spacing=5, halign=Gtk.Align.START)
 
-        self.pack_start(widget, NO_EXPAND, NO_FILL, NO_PADDING)
+        self.controller = controller
+        self.context = context
+        self.radio1 = Gtk.RadioButton.new_with_label(None, first_option)
+        self.radio2 = Gtk.RadioButton.new_from_widget(self.radio1)
+        self.radio2.set_label(second_option)
+        self.pack_start(self.radio1, NO_EXPAND, NO_FILL, NO_PADDING)
+        self.pack_start(self.radio2, NO_EXPAND, NO_FILL, NO_PADDING)
+
+    def set_suboption_active(self, state: bool) -> None:
+        # NOTE: defer connection of signal until after state is set
+        self.radio2.set_active(state)
+        self.radio1.connect("toggled", self._on_radio_toggled, self.context)
+
+    def _on_radio_toggled(self, button: Gtk.RadioButton, context: Preferences) -> None:
+        self.controller.toggle_config(context)
+
+    def set_sensitive(self, state: bool) -> None:
+        for el in self.radio1, self.radio2:
+            el.set_sensitive(state)
 
 
-class Options(Gtk.Box):
+class Options(ScrollableMixin, Gtk.ScrolledWindow):  # type: ignore
     def __init__(self, controller: "Controller"):
         super().__init__(
-            orientation=Gtk.Orientation.VERTICAL,
             margin_start=10,
             margin_end=10,
         )
@@ -60,29 +86,16 @@ class Options(Gtk.Box):
         self.DEFAULT_WIDTH = 1
         self.DEFAULT_HEIGHT = 1
 
-        label = Gtk.Label(label=strings.options.header)
-        label.set_halign(Gtk.Align.CENTER)
-        css.add_class(label, "page-heading")
-        self.add(label)
-
         self.steam_entry: Gtk.Entry
-        self.bm_entry: Gtk.Entry
 
         self.steam = WebButton(label=strings.options.steam_web)
         self.steam.connect("clicked", self._on_link_button_clicked, STEAM_API_SETUP)
 
-        self.bm = WebButton(label=strings.options.bm_web)
-        self.bm.connect("clicked", self._on_link_button_clicked, BM_API_SETUP)
-
         self.steam_box = self._make_submit_field(
             strings.options.enter_steam, Preferences.STEAM, True
         )
-        self.bm_box = self._make_submit_field(
-            strings.options.enter_bm, Preferences.BM, True
-        )
         api_rows = [
-            [LeftLabel(strings.options.steam_placeholder), self.steam_box],
+            [LeftLabel(strings.options.steam_placeholder), self.steam_box, self.steam],
-            [LeftLabel(strings.options.bm_placeholder), self.bm_box],
         ]
 
         self.player_box = self._make_submit_field(
@@ -92,19 +105,26 @@ class Options(Gtk.Box):
         # TODO: make submit field a standalone class
         self.player_box.get_children()[0].set_width_chars(30)  # type: ignore
 
-        self.fullscreen_toggle = self.make_binary_radio(
+        self.fullscreen_toggle = ToggleField(
+            self.controller,
             strings.options.last_used,
             strings.options.always_fs,
             Preferences.WINDOW,
         )
 
+        # TODO: strings
+        eb = InfoEventBox(
+            "This option is not available on Steam Deck.", self.controller
+        )
+        self.fullscreen_toggle.add(eb)
+
         self.client_combo = ClientCombo()
         self.client_combo.connect("changed", self._on_client_changed)
 
         client_hbox = ShortHBox(self.client_combo)
 
-        self.distance_toggle = self.make_binary_radio(
+        self.distance_toggle = ToggleField(
-            strings.options.km, strings.options.mi, Preferences.DIST
+            self.controller, strings.options.km, strings.options.mi, Preferences.DIST
         )
 
         combo_store = Gtk.ListStore(str, object)
@@ -144,18 +164,6 @@ class Options(Gtk.Box):
         api_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
         api_grid = self._make_grid(api_rows)
         api_box.add(api_grid)
-        api_links_box = Gtk.Box(
-            orientation=Gtk.Orientation.HORIZONTAL,
-            margin_start=5,
-            margin_end=5,
-            margin_top=5,
-            margin_bottom=10,
-            homogeneous=True,
-            spacing=10,
-        )
-        api_links_box.add(self.steam)
-        api_links_box.add(self.bm)
-        api_box.add(api_links_box)
 
         prefs_grid = self._make_grid(pref_rows)
         version_grid = self._make_grid(version_rows)
@@ -176,7 +184,7 @@ class Options(Gtk.Box):
             grid.attach(developers, 1, 0, self.DEFAULT_WIDTH, self.DEFAULT_HEIGHT)
 
         for pair in [
-            (api_box, strings.options.api_keys),
+            (api_box, strings.options.api_key),
             (prefs_grid, strings.options.prefs),
             (version_grid, strings.options.version),
         ]:
@@ -185,9 +193,16 @@ class Options(Gtk.Box):
             grid.attach(frame, col, row, self.DEFAULT_WIDTH, self.DEFAULT_HEIGHT)
             row += 1
 
-        self.scrollable = Gtk.ScrolledWindow(vexpand=True)
+        label = Gtk.Label(label=strings.options.header)
-        self.scrollable.add(grid)
+        label.set_halign(Gtk.Align.CENTER)
-        self.add(self.scrollable)
+        css.add_class(label, "page-heading")
+
+        box = VBox()
+        box.add(label)
+        box.add(grid)
+        self.add(box)
+
+        self.connect("key-press-event", self._on_keypress)
 
     def get_client_name(self) -> str:
         model = self.client_combo.get_model()
@@ -195,13 +210,11 @@ class Options(Gtk.Box):
         return str(model[ind][0])
 
     def block_text_entry(self) -> None:
-        for entry in self.steam_entry, self.bm_entry:
+        self.steam_entry.set_position(-1)
-            entry.set_position(-1)
+        self.steam_entry.set_can_focus(False)
-            entry.set_can_focus(False)
 
     def unblock_text_entry(self) -> None:
-        for entry in self.steam_entry, self.bm_entry:
+        self.steam_entry.set_can_focus(True)
-            entry.set_can_focus(True)
 
     def _on_developers_clicked(self, button: Gtk.Button) -> None:
         self.controller.show_developers_page()
@@ -234,8 +247,6 @@ class Options(Gtk.Box):
 
             if context == Preferences.STEAM:
                 self.steam_entry = entry
-            else:
-                self.bm_entry = entry
 
         box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=10)
         box.add(entry)
@@ -282,7 +293,7 @@ class Options(Gtk.Box):
             case Preferences.NAME:
                 value = entry.get_text().strip()
                 self.controller.update_config(enum, value)
-            case Preferences.BM | Preferences.STEAM:
+            case Preferences.STEAM:
                 text = "".join(entry.get_text().split())
                 self.controller.update_api_key(enum, text)
 
@@ -298,9 +309,6 @@ class Options(Gtk.Box):
     def revert(self, mode: Preferences) -> None:
         if mode == Preferences.STEAM:
             self.steam_entry.set_text(self.old_steam)
-        else:
-            self.bm_entry.set_text(self.old_bm)
-        pass
 
     def _on_start_tab_changed(self, combo: Gtk.ComboBoxText) -> None:
         _iter = combo.get_active_iter()
@@ -317,14 +325,6 @@ class Options(Gtk.Box):
         real_cmd = combo.get_model()[_iter][1]
         self.controller.update_config(Preferences.CLIENT, real_cmd)
 
-    def _on_radio_toggled(self, button: Gtk.RadioButton, context: Preferences) -> None:
-        try:
-            self.controller.toggle_config(context)
-        except Exception:
-            button.handler_block_by_func(self._on_radio_toggled)
-            self.populate_settings()
-            button.handler_unblock_by_func(self._on_radio_toggled)
-
     def _is_valid_text(self, text: str, context: Preferences) -> bool:
         if text.isspace():
             return False
@@ -336,8 +336,6 @@ class Options(Gtk.Box):
                 old = self.old_name
             case Preferences.STEAM:
                 old = self.old_steam
-            case Preferences.BM:
-                old = self.old_bm
         if text == old:
             return False
         return True
@@ -370,23 +368,6 @@ class Options(Gtk.Box):
         state = self._is_valid_text(text, context)
         button.set_sensitive(state)
 
-    def make_binary_radio(
-        self,
-        first_option: str,
-        second_option: str,
-        context: Preferences,
-    ) -> Gtk.Box:
-
-        hbox = Gtk.Box(spacing=5, halign=Gtk.Align.START)
-        radio1 = Gtk.RadioButton.new_with_label(None, first_option)
-        radio2 = Gtk.RadioButton.new_from_widget(radio1)
-        radio2.set_label(second_option)
-        radio1.connect("toggled", self._on_radio_toggled, context)
-        hbox.pack_start(radio1, NO_EXPAND, NO_FILL, NO_PADDING)
-        hbox.pack_start(radio2, NO_EXPAND, NO_FILL, NO_PADDING)
-
-        return hbox
-
     def populate_settings(self) -> None:
         prefs = self.controller.get_prefs()
         # NOTE: re-check in case file was removed by user between runs
@@ -401,34 +382,31 @@ class Options(Gtk.Box):
         name = self.controller.query_config(Preferences.NAME)
         default_steam_path = self.controller.query_config(Preferences.DEFAULT)
         steam = self.controller.query_config(Preferences.STEAM)
-        bm = self.controller.query_config(Preferences.BM)
 
         steam_path = Path(default_steam_path)
 
         self.old_steam = steam
-        self.old_bm = bm
         self.old_name = name
 
         self.steam_entry.set_text(steam)
-        self.bm_entry.set_text(bm)
         p = self.player_box.get_children()[0]
         if hasattr(p, "set_text"):
             p.set_text(name)
 
-        # NOTE: suppress toggle signal until radios are built
+        fs = config["fullscreen"]
-        self._suppress_toggles(True)
+        miles = config["use_miles"]
-        for el, conf_state in [
+
-            (self.fullscreen_toggle, config["fullscreen"]),
+        if prefs.is_steam_deck:
-            (self.distance_toggle, config["use_miles"]),
+            self.fullscreen_toggle.set_sensitive(False)
-        ]:
+            fs = True
-            el.get_children()[conf_state].set_active(True)
+
-        self._suppress_toggles(False)
+        self.fullscreen_toggle.set_suboption_active(fs)
+        self.distance_toggle.set_suboption_active(miles)
 
         # NOTE: disable buttons if no text is set
         for field in (
             [name, self.player_box],
             [steam, self.steam_box],
-            [bm, self.bm_box],
         ):
             if field[0] == "":
                 field[1].get_children()[1].set_sensitive(False)
@@ -475,4 +453,4 @@ class Options(Gtk.Box):
         widget.set_visibility(state)
 
     def grab_content_area(self) -> None:
-        return
+        self.grab_focus()

dzgui/views/pages/preconnect.py

@@ -239,6 +239,15 @@ class PreConnectionAssistant(Gtk.Box):
         )
 
         """Errors"""
+        if len(prereqs.invalid_mods) > 0:
+            pairs = [": ".join(sub) for sub in prereqs.invalid_mods]
+            lines = "\n".join(pairs)
+            msg = (
+                "Server has invalid mods that are not recognized by Steam.\n"
+                "Contact the server owner and include these mod IDs in your report:\n"
+                f"{lines}"
+            )
+            errors.append(msg)
         if prereqs.binary_missing:
             errors.append(
                 f"Remote server is running the build '{prereqs.build}', but it is not installed.\n{resync_msg}"
@@ -273,12 +282,12 @@ class PreConnectionAssistant(Gtk.Box):
             )
 
         allows_dl, running_app = prereqs.allows_downloads
-        if allows_dl is False:
+        if len(prereqs.mods) > 0 and allows_dl is False:
             msg = (
-                f"The game '{running_app}' is currently running in Steam, but background downloads are not enabled.\n"
+                f"The app '{running_app}' is currently running in Steam, but background downloads are not enabled.\n"
                 "Either stop the game first, or update your global Steam settings or the game's local settings.\n"
                 "Otherwise, mods may be queued for download but never update."
-                )
+            )
             warnings.append(msg)
 
         self.add_warnings(warnings)

dzgui/views/trees/tree_base.py

@@ -1,7 +1,6 @@
 import logging
 
 from typing import Any, Optional, TYPE_CHECKING
-from warnings import deprecated
 
 from dzgui.const.constants import APP_NAME, SEPARATOR
 from dzgui.util.keys import is_ctrl_mask, is_navkey
@@ -173,7 +172,7 @@ class TreeView(CursorMixin, Gtk.TreeView):  # type: ignore
         (model, pathlist) = sels
         return (model, pathlist)
 
-    @deprecated("Currently unused")
+    # @deprecated("Currently unused")
     # def get_mpath(self) -> Optional[Gtk.TreePath]:
     #    (model, pathlist) = self.get_model_and_pathlist()
     #    if len(pathlist) < 1:
@@ -195,7 +194,7 @@ class TreeView(CursorMixin, Gtk.TreeView):  # type: ignore
             return True
         return False
 
-    @deprecated("unused")
+    # @deprecated("unused")
     # def get_selected_row(self) -> Optional[Gtk.TreeModelRow]:
     #    ind = self.get_selected_row_index()
     #    model = self.get_model()

dzgui/views/trees/tree_log.py

@@ -53,7 +53,7 @@ class LogTreeView(ContextMixin, TreeView):  # type: ignore
         model = ModelFactory().new_model_from_logfile(filepath)
         _filter = model.filter_new()
         _filter.set_visible_func(self._filter_rows)
-        sortable = Gtk.TreeModelSort(_filter)
+        sortable = Gtk.TreeModelSort.new_with_model(_filter)
         self.set_model(sortable)
         _filter.refilter()
         path = Gtk.TreePath.new_from_indices([0])

pyproject.toml

@@ -4,7 +4,7 @@ description = "DayZ server browser and mod manager for Linux"
 authors = [
     {name = "aclist"}
 ]
-version = "7.0.0b16"
+version = "7.0.0b21"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 readme = "README.md"
@@ -107,11 +107,13 @@ config-settings-package = { pygobject-stubs = { config = "Gtk3,Gdk3,Soup2" } }
 
 [tool.pytest.ini_options]
 markers = [
+    "apitest: checks remote endpoints",
     "config: config file keys/values",
+    "realconfig: depends on actual generated local config file",
     "mods: tests mod metadata/link creation",
     "pefile: validate PE files",
     "post_install: requires a completed installation",
     "redact: log redaction mechanisms",
     "slow: long-running tests",
-    "webtest: checks remote endpoints"
+    "webtest: depends on remote endpoint",
 ]

tests/fixtures/api/loginusers_beta_client.vdf

@@ -0,0 +1,13 @@
+"users"
+{
+	"0"
+	{
+		"AccountName"		"STEAMUSER"
+		"PersonaName"		"STEAMUSER"
+		"RememberPassword"		"0"
+		"WantsOfflineMode"		"0"
+		"SkipOfflineModeWarning"		"0"
+		"AutoLogin"		"1"
+		"Timestamp"		"0"
+	}
+}

tests/fixtures/api/loginusers_legacy_client.vdf

@@ -0,0 +1,14 @@
+"users"
+{
+	"0"
+	{
+		"AccountName"		"STEAMUSER"
+		"PersonaName"		"STEAMUSER"
+		"RememberPassword"		"0"
+		"WantsOfflineMode"		"0"
+		"SkipOfflineModeWarning"		"0"
+		"AllowAutoLogin"		"1"
+		"MostRecent"		"1"
+		"Timestamp"		"0"
+	}
+}

tests/fixtures/api/loginusers_legacy_client_multiple.vdf

@@ -0,0 +1,25 @@
+"users"
+{
+	"0"
+	{
+		"AccountName"		"STEAMUSER"
+		"PersonaName"		"STEAMUSER"
+		"RememberPassword"		"0"
+		"WantsOfflineMode"		"0"
+		"SkipOfflineModeWarning"		"0"
+		"AllowAutoLogin"		"1"
+		"MostRecent"		"0"
+		"Timestamp"		"0"
+	}
+	"1"
+	{
+		"AccountName"		"STEAMUSER2"
+		"PersonaName"		"STEAMUSER2"
+		"RememberPassword"		"0"
+		"WantsOfflineMode"		"0"
+		"SkipOfflineModeWarning"		"0"
+		"AllowAutoLogin"		"1"
+		"MostRecent"		"1"
+		"Timestamp"		"0"
+	}
+}

tests/test_config.py

@@ -7,13 +7,12 @@ from dzgui.config.xdg import get_xdg_paths, parse_filepaths
 from dzgui.config import convert
 from tests.fixtures import fixture_path
 
-pytestmark = pytest.mark.config
-
 
 @pytest.fixture
 def legacy_config():
     return fixture_path("dztuirc_1")
 
+
 @pytest.fixture
 def unset_values():
     return fixture_path("dztuirc_3")
@@ -22,7 +21,6 @@ def unset_values():
 @pytest.fixture
 def keys():
     return [
-        "bm_api",
         "fav_server",
         "fav_label",
         "name",
@@ -38,6 +36,7 @@ def keys():
 
 # TODO: use a static fixture instead of system config
 @pytest.fixture
+@pytest.mark.realconfig
 def config():
     paths = get_xdg_paths()
     xdg = parse_filepaths(paths)
@@ -45,18 +44,21 @@ def config():
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_invalid_config_value(config):
     with pytest.raises(Exception):
         assert config["foo"] is None
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_default_config_values(keys, config):
     for key in keys:
         assert config[key] is not None
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_contains_invalid_values(keys, config):
     for key in config:
         assert key in keys
@@ -81,7 +83,6 @@ def test_key_conversion(legacy_config):
     j = convert.rc2json(legacy_config)
     j = json.loads(j)
     keys = [
-        "api_key",
         "staging_dir",
         "src_path",
         "steam_path",
@@ -91,6 +92,7 @@ def test_key_conversion(legacy_config):
     for key in keys:
         assert key not in j
 
+
 def test_missing_values(unset_values):
     j = convert.rc2json(unset_values)
     j = json.loads(j)

tests/test_html_escaping.py

@@ -0,0 +1,30 @@
+from dzgui.api.servers import Details
+from dzgui.views.dialogs.servers import ServerDetailsDialog
+
+import gi
+
+gi.require_version("Gtk", "3.0")
+from gi.repository import Gtk  # noqa E402
+
+
+class MockController:
+    def __init__(self) -> None:
+        self.window = Gtk.Window()
+
+    def get_window(self) -> Gtk.Window:
+        return self.window
+
+    def get_server_name(self) -> str:
+        return "My server"
+
+    def get_emitter(self) -> None:
+        return None
+
+
+def test_html_escaping() -> None:
+    text = "<Server description> Game & mods"
+    details = Details([["0", "1"]], text, True)
+    controller = MockController()
+    dialog = ServerDetailsDialog(controller, details)
+
+    assert dialog.description.get_text() == text

tests/test_ip.py

@@ -1,6 +1,24 @@
 import pytest
 
 from dzgui.api.servers import validate_ip
+from dzgui.views.components.entry import validate_ip_truthy
+
+
+@pytest.mark.parametrize(
+    "ip",
+    [
+        ("foo", False),
+        ("999", False),
+        ("192.168.1.101", False),
+        ("192.168.1.101:", False),
+        (":1", False),
+        ("192.168.1.101:27016", True),
+    ],
+)
+def test_ip_entry(ip) -> None:
+    string, state = ip
+    assert validate_ip_truthy(string) is state
+
 
 def test_ip_validation() -> None:
     ip = "192.168.1.1:100"
@@ -15,6 +33,7 @@ def test_invalid_port() -> None:
     with pytest.raises(Exception):
         validate_ip(ip)
 
+
 @pytest.mark.parametrize("port", [-1, 65536])
 def test_port_out_of_range(port: int) -> None:
     ip = f"192.168.1.1:{port}"
@@ -27,6 +46,7 @@ def test_invalid_socket() -> None:
     with pytest.raises(Exception):
         validate_ip(ip)
 
+
 # TODO: ?
 def test_ipdb() -> None:
     pass

tests/test_log_redaction.py

@@ -37,6 +37,14 @@ class RecordsListHandler(logging.Handler):
             "Error in directory: '/home/SENSITIVE_USERNAME'",
             "Error in directory: '/home/REDACTED'",
         ),
+        (
+            "User directory: /home/user/.local/share/Steam/userdata/999999/grid",
+            "User directory: /home/REDACTED/.local/share/Steam/userdata/REDACTED/grid",
+        ),
+        (
+            "User directory: /drive/.local/share/Steam/userdata/999999",
+            "User directory: /drive/.local/share/Steam/userdata/REDACTED",
+        ),
     ],
 )
 def test_log_redaction(log_error: str, expect: str) -> None:

tests/test_loginusers.py

@@ -0,0 +1,25 @@
+import pytest
+
+from pathlib import Path
+
+from dzgui.api.steam import find_user_id
+from tests.fixtures import fixture_path
+
+pytestmark = pytest.mark.apitest
+
+
+@pytest.mark.parametrize(
+    "fixture, expect",
+    [
+        ("api/loginusers_legacy_client.vdf", 0),
+        ("api/loginusers_legacy_client_multiple.vdf", 1),
+        ("api/loginusers_beta_client.vdf", 0),
+    ],
+)
+def test_loginusers(monkeypatch, fixture: str, expect: int) -> None:
+    def mock_loginusers(path: Path) -> Path:
+        return fixture_path(fixture)
+
+    monkeypatch.setattr("dzgui.api.steam.find_loginusers", mock_loginusers)
+    uid = find_user_id(Path(""))
+    assert int(uid) == expect

tests/test_pefile.py

@@ -12,7 +12,7 @@ from dzgui.api.steam import (
 
 from dzgui.config.query import get_config
 from dzgui.config.xdg import get_xdg_paths, parse_filepaths
-from dzgui.const.constants import APPID_DAYZ, LIBRARYFOLDERS_PATH
+from dzgui.const.constants import APPID_DAYZ
 
 from tests.fixtures import fixture_path
 

tests/test_remote_api.py

@@ -13,13 +13,11 @@ def config():
     xdg = parse_filepaths(paths)
     return get_config(xdg.config)
 
+
 def test_ipdb():
     assert probe.test_ipdb()
 
+
 def test_steam(config):
     key = config["steam_api"]
     assert probe.test_steam_api(key)
-
-def test_bm(config):
-    key = config["bm_api"]
-    assert probe.test_bm_api(key)

tests/test_shortcuts.py

@@ -30,33 +30,33 @@ def test_no_shortcuts(monkeypatch) -> None:
 @pytest.fixture
 def dummy_app() -> None:
     d = {
-        "appname": "TEST APP",
+        "AppName": "TEST APP",
         "StartDir": "TEST_DIR",
-        "exe": "TEST_DIR/TEST_EXE.EXE",
+        "Exe": "TEST_DIR/TEST_EXE.EXE",
         "icon": "IMAGES_DIR/TEST_IMAGE.PNG",
     }
     return d
 
 
-def test_wrap_exe(dummy_app) -> None:
+def test_wrap_exe(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
-    assert s.shortcuts["shortcuts"]["0"]["exe"][0] == '"'
+    assert s.shortcuts["shortcuts"]["0"]["Exe"][0] == '"'
-    assert s.shortcuts["shortcuts"]["0"]["exe"][-1] == '"'
+    assert s.shortcuts["shortcuts"]["0"]["Exe"][-1] == '"'
 
 
-def test_add_shortcut(dummy_app) -> None:
+def test_add_shortcut(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
     new = s.shortcuts["shortcuts"]
     ind = str(len(new) - 1)
     for k, v in dummy_app.items():
-        if k == "exe":
+        if k == "Exe":
             v = f'"{v}"'
         assert new[ind][k] == v
 
 
-def test_save_shortcut(dummy_app) -> None:
+def test_save_shortcut(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
     with tempfile.NamedTemporaryFile() as f:
@@ -65,3 +65,27 @@ def test_save_shortcut(dummy_app) -> None:
         s.save_shortcuts()
         s._load_shortcuts(tmp)
         assert len(s.shortcuts["shortcuts"]) == 1
+
+
+def test_shortcut_crc(dummy_app: dict[str, str]) -> None:
+    s = Shortcuts(Path(""))
+    s.add_shortcut(*dummy_app.values())
+    for key in s.shortcuts["shortcuts"].keys():
+        entry = s.shortcuts["shortcuts"][key]
+        name = entry["AppName"]
+        exe = entry["Exe"]
+        uid = name + exe
+        bpid = s.gen_bpid(uid)
+        assert entry["appid"] & 0xFFFFFFFF == bpid
+
+
+def test_reverse_crc(dummy_app: dict[str, str]) -> None:
+    s = Shortcuts(Path(""))
+    s.add_shortcut(*dummy_app.values())
+    for key in s.shortcuts["shortcuts"].keys():
+        entry = s.shortcuts["shortcuts"][key]
+        name = entry["AppName"]
+        exe = entry["Exe"]
+        uid = name + exe
+        bpid = s.gen_bpid(uid)
+        assert s.find_appname_by_unsigned_id(bpid) == name