Wine-GE: Match launcher naming schemes on extract (#296)

* Wine-GE: Match launcher naming schemes on extract

* Use util function to check launcher from install_dir

* Use util function for other ctmods as well

* Use str.lower for get_launcher_from_installdir

* Launcher Enum: Change enumeration

* Wine-GE, get_launcher_extract_dirname: Remove redudant "or original_name"

---------

Co-authored-by: DavidoTek <54072917+DavidoTek@users.noreply.github.com>

pupgui2/datastructures.py

@@ -207,3 +207,11 @@ def get_game_config(self):
 
         with open(game_config, 'r') as gcf:
             return json.load(gcf).get(self.app_name, {})
+
+
+class Launcher(Enum):
+    UNKNOWN = 0
+    STEAM = 1
+    LUTRIS = 2
+    BOTTLES = 3
+    HEROIC = 4

pupgui2/resources/ctmods/ctmod_00winege.py

@@ -8,7 +8,8 @@
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck, extract_tar
+from pupgui2.datastructures import Launcher
+from pupgui2.util import ghapi_rlcheck, extract_tar, get_launcher_from_installdir
 
 
 CT_NAME = 'Wine-GE'
@@ -133,12 +134,14 @@ def get_tool(self, version, install_dir, temp_dir):
         if not data or 'download' not in data:
             return False
 
-        protondir = f'{install_dir}lutris-ge-' + data['version'].replace('GE-', '').lower() + '-x86_64'
-        checksum_dir = f'{protondir}/sha512sum'
+        ge_extract_basename = f"lutris-{data['version']}-x86_64"
+        ge_extract_fullpath = os.path.join(install_dir, ge_extract_basename)
+
+        checksum_dir = os.path.join(ge_extract_fullpath, 'sha512sum')
         source_checksum = self.rs.get(data['checksum']).text if 'checksum' in data else None
         local_checksum = open(checksum_dir).read() if os.path.exists(checksum_dir) else None
 
-        if os.path.exists(protondir):
+        if os.path.exists(ge_extract_fullpath):
             if local_checksum and source_checksum:
                 if local_checksum in source_checksum:
                     return False
@@ -159,10 +162,34 @@ def get_tool(self, version, install_dir, temp_dir):
         if os.path.exists(checksum_dir):
             open(checksum_dir, 'w').write(download_checksum)
 
+        # Make sure extracted directory name matches name launcher expects (i.e. Lutris uses a custom name format)
+        ge_updated_dirname = os.path.join(install_dir, self.get_launcher_extract_dirname(ge_extract_basename, install_dir))
+        os.rename(ge_extract_fullpath, ge_updated_dirname)
+
         self.__set_download_progress_percent(100)
 
         return True
 
+    def get_launcher_extract_dirname(self, original_name: str, install_dir: str) -> str:
+
+        """
+        Return base extract directory name updated to match naming scheme expected for given launcher.
+        Example: 'lutris-GE-Proton8-17-x86_64' -> 'wine-ge-8-17-x86_64'
+
+        Return Type: str
+        """
+
+        launcher_name = ''
+        launcher = get_launcher_from_installdir(install_dir)
+        if launcher == Launcher.LUTRIS:
+            # Lutris expects this name format for self-updating, see #294 -- ex: wine-ge-8-17-x86_64
+            launcher_name = original_name.lower().replace('lutris', 'wine').replace('proton', '')
+        elif launcher == Launcher.HEROIC:
+            # This matches Heroic Wine-GE naming convention -- ex: Wine-GE-Proton8-17
+            launcher_name = original_name.replace('lutris', 'Wine').rsplit('-', 1)[0]
+
+        return launcher_name or original_name
+
     def get_info_url(self, version):
         """
         Get link with info about version (eg. GitHub release page)

pupgui2/resources/ctmods/ctmod_d8vk.py

@@ -7,7 +7,8 @@
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck, extract_zip
+from pupgui2.datastructures import Launcher
+from pupgui2.util import ghapi_rlcheck, extract_zip, get_launcher_from_installdir
 
 
 CT_NAME = 'D8VK (nightly)'
@@ -163,9 +164,10 @@ def get_extract_dir(self, install_dir: str) -> str:
         Return Type: str
         """
 
-        if 'lutris/runners' in install_dir:
+        launcher = get_launcher_from_installdir(install_dir)
+        if launcher == Launcher.LUTRIS:
             return os.path.abspath(os.path.join(install_dir, '../../runtime/dxvk'))
-        if 'heroic/tools' in install_dir:
+        if launcher == Launcher.HEROIC:
             return os.path.abspath(os.path.join(install_dir, '../dxvk'))
         else:
             return install_dir  # Default to install_dir

pupgui2/resources/ctmods/ctmod_vkd3dproton.py

@@ -7,7 +7,8 @@
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck, extract_tar, extract_tar_zst
+from pupgui2.datastructures import Launcher
+from pupgui2.util import ghapi_rlcheck, extract_tar, extract_tar_zst, get_launcher_from_installdir
 
 
 CT_NAME = 'vkd3d-proton'
@@ -144,9 +145,10 @@ def get_extract_dir(self, install_dir: str) -> str:
         Return Type: str
         """
 
-        if 'lutris/runners' in install_dir:
+        launcher = get_launcher_from_installdir(install_dir)
+        if launcher == Launcher.LUTRIS:
             return os.path.abspath(os.path.join(install_dir, '../../runtime/vkd3d'))
-        if 'heroic/tools' in install_dir:
+        if launcher == Launcher.HEROIC:
             return os.path.abspath(os.path.join(install_dir, '../vkd3d'))
         else:
             return install_dir  # Default to install_dir

pupgui2/resources/ctmods/ctmod_z0dxvk.py

@@ -7,7 +7,8 @@
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck, extract_tar
+from pupgui2.datastructures import Launcher
+from pupgui2.util import ghapi_rlcheck, extract_tar, get_launcher_from_installdir
 
 
 CT_NAME = 'DXVK'
@@ -142,9 +143,10 @@ def get_extract_dir(self, install_dir: str) -> str:
         Return Type: str
         """
 
-        if 'lutris/runners' in install_dir:
+        launcher = get_launcher_from_installdir(install_dir)
+        if launcher == Launcher.LUTRIS:
             return os.path.abspath(os.path.join(install_dir, '../../runtime/dxvk'))
-        if 'heroic/tools' in install_dir:
+        if launcher == Launcher.HEROIC:
             return os.path.abspath(os.path.join(install_dir, '../dxvk'))
         else:
             return install_dir  # Default to install_dir

pupgui2/util.py

@@ -20,7 +20,7 @@
 
 from pupgui2.constants import POSSIBLE_INSTALL_LOCATIONS, CONFIG_FILE, PALETTE_DARK, TEMP_DIR
 from pupgui2.constants import AWACY_GAME_LIST_URL, LOCAL_AWACY_GAME_LIST
-from pupgui2.datastructures import BasicCompatTool, CTType
+from pupgui2.datastructures import BasicCompatTool, CTType, Launcher
 from pupgui2.steamutil import remove_steamtinkerlaunch
 
 
@@ -654,3 +654,22 @@ def extract_tar_zst(zst_path: str, extract_path: str) -> bool:
         print(f'Could not extract archive \'{zst_path}\': {e}')
 
     return False
+
+
+def get_launcher_from_installdir(install_dir: str) -> Launcher:
+
+    """
+    Return the launcher type based on the install path given.
+    Return Type: Launcher (Enum)
+    """
+
+    if 'steam/compatibilitytools.d' in install_dir.lower():
+        return Launcher.STEAM
+    elif 'lutris/runners' in install_dir.lower():
+        return Launcher.LUTRIS
+    elif 'heroic/tools' in install_dir.lower():
+        return Launcher.HEROIC
+    elif 'bottles/runners' in install_dir.lower():
+        return Launcher.BOTTLES
+    else:
+        return Launcher.UNKNOWN