feat: Verified mods auto-downloading

.github/nativefuncs.json

@@ -406,6 +406,36 @@
 			"returnTypeString":"bool",
 			"argTypes":"string modName"
 		},
+		{
+			"name": "NSIsModVerified",
+			"helpText": "Tells if a mod is verified or not.",
+			"returnTypeString": "bool",
+			"argTypes": "string modName, string modVersion"
+		},
+		{
+			"name": "NSDownloadMod",
+			"helpText": "Starts downloading a mod; returns nothing because actual mod downloading is done in a thread, as not to block UI.",
+			"returnTypeString": "void",
+			"argTypes": "string modname, string modVersion"
+		},
+		{
+			"name": "NSIsModBeingDownloaded",
+			"helpText": "Tells if a mod is being downloaded; this is used by UI to check if it should display loading dialog to the user.",
+			"returnTypeString": "bool",
+			"argTypes": "string modName"
+		},
+		{
+			"name": "NSGetCurrentDownloadProgress",
+			"helpText": "Returns progression in percentage of current download/extraction.",
+			"returnTypeString": "array<float>",
+			"argTypes": ""
+		},
+		{
+			"name": "NSGetModExtractionResult",
+			"helpText": "Returns result of mod download/extraction.",
+			"returnTypeString": "string",
+			"argTypes": ""
+		},
 		{
 			"name":"NSGetModConvarsByModName",
 			"helpText":"",

Northstar.Client/mod/resource/northstar_client_localisation_english.txt

@@ -321,6 +321,24 @@ Press Yes if you agree to this. This choice can be changed in the mods menu at a
 		"INVALID_MASTERSERVER_TOKEN" 	"Invalid or expired masterserver token"
 		"JSON_PARSE_ERROR" 				"Error parsing json response"
 		"UNSUPPORTED_VERSION" 			"The version you are using is no longer supported"
+
+		"DOWNLOADING_MOD_TITLE"			"Downloading mod"
+		"DOWNLOADING_MOD_TITLE_WITH_PROGRESS"	"Downloading mod (%s1%)"
+		"DOWNLOADING_MOD_TEXT"			"Downloading %s1 v%s2..."
+		"DOWNLOADING_MOD_TEXT_WITH_PROGRESS"	"Downloading %s1 v%s2...\n(%s3 %s4 / %s5 %s6)"
+		"EXTRACTING_MOD_TITLE"			"Extracting mod (%s1%)"
+		"EXTRACTING_MOD_TEXT"			"Extracting %s1 v%s2...\n(%s3/%s4 files)"
+		"FAILED_DOWNLOADING"			"Failed downloading %s1"
+		"MISSING_MOD"					"Missing mod %s1 v%s2"
+		"MOD_NOT_VERIFIED"				"(mod is not verified, and couldn't be downloaded automatically)"
+		"MEGABYTE_SMALL"				"MB"
+
+		"FAILED"						"Mod extraction failed. Check logs for more details."
+		"FAILED_READING_ARCHIVE"		"An error occurred while reading mod archive."
+		"FAILED_WRITING_TO_DISK"		"An error occurred while extracting mod files to the filesystem."
+		"MOD_FETCHING_FAILED"			"Mod archive could not be downloaded from Thunderstore."
+		"MOD_CORRUPTED"					"Downloaded archive checksum does not match verified signature."
+		"NO_DISK_SPACE_AVAILABLE"		"There is not enough space on your disk."
 
 		// Mod Settings
 		"MOD_SETTINGS"					"Mod Settings"

Northstar.Client/mod/resource/northstar_client_localisation_french.txt

@@ -320,6 +320,24 @@ Choisissez Oui si vous êtes d'accord. Ce choix peut être modifié à tout inst
 		"JSON_PARSE_ERROR"                 "Une erreur est survenue durant l'analyse JSON"
 		"UNSUPPORTED_VERSION"             "La version que vous utilisez n'est plus supportée"
 
+		"DOWNLOADING_MOD_TITLE"			"Téléchargement du mod"
+		"DOWNLOADING_MOD_TITLE_WITH_PROGRESS"	"Téléchargement du mod (%s1%)"
+		"DOWNLOADING_MOD_TEXT"			"Téléchargement de %s1 v%s2..."
+		"DOWNLOADING_MOD_TEXT_WITH_PROGRESS"	"Téléchargement de %s1 v%s2...\n(%s3 %s4 / %s5 %s6)"
+		"EXTRACTING_MOD_TITLE"			"Extraction du mod (%s1%)"
+		"EXTRACTING_MOD_TEXT"			"Extraction de %s1 v%s2...\n(%s3/%s4 fichiers)"
+		"FAILED_DOWNLOADING"			"Echec du téléchargement de %s1"
+		"MISSING_MOD"					"Mod manquant : %s1 v%s2"
+		"MOD_NOT_VERIFIED"				"(ce mod n'est pas vérifié, et n'a donc pas pu être automatiquement téléchargé)"
+		"MEGABYTE_SMALL"				"Mo"
+
+		"FAILED"						"L'extraction du mod a échoué.\nVeuillez lire le journal d'événements pour plus d'informations."
+		"FAILED_READING_ARCHIVE"		"Une erreur est survenue lors de la lecture de l'archive."
+		"FAILED_WRITING_TO_DISK"		"Une erreur est survenue lors de l'extraction de fichiers."
+		"MOD_FETCHING_FAILED"			"L'archive du mod n'a pas pu être téléchargée depuis Thunderstore."
+		"MOD_CORRUPTED"					"La somme de contrôle de l'archive ne correspond pas à la signature vérifiée."
+		"NO_DISK_SPACE_AVAILABLE"		"Il n'y a plus assez d'espace disque."
+
 		"MOD_SETTINGS"                    "Paramètres de mod"
 		"NORTHSTAR_BASE_SETTINGS"        "Paramètres de base de Northstar"
 		"ONLY_HOST_MATCH_SETTINGS"        "Seul l'hôte peut changer les paramètres de match privé"

Northstar.Client/mod/scripts/vscripts/ui/menu_ns_serverbrowser.nut

@@ -98,7 +98,41 @@ struct {
 	array< void functionref( ServerInfo ) > connectCallbacks
 } file
 
+enum eProgressType
+{
+    DOWNLOAD = 0,
+    EXTRACTION = 1
+}
 
+// This struct holds information about the currently downloaded mod:
+struct ModDownloadProgress {
+	float received					// received quantity
+	float total						// total quantity expected
+	float receivedPercentage		// ratio of received / expected (computed in native for PERFS!)
+	int progressType				// nature of previous data (0=download stats [in MBs], 1=extraction stats [in files count])
+
+	// The following information should only be used with big files (as there's no need to display this
+	// for small files due to extraction speed):
+	float currentFileExtracted		// extracted size of current file
+	float currentFileTotal 			// total size of current file
+}
+
+const int MB = 1024*1000;
+
+/**
+ * Builds up a ModDownloadProgress struct from values retrieved from native code.
+ **/
+ModDownloadProgress function BuildModDownloadingProgress(array<float> values)
+{
+	ModDownloadProgress p
+	p.received = values[0]
+	p.total = values[1]
+	p.receivedPercentage = values[2]
+	p.progressType = int(values[3])
+	p.currentFileExtracted = values[4]
+	p.currentFileTotal = values[5]
+	return p
+}
 
 bool function FloatsEqual( float arg1, float arg2, float epsilon )
 {
@@ -951,6 +985,11 @@ string function FillInServerModsLabel( array<RequiredModInfo> mods )
 
 
 void function OnServerSelected( var button )
+{
+	thread OnServerSelected_Threaded(button);
+}
+
+void function OnServerSelected_Threaded( var button )
 {
 	if ( NSIsRequestingServerList() || NSGetServerCount() == 0 || file.serverListRequestFailed )
 		return
@@ -959,15 +998,123 @@ void function OnServerSelected( var button )
 
 	file.lastSelectedServer = server
 
+	// Count mods that have been successfully downloaded
+	int downloadedMods = 0;
+
+	// check mods
 	foreach ( RequiredModInfo mod in server.requiredMods )
 	{
-		if ( !NSGetModNames().contains( mod.name ) )
+		string modName = mod.name;
+		string modVersion = mod.version;
+		print( format("Server requires mod \"%s\" v%s.", modName, modVersion) )
+
+		// If mod is locally installed already, no need to download it.
+		if (NSGetModNames().contains( modName ) && NSGetModVersionByModName( modName ) == modVersion && !NSIsModEnabled( modName ))
 		{
+			print( format("Required mod \"%s\" is locally there but disabled, enabling it.", modName) )
+			NSSetModEnabled( modName, true )
+			downloadedMods++
+			continue
+		}
+
+		if ( !NSGetModNames().contains( modName ) )
+		{
+			string fullModName = "\"" + modName + "\""
+
+			// check if mod is verified
+			bool modIsVerified = false
+			if ( NSIsModVerified( modName, modVersion ) )
+			{
+				bool modIsVerified = true
+				string MB_UNIT = Localize( "#MEGABYTE_SMALL" )
+				NSDownloadMod( modName, modVersion )
+
+				// Downloading mod UI
+				DialogData dialogData
+				dialogData.header = Localize( "#DOWNLOADING_MOD_TITLE" )
+				dialogData.message = Localize( "#DOWNLOADING_MOD_TEXT", fullModName, modVersion )
+				dialogData.showSpinner = true;
+				// Prevent user from closing dialog
+				dialogData.forceChoice = true;
+
+				OpenDialog( dialogData )
+				// Save reference to UI elements, to update their content
+				var menu = GetMenu( "Dialog" )
+				var header = Hud_GetChild( menu, "DialogHeader" )
+				var body = GetSingleElementByClassname( menu, "DialogMessageClass" )
+
+				while( NSIsModBeingDownloaded(modName) )
+				{
+					// This array holds a bunch of progress information about mod.
+					ModDownloadProgress downloadStats = BuildModDownloadingProgress( NSGetCurrentDownloadProgress() );
+					bool isDownloading = downloadStats.progressType == eProgressType.DOWNLOAD;
+
+					// Mod is being downloaded.
+					if (isDownloading)
+					{
+						Hud_SetText( header, Localize( "#DOWNLOADING_MOD_TITLE_WITH_PROGRESS", downloadStats.receivedPercentage) )
+						Hud_SetText( body, Localize( "#DOWNLOADING_MOD_TEXT_WITH_PROGRESS", fullModName, modVersion, floor(downloadStats.received / MB), MB_UNIT, floor(downloadStats.total / MB), MB_UNIT))
+					}
+					else // Mod is being extracted.
+					{
+						Hud_SetText( header, Localize( "#EXTRACTING_MOD_TITLE", downloadStats.receivedPercentage ) )
+						string text = Localize( "#EXTRACTING_MOD_TEXT", fullModName, modVersion, floor(downloadStats.received), floor(downloadStats.total) )
+
+						// We only display extraction progress for big files (> 15MB), for users not to think Northstar has crashed.
+						float filesize = downloadStats.currentFileTotal;
+						if ( filesize > 15 * MB )
+						{
+							text += format( " [%i%s / %i%s]", floor(downloadStats.currentFileExtracted / MB), MB_UNIT, floor(downloadStats.currentFileTotal / MB), MB_UNIT )
+						}
+
+						Hud_SetText( body, text )
+					}
+
+					WaitFrame();
+				}
+
+				// Close loading dialog
+				CloseActiveMenu()
+
+				// Check result of downloading and extraction
+				string result = NSGetModExtractionResult()
+				if ( result == "OK" )
+				{
+					downloadedMods++
+					continue
+				}
+
+				// If mod downloading or extraction failed, we display the error
+				// and exit current thread.
+				else 
+				{
+					DialogData dialogData
+					dialogData.header = Localize( "#FAILED_DOWNLOADING", modName )
+					dialogData.message = Localize( format("#%s", result) )
+					dialogData.image = $"ui/menu/common/dialog_error"
+
+					#if PC_PROG
+						AddDialogButton( dialogData, "#DISMISS" )
+						AddDialogFooter( dialogData, "#A_BUTTON_SELECT" )
+					#endif
+					AddDialogFooter( dialogData, "#B_BUTTON_DISMISS_RUI" )
+
+					OpenDialog( dialogData )
+					return
+				}
+
+			}
+
 			DialogData dialogData
 			dialogData.header = "#ERROR"
-			dialogData.message = format( "Missing mod \"%s\" v%s", mod.name, mod.version )
+			dialogData.message = Localize( "#MISSING_MOD", fullModName, modVersion )
 			dialogData.image = $"ui/menu/common/dialog_error"
 
+			if (!modIsVerified)
+			{
+				dialogData.message += "\n" + Localize( "#MOD_NOT_VERIFIED" )
+			}
+
 			#if PC_PROG
 				AddDialogButton( dialogData, "#DISMISS" )
 
@@ -982,8 +1129,8 @@ void function OnServerSelected( var button )
 		else
 		{
 			// this uses semver https://semver.org
-			array<string> serverModVersion = split( mod.name, "." )
-			array<string> clientModVersion = split( NSGetModVersionByModName( mod.name ), "." )
+			array<string> serverModVersion = split( modVersion, "." )
+			array<string> clientModVersion = split( NSGetModVersionByModName( modName ), "." )
 
 			bool semverFail = false
 			// if server has invalid semver don't bother checking
@@ -1001,7 +1148,7 @@ void function OnServerSelected( var button )
 			{
 				DialogData dialogData
 				dialogData.header = "#ERROR"
-				dialogData.message = format( "Server has mod \"%s\" v%s while we have v%s", mod.name, mod.version, NSGetModVersionByModName( mod.name ) )
+				dialogData.message = format( "Server has mod \"%s\" v%s while we have v%s", modName, modVersion, NSGetModVersionByModName( mod.name ) )
 				dialogData.image = $"ui/menu/common/dialog_error"
 
 				#if PC_PROG
@@ -1018,6 +1165,13 @@ void function OnServerSelected( var button )
 		}
 	}
 
+	// Make Northstar aware new mods have been added
+	if ( downloadedMods > 0 )
+	{
+		print("Some new mods have been downloaded or enabled, reloading mods.")
+		NSReloadMods();
+	}
+
 	if ( server.requiresPassword )
 	{
 		OnCloseServerBrowserMenu()