Merge branch 'bugfix/refactor/bedrock-update-unzip' into 'dev'

Only copy bedrock_server executable on update

See merge request crafty-controller/crafty-4!562

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Bump Cryptography/pyOpenSSL for CVE-2023-23931 ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/554))
 - Fix debug logging to only display with the -v (verbose) flag ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/560))
 - Optimize world size calculation ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/550))
+- Only copy bedrock_server executable on update ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/562))
 ### Tweaks
 - Cleanup authentication helpers ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/545))
 - Optimize file upload progress WS ([Merge Request](https://gitlab.com/crafty-controller/crafty-4/-/merge_requests/546))

app/classes/shared/file_helpers.py

@@ -283,27 +283,31 @@ class FileHelpers:
         return True
 
     @staticmethod
-    def unzip_file(zip_path):
-        new_dir_list = zip_path.split("/")
-        new_dir = ""
-        for i in range(len(new_dir_list) - 1):
-            if i == 0:
-                new_dir += new_dir_list[i]
-            else:
-                new_dir += "/" + new_dir_list[i]
-
+    def unzip_file(zip_path, server_update=False):
+        ignored_names = ["server.properties", "permissions.json", "allowlist.json"]
+        # Get directory without zipfile name
+        new_dir = pathlib.Path(zip_path).parents[0]
+        # make sure we're able to access the zip file
         if Helpers.check_file_perms(zip_path) and os.path.isfile(zip_path):
+            # make sure the directory we're unzipping this to exists
             Helpers.ensure_dir_exists(new_dir)
+            # we'll make a temporary directory to unzip this to.
             temp_dir = tempfile.mkdtemp()
             try:
                 with zipfile.ZipFile(zip_path, "r") as zip_ref:
+                    # we'll extract this to the temp dir using zipfile module
                     zip_ref.extractall(temp_dir)
-                    full_root_path = temp_dir
-                for item in os.listdir(full_root_path):
-                    if os.path.isdir(os.path.join(full_root_path, item)):
+                # we'll iterate through the top level directory moving everything
+                # out of the temp directory and into it's final home.
+                for item in os.listdir(temp_dir):
+                    # if the file is one of our ignored names we'll skip it
+                    if item in ignored_names and server_update:
+                        continue
+                    # we handle files and dirs differently or we'll crash out.
+                    if os.path.isdir(os.path.join(temp_dir, item)):
                         try:
                             FileHelpers.move_dir_exist(
-                                os.path.join(full_root_path, item),
+                                os.path.join(temp_dir, item),
                                 os.path.join(new_dir, item),
                             )
                         except Exception as ex:
@@ -311,7 +315,7 @@ class FileHelpers:
                     else:
                         try:
                             FileHelpers.move_file(
-                                os.path.join(full_root_path, item),
+                                os.path.join(temp_dir, item),
                                 os.path.join(new_dir, item),
                             )
                         except Exception as ex:

app/classes/shared/server.py

@@ -1320,7 +1320,7 @@ class ServerInstance:
                 unzip_path = os.path.join(self.settings["path"], "bedrock_server.zip")
                 unzip_path = self.helper.wtol_path(unzip_path)
                 # unzips archive that was downloaded.
-                FileHelpers.unzip_file(unzip_path)
+                FileHelpers.unzip_file(unzip_path, server_update=True)
                 # adjusts permissions for execution if os is not windows
                 if not self.helper.is_os_windows():
                     os.chmod(
@@ -1334,6 +1334,7 @@ class ServerInstance:
                 logger.critical(
                     f"Failed to download bedrock executable for update \n{e}"
                 )
+                downloaded = False
 
         if downloaded:
             logger.info("Executable updated successfully. Starting Server")