Use Helper Methods for ctmod Extraction (#250)

* Use helper functions to extract ctmod archives

* Proton-tkg: Use new extraction logic

* Luxtorpeda: Use new extraction logic + refactor

* DXVK: use new extraction logic

* Boxtron: use new extraction

* Northstar Proton: use new extraction

* Roberta: Use new extraction

* DXVK Async: Use new extraction

* GE-Proton: use new extraction

* Wine-GE: Use new extraction

* Kron4ek: Use new extraction

* Lutris-Wine: Use new extraction

* ctmod: Remove unused imports

* DXVK Nightly: Use new extraction

Also fix silly mistake with Lutris Wine

* Util: Remove extract_zst

Not used during development

Author: sonic2kk

pupgui2/resources/ctmods/ctmod_00protonge.py

@@ -3,14 +3,12 @@
 # Copyright (C) 2021 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 import hashlib
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar
 
 
 CT_NAME = 'GE-Proton'
@@ -149,20 +147,17 @@ def get_tool(self, version, install_dir, temp_dir):
             else:
                 return False
 
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        proton_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=proton_tar):
             return False
 
-        download_checksum = self.__sha512sum(destination)
+        download_checksum = self.__sha512sum(proton_tar)
         if source_checksum and (download_checksum not in source_checksum):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:gz").extractall(install_dir)
+        if not extract_tar(proton_tar, install_dir, mode='gz'):
+            return False
+
         if os.path.exists(checksum_dir):
             open(checksum_dir, 'w').write(download_checksum)
 

pupgui2/resources/ctmods/ctmod_00winege.py

@@ -3,14 +3,12 @@
 # Copyright (C) 2021 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 import hashlib
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar
 
 
 CT_NAME = 'Wine-GE'
@@ -147,20 +145,17 @@ def get_tool(self, version, install_dir, temp_dir):
             else:
                 return False
 
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        proton_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=proton_tar):
             return False
 
-        download_checksum = self.__sha512sum(destination)
+        download_checksum = self.__sha512sum(proton_tar)
         if source_checksum and (download_checksum not in source_checksum):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:xz").extractall(install_dir)
+        if not extract_tar(proton_tar, install_dir, mode='xz'):
+            return False
+
         if os.path.exists(checksum_dir):
             open(checksum_dir, 'w').write(download_checksum)
 

pupgui2/resources/ctmods/ctmod_boxtron.py

@@ -3,15 +3,12 @@
 # Copyright (C) 2021 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 from PySide6.QtWidgets import QMessageBox
 
-from pupgui2.util import ghapi_rlcheck
-from pupgui2.util import host_which
+from pupgui2.util import ghapi_rlcheck, host_which, extract_tar, write_tool_version
 
 
 CT_NAME = 'Boxtron'
@@ -135,23 +132,15 @@ def get_tool(self, version, install_dir, temp_dir):
         if not data or 'download' not in data:
             return False
 
-        protondir = f'{install_dir}boxtron'
 
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        boxtron_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=boxtron_tar):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:xz").extractall(install_dir)
-
-        if os.path.exists(protondir):
-            with open(os.path.join(protondir, 'VERSION.txt'), 'w') as f:
-                f.write(version)
-                f.write('\n')
+        boxtron_dir = os.path.join(install_dir, 'boxtron')
+        if not extract_tar(boxtron_tar, install_dir, mode='xz'):
+            return False
+        write_tool_version(boxtron_dir, version)
 
         self.__set_download_progress_percent(100)
 

pupgui2/resources/ctmods/ctmod_d8vk.py

@@ -3,13 +3,11 @@
 # Copyright (C) 2022 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
 import requests
-import zipfile
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_zip
 
 
 CT_NAME = 'D8VK (nightly)'
@@ -135,19 +133,13 @@ def get_tool(self, version, install_dir, temp_dir):
         if not data or 'download' not in data:
             return False
 
-        dxvk_dir = self.get_extract_dir(install_dir)
-        dxvk_install_dir = os.path.join(dxvk_dir, 'd8vk-git-' + data['version'])
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination, f_size=data['size']):
+        d8vk_zip = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=d8vk_zip, f_size=data['size']):
             return False
 
-        if os.path.exists(dxvk_dir + 'd8vk-git-' + data['version']):
-            shutil.rmtree(dxvk_dir + 'd8vk-git-' + data['version'])
-        with zipfile.ZipFile(destination) as zip:
-            zip.extractall(dxvk_install_dir)
+        d8vk_dir = os.path.join(self.get_extract_dir(install_dir), 'd8vk-git-' + data['version'])
+        if not extract_zip(d8vk_zip, d8vk_dir):
+            return False
 
         self.__set_download_progress_percent(100)
 

pupgui2/resources/ctmods/ctmod_kron4ekvanilla.py

@@ -4,13 +4,11 @@
 
 import os
 import subprocess
-import shutil
-import tarfile
 import requests
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar
 
 
 CT_NAME = 'Kron4ek Wine-Builds Vanilla'
@@ -122,22 +120,15 @@ def get_tool(self, version, install_dir, temp_dir):
         """
 
         data = self.__fetch_github_data(version)
-
         if not data or 'download' not in data:
             return False
 
-        protondir = f'{install_dir}wine-{data["version"].lower()}-amd64'
-
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        kron4ek_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=kron4ek_tar):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:xz").extractall(install_dir)
+        if not extract_tar(kron4ek_tar, install_dir, mode='xz'):
+            return False
 
         self.__set_download_progress_percent(100)
 

pupgui2/resources/ctmods/ctmod_lutriswine.py

@@ -3,14 +3,12 @@
 # Copyright (C) 2021 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 import hashlib
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar
 
 
 CT_NAME = 'Lutris-Wine'
@@ -164,20 +162,17 @@ def get_tool(self, version, install_dir, temp_dir):
             else:
                 return False
 
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        proton_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=proton_tar):
             return False
 
-        download_checksum = self.__sha512sum(destination)
+        download_checksum = self.__sha512sum(proton_tar)
         if source_checksum and (download_checksum not in source_checksum):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:xz").extractall(install_dir)
+        if not extract_tar(proton_tar, install_dir, mode='xz'):
+            return False
+
         if os.path.exists(checksum_dir):
             open(checksum_dir, 'w').write(download_checksum)
 

pupgui2/resources/ctmods/ctmod_luxtorpeda.py

@@ -3,13 +3,11 @@
 # Copyright (C) 2021 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 
 from PySide6.QtCore import QObject, QCoreApplication, Signal, Property
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar, write_tool_version
 
 
 CT_NAME = 'Luxtorpeda'
@@ -118,23 +116,14 @@ def get_tool(self, version, install_dir, temp_dir):
         if not data or 'download' not in data:
             return False
 
-        protondir = f'{install_dir}luxtorpeda'
-
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        luxtorpeda_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=luxtorpeda_tar):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:xz").extractall(install_dir)
-
-        if os.path.exists(protondir):
-            with open(os.path.join(protondir, 'VERSION.txt'), 'w') as f:
-                f.write(version)
-                f.write('\n')
+        luxtorpeda_dir = os.path.join(install_dir, 'luxtorpeda')
+        if not extract_tar(luxtorpeda_tar, install_dir, mode='xz'):
+            return False
+        write_tool_version(luxtorpeda_dir, version)
 
         self.__set_download_progress_percent(100)
 

pupgui2/resources/ctmods/ctmod_northstarproton.py

@@ -3,13 +3,11 @@
 # Copyright (C) 2022 DavidoTek, partially based on AUNaseef's protonup
 
 import os
-import shutil
-import tarfile
 import requests
 
 from PySide6.QtCore import QObject, Signal, Property, QCoreApplication
 
-from pupgui2.util import ghapi_rlcheck
+from pupgui2.util import ghapi_rlcheck, extract_tar
 
 
 CT_NAME = 'NorthStar Proton (TitanFall 2)'
@@ -118,18 +116,12 @@ def get_tool(self, version, install_dir, temp_dir):
         if not data or 'download' not in data:
             return False
 
-        protondir = os.path.join(install_dir, data['version'])
-
-        destination = temp_dir
-        destination += data['download'].split('/')[-1]
-        destination = destination
-
-        if not self.__download(url=data['download'], destination=destination):
+        northstar_tar = os.path.join(temp_dir, data['download'].split('/')[-1])
+        if not self.__download(url=data['download'], destination=northstar_tar):
             return False
 
-        if os.path.exists(protondir):
-            shutil.rmtree(protondir)
-        tarfile.open(destination, "r:gz").extractall(install_dir)
+        if not extract_tar(northstar_tar, install_dir, mode='gz'):
+            return False
 
         self.__set_download_progress_percent(100)