feat: detect opengl version (#389)

* feat: detect opengl version

* feat: add glxinfo package

Author: thw26

ou_dedetai/installer.py

@@ -6,14 +6,15 @@
 from pathlib import Path
 from typing import Optional
 
-from ou_dedetai import system
 from ou_dedetai.app import App, UserExitedFromAsk
 
 from . import constants
 from . import network
+from . import system
 from . import utils
 from . import wine
 
+from ou_dedetai.system import OpenGLIncompatible
 
 # This step doesn't do anything per-say, but "collects" all the choices in one step
 # The app would continue to work without this function
@@ -78,10 +79,6 @@ def check_for_known_bugs(app: App):
     """Checks for any known bug conditions and recommends user action.
     This is a best-effort check
     """
-    app.installer_step_count += 1
-    ensure_sys_deps(app=app)
-    app.installer_step += 1
-
     # Begin workaround #435
     # FIXME: #435 Remove this check when the issue is fixed upstream in wine    
     # Check to see if our default browser is chromium, google-chrome, brave, or vivaldi 
@@ -163,20 +160,46 @@ def check_for_known_bugs(app: App):
 
     # End workaround #435
 
+def check_opengl(app: App):
+    app.status("Checking available OpenGL version…")
+    try:
+        opengl_version, reason = system.check_opengl_version(app)
+        app.status(reason)
+    except OpenGLIncompatible:
+        app.status(f"Incompatible OpenGL version.")
+        question = "Incompatible OpenGL version. Logos will be unable to launch. Should the install continue anyways?"
+        if app.approve(question):
+            logging.debug("> User continuing with incompatible OpenGL.")
+        else:
+            app.status("Exiting install…")
+            sys.exit()  # Exits the install thread.
 
-def ensure_appimage_download(app: App):
-    app.installer_step_count += 1
+    logging.debug("> Done.")
+
+
+def check_system_compatibility(app: App):
     try:
         check_for_known_bugs(app=app)
     except Exception:
         logging.exception("Failed to check for known bugs - assuming everything is fine and continuing install.")
-    app.installer_step += 1
     if (
-        app.conf.faithlife_product_version != '9' 
+        app.conf.faithlife_product_version != '9'
         and not str(app.conf.wine_binary).lower().endswith('appimage')
         and app.conf.wine_binary not in [constants.WINE_BETA_SIGIL, constants.WINE_RECOMMENDED_SIGIL]
     ):
         return
+
+    check_opengl(app=app)
+
+
+def ensure_appimage_download(app: App):
+    app.installer_step_count += 1
+    ensure_sys_deps(app=app)
+    check_system_compatibility(app=app)
+    app.installer_step += 1
+
+    if app.conf.faithlife_product_version != '9' and not str(app.conf.wine_binary).lower().endswith('appimage'):
+        return
     app.status("Ensuring wine AppImage is downloaded…")
 
     downloaded_file = None
@@ -401,6 +424,7 @@ def ensure_launcher_shortcuts(app: App):
             f"Runmode is '{constants.RUNMODE}'. Won't create desktop shortcuts",
         )
 
+
 def install(app: App):
     """Entrypoint for installing"""
     app.status('Installing…')

ou_dedetai/main.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-from ou_dedetai.repair import detect_and_recover
+from .repair import detect_and_recover
 
 from . import cli
 from . import constants

ou_dedetai/system.py

@@ -1,8 +1,5 @@
-from dataclasses import dataclass
-from pathlib import Path
-from typing import Optional, Tuple
-from collections.abc import MutableMapping
-import zipfile
+import re
+
 import distro
 import logging
 import os
@@ -13,12 +10,19 @@
 import subprocess
 import sys
 import time
+import zipfile
 
-from ou_dedetai import constants, network
+from collections.abc import MutableMapping
+from dataclasses import dataclass
+from packaging.version import Version
+from pathlib import Path
+from typing import Optional, Tuple
+
+from ou_dedetai import constants, network, wine
 from ou_dedetai.app import App
 
 
-def fix_ld_library_path(env: Optional[MutableMapping[str, str]]) -> dict[str, str]: 
+def fix_ld_library_path(env: Optional[MutableMapping[str, str]]) -> dict[str, str]:
     """Removes pyinstaller bundled dynamic linked libraries when executing commands
 
     - https://pyinstaller.org/en/latest/common-issues-and-pitfalls.html#launching-external-programs-from-the-frozen-application
@@ -366,6 +370,34 @@ class SuperuserCommandNotFound(Exception):
     """Superuser command not found. Install pkexec or sudo or doas"""
 
 
+class OpenGLIncompatible(Exception):
+    """OpenGL version is incompatible."""
+
+
+def check_opengl_version(app: App, required_version="3.2") -> tuple[bool, str]:
+    try:
+        env = wine.get_wine_env(app, None)
+        result = run_command(['glxinfo'], env=fix_ld_library_path(env), capture_output=True, text=True, check=True)
+    except FileNotFoundError:
+        return False, "glxinfo command not found. Please install mesa-utils or equivalent."
+    except subprocess.CalledProcessError as e:
+        return False, f"glxinfo command failed: {e.stderr.strip()}"
+
+    match = re.search(r"OpenGL version string:\s+([\d\.]+)", result.stdout)
+    if not match:
+        return False, "Failed to parse OpenGL version from glxinfo output."
+
+    opengl_version = match.group(1)
+    if Version(opengl_version) >= Version(required_version):
+        message = f"OpenGL Version: {opengl_version} is supported (>= {required_version})."
+        logging.info(message)
+        return True, message
+    else:
+        message = f"OpenGL Version: {opengl_version} is not supported (must be >= {required_version})."
+        logging.info(message)
+        raise OpenGLIncompatible()
+
+
 def get_superuser_command() -> str:
     if shutil.which('pkexec'):
         return "pkexec"
@@ -420,6 +452,7 @@ def get_package_manager() -> PackageManager | None:
             "binutils wget winbind "  # wine
             "p7zip-full cabextract " # winetricks
             "xdg-utils " # For xdg-mime needed for custom url scheme registration
+            "mesa-utils"  # verify opengl version
         )
 
         # Now set the appimage packages, this has changed over time
@@ -470,6 +503,7 @@ def get_package_manager() -> PackageManager | None:
             "mod_auth_ntlm_winbind samba-winbind samba-winbind-clients "  # wine
             "cabextract " # winetricks
             "xdg-utils " # For xdg-mime needed for custom url scheme registration
+            "glx-utils"  # verify opengl version
         )
         incompatible_packages = ""  # appimagelauncher handled separately
     elif shutil.which('zypper') is not None:  # OpenSUSE
@@ -485,6 +519,7 @@ def get_package_manager() -> PackageManager | None:
             "curl gawk grep "  # other
             "7zip cabextract "  # winetricks
             "xdg-utils " # For xdg-mime needed for custom url scheme registration
+            "Mesa-demo-x"  # verify opengl version
         )
         incompatible_packages = ""  # appimagelauncher handled separately
     elif shutil.which('apk') is not None:  # alpine
@@ -496,11 +531,12 @@ def get_package_manager() -> PackageManager | None:
         packages = (
             "bash bash-completion "  # bash support
             "gcompat "  # musl to glibc
-            #"fuse-common fuse fuse3 "  # appimages
+            #"fuse-common fuse fuse3 "  # appimages; incompatible with muslc
             "wget curl "  # network
             "7zip cabextract " # winetricks
             "samba sed grep gawk bash bash-completion "  # other
             "xdg-utils " # For xdg-mime needed for custom url scheme registration
+            "mesa-demos"  # verify opengl version
         )
         incompatible_packages = ""  # appimagelauncher handled separately
     elif shutil.which('pamac') is not None:  # manjaro
@@ -515,6 +551,7 @@ def get_package_manager() -> PackageManager | None:
             "curl gawk grep "  # other
             "7zip cabextract "  # winetricks (7zip used to be called p7zip)
             "xdg-utils " # For xdg-mime needed for custom url scheme registration
+            "mesa-utils"  # verify opengl version
         )
         incompatible_packages = ""  # appimagelauncher handled separately
     elif shutil.which('pacman') is not None:  # arch, steamOS
@@ -536,6 +573,7 @@ def get_package_manager() -> PackageManager | None:
                 "lib32-ncurses ocl-icd lib32-ocl-icd libxslt lib32-libxslt libva lib32-libva gtk3 lib32-gtk3 "
                 "gst-plugins-base-libs lib32-gst-plugins-base-libs vulkan-icd-loader lib32-vulkan-icd-loader "
                 "xdg-utils " # For xdg-mime needed for custom url scheme registration
+                "mesa-utils"  # verify opengl version
             )
         else:  # arch
             packages = (
@@ -548,6 +586,7 @@ def get_package_manager() -> PackageManager | None:
                 "libva mpg123 v4l-utils "  # video
                 "libxslt sqlite "  # misc
                 "xdg-utils " # For xdg-mime needed for custom url scheme registration
+                "mesa-utils"  # verify opengl version
             )
         incompatible_packages = ""  # appimagelauncher handled separately
     elif os_name == "org.freedesktop.platform":

ou_dedetai/tui_app.py

@@ -772,6 +772,12 @@ def utilities_menu_select(self, choice):
                 self.reset_screen()
                 self.logos.switch_logging()
                 self.go_to_main_menu()
+            elif choice == "Check OpenGL":
+                self.reset_screen()
+                opengl_version, reason = system.check_opengl_version(self)
+                logging.info(reason)
+                self.status(reason)
+                self.go_to_main_menu()
             elif choice == "Uninstall":
                 control.uninstall(self)
                 self.go_to_main_menu()
@@ -1089,6 +1095,7 @@ def set_utilities_menu_options(self):
         )
         labels.append(label)
 
+        labels.append("Check OpenGL")
         labels.append("Return to Main Menu")
 
         options = self.which_dialog_options(labels)