feat(unsupported warnings): begin work on downgrade warnings

BREAKING CHANGE: The format of the version file has been updated, and it will no longer work with older versions of Vanilla Installer. Fixes #80

Author: osfanbuff63

pyproject.toml

@@ -5,7 +5,7 @@ description = "An installer of Fabulously Optimized for the vanilla launcher."
 authors = [
     "osfanbuff63 <[email protected]>",
     "nsde <[email protected]>",
-    "Kichura <blobfox.coffee/@Kichura>"
+    "Kichura <Kichura@blobfox.coffee>"
 ]
 documentation = "https://fabulously-optimized.gitbook.io/vanilla-installer"
 homepage = "https://fabulously-optimized.gitbook.io/vanilla-installer"

vanilla_installer/assets/versions.json

@@ -1,6 +1,69 @@
 {
-  "1.19.4": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.19.4/pack.toml",
-  "1.18.2": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.18.2/pack.toml",
-  "1.17.1": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.17.1/pack.toml",
-  "1.16.5": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.16.5/pack.toml"
-}
+  "format_version": 2,
+  "versions": {
+    "1.19.4": {
+      "packwiz": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.19.4/pack.toml",
+      "major_version": 4,
+      "enabled": true
+    },
+    "1.19.3": {
+      "major_version": 4,
+      "enabled": false
+    },
+    "1.19.2": {
+      "major_version": 4,
+      "enabled": false
+    },
+    "1.19.1": {
+      "major_version": 4,
+      "enabled": false
+    },
+    "1.19": {
+      "major_version": 4,
+      "enabled": false
+    },
+    "1.18.2": {
+      "packwiz": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.18.2/pack.toml",
+      "major_version": 3,
+      "enabled": true
+    },
+    "1.18.1": {
+      "major_version": 3,
+      "enabled": false
+    },
+    "1.18": {
+      "major_version": 3,
+      "enabled": false
+    },
+    "1.17.1": {
+      "packwiz": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.17.1/pack.toml",
+      "major_version": 2,
+      "enabled": true
+    },
+    "1.17": {
+      "major_version": 2,
+      "enabled": false
+    },
+    "1.16.5": {
+      "packwiz": "https://raw.githubusercontent.com/Fabulously-Optimized/fabulously-optimized/main/Packwiz/1.16.5/pack.toml",
+      "major_version": 1,
+      "enabled": true
+    },
+    "1.16.4": {
+      "major_version": 1,
+      "enabled": false
+    },
+    "1.16.3": {
+      "major_version": 1,
+      "enabled": false
+    },
+    "1.16.2": {
+      "major_version": 1,
+      "enabled": false
+    },
+    "1.16.1": {
+      "major_version": 1,
+      "enabled": false
+    }
+  }
+}

vanilla_installer/gui.py

@@ -203,7 +203,6 @@ def setupUi(self, MainWindow: QMainWindow) -> None:
             Ui_MainWindow.getAsset("settings.svg"), self.settingsButton
         )
         self.settingsButtonIcon.setGeometry(70, 0, 24, 24)
-
         self.windowIcon = Ui_MainWindow.getAsset("icon.png")
         MainWindow.setWindowIcon(QIcon(self.windowIcon))
 

vanilla_installer/log.py

@@ -6,8 +6,8 @@
 
 import logging
 import logging.handlers  # pylance moment
-from pathlib import Path
 import sys
+from pathlib import Path
 
 
 class LoggerWriter:
@@ -16,9 +16,9 @@ def __init__(self, logfct):
         self.buf = []
 
     def write(self, msg):
-        if msg.endswith('\n'):
-            self.buf.append(msg.removesuffix('\n'))
-            self.logfct(''.join(self.buf))
+        if msg.endswith("\n"):
+            self.buf.append(msg.removesuffix("\n"))
+            self.logfct("".join(self.buf))
             self.buf = []
         else:
             self.buf.append(msg)
@@ -35,11 +35,11 @@ def flush(self):
     with logfile_path as file:
         open(file, "x", encoding="utf-8").write("")
 handler = logging.handlers.RotatingFileHandler(
-        filename=logfile_path,
-        encoding="utf-8",
-        maxBytes=32 * 1024 * 1024,  # 32 MiB
-        backupCount=5,  # Rotate through 5 files
-    )
+    filename=logfile_path,
+    encoding="utf-8",
+    maxBytes=32 * 1024 * 1024,  # 32 MiB
+    backupCount=5,  # Rotate through 5 files
+)
 
 dt_fmt = "%Y-%m-%d %H:%M:%S"
 formatter = logging.Formatter(

vanilla_installer/main.py

@@ -13,7 +13,7 @@
 import subprocess
 import zipfile
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Union
 
 import click
 import minecraft_launcher_lib as mll
@@ -28,6 +28,12 @@
 FOLDER_LOC = ""
 
 
+class UnsupportedFormatVersion(Exception):
+    """The format version is not supported by this program version."""
+
+    pass
+
+
 def set_dir(path: str = mll.utils.get_minecraft_directory()) -> str | None:
     """
     Sets the Minecraft game directory.
@@ -376,34 +382,79 @@ def create_profile(mc_dir: str, version_id: str) -> None:
     launcher_profiles_path.write_text(profiles_json)
 
 
-def get_pack_mc_versions() -> dict:
+def log_installed_version(
+    version: Union[str, int, float], install_dir: Union[str, bytes, os.PathLike]
+) -> None:
+    """Log the version of Minecraft that FO has been installed for. Used to find out later
+
+    Args:
+        version (Union[str, int, float]): The version to log.
+        install_dir (Union[str, bytes, os.PathLike]): The directory that FO was installed to.
     """
-    Gets a list of all the versions FO currently supports.
+    dir_path = Path(install_dir).resolve() / ".fabulously-optimized"
+    dir_path.mkdir(exist_ok=True)
+    file_path = dir_path / "mc_version.txt"
+    if file_path.exists() is False:
+        file_path.touch()
+    with file_path.open("w") as file:
+        file.write(str(version))
+
+
+def read_versions() -> dict:
+    """Reads the versions.json file, either over the Internet, or locally.
+
+    Returns:
+        dict: The JSON file, formatted as a dictionary.
     """
+    SUPPORTED_FORMAT_VERSION = 2
 
-    return_value = dict()
     try:
+        response = requests.get(
+            "https://raw.githubusercontent.com/Fabulously-Optimized/vanilla-installer/main/vanilla_installer/assets/versions.json"
+        ).json()
+        format_version = response["format_version"]
+        if response["format_version"] != SUPPORTED_FORMAT_VERSION:
+            raise UnsupportedFormatVersion(
+                f"Format version {format_version} is not supported by this version."
+            )
+    except requests.exceptions.RequestException or response.status_code != "200":
+        # This should never happen unless a) there's no internet connection, b) the file was deleted or is missing in a development case.
+        # In this case, fall back to a local file.
+        logger.warning("GitHub failed, falling back to local...")
         try:
-            response = requests.get(
-                "https://raw.githubusercontent.com/Fabulously-Optimized/vanilla-installer/main/vanilla_installer/assets/versions.json"
-            ).json()
-        except requests.exceptions.RequestException or response.status_code != "200":
-            # This should never happen unless a) there's no internet connection, b) the file was deleted or is missing in a development case.
-            # In this case, fall back to a local file since in the latter you'll likely have the whole repo cloned.
-            # For this to work, you need to be in the root directory of the repository running this, otherwise the files will not be found.
-            logger.warning("GitHub failed, falling back to local...")
-            try:
-                local_path = (
-                    Path("vanilla_installer/assets").resolve() / "versions.json"
-                )
-            except:
-                local_path = Path("assets").resolve() / "versions.json"
-            response = json.loads(local_path.read_bytes())
+            local_path = Path("vanilla_installer/assets").resolve() / "versions.json"
+        except:
+            local_path = Path("assets").resolve() / "versions.json"
+        response = json.loads(local_path.read_bytes())
+    except UnsupportedFormatVersion:
+        logger.exception(
+            "Format version was not supported - using local file. Update Vanilla Installer to fix this."
+        )
+        try:
+            local_path = Path("vanilla_installer/assets").resolve() / "versions.json"
+        except:
+            local_path = Path("assets").resolve() / "versions.json"
+        response = json.loads(local_path.read_bytes())
+    return dict(response)
 
-        return_value = dict(response)
-        return return_value
-    except requests.exceptions.RequestException as e:
-        logger.exception(f"Couldn't get minecraft versions: {e}")
+
+def get_pack_mc_versions() -> dict:
+    """
+    Gets a list of all the versions FO currently supports.
+    """
+    return_value = dict()
+    raw_dict = read_versions()
+    for version in raw_dict["versions"]:
+        raw_version = raw_dict["versions"][version]
+        if raw_version["enabled"] is True or raw_version["enabled"] == "true":
+            return_value[version] = raw_version
+    for key in return_value.keys():
+        try:
+            if key["packwiz"] != "":
+                pass
+        except KeyError:
+            return_value.pop(key)
+    return return_value
 
 
 def convert_version(input_mcver: str) -> str:
@@ -414,7 +465,7 @@ def convert_version(input_mcver: str) -> str:
         input_mcver (str): The Minecraft version to find.
 
     Returns:
-        str: The converted version as a direct JSDelivr URL.
+        str: The converted version as a URL.
     """
     versions = get_pack_mc_versions()
     return_value = versions.get(input_mcver)
@@ -424,6 +475,18 @@ def convert_version(input_mcver: str) -> str:
         return return_value
 
 
+def downgrade_check(version: Union[str, int, float]) -> bool:
+    """Checks whether the given version is a downgrade from the one currently installed.
+
+    Args:
+        version (Union[str, int, float]): _description_
+
+    Returns:
+        bool: Whether this is a downgrade.
+    """
+    version_dict = read_versions()
+
+
 def run(
     mc_dir: str = mll.utils.get_minecraft_directory(),
     version: Optional[str] = None,