Added WIP JSON-based script support, removed old format

The old script code was already broken from the previous commits anyway, since they changed too much internally. This new format is much easier to understand and will allow for creating more powerful scripts.

NUSGet.py

@@ -34,8 +34,9 @@ from qt.py.ui_MainMenu import Ui_MainWindow
 
 from modules.core import *
 from modules.tree import NUSGetTreeModel
-from modules.download_wii import run_nus_download_wii, run_nus_download_wii_batch
+from modules.download_batch import run_nus_download_batch
-from modules.download_dsi import run_nus_download_dsi, run_nus_download_dsi_batch
+from modules.download_wii import run_nus_download_wii
+from modules.download_dsi import run_nus_download_dsi
 
 nusget_version = "1.3.0"
 
@@ -333,86 +334,75 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         msg_box.setStandardButtons(QMessageBox.StandardButton.Ok)
         msg_box.setDefaultButton(QMessageBox.StandardButton.Ok)
         msg_box.setWindowTitle(app.translate("MainWindow", "Script Download Failed"))
-        file_name = QFileDialog.getOpenFileName(self, caption=app.translate("MainWindow", "Open NUS script"),
+        file_name = QFileDialog.getOpenFileName(self, caption=app.translate("MainWindow", "Open NUS Script"),
-                                                filter=app.translate("MainWindow", "NUS Scripts (*.nus *.txt)"),
+                                                filter=app.translate("MainWindow", "NUS Scripts (*.nus *.json)"),
                                                 options=QFileDialog.Option.ReadOnly)
+        # The old plaintext script format is no longer supported in NUSGet v1.3.0 and later. This script parsing code
+        # is for the new JSON script format, which is much easier to use and is cleaner.
         if len(file_name[0]) == 0:
             return
         try:
-            content = open(file_name[0], "r").readlines()
+            with open(file_name[0]) as script_file:
-        except os.error:
+                script_data = json.load(script_file)
-            msg_box.setText(app.translate("MainWindow", "The script could not be opened."))
+        except json.JSONDecodeError as e:
+            msg_box.setText(app.translate("MainWindow", "An error occurred while parsing the script file!"))
+            msg_box.setInformativeText(app.translate("MainWindow", f"Error encountered at line {e.lineno}, column {e.colno}. Please double-check the script and try again."))
             msg_box.exec()
             return
-
+        # Build a list of the titles we need to download.
-        # NUS Scripts are plaintext UTF-8 files that list a title per line, terminated with newlines.
-        # Every title is its u64 TID, a space and its u16 version, *both* written in hexadecimal.
-        # NUS itself expects versions as decimal notation, so they need to be decoded first, but TIDs are always written
-        # in hexadecimal notation.
         titles = []
-        for index, title in enumerate(content):
+        for title in script_data:
-            decoded = title.replace("\n", "").split(" ", 1)
-            if len(decoded[0]) != 16:
-                msg_box.setText(app.translate("MainWindow", "The TID for title #%n is not valid.", "", index + 1))
-                msg_box.exec()
-                return
-            elif len(decoded[1]) != 4:
-                msg_box.setText(app.translate("MainWindow", "The version for title #%n is not valid.", "", index + 1))
-                msg_box.exec()
-                return
-            
-            tid = decoded[0]
-
             try:
-                target_version = int(decoded[1], 16)
+                tid = title["Title ID"]
-            except ValueError:
+            except KeyError:
-                msg_box.setText(app.translate("MainWindow", "The version for title #%n is not valid.", "", index + 1))
+                msg_box.setText(app.translate("MainWindow", "An error occurred while parsing Title IDs!"))
+                msg_box.setInformativeText(app.translate("MainWindow", f"The title at index {script_data.index(title)} does not have a Title ID!"))
                 msg_box.exec()
                 return
-
+            # No version key is acceptable, just treat it as latest.
-            title = None
+            try:
-            for category in self.trees[self.ui.platform_tabs.currentIndex()][1]:
+                title_version = int(title["Version"])
-                for title_ in self.trees[self.ui.platform_tabs.currentIndex()][1][category]:
+            except KeyError:
-                    # The last two digits are either identifying the title type (IOS slot, BC type, etc.) or a region code; in case of the latter, skip the region here to match it
+                title_version = -1
-                    if not ((title_["TID"][-2:] == "XX" and title_["TID"][:-2] == tid[:-2]) or title_["TID"] == tid):
+            # If no console was specified, assume Wii.
-                        continue
+            try:
-
+                console = title["Console"]
-                    found_ver = False
+            except KeyError:
-                    for region in title_["Versions"]:
+                console = "Wii"
-                        for db_version in title_["Versions"][region]:
+            # Look up the title, and load the archive name for it if one can be found.
-                            if db_version == target_version:
+            archive_name = ""
-                                found_ver = True
+            if console == "vWii":
-                                break
+                target_database = vwii_database
-
+            elif console == "DSi":
-                    if not found_ver:
+                target_database = dsi_database
-                        msg_box.setText(app.translate("MainWindow", "The version for title #%n could not be discovered in the database.", "", index + 1))
-                        msg_box.exec()
-                        return
-
-                    title = title_
-                    break
-            
-            if title is None:
-                msg_box.setText(app.translate("MainWindow", "Title #%n could not be discovered in the database.", "", index + 1))
-                msg_box.exec()
-                return
-
-            titles.append((title["TID"], str(target_version), title["Archive Name"]))
-
-        self.lock_ui_for_download()
-
-        self.update_log_text(f"Found {len(titles)} titles, starting batch download.")
-
-        if self.ui.console_select_dropdown.currentText() == "DSi":
-            worker = Worker(run_nus_download_dsi_batch, out_folder, titles, self.ui.pack_archive_chkbox.isChecked(),
-                            self.ui.keep_enc_chkbox.isChecked(), self.ui.create_dec_chkbox.isChecked(),
-                            self.ui.use_local_chkbox.isChecked(), self.ui.archive_file_entry.text())
             else:
-            worker = Worker(run_nus_download_wii_batch, out_folder, titles, self.ui.pack_archive_chkbox.isChecked(),
+                target_database = wii_database
+            for category in target_database:
+                for t in target_database[category]:
+                    if t["TID"][-2:] == "XX":
+                        for r in regions:
+                            if f"{t['TID'][:-2]}{regions[r][0]}" == tid:
+                                try:
+                                    archive_name = t["Archive Name"]
+                                    break
+                                except KeyError:
+                                    archive_name = ""
+                                    break
+                    else:
+                        if t["TID"] == tid:
+                            try:
+                                archive_name = t["Archive Name"]
+                                break
+                            except KeyError:
+                                archive_name = ""
+                                break
+            print(archive_name)
+            titles.append(BatchTitleData(tid, title_version, console, archive_name))
+        self.lock_ui_for_download()
+        worker = Worker(run_nus_download_batch, out_folder, titles, self.ui.pack_archive_chkbox.isChecked(),
                         self.ui.keep_enc_chkbox.isChecked(), self.ui.create_dec_chkbox.isChecked(),
                         self.ui.use_wiiu_nus_chkbox.isChecked(), self.ui.use_local_chkbox.isChecked(),
                         self.ui.pack_vwii_mode_chkbox.isChecked(), self.ui.patch_ios_chkbox.isChecked())
-
         worker.signals.result.connect(self.check_download_result)
         worker.signals.progress.connect(self.update_log_text)
         self.threadpool.start(worker)

modules/core.py

@@ -18,6 +18,15 @@ class TitleData:
     danger: str
 
 
+@dataclass
+class BatchTitleData:
+    # Class to store all data for a Title in a batch operation.
+    tid: str
+    version: int
+    console: str
+    archive_name: str
+
+
 def check_nusget_updates(app, current_version: str, progress_callback=None) -> str | None:
     # Simple function to make a request to the GitHub API and then check if the latest available version is newer.
     gh_api_request = requests.get(url="https://api.github.com/repos/NinjaCheetah/NUSGet/releases/latest", stream=True)

modules/download_batch.py

@@ -0,0 +1,36 @@
+# "modules/download_batch.py", licensed under the MIT license
+# Copyright 2024 NinjaCheetah
+
+import pathlib
+from typing import List
+from modules.core import BatchTitleData
+from modules.download_dsi import run_nus_download_dsi
+from modules.download_wii import run_nus_download_wii
+
+
+def run_nus_download_batch(out_folder: pathlib.Path, titles: List[BatchTitleData], pack_wad_chkbox: bool,
+                               keep_enc_chkbox: bool, decrypt_contents_chkbox: bool, wiiu_nus_chkbox: bool,
+                               use_local_chkbox: bool, repack_vwii_chkbox: bool, patch_ios: bool,
+                               progress_callback=None):
+    for title in titles:
+        if title.console == "Wii" or title.console == "vWii":
+            if title.archive_name != "":
+                archive_name = f"{title.archive_name}-v{title.version}-{title.console}.wad"
+            else:
+                archive_name = f"{title.tid}-v{title.version}-{title.console}.wad"
+            result = run_nus_download_wii(out_folder, title.tid, str(title.version), pack_wad_chkbox, keep_enc_chkbox,
+                                          decrypt_contents_chkbox, wiiu_nus_chkbox, use_local_chkbox, repack_vwii_chkbox,
+                                          patch_ios, archive_name, progress_callback)
+            if result != 0:
+                return result
+        elif title.console == "DSi":
+            if title.archive_name != "":
+                archive_name = f"{title.archive_name}-v{title.version}-{title.console}.tad"
+            else:
+                archive_name = f"{title.tid}-v{title.version}-{title.console}.tad"
+            result = run_nus_download_dsi(out_folder, title.tid, str(title.version), pack_wad_chkbox, keep_enc_chkbox,
+                                          decrypt_contents_chkbox, use_local_chkbox, archive_name, progress_callback)
+            if result != 0:
+                return result
+    progress_callback.emit(f"Batch download finished.")
+    return 0