moving the deployment functions into a class to avoid juggling dirs as arguments

gui/deploy.py

@@ -17,26 +17,6 @@ from distutils.dir_util import copy_tree
 from pathlib import Path
 from widgets import create_logger
 
-def find_install_dir():
-    library_folders = Path("C:\Program Files (x86)\Steam\steamapps\libraryfolders.vdf")
-    game_id = "602960"
-    data = vdf.load(open(library_folders))
-    install_path = ""
-    for (id, folder) in data["libraryfolders"].items():
-        if game_id in folder["apps"]:
-            install_path = Path(folder["path"]) / Path("steamapps\common\Barotrauma")
-
-    return install_path.as_posix()
-
-
-def download_via_requests(url_source, file_name):
-
-    response = requests.get(url_source, stream=True, verify=certifi.where())
-
-    with open(file_name, 'wb') as out_file:
-        shutil.copyfileobj(response.raw, out_file)
-    del response
-
 
 def rmfulldir(dirpath):
     try:
@@ -45,48 +25,12 @@ def rmfulldir(dirpath):
         pass
 
 
-def update(utils_dir: str):
+def download_via_requests(url_source, file_name):
-    logging.info(f"checking for updates via git pull.")
+    response = requests.get(url_source, stream=True, verify=certifi.where())
-    pull = [f"{utils_dir}/git/bin/git.exe", "pull"]
-    subprocess.call(pull)
 
-
+    with open(file_name, 'wb') as out_file:
-def download_and_extract(url_source, out_archive, utils_dir="./utils", subdir=""):
+        shutil.copyfileobj(response.raw, out_file)
-    logger = create_logger()
+    del response
-    logger.info(f"Downloading {url_source}, this may take a while.")
-
-    download_via_requests(url_source, out_archive)
-    time.sleep(0.7)
-    logger.info("Download complete.")
-
-    logger.info(f"Extracting {out_archive}")
-    extract = [f"{utils_dir}/7z/7za.exe", "x", out_archive, "-o" f"{utils_dir}{subdir}"]
-    subprocess.call(extract)
-
-    time.sleep(0.7)
-    logger.info("Removing " + out_archive)
-    os.remove(out_archive)
-
-
-def download_ffmpeg(utils_dir: str, clean=False):
-
-    if clean:
-        rmfulldir(f"{utils_dir}/ffmpeg-" + get_ffmpeg_version() + "-full_build")
-
-    url_ffmpeg_source = "https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full.7z"
-    out_ffmpeg_archive = f"{utils_dir}/ffmpeg-release-full.7z.exe"
-
-    download_and_extract(url_ffmpeg_source, out_ffmpeg_archive, utils_dir)
-
-def download_git(utils_dir: str, clean=False):
-    if clean:
-        rmfulldir(f"{utils_dir}/git")
-
-    url_git_source = ("https://github.com/git-for-windows/git/releases/download/"
-                      "v2.46.2.windows.1/PortableGit-2.46.2-64-bit.7z.exe")
-    out_git_archive = f"{utils_dir}/PortableGit-2.46.2-64-bit.7z.exe"
-
-    download_and_extract(url_git_source, out_git_archive, utils_dir, subdir="/git")
 
 
 def get_ffmpeg_version():
@@ -99,15 +43,79 @@ def get_ffmpeg_version():
     return ffmpeg_version
 
 
-def fetch_and_cut_song(utils_dir: str, build_dir: str, tape, ffmpeg_version):
+class Deployer:
-    python_executable = f"{utils_dir}/python-3.9.7-embed-amd64/python.exe"
+    def __init__(self):
+        logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+        self.logger = logging.getLogger()
+
+        self.utils_dir = "./utils"
+        self.build_dir = "./build"
+        self.music_dir = "./build/music"
+        self.source_dir = "./source"
+        self.install_dir = self.find_install_dir()
+
+    def find_install_dir(self):
+        self.logger.info("Trying to find Barotraumma install folder")
+        library_folders = Path("C:\Program Files (x86)\Steam\steamapps\libraryfolders.vdf")
+        game_id = "602960"
+        data = vdf.load(open(library_folders))
+        install_path = ""
+        for (id, folder) in data["libraryfolders"].items():
+            if game_id in folder["apps"]:
+                install_path = Path(folder["path"]) / Path("steamapps\common\Barotrauma")
+
+        self.logger.info(f"Barotrauma is installed in {install_path.as_posix()}")
+
+        return install_path.as_posix()
+
+    def download_ffmpeg(self, clean=False):
+        if clean:
+            rmfulldir(f"{self.utils_dir}/ffmpeg-" + get_ffmpeg_version() + "-full_build")
+
+        url_ffmpeg_source = "https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full.7z"
+        out_ffmpeg_archive = f"{self.utils_dir}/ffmpeg-release-full.7z.exe"
+
+        self.download_and_extract(url_ffmpeg_source, out_ffmpeg_archive)
+
+    def download_git(self, clean=False):
+        if clean:
+            rmfulldir(f"{self.utils_dir}/git")
+
+        url_git_source = ("https://github.com/git-for-windows/git/releases/download/"
+                          "v2.46.2.windows.1/PortableGit-2.46.2-64-bit.7z.exe")
+        out_git_archive = f"{self.utils_dir}/PortableGit-2.46.2-64-bit.7z.exe"
+
+        self.download_and_extract(url_git_source, out_git_archive, subdir="/git")
+
+    def download_and_extract(self, url_source, out_archive, subdir=""):
+        self.logger.info(f"Downloading {url_source}, this may take a while.")
+
+        download_via_requests(url_source, out_archive)
+        time.sleep(0.7)
+        self.logger.info("Download complete.")
+
+        self.logger.info(f"Extracting {out_archive}")
+        extract = [f"{self.utils_dir}/7z/7za.exe", "x", out_archive, "-o" f"{self.utils_dir}{subdir}"]
+        subprocess.call(extract)
+
+        time.sleep(0.7)
+        self.logger.info("Removing " + out_archive)
+        os.remove(out_archive)
+
+    def update(self):
+        self.logger.info(f"checking for updates via git pull.")
+        pull = [f"{self.utils_dir}/git/bin/git.exe", "pull"]
+        subprocess.call(pull)
+
+    def fetch_and_cut_song(self, tape, ffmpeg_version):
+        python_executable = f"{self.utils_dir}/python-3.9.7-embed-amd64/python.exe"
         script = "./fetch_song.py"
 
         if type(tape["source"]) == str:
-        shutil.copy(tape["source"], f"{build_dir}/music/{tape['identifier']}.ogg")
+            shutil.copy(tape["source"], f"{self.music_dir}/{tape['identifier']}.ogg")
         else:
             fetch = [python_executable, script, tape["source"]["url"], "-x", "--audio-format", "vorbis",
-                 "--audio-quality", "0", "-o", f"{build_dir}/tmp_music/{tape['identifier']}.ogg"]
+                     "--audio-quality", "0", "-o", f"{self.build_dir}/tmp_music/{tape['identifier']}.ogg"]
 
             # this is done in a separate python script because subprocess.call makes sure that the
             # download process is finished before trying to cut the song
@@ -116,11 +124,11 @@ def fetch_and_cut_song(utils_dir: str, build_dir: str, tape, ffmpeg_version):
 
             time.sleep(0.1)
 
-        cut = [f"{utils_dir}/ffmpeg-" + ffmpeg_version + "-full_build/bin/ffmpeg.exe",
+            cut = [f"{self.utils_dir}/ffmpeg-" + ffmpeg_version + "-full_build/bin/ffmpeg.exe",
                    "-y", "-ss", f"{tape['source']['start']}",
-               "-i", f"{build_dir}/tmp_music/{tape['identifier']}.ogg", "-acodec", "libvorbis",
+                   "-i", f"{self.build_dir}/tmp_music/{tape['identifier']}.ogg", "-acodec", "libvorbis",
                    "-ac", "1", "-af", f"volume={tape['source']['volume']}dB",
-               f"{build_dir}/music/{tape['identifier']}.ogg"]
+                   f"{self.music_dir}/{tape['identifier']}.ogg"]
 
             if tape["source"]["end"] != -1:
                 cut = cut[:-7] + ["-to", f"{tape['source']['end']}"] + cut[-7:]
@@ -132,22 +140,21 @@ def fetch_and_cut_song(utils_dir: str, build_dir: str, tape, ffmpeg_version):
                       "or download the latest release version manually.")
                 sys.exit()
 
-    walkman = [f"{utils_dir}/ffmpeg-" + ffmpeg_version + "-full_build/bin/ffmpeg.exe",
+        walkman = [f"{self.utils_dir}/ffmpeg-" + ffmpeg_version + "-full_build/bin/ffmpeg.exe",
-               "-i", f"{build_dir}/music/{tape['identifier']}.ogg",
+                   "-i", f"{self.music_dir}/{tape['identifier']}.ogg",
                    "-af", f"highpass=f=300,lowpass=f=12000",
-               f"{build_dir}/music/{tape['identifier']}-walkman.ogg"]
+                   f"{self.music_dir}/{tape['identifier']}-walkman.ogg"]
 
         try:
             subprocess.call(walkman)
         except FileNotFoundError:
-        print("ffmpeg not in utils directory. Run python install_dependencies.py "
+            self.logger.error("ffmpeg not in utils directory. Run python install_dependencies.py "
                               "or download the latest release version manually.")
             sys.exit()
 
 
-def assemble_png_images(tapes, outfile: str, resize=None):
+    def assemble_png_images(self, tapes, outfile: str, resize=None):
-
+        img_names = [f"{self.source_dir}/images/{tape['identifier']}.png" for tape in tapes]
-    img_names = [f"./source/images/{tape['identifier']}.png" for tape in tapes]
 
         images = [Image.open(x) for x in img_names]
 
@@ -175,47 +182,48 @@ def assemble_png_images(tapes, outfile: str, resize=None):
             y_offset = max(heights) * math.floor(i / columns)
             new_im.paste(im, (x_offset, y_offset))
 
-    new_im.save(f"./build/{outfile}.png")
+        new_im.save(f"{self.build_dir}/{outfile}.png")
 
 
-def prepare_music(data, music_dir: str, build_dir: str):
+    def prepare_music(self, data):
         try:
-        os.mkdir(f'{music_dir}')
+            os.mkdir(f'{self.music_dir}')
         except FileExistsError:
             pass
 
         ffmpeg_version = get_ffmpeg_version()
 
-    logging.info("downloading and cutting the songs")
+        self.logger.info("downloading and cutting the songs")
         for i, tape in enumerate(data):
-        if not (os.path.exists(f"./build/music/{tape['identifier']}.ogg") or os.path.exists(f"./build/music/{tape['identifier']}-walkman.ogg")):
+            if not (os.path.exists(f"{self.music_dir}/{tape['identifier']}.ogg") or os.path.exists(
-            logging.info(f"{i + 1}/{len(data)} Downloading: {tape['name']}")
+                    f"{self.music_dir}/{tape['identifier']}-walkman.ogg")):
-            fetch_and_cut_song(tape, ffmpeg_version)
+                self.logger.info(f"{i + 1}/{len(data)} Downloading: {tape['name']}")
+                self.fetch_and_cut_song(tape, ffmpeg_version)
             else:
-            logging.info(f"{i + 1}/{len(data)} Already exists: {tape['name']}")
+                self.logger.info(f"{i + 1}/{len(data)} Already exists: {tape['name']}")
 
-    logging.info(f"removing temporary music folder")
+        self.logger.info(f"removing temporary music folder")
-    rmfulldir(f"{build_dir}/tmp_music/")
+        rmfulldir(f"{self.build_dir}/tmp_music/")
 
-    logging.info(f"copying the sound effects to build")
+        self.logger.info(f"copying the sound effects to build")
-    copy_tree("./source/sound_effects", f"{build_dir}/sound_effects")
+        copy_tree(f"{self.source_dir}/sound_effects", f"{self.build_dir}/sound_effects")
 
 
-def prepare_images(data, build_dir:str):
+    def prepare_images(self, data):
         logging.info(f"assembling covers and icons into png files")
-    assemble_png_images(data, "covers")
+        self.assemble_png_images(data, "covers")
-    assemble_png_images(data, "icons", resize=(64, 41))
+        self.assemble_png_images(data, "icons", resize=(64, 41))
-    assemble_png_images(data, "sprites", resize=(33, 21))
+        self.assemble_png_images(data, "sprites", resize=(33, 21))
 
         logging.info(f"copying other images")
-    shutil.copy("./source/images/players_icons.png", f"{build_dir}/players_icons.png")
+        shutil.copy(f"{self.source_dir}/images/players_icons.png", f"{self.build_dir}/players_icons.png")
-    shutil.copy("./source/images/players_sprites.png", f"{build_dir}/players_sprites.png")
+        shutil.copy(f"{self.source_dir}/images/players_sprites.png", f"{self.build_dir}/players_sprites.png")
-    shutil.copy("./source/images/PreviewImage.png", f"{build_dir}/PreviewImage.png")
+        shutil.copy(f"{self.source_dir}/images/PreviewImage.png", f"{self.build_dir}/PreviewImage.png")
 
 
-def build_xml_code(data, build_dir:str, config):
+    def build_xml_code(self, data, config):
-    logging.info(f"calculate the value that lets you use the songs n-times")
+        self.logger.info(f"calculate the value that lets you use the songs n-times")
-    song_lengths = [OggVorbis(f"./build/music/{tape['identifier']}.ogg").info.length
+        song_lengths = [OggVorbis(f"{self.music_dir}/{tape['identifier']}.ogg").info.length
                         for tape in data]
 
         use_lengths = [song_length * n for song_length, n in
@@ -227,23 +235,22 @@ def build_xml_code(data, build_dir:str, config):
         columns = int((len(data)) ** 0.5)
         positions = [{"column": i % columns, "row": math.floor(i / columns)} for i in range(len(data))]
 
-    logging.info(f"creating jinja environment")
+        self.logger.info(f"creating jinja environment")
         # create jinja2 environment
         j2env = j2.Environment(loader=j2.FileSystemLoader(Path(".")))
         j2env.globals.update(zip=zip)
 
         # load the template file
-    template0 = j2env.get_template("./source/filelist_template.xml")
+        template0 = j2env.get_template(f"{self.source_dir}/filelist_template.xml")
-    template1 = j2env.get_template("./source/sunken_tapes_template.xml")
+        template1 = j2env.get_template(f"{self.source_dir}/sunken_tapes_template.xml")
+        template2 = j2env.get_template(f"{self.source_dir}/sunken_tapes_style_template.xml")
 
-    template2 = j2env.get_template("./source/sunken_tapes_style_template.xml")
+        self.logger.info(f"rendering the xml files")
-
+        with open(f"{self.build_dir}/filelist.xml", "w+", encoding="utf8") as output_file:
-    logging.info(f"rendering the xml files")
-    with open(f"{build_dir}/filelist.xml", "w+", encoding="utf8") as output_file:
             # render the template
             output_file.write(template0.render(config=config, tapes=data))
 
-    with open(f"{build_dir}/{config['slug']}.xml", "w+", encoding="utf8") as output_file:
+        with open(f"{self.build_dir}/{config['slug']}.xml", "w+", encoding="utf8") as output_file:
             # render the template
             output_file.write(template1.render(tapes=data, config=config,
                                                condition_delta=condition_delta,
@@ -251,42 +258,42 @@ def build_xml_code(data, build_dir:str, config):
                                                song_lengths=song_lengths,
                                                positions=positions))
 
-    with open(f"{build_dir}/{config['slug']}_style.xml", "w+", encoding="utf8") as output_file:
+        with open(f"{self.build_dir}/{config['slug']}_style.xml", "w+", encoding="utf8") as output_file:
             # render the template
             output_file.write(template2.render(tapes=data, config=config, positions=positions))
 
 
-def deploy(build_dir: str, install_dir: str, local_mod_name: str, config):
+    def deploy(self, local_mod_name: str, config):
         try:
-        os.mkdir(build_dir)
+            os.mkdir(self.build_dir)
         except FileExistsError:
-        logging.info(f"removing old XML files in ./build/:")
+            self.logger.info(f"removing old XML files in ./build/:")
-        for f in Path(build_dir).glob("*.xml"):
+            for f in Path(self.build_dir).glob("*.xml"):
-            logging.info(f"  {f}")
+                self.logger.info(f"  {f}")
                 os.remove(f)
             pass
 
-    logging.info("Reading tapes.yaml")
+        self.logger.info("Reading tapes.yaml")
         data_file = Path("./source/tapes.yaml")
 
         # load yaml file
         with data_file.open(encoding='utf-8') as fr:
             data = yaml.load(fr, Loader=yaml.SafeLoader)
 
-    prepare_music(data)
+        self.prepare_music(data)
-    prepare_images(data, build_dir)
+        self.prepare_images(data)
-    build_xml_code(data, build_dir, config)
+        self.build_xml_code(data, config)
 
-    mod_directory = f"{install_dir}/LocalMods/{local_mod_name}/"
+        mod_directory = f"{self.install_dir}/LocalMods/{local_mod_name}/"
 
-    logging.info(f"removing the old installed mod directory {mod_directory}")
+        self.logger.info(f"removing the old installed mod directory {mod_directory}")
         rmfulldir(mod_directory)
 
-    logging.info(f"copying the new build")
+        self.logger.info(f"copying the new build")
-    if Path(f"{install_dir}").is_dir():
+        if Path(f"{self.install_dir}").is_dir():
-        copy_tree(build_dir, mod_directory)
+            copy_tree(self.build_dir, mod_directory)
         else:
             raise FileNotFoundError(
-            f"{install_dir} does not exist. Set up the correct Barotrauma installation directory")
+                f"{self.install_dir} does not exist. Set up the correct Barotrauma installation directory")
 
-    logging.info(f"Done!")
+        self.logger.info(f"Done!")

gui/installer.py

@@ -4,9 +4,10 @@ import getpass
 import logging
 import time
 
+from gui.deploy import Deployer
 from tape_editor_widgets import *
 from widgets import LabelWebLink
-from deploy import download_ffmpeg, get_ffmpeg_version, download_git, find_install_dir
+from deploy import Deployer, get_ffmpeg_version
 
 from PIL import ImageGrab
 
@@ -19,6 +20,7 @@ class OptionsWidget(QWidget):
         super().__init__()
 
         self.parent = parent
+        self.deployer = Deployer()
 
         options = [("Buffs", "Some songs affect the characters with strengthen\nand haste afflictions."),
                    ("De-buffs", "Some songs affect the characters with psychosis \naffliction."),
@@ -92,7 +94,7 @@ class OptionsWidget(QWidget):
         # Update widget
         self.update_widget = UpdateWidget(self)
         # Install widget
-        self.install_widget = InstallWidget(self)
+        self.install_widget = InstallWidget(self, self.deployer)
         # Console widget
         self.console_widget = ConsoleWidget(self)
 
@@ -421,7 +423,7 @@ class UpdateWidget(QGroupBox):
         self.does_git_exist()
 
     def download_git_action(self):
-        download_git(self.git_dir.directory)
+        self.parent.deployer.download_git()
 
     def does_git_exist(self):
         executable_path = Path("git/bin/git.exe")
@@ -447,10 +449,11 @@ class ConsoleWidget(QGroupBox):
 
 
 class InstallWidget(QGroupBox):
-    def __init__(self, parent: QWidget):
+    def __init__(self, parent: QWidget, deployer: Deployer):
         super().__init__("Install steps")
 
         self.parent = parent
+        self.deployer = deployer
         self.grid = QGridLayout(self)
 
         hr_html_string = "<hr style=\"background-color:gray;\">"
@@ -461,7 +464,7 @@ class InstallWidget(QGroupBox):
         self.ffmpeg_label_link = LabelWebLink("https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full.7z")
         self.ffmpeg_pushbutton = QPushButton("Download")
         self.ffmpeg_pushbutton.clicked.connect(self.download_ffmpeg_action)
-        self.ffmpeg_dir = DirWidget("./utils")
+        self.ffmpeg_dir = DirWidget(self.deployer.utils_dir)
         self.grid.addWidget(self.ffmpeg_checkbox, 0, 0)
         self.grid.addWidget(self.ffmpeg_label, 0, 1)
         self.grid.addWidget(self.ffmpeg_pushbutton, 0, 2)
@@ -472,7 +475,7 @@ class InstallWidget(QGroupBox):
         self.songs_download_checkbox = QCheckBox()
         self.songs_download_checkbox.setDisabled(True)
         self.songs_download_label = QLabel("Download songs and process them")
-        self.songs_download_dir = DirWidget("./build/music")
+        self.songs_download_dir = DirWidget(self.deployer.music_dir)
         self.songs_download_pushbutton = QPushButton("Download")
         self.songs_download_pushbutton.clicked.connect(self.are_songs_ready)
         self.grid.addWidget(self.songs_download_checkbox, 20, 0)
@@ -484,7 +487,7 @@ class InstallWidget(QGroupBox):
         self.compile_checkbox = QCheckBox()
         self.compile_checkbox.setDisabled(True)
         self.compile_label = QLabel("Compile mod according to the settings")
-        self.compile_dir = DirWidget("./build")
+        self.compile_dir = DirWidget(self.deployer.build_dir)
         self.compile_pushbutton = QPushButton("Compile")
         self.grid.addWidget(self.compile_checkbox, 30, 0)
         self.grid.addWidget(self.compile_label, 30, 1)
@@ -495,7 +498,7 @@ class InstallWidget(QGroupBox):
         self.install_checkbox = QCheckBox()
         self.install_checkbox.setDisabled(True)
         self.install_label = QLabel("Copy the files to the install directory")
-        self.install_dir = DirWidget(find_install_dir())
+        self.install_dir = DirWidget(self.deployer.install_dir)
         self.install_pushbutton = QPushButton("Install")
         self.grid.addWidget(self.install_checkbox, 40, 0)
         self.grid.addWidget(self.install_label, 40, 1)
@@ -576,5 +579,4 @@ def main():
 
 
 if __name__ == "__main__":
-    logging.basicConfig(stream=sys.stdout, level=logging.INFO)
     main()