Fixed bug where new version config data is not loaded correctly

Author: OwenCochell

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: Package with pyinstaller and add to release
+
+on:
+    workflow_dispatch:
+    release:
+        types: [published]
+
+jobs:
+    pyinstaller-build:
+        runs-on: windows-latest
+        steps:
+            - name: PyInstaller Action
+              uses: Martin005/[email protected]
+              with:
+                spec: server_update.py
+                options: --onefile, --name "PaperMC-Update"
+            - name: Upload Release
+              uses: AButler/[email protected]
+              with:
+                files: ${{ steps.step1.outputs.executable_path }}
+                repo-token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog 
 
+## 2.2.2
+
+Bug Fixes:
+
+  - Now reads new version info format
+    - Caused config version load failures 
+
+Other Fixes:
+
+  - Minor refractor and documentation change
+
 ## 2.2.1
 
 Bug Fixes:

server_update.py

@@ -33,7 +33,7 @@
 A Set of tools to automate the server update process.
 """
 
-__version__ = '2.2.1'
+__version__ = '2.2.2'
 
 # These variables contain links for the script updating process.
 
@@ -42,28 +42,38 @@
 GITHUB_RAW = 'https://raw.githubusercontent.com/Owen-Cochell/PaperMC-Update/master/server_update.py'
 
 
-def load_config(config: str) -> Tuple[str, int]:
+def load_config_old(config: dict) -> Tuple[str, int]:
     """
     Loads configuration data from the given file.
 
     We only load version info if it's in the official format!
     We return the version and build number found in the configuration file.
 
-    :param config: Path to config file
-    :type config: str
-    :return: Tuple contaning version and build data respectively
+    This function looks for config data in the old format,
+    which at this time seems to be pre 1.21 (TODO: Confirm)
+    We preform a check to see if the data looks correct,
+    the current version string MUST start with 'git-Paper',
+    otherwise we will raise a value error. 
+
+    :param config: JSON data to consider
+    :type config: dict
+    :return: Tuple containing version and build data respectively
     :rtype: Tuple[str, int]
     """
 
-    # Exists and is file, read it
+    OLD_PREFIX = 'git-Paper'  # Old prefix
+
+    # Read the data, and attempt to pull some info out of it
 
-    file = open(config, 'r')
+    current = config['currentVersion']
 
-    data = json.load(file)
+    # Ensure string prefix is correct:
 
-    # Read the data, and attempt to pull some info out of it
+    if not OLD_PREFIX == current[:len(OLD_PREFIX)]:
 
-    current = data['currentVersion']
+        # Does not match! Must be invalid ...
+
+        raise ValueError("Invalid old config data format!")
 
     # Splitting the data in two so we can pull some content out:
 
@@ -82,6 +92,43 @@ def load_config(config: str) -> Tuple[str, int]:
     return version, build
 
 
+def load_config_new(config: dict) -> Tuple[str, int]:
+    """
+    Loads configuration data from the given file.
+
+    We only load version info if it's in the official format!
+    We return the version and build number found in the configuration file.
+
+    This function looks for config data in the new format,
+    which at this time seems to be post 1.21 (TODO: Confirm)
+
+    :param config: JSON data to consider
+    :type config: dict
+    :return: Tuple containing version and build data respectively
+    :rtype: Tuple[str, int]
+    """
+
+    # Read the data, and attempt to pull some info out of it
+
+    current = config['currentVersion']
+
+    # Splitting the data in two so we can pull some content out:
+
+    split = current.split(" ")[0].split("-")
+
+    # Getting build information:
+
+    build = int(split[1])
+
+    # Getting version information:
+
+    version = split[0]
+
+    # Returning version information:
+
+    return version, build
+
+
 def upgrade_script(serv: ServerUpdater):
     """
     Upgrades this script.
@@ -717,31 +764,55 @@ def load_config(self, config: str) -> Tuple[str, int]:
 
         output("# Loading configuration data from file [{}] ...".format(config))
 
-        if os.path.isfile(config):
+        if not os.path.isfile(config):
 
-            try:
+            print("# Unable to load config data from file at [{}] - Not found/Not a file!".format(config))
 
-                return load_config(config)
+            return '0', 0
 
-            except JSONDecodeError:
+        # Load file content
 
-                # Data not in valid JSON format.
+        try:
 
-                output("# Failed to load config data - Not in JSON format!")
+            # Open file
 
-                return '0', 0
+            with open(config, 'r') as file:
 
-            except Exception:
+                # Decode file
 
-                # Extra weird errors due to formatting issues:
+                data = json.load(file)
 
-                output("# Failed to load config data - Strange format, we support official builds only!")
+        except JSONDecodeError:
 
-                return '0', 0
+            # Data not in valid JSON format.
 
-        else:
+            output("# Failed to load config data - Not in JSON format!")
 
-            print("# Unable to load config data from file at [{}] - Not found/Not a file!".format(config))
+            return '0', 0
+
+        try:
+
+            # First, try old format...
+
+            return load_config_old(data)
+
+        except Exception:
+
+            # Did not work, try something else ...
+
+            pass
+
+        # Try new format:
+
+        try:
+
+            return load_config_new(data)
+
+        except Exception:
+
+            # Extra weird errors due to formatting issues:
+
+            output("# Failed to load config data - Strange format, we support official builds only!")
 
             return '0', 0