chore: update test decorator

fix: add path out of loop

README.md

@@ -17,7 +17,7 @@ DZGUI follows a specific set of guidelines, enumerated below:
 - Provide a free and open-source tool under GPL
 - Do not use undocumented, third-party servers to aggregate data; no central "DZGUI" server
 - All connections go to Steam and DayZ servers directly; the tool should function in perpetuity without intermediary endpoints
-- Target Linux desktop and Steam deck specifically; not a cross-platform tool
+- Target Linux desktop and Steam Deck specifically; not a cross-platform tool
 
 ## Setup and usage
 

dzgui/api/shortcuts.py

@@ -173,11 +173,12 @@ class Shortcuts:
         self.save_shortcuts()
 
     def save_shortcuts(self) -> None:
-        try:
-            backup = self.shortcuts_path.with_suffix(".vdf.bak")
-            shutil.copy(self.shortcuts_path, backup)
-        except Exception as e:
-            logger.critical(e)
+        if self.shortcuts_path.is_file():
+            try:
+                backup = self.shortcuts_path.with_suffix(".vdf.bak")
+                shutil.copy(self.shortcuts_path, backup)
+            except Exception as e:
+                logger.critical(e)
         try:
             with open(self.shortcuts_path, "wb") as f:
                 vdf.binary_dump(self.shortcuts, f)

dzgui/api/steam.py

@@ -12,8 +12,9 @@ from typing import Any, Generator, Union
 from warnings import deprecated
 
 from dzgui.api.acf import ACF
+from dzgui.const.endpoints import VALIDATE
 from dzgui.init.prereqs import has_any_client
-from dzgui.init.proc import has_cmd
+from dzgui.init.prereqs import has_flatpak_client, has_steam_client
 from dzgui.const.constants import (
     APPID_DAYZ,
     APPID_DAYZ_EXP,
@@ -23,11 +24,9 @@ from dzgui.const.constants import (
     DEBIAN_STEAM_PATH,
     DEFAULT_STEAM_PATH,
     DOWNLOADS_PATH,
-    FLATPAK_CMD,
     FLATPAK_STEAM_PATH,
     LIBRARYFOLDERS_PATH,
     REQUEST_TIMEOUT,
-    STEAM_CMD,
     UBUNTU_STEAM_PATH,
     VDF_PATH,
 )
@@ -85,9 +84,9 @@ def get_steam_paths() -> list[tuple[Path, str]]:
         }
 
         for path in DEFAULT_PATH, FLATPAK_PATH, UBUNTU_PATH, DEBIAN_PATH:
-            if path is FLATPAK_PATH and has_cmd(FLATPAK_CMD) is False:
+            if path is FLATPAK_PATH and has_flatpak_client() is False:
                 continue
-            if path is not FLATPAK_PATH and has_cmd(STEAM_CMD) is False:
+            if path is not FLATPAK_PATH and has_steam_client() is False:
                 continue
             if path.joinpath(VDF_PATH).is_file():
                 paths.append((path, human[path]))
@@ -318,10 +317,9 @@ def unsubscribe(key: str, mod: int) -> None:
     update_workshop(key, mod, UNSUB_ENDPOINT)
 
 
-@deprecated("Use subscribe()")
-def enqueue_mod(client: str, mod: str, appid: int) -> None:
+def validate_mod(client: str, mod: str) -> None:
     client_args = concat_bash_args(client)
-    subprocess.Popen([*client_args, "+workshop_download_item", str(appid), mod])
+    subprocess.Popen([*client_args, "+workshop_download_item", str(APPID_DAYZ), mod])
 
 
 @deprecated("Cf. https://github.com/ValveSoftware/steam-for-linux/issues/9672")
@@ -502,3 +500,10 @@ def get_app_name(appid: int) -> str | None:
     except Exception as e:
         logger.debug(e)
         return None
+
+
+@deprecated("Currently unused")
+def validate_dayz(client: str) -> None:
+    client_args = concat_bash_args(client)
+    uri = VALIDATE + str(APPID_DAYZ)
+    subprocess.Popen([*client_args, uri])

dzgui/app_init.py

@@ -7,7 +7,12 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 
-from dzgui.const.constants import APP_NAME, APP_NAME_LOWER,  FLATPAK_ROOT_PATH, ICONS_PATH
+from dzgui.const.constants import (
+    APP_NAME,
+    APP_NAME_LOWER,
+    FLATPAK_ROOT_PATH,
+    ICONS_PATH,
+)
 from dzgui.const.enum import Preferences
 from dzgui.config.query import lookup
 from dzgui.config.userprefs import UserPrefs
@@ -103,7 +108,8 @@ def load_steam_icon() -> None:
     import gi
 
     gi.require_version("Gtk", "3.0")
-    from gi.repository import Gtk # noqa
+    from gi.repository import Gtk  # noqa
+
     try:
         traversable = resources.files(APP_NAME_LOWER).joinpath(ICONS_PATH)
         icons = Path(str(traversable))

dzgui/const/constants.py

@@ -96,6 +96,7 @@ LOG_FILTERS = ("CRITICAL", "WARNING", "INFO", "DEBUG")
 TMP_PATH = "/tmp"
 TMP_TARBALL = "/tmp/dzgui.tar.gz"
 TMP_EXE = "/tmp/dzgui/dzgui"
+LOCK_FILE = "/tmp/dzgui.flock"
 
 DAYZ_COMMUNITY_ROOT = "Missions"
 

dzgui/const/endpoints.py

@@ -18,6 +18,7 @@ COORDS_API = "http://ip-api.com/json"
 # steam URIs
 WORKSHOP = "steam://url/CommunityFilePage/"
 OPEN_URL = "steam://openurl/"
+VALIDATE = "steam://validate/"
 
 # user facing
 GITHUB_PAGES = "https://aclist.github.io/dzgui/index"

dzgui/const/enum.py

@@ -157,6 +157,7 @@ class ContextMenu(EnumWithAttrs):
     COPY_SERVER_IP = {"label": strings.copy_ip}
     COPY_SERVER_NAME = {"label": strings.copy_name}
     UNSUB_MOD = {"label": strings.unsub_mod}
+    VALIDATE_MOD = {"label": strings.validate_mod}
     OPEN_WORKSHOP = {"label": strings.open_workshop}
     REFRESH_PLAYERS = {"label": strings.refresh_players}
     REMOVE_HISTORY = {"label": strings.remove_history}
@@ -172,7 +173,7 @@ class ContextMenuGroup(Enum):
     """
 
     SERVER_MOD = (ContextMenu.OPEN_WORKSHOP,)
-    MOD = (ContextMenu.OPEN_WORKSHOP, ContextMenu.UNSUB_MOD)
+    MOD = (ContextMenu.OPEN_WORKSHOP, ContextMenu.UNSUB_MOD, ContextMenu.VALIDATE_MOD)
     MOD_OFFLINE = (None,)
     LOG = (ContextMenu.COPY_LOG_CLIPBOARD,)
     SERVER_BROWSER = (
@@ -246,6 +247,10 @@ class ModButton(EnumWithAttrs):
         "label": strings.mod_panel.select_stale,
         "tooltip": strings.mod_panel.select_stale_tooltip,
     }
+    VALIDATE = {
+        "label": strings.mod_panel.validate,
+        "tooltip": strings.mod_panel.validate_tooltip,
+    }
 
 
 class ButtonType(EnumWithAttrs):

dzgui/controllers/emitter.py

@@ -111,6 +111,10 @@ class Emitter(GObject.GObject):
     def check_toggled(self, label: str, state: bool) -> None:
         pass
 
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def servers_timed_out(self) -> None:
+        pass
+
     @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(object,))
     def servers_loaded(self, tag: "ServerTab") -> None:
         pass

dzgui/controllers/mc.py

@@ -102,6 +102,16 @@ class Controller(GObject.GObject):
         except AttributeError:
             logger.critical(f"{attr} is not a valid AppNavigation attribute.")
 
+    def validate_mods(
+        self, treeview: Union["ModTreeView", "OfflineModTreeView", None] = None
+    ) -> None:
+        if treeview is None:
+            view = self.mediator.modtreeview
+        else:
+            view = treeview
+        mod_man = view.get_mod_man()
+        mod_man.validate_mods()
+
     def get_prefs(self) -> UserPrefs:
         return self.prefs
 

dzgui/init/flock.py

@@ -5,8 +5,9 @@ import sys
 from pathlib import Path
 from typing import TextIO
 
-from dzgui.views.dialogs.early_alert import EarlyAlertDialog
+from dzgui.const.constants import LOCK_FILE
 from dzgui.util.strings import cannot_acquire_lock
+from dzgui.views.dialogs.early_alert import EarlyAlertDialog
 
 
 def lock_release(lock: TextIO) -> None:
@@ -15,7 +16,7 @@ def lock_release(lock: TextIO) -> None:
 
 
 def lock_acquire() -> TextIO:
-    lockfile = Path("/tmp/dzgui.flock")
+    lockfile = Path(LOCK_FILE)
     lock = open(lockfile, "w")
     try:
         fcntl.flock(lock, fcntl.LOCK_EX | fcntl.LOCK_NB)

dzgui/init/prereqs.py

@@ -3,11 +3,14 @@ import shutil
 import subprocess
 
 from dzgui.const.constants import APP_NAME, FLATPAK_APPID, FLATPAK_CMD, STEAM_CMD
+from dzgui.init.proc import is_sandboxed
 
 logger = logging.getLogger(APP_NAME)
 
 
 def has_flatpak_client() -> bool:
+    if is_sandboxed():
+        return True
     try:
         res = subprocess.run(
             [FLATPAK_CMD, "list", "--columns=application"],

dzgui/managers/contextmenu.py

@@ -75,10 +75,14 @@ class ContextMenuManager:
 
         if isinstance(self.treeview, (ModTreeView, OfflineModTreeView)):
             match action:
-                case ContextMenu.UNSUB_MOD:
-                    self.controller.unsub_mods(self.treeview)
                 case ContextMenu.OPEN_WORKSHOP:
                     self.open_mod_page()
+                case ContextMenu.UNSUB_MOD:
+                    self.controller.unsub_mods(self.treeview)
+                case ContextMenu.VALIDATE_MOD:
+                    self.controller.validate_mods(self.treeview)
+                case _:
+                    pass
 
         if isinstance(self.treeview, LogTreeView):
             match action:

dzgui/managers/mods.py

@@ -4,7 +4,7 @@ import time
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from dzgui.api.steam import unsubscribe
+from dzgui.api.steam import unsubscribe, validate_mod
 from dzgui.api.mods import (
     get_delimited_mods,
     find_stale_mods,
@@ -85,7 +85,7 @@ class ModManager:
         total_mods = len(self.store)
         self.emitter.emit("mods_updated", msg, total_mods)
 
-    def unsub_mods(self) -> None:
+    def get_selected_mods(self) -> list[tuple[str, Gtk.TreeIter]]:
         sel = self.treeview.get_selection()
         model, pathlist = sel.get_selected_rows()
         # NOTE: reverse when multiple selection
@@ -96,6 +96,15 @@ class ModManager:
                 continue
             mod, _iter = res
             mods.append((mod, _iter))
+        return mods
+
+    def validate_mods(self) -> None:
+        mods = self.get_selected_mods()
+        self.thread_man.set_job_count(len(mods))
+        self.validate_all_mods(mods)
+
+    def unsub_mods(self) -> None:
+        mods = self.get_selected_mods()
         self.thread_man.set_job_count(len(mods))
         self.unsub_all_mods(mods)
 
@@ -109,6 +118,21 @@ class ModManager:
         mod = model.get_value(tree_iter, 2)
         return mod, tree_iter
 
+    def validate_atomic_mod(self, mod: str) -> None:
+        # NOTE: propagation to dayz exp will happen during
+        # subsequent symlink phase on connect
+        client = self.controller.query_config(Preferences.CLIENT)
+        validate_mod(client, mod)
+
+    @call_on_thread(dialogs.validating_mods)
+    def validate_all_mods(self, mods: list[tuple[str, Gtk.TreeIter]]) -> None:
+        for mod, _iter in mods:
+            self.validate_atomic_mod(mod)
+            self.thread_man.increment_dialog()
+            time.sleep(API_RATE_LIMIT)
+        func = StoredFunc(lambda: None)
+        self.thread_man.set_cleanup_func(func)
+
     @call_on_thread(dialogs.deleting_mods)
     def unsub_all_mods(self, mods: list[tuple[str, Gtk.TreeIter]]) -> None:
         for mod, _iter in mods:

dzgui/model/servers.py

@@ -92,6 +92,7 @@ class ServerModelManager:
         job = Servers.query_api
         params = Servers.params
         servers = []
+
         with ThreadPoolExecutor() as executor:
             futures = [executor.submit(job, key, APPID_DAYZ, param) for param in params]
             for future in as_completed(futures):
@@ -414,6 +415,8 @@ class ServerModelManager:
         # TODO: disable map, keyword, and filter widgets if model is None
         # signal driven (servers_empty, servers_failed_to_load)
 
+        self.emitter.emit("servers_timed_out")
+
         if self.preserve_on_fail is False:
             self.tv.set_model(None)
             filter_man = self.tv.get_filter_man()

dzgui/strings/dialogs.py

@@ -9,6 +9,7 @@ update_success = "Updated successfully. Please exit and relaunch."
 load_error_lan = "Failed to find any servers on your network.\nCheck the server query port or your firewall settings."
 fetching_mods = "Fetching mod metadata"
 deleting_mods = "Unsubscribing mods"
+validating_mods = "Validating mods"
 scanning_mods = "Scanning mods"
 parsing_mods = "Parsing mods"
 

dzgui/util/flatpak.py

@@ -1,7 +1,7 @@
 import logging
 import subprocess
 
-from dzgui.const.constants import APP_NAME, FLATPAK_APPID, GTK_APP_ID
+from dzgui.const.constants import APP_NAME, FLATPAK_APPID, GTK_APP_ID, TMP_PATH
 
 logger = logging.getLogger(APP_NAME)
 
@@ -18,7 +18,11 @@ def apply_overrides(xdg: dict[str, str]) -> None:
         ]
         subprocess.run([*args], capture_output=True)
 
-        for path in xdg.values():
+        paths: list[str] = []
+        paths.extend([*xdg.values()])
+        paths.append(TMP_PATH)
+
+        for path in paths:
             args = [
                 "flatpak",
                 "--user",

dzgui/util/strings.py

@@ -31,6 +31,7 @@ show_details = "Show server details"
 refresh_players = "Refresh player count"
 open_workshop = "Open in Steam Workshop"
 unsub_mod = "Unsubscribe mod"
+validate_mod = "Validate mod"
 copy_name = "Copy name to clipboard"
 copy_ip = "Copy IP to clipboard"
 copy_log = "Copy record(s) to clipboard"
@@ -200,6 +201,8 @@ class ModPanelStrings:
     clear_highlights: str
     select_stale: str
     select_stale_tooltip: str
+    validate: str
+    validate_tooltip: str
 
 
 @dataclass(slots=True, frozen=True)
@@ -319,6 +322,8 @@ mod_panel = ModPanelStrings(
     clear_highlights="Clears highlights and reverts the table to a default state",
     select_stale="Select stale",
     select_stale_tooltip="Only selects highlighted stale mods",
+    validate="Validate selected",
+    validate_tooltip="Validates selected mods and updates them if necessary",
 )
 
 

dzgui/views/components/buttons.py

@@ -163,18 +163,24 @@ class RefreshButton(IconTextButton):
         self.set_tooltip_text(atomic_buttons.refresh_tooltip)
 
         self.connect("clicked", self._on_refresh_clicked)
-        emitter.connect("servers_loaded", self.start_decrement)
+        emitter.connect("servers_loaded", self._on_load)
+        emitter.connect("servers_timed_out", self._on_timeout)
+
+    def _on_timeout(self, emitter: "Emitter") -> None:
+        self.is_clicked = True
+        self.start_decrement()
+
+    def _on_load(self, emitter: "Emitter", tab: "ServerTab") -> None:
+        self.start_decrement()
 
     def _on_refresh_clicked(self, button: Self) -> None:
         """Spawned in a thread"""
-        if self.controller.get_active_treeview().is_loaded() is False:
-            return
         self.is_clicked = True
         self.controller.refresh_tree()
         # TODO: get server tab enum
         # if LAN tab, reload existing entries in place
 
-    def start_decrement(self, emitter: "Emitter", tab: "ServerTab") -> None:
+    def start_decrement(self) -> None:
         if self.is_clicked is False:
             return
         if self.loading:

dzgui/views/components/mod_panel.py

@@ -50,6 +50,7 @@ class ModSelectionPanel(Gtk.Box):
             ModButton.SELECT_ALL,
             ModButton.UNSELECT_ALL,
             ModButton.UNSUB_SELECTED,
+            ModButton.VALIDATE,
         )
         for button in buttons:
             b = EnumeratedModButton(button)
@@ -114,3 +115,5 @@ class ModSelectionPanel(Gtk.Box):
                 self.swap_sensitive(False)
             case ModButton.SELECT_STALE:
                 self.controller.select_colorized()
+            case ModButton.VALIDATE:
+                self.controller.validate_mods()

dzgui/views/dialogs/wizard.py

@@ -14,6 +14,7 @@ from dzgui.const.constants import (
     HERO_PATH,
     FLATPAK_ROOT_PATH,
     LEGACY_CONFIG_PATH,
+    TMP_PATH
 )
 from dzgui.const.boilerplate import config_boilerplate
 from dzgui.const.endpoints import STEAM_API_SETUP
@@ -432,6 +433,8 @@ class FlatpakOverridePage(EnumeratedWizardPage):
         store = Gtk.ListStore(str)
         for path in xdg_paths.values():
             store.append((str(path),))
+        store.append((TMP_PATH,))
+
         tree = SimpleTree(store, wizard.tree_column)
         tree.set_halign(Gtk.Align.CENTER)
 

pyproject.toml

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

tests/test_config.py

@@ -36,7 +36,6 @@ 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)