Merge pull request #296 from aclist/fix/empty-statusbar

fix: statusbar being wiped when calcdist fails on empty row

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: aclist

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,57 @@
+name: Bug report
+description: Submit bugs that affect functionality here
+title: "[BUG] Your title here"
+labels: ["bug"]
+assignees:
+  - aclist
+body:
+  - type: markdown
+    attributes:
+      value: |
+          ### WARNING: When posting log/config data, redact any sensitive information like API keys.
+  - type: checkboxes
+    id: kb
+    attributes:
+      label: Did you check if this issue already exists?
+      options:
+        - label: I have checked the [Knowledge Base](https://aclist.github.io/dzgui/kb.html) and searched through [past issues](https://github.com/aclist/dztui/issues?q=is%3Aissue+is%3Aclosed) and did not find my issue there.
+          required: true
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: What did you expect to happen?
+      placeholder: "E.g., When doing X, Y occurred. Include as much detail as possible."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional log output
+      description: Attach the file `$HOME/.local/state/dzgui/DZGUI_DEBUG.log` by clicking this area to highlight it and then dragging the file in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,47 @@
+name: Feature suggestion
+description: Submit requests for new features here
+title: "[FEAT] Your title here"
+labels: ["enhancement"]
+assignees:
+  - aclist
+body:
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the feature
+      description: A clear and detailed description
+      placeholder: "E.g., Add a dialog to the Options menu that automatically lets the user do Y"
+    validations:
+      required: true
+  - type: textarea
+    id: why
+    attributes:
+      label: Describe the benefit
+      description: How will this feature benefit large numbers of users?
+      placeholder: "E.g., Currently, users have to manually do X to achieve Y. Implementing this feature would achieve A, B, and C."
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/trouble.yml

@@ -0,0 +1,50 @@
+name: Troubleshooting
+description: Submit user error/troubleshooting questions here
+title: "[HELP] Your title here"
+labels: ["troubleshooting"]
+assignees:
+  - aclist
+body:
+  - type: markdown
+    attributes:
+      value: |
+          ### WARNING: When posting log/config data, redact any sensitive information like API keys.
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the issue
+      description: A detailed description. What did you expect to happen?
+      placeholder: "Include as much detail as possible and state the steps leading up to the problem. E.g., First I do this, then I do this, then this happens."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional log output
+      description: Attach the file `$HOME/.local/state/dzgui/DZGUI_DEBUG.log` by clicking this area to highlight it and then dragging the file in.
+    validations:
+      required: false

.github/workflows/mirror.yml

@@ -0,0 +1,18 @@
+name: Mirror to Codeberg
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  mirror-to-codeberg:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: pixta-dev/repository-mirroring-action@v1
+        if: ${{ vars.GIT_REMOTE != '' }}
+        with:
+          target_repo_url: ${{ vars.GIT_REMOTE }}
+          ssh_private_key: ${{ secrets.GIT_SSH_PRIVATE_KEY }}

CHANGELOG.md

@@ -34,6 +34,7 @@
 - Early load alerts button
 - Preconnect dialog
 - Preconnect warnings/failsafes like filesize
+- Save filters per server context between sessions
 
 
 ## Changed

DEVELOPERS.md

@@ -1,18 +1,23 @@
 # TODO: link to here from sphinx docs
 
+# Installing dev dependencies
+uv pip install -e .[dev]
+
 # Setting up precommit hooks
 pre-commit install
 
 # Fetching submodules
 git submodule update --recursive --init
 
-# Installing dev dependencies
-uv pip install -e .[dev]
-
 # Building documentation
 sphinx-build -M html source build -a
 
 # Building standalone DZGUI release binaries
 1. Run `./scripts/dl_pyapp.sh`
-2. Run `python3 scripts/release.py`
-3. Generate a release and tag against the bundled `dzgui` executable
+# TODO: secondary script that packs this archive
+2. Download cpython 3.13, linux, gnu, v3
+https://github.com/astral-sh/python-build-standalone/releases/download/20251014/cpython-3.13.9%2B20251014-x86_64_v3-unknown-linux-gnu-install_only_stripped.tar.gz
+3. Explicitly install dependencies into site-packages
+4. Pack back into a tarball
+5. Run `python3 scripts/release.py`
+6. Generate a release and tag against the bundled `dzgui` executable

docs/source/kb.rst

@@ -34,7 +34,7 @@ DZG-004: On Steam Deck, some mods in the Workshop show a black screen when DZGUI
 ---------------------------------------------------------------------------------------------------------
 This is a bug in the Steam client that is being tracked at Valve's Steam for Linux issue tracker here: https://github.com/ValveSoftware/steam-for-linux/issues/9598.
 
-To resolve this issue, manually intervene in the Steam client by selecting a different context (e.g., Store, Library), waiting for it to load, then navigating back to the Workshop context. This should 
+To resolve this issue, manually intervene in the Steam client by selecting a different context (e.g., Store, Library), waiting for it to load, then navigating back to the Workshop context. This should
 clear the blockage and allow the contents to render.
 
 .. _DZG-005:

dzgui/api/servers.py

@@ -106,7 +106,7 @@ class A2SInfo:
 
 def get_netmask() -> str:
     hostname = os.uname()[1]
-    i = socket.gethostbyname(hostname)
+    i = socket.gethostbyname(f"{hostname}.local")
     netmask = i.rsplit(".", 1)[0]
     return netmask
 
@@ -472,6 +472,7 @@ def query_by_ip(addr: str) -> A2SInfo:
         return A2SInfo(Record("0", 0, 0), None)
     return query_by_record(record, update_gameport=True)
 
+
 def query_by_id(server_id: int, key: str) -> A2SInfo:
     """
     Used with numeric Battlemetrics IDs

dzgui/config/xdg.py

@@ -17,6 +17,7 @@ class Xdg:
     system: Path
     debug: Path
     ips: Path
+    filters: Path
 
 
 def is_writeable(path_str: str) -> bool:
@@ -63,9 +64,6 @@ def get_xdg_paths() -> dict:
 
 
 def parse_filepaths(xdg: dict) -> Xdg:
-    # cache = xdg["XDG_CACHE_HOME"]
-    # data = xdg["XDG_DATA_HOME"]
-
     config = xdg["XDG_CONFIG_HOME"]
     state = xdg["XDG_STATE_HOME"]
 
@@ -80,6 +78,7 @@ def parse_filepaths(xdg: dict) -> Xdg:
     history = state / "dzg.history"
     versions = state / "dzg.versions"
     ips = state / "ips.csv"
+    filters = state / "dzg.filters.json"
 
     return Xdg(
         config,
@@ -91,4 +90,5 @@ def parse_filepaths(xdg: dict) -> Xdg:
         system,
         debug,
         ips,
+        filters
     )

dzgui/controllers/emitter.py

@@ -12,6 +12,7 @@ if TYPE_CHECKING:
 
 # TODO: if servers fail to load, may leave dangling widgets waiting for a signal
 
+
 class Emitter(GObject.GObject):
     def __init__(self) -> None:
         super().__init__()
@@ -150,3 +151,6 @@ class Emitter(GObject.GObject):
     def keyword_set(self, keyword: str) -> None:
         pass
 
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def lan_page_initialized(self) -> None:
+        pass

dzgui/controllers/mc.py

@@ -260,6 +260,21 @@ class Controller(GObject.GObject):
     def select_colorized(self) -> None:
         self.mod_man.select_colorized()
 
+    def get_all_tree_filters(self) -> dict[str, dict[str, bool]]:
+        servers = self.get_servers()
+        all_filters: dict[str, dict[str, bool]] = {}
+        trees = (
+            servers.get_browser(),
+            servers.get_saved(),
+            servers.get_recent(),
+            servers.get_lan(),
+        )
+        for tree in trees:
+            enum = str(tree.get_enum())
+            filters = tree.get_filter_man().get_filters()
+            all_filters[enum] = filters
+        return all_filters
+
     def get_filter_man(self) -> "FilterManager":
         """Each ServerTreeView has an atomic FilterManager"""
         return self.get_active_treeview().get_filter_man()
@@ -303,8 +318,21 @@ class Controller(GObject.GObject):
             self.emitter.emit("servers_loaded", tv.get_enum())
             return
         self.mediator.statusbar.set_by_context(tv.get_enum(), "")
+        self.mediator.filters.button_grid.block_toggles(True)
+        self.populate_filter_prefs()
+        self.mediator.filters.button_grid.block_toggles(False)
         ServerModelManager(self, tv).load()
 
+    def populate_filter_prefs(self) -> None:
+        tv = self.get_active_treeview()
+        filters = self.config_man.get_filters(tv)
+        if filters is None:
+            return
+        filter_man = self.get_filter_man()
+        for filt, state in filters.items():
+            filter_man.set_filter(filt, state)
+        self.mediator.filters.set_filters(filters)
+
     def get_dist_cache(self) -> dict[str, "Haversine"]:
         return self.dist_cache
 

dzgui/data/CHANGELOG.md

@@ -34,6 +34,7 @@
 - Early load alerts button
 - Preconnect dialog
 - Preconnect warnings/failsafes like filesize
+- Save filters per server context between sessions
 
 
 ## Changed

dzgui/main.py

@@ -112,6 +112,9 @@ def main() -> None:
         copy_state_files(xdg_paths["XDG_STATE_HOME"])
         # TODO: add logging inside wizard
         SetupWizard(_is_steam_deck, XDG.config)
+
+    # NOTE: implies that setup wizard failed or was closed
+    if has_new_config(XDG.config) is False:
         return
 
     setup_logger(XDG.debug)
@@ -127,7 +130,7 @@ def main() -> None:
         if has_steam_client() is False:
             EarlyAlertDialog(init.requires_steam)
 
-    # NOTE: clear versions file of unlinked mods
+    # NOTE: clears versions file of unlinked mods
     rebuild_symlinks(XDG.config)
     remove_stale_signatures(XDG.config, XDG.version)
 

dzgui/managers/config.py

@@ -22,7 +22,6 @@ import gi
 gi.require_version("Gtk", "3.0")
 from gi.repository.Gtk import main_quit  # noqa E402
 
-# import dzgui.api.servers as Servers
 if TYPE_CHECKING:
     from dzgui.config.userprefs import UserPrefs
     from dzgui.controllers.mc import Controller
@@ -160,6 +159,9 @@ class ConfigManager:
 
     def save_res_and_quit(self, tv: "ServerTreeView", window: "OuterWindow") -> None:
         columns = tv.get_columns()
+        filters = self.controller.get_all_tree_filters()
+        filters_file = self.prefs.paths.filters
+
         columns_file = self.prefs.paths.columns
         try:
             data = read_json(columns_file)
@@ -174,6 +176,7 @@ class ConfigManager:
 
         try:
             write_json(data, columns_file)
+            write_json(filters, filters_file)
         except Exception as e:
             logger.critical(e)
 
@@ -217,3 +220,12 @@ class ConfigManager:
             h = WINDOW_DEFAULT_Y
             logger.info(f"Using default window size {w},{h}")
             window.set_default_size(w, h)
+
+    def get_filters(self, tv: "ServerTreeView") -> Any | None:
+        filters = self.prefs.paths.filters
+        try:
+            enum = tv.get_enum()
+            filters = read_json(filters)
+            return filters[str(enum)]
+        except Exception:
+            return None

dzgui/managers/notes.py

@@ -20,7 +20,10 @@ logger = logging.getLogger(APP_NAME)
 class NoteManager:
     def __init__(self, controller: "Controller", path: "Path") -> None:
         self.notes_path = path
-        self.cache: dict[str, str] = read_json(self.notes_path)
+        try:
+            self.cache: dict[str, str] = read_json(self.notes_path)
+        except Exception:
+            self.cache = {}
 
     def add_note(self, server: str, note: str) -> None:
         self.cache[server] = note

dzgui/model/servers.py

@@ -73,6 +73,7 @@ class ServerModelManager:
                 self._dump_history()
             case ServerTab.LAN:
                 # NOTE: LAN tab is only loaded on demand
+                self.emitter.emit("lan_page_initialized")
                 pass
             case _:
                 pass
@@ -123,8 +124,10 @@ class ServerModelManager:
         parsed = Servers.parse_json(servers)
         self._push_data(parsed)
 
-    @call_on_thread(dialog.scanning)
+    @call_on_thread(dialog.scanning, show_cancel=True)
     def dump_lan(self, port: int, early_abort: bool) -> None:
+        self.first_iteration = True
+
         servers = []
         ports = range(1, 256)
         failure_func = StoredFunc(self._cleanup_on_failure)
@@ -135,19 +138,20 @@ class ServerModelManager:
             for future in as_completed(futures):
                 try:
                     if self.controller.get_exit_event().is_set():
+                        event.set()
+                        return
+                    if self.controller.get_cancel_event().is_set():
+                        event.set()
+                        self.controller.clear_cancel_event()
                         return
                     res = future.result(timeout=LAN_TIMEOUT)
                     if res is None:
                         continue
+                    servers.append(res)
                     if early_abort is True:
                         # NOTE: on first non-empty hit, flag pending threads to close
                         event.set()
-                        servers.append(res)
-                        self.thread_man.set_cleanup_func(
-                            StoredFunc(self._cleanup_on_success)
-                        )
-                        return
-                    servers.append(res)
+                        break
                 except Exception as e:
                     logger.critical(e)
                     self.thread_man.set_cleanup_func(failure_func, destroy_first=True)

dzgui/strings/wizard.py

@@ -67,4 +67,4 @@ label_client = "Steam client"
 
 ### Completion page
 heading_completion = "Setup complete"
-blurb_completion = "Configuration completed successfully. Please exit and restart DZGUI to apply changes."
+blurb_completion = "Configuration completed successfully. Click 'Close' to close this dialog and launch DZGUI."

dzgui/util/_json.py

@@ -2,15 +2,13 @@ import json
 from pathlib import Path
 from typing import Any
 
+
 def read_json(path: Path) -> Any:
     try:
         with open(path, "r") as infile:
-            try:
-                data = json.load(infile)
-                return data
-            except json.decoder.JSONDecodeError as e:
-                raise e
-    except OSError as e:
+            data = json.load(infile)
+            return data
+    except Exception as e:
         raise e
 
 

dzgui/util/strings.py

@@ -101,7 +101,7 @@ build_corrupted = (
     "Steam settings or DayZ installation may be corrupted. Try restarting Steam."
 )
 api_warn_msg = """No servers returned. Please wait and try again.
-If this issue persists, your API key may be defunct or your network is blocking requests.
+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 = (

dzgui/views/base.py

@@ -262,8 +262,8 @@ class Grid(Gtk.Grid):
 
         self.emitter.connect("server_page_toggled", self.toggle_filter_panels)
 
+    # TODO: drop, use map/signal
     def hide_widgets_on_init(self) -> None:
-        self.conpan.set_lan_visible(False)
         self.right_panel.sel_panel.hide()
 
     def toggle_filter_panels(self, emitter: "Emitter", state: bool) -> None:

dzgui/views/components/connect_panel.py

@@ -278,9 +278,7 @@ class ConnectPanel(Gtk.Box):
 
         for el in self.lan, self.fav, self.add_panel:
             self.add(el)
-
-    def set_lan_visible(self, state: bool) -> None:
-        self.lan.set_visible(state)
+        self.lan.set_visible(False)
 
     def _on_lan_tab_toggled(self, emitter: "Emitter", state: bool) -> None:
-        self.set_lan_visible(state)
+        self.lan.set_visible(state)

dzgui/views/components/filter_panel.py

@@ -68,6 +68,7 @@ class ButtonGrid(Gtk.Grid):
             )
 
     def reload_filters(self) -> None:
+        # TODO: may be superfluous
         checkboxes = self.checks
         self.block_toggles(True)
         filters = self.controller.get_enabled_filters()
@@ -330,3 +331,8 @@ class FilterPanel(Gtk.Box):
             self.block_map_change_propagation = False
             return
         self.emitter.emit("map_selection_changed", name)
+
+    def set_filters(self, filters: dict[str, bool]) -> None:
+        for check in self.button_grid.checks:
+            label = check.get_label()
+            check.set_active(filters[label])

dzgui/views/components/right_panel.py

@@ -52,6 +52,7 @@ class RightPanel(Gtk.Box):
         emitter = controller.get_emitter()
         emitter.connect("servers_loaded", self._on_servers_loaded)
         emitter.connect("server_page_changed", self._on_server_page_changed)
+        emitter.connect("lan_page_initialized", self._on_lan_page_init)
 
         self.button_vbox = ButtonBox(controller)
         self.filters_vbox = FilterPanel(controller)
@@ -152,10 +153,15 @@ class RightPanel(Gtk.Box):
             return
         self.filters_vbox.set_sensitive(False)
 
+    def _on_lan_page_init(self, emitter: "Emitter") -> None:
+        self.filters_vbox.set_sensitive(False)
+        self.refresh_button.set_sensitive(False)
+
     def _on_servers_loaded(self, emitter: "Emitter", context: "ServerTab") -> None:
         # TODO: similar logic on notebook page change
         state = self.controller.has_server_model()
-        self.filters_vbox.set_sensitive(state)
+        for el in self.filters_vbox, self.refresh_button:
+            el.set_sensitive(state)
 
     def _on_version_clicked(self, widget: Gtk.EventBox, event: Gdk.EventButton) -> None:
         def revert() -> Literal[False]:

dzgui/views/components/statusbar.py

@@ -111,9 +111,9 @@ class Statusbar(Gtk.Grid):
         context: Union["ServerTab", NotebookPage],
     ) -> None:
         self.spinner.stop()
-        # TODO: CalcDist is being called when table is not loaded
+        # FIXME: CalcDist is being called when table is not loaded
         if dist is None:
-            self.set_by_context(context, "")
+            return
         else:
             pretty = self.append_distance(dist)
             self.set_by_context(context, pretty)

dzgui/views/mixins/mods_mixin.py

@@ -11,5 +11,5 @@ class ModsMixin:
         self, tree: TreeView, path: Gtk.TreePath, column: Gtk.TreeViewColumn
     ) -> None:
 
-        path = self.get_focused_row_path()  # type: ignore
-        self.controller.open_mod_page(path)  # type: ignore
+        mod = self.get_value_at_index(2)  # type: ignore
+        self.controller.open_workshop_page(mod)  # type: ignore

dzgui/views/pages/preconnect.py

@@ -17,7 +17,7 @@ from dzgui.views.trees.tree_server_mods import ServerModTreeView
 import gi
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gdk, Gtk  # type: ignore # noqa E402
+from gi.repository import Gdk, Gtk  # noqa E402
 
 
 if TYPE_CHECKING:

dzgui/views/trees/tree_servers.py

@@ -162,8 +162,8 @@ class ServerTreeView(ContextMixin, TreeView):  # type: ignore
 
     def _on_map(self, widget: Self) -> None:
         # TODO: disable filter panel if current model is None
-        if self.get_enum() is ServerTab.LAN:
-            self.emitter.emit("lan_tab_toggled", True)
+        state = self.get_enum() is ServerTab.LAN
+        self.emitter.emit("lan_tab_toggled", state)
 
         store = self.filter_man.get_map_store()
 
@@ -178,8 +178,6 @@ class ServerTreeView(ContextMixin, TreeView):  # type: ignore
         # NOTE: removes queue checker for this tab
         GLib.Source.remove(self.queue_id)
         self.emitter.disconnect(self.handler_id)
-        if self.get_enum() is ServerTab.LAN:
-            self.emitter.emit("lan_tab_toggled", False)
 
     def _on_col_width_changed(
         self, col: Gtk.TreeViewColumn, width: GObject.ParamSpecInt

pyproject.toml

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

scripts/release.py

@@ -9,6 +9,7 @@ root = Path(__file__).resolve().parents[1]
 output = root.joinpath("dist")
 
 pyapp_dir = root.joinpath("pyapp-latest")
+cpython = root.joinpath("build/cpython/airgapped.tar.gz")
 
 builder = build.ProjectBuilder(root)
 wheel = builder.build("wheel", output_directory=output)
@@ -26,9 +27,15 @@ env["PYAPP_PROJECT_VERSION"] = version
 env["PYAPP_PROJECT_NAME"] = appname
 env["PYAPP_EXEC_SPEC"] = entrypoint
 env["PYAPP_PROJECT_PATH"] = wheel
-env["PYAPP_DISTRIBUTION_EMBED"] = "true"
-env["PYAPP_PYTHON_VERSION"] = "3.13"
 env["PYAPP_PASS_LOCATION"] = "true"
+# env["PYAPP_PYTHON_VERSION"] = "3.13"
+
+# NOTE: explicitly install all dependencies into distribution
+env["PYAPP_SKIP_INSTALL"] = "true"
+env["PYAPP_DISTRIBUTION_EMBED"] = "true"
+env["PYAPP_FULL_ISOLATION"] = "true"
+env["PYAPP_DISTRIBUTION_PATH"] = str(cpython)
+env["PYAPP_DISTRIBUTION_PYTHON_PATH"] = "python/bin/python3"
 
 proc = subprocess.run(["cargo", "build", "--release"], env=env, cwd=pyapp_dir)
 if proc.returncode == 0: