[Genshin] Use Sophon as reference for File Cleanup

neon-nyan · neon-nyan · commit e33da83156e8 · 2025-05-08T19:43:22.000+07:00
diff --git a/CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.SophonPatch.cs b/CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.SophonPatch.cs
@@ -77,7 +77,7 @@ await branchResources.EnsureReassociated(httpClient,
                 await SophonPatch.CreateSophonChunkManifestInfoPair(httpClient,
                                                                     url: branchResources.PatchUrl,
                                                                     versionUpdateFrom: requestedVersionFrom.Value.VersionString,
-                                                                    matchingField: GameVersionManager.GamePreset.LauncherResourceChunksURL.MainBranchMatchingField,
+                                                                    matchingField: branchResources.MainBranchMatchingField,
                                                                     token: Token.Token);
 
             // If the patch metadata is not found, then return false and back to old compare method
diff --git a/CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.cs b/CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.cs
@@ -65,6 +65,7 @@
 using ZipArchive = SharpCompress.Archives.Zip.ZipArchive;
 using ZipArchiveEntry = SharpCompress.Archives.Zip.ZipArchiveEntry;
 // ReSharper disable SwitchStatementMissingSomeEnumCasesNoDefault
+#pragma warning disable CS8777 // Parameter must have a non-null value when exiting.
 #endif
 
 // ReSharper disable ForCanBeConvertedToForeach
@@ -2138,15 +2139,23 @@ protected virtual int GetIDByLanguageLocaleCode([NotNull] string? localeCode)
                    };
         }
 
-        protected virtual string GetLanguageStringByLocaleCode([NotNull] string? localeCode)
+        protected virtual string GetLanguageStringByLocaleCode([NotNull] string? localeCode, bool throwIfInvalid =
+#if DEBUG
+            true
+#else
+            false
+#endif
+            )
         {
             return localeCode switch
                    {
                        "zh-cn" => "Chinese",
                        "en-us" => "English(US)",
                        "ja-jp" => "Japanese",
                        "ko-kr" => "Korean",
-                       _ => throw new KeyNotFoundException($"Locale code: {localeCode} is not supported!")
+                       _ => throwIfInvalid
+                           ? throw new NotSupportedException($"This locale code: {localeCode} is not supported")
+                           : string.Empty
                    };
         }
 
@@ -2365,7 +2374,7 @@ protected virtual void WriteAudioLangList(List<GameInstallPackage> gamePackage)
                 sw.WriteLine(langString);
             }
         }
-        #endregion
+#endregion
 
         #region Private Methods - GetInstallationPath
         private async ValueTask<int> CheckExistingBHI3LInstallation(bool isHasOnlyMigrateOption = false)
@@ -2696,7 +2705,7 @@ private bool TryGetExistingSteamPath(ref string OutputPath)
             }
 
             List<AppInfo> steamAppList = SteamTool.GetSteamApps(steamLibsList);
-        #nullable enable
+#nullable enable
             AppInfo? steamAppInfo = steamAppList.FirstOrDefault(x => x.Id == steamID);
 
             // If the app info is not null, then assign OutputPath to the game path
@@ -2707,14 +2716,14 @@ private bool TryGetExistingSteamPath(ref string OutputPath)
 
             OutputPath = steamAppInfo.GameRoot;
             return true;
-        #nullable disable
+#nullable disable
 
             // If none of them has it, then return false
         }
 
         private bool TryGetExistingBHI3LPath(ref string OutputPath)
         {
-        #nullable enable
+#nullable enable
             // If the preset doesn't have BetterHi3Launcher registry ver info, then return false
             if (GameVersionManager.GamePreset.BetterHi3LauncherVerInfoReg == null)
             {
@@ -2840,7 +2849,7 @@ private async Task GetLatestPackageList(List<GameInstallPackage> packageList, Ga
             }
         }
 
-    #nullable enable
+#nullable enable
         protected virtual void TryAddPluginPackage(List<GameInstallPackage> assetList)
         {
             const string pluginKeyStart = "plugin_";
@@ -2910,7 +2919,7 @@ protected virtual void TryAddPluginPackage(List<GameInstallPackage> assetList)
                 assetList.Add(new GameInstallPackage(pluginResource.Value, GamePath));
             }
         }
-    #nullable restore
+#nullable restore
 
         private async ValueTask<int> CheckExistingOrAskFolderDialog()
         {
@@ -2939,7 +2948,7 @@ private async ValueTask<int> CheckExistingOrAskFolderDialog()
 
         #region Virtual Methods - GetInstallationPath
 
-    #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
         protected virtual async ValueTask TryAddResourceVersionList(RegionResourceVersion    asset,
                                                                     List<GameInstallPackage> packageList,
                                                                     bool                     isSkipMainPackage = false)
@@ -3067,7 +3076,7 @@ protected virtual async ValueTask AddMainResourceVersionList(RegionResourceVersi
                 }
             }
         }
-    #pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
+#pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
 
         protected virtual async ValueTask TryAddOtherInstalledVoicePacks(
             List<RegionResourceVersion> packs, List<GameInstallPackage> packageList, string assetVersion)
@@ -3486,7 +3495,7 @@ private async ValueTask CheckDriveFreeSpace(List<GameInstallPackage> packageList
             LogWriteLine($"Total free space required: {ConverterTool.SummarizeSizeSimple(remainedDownloadUncompressed)} remained to be downloaded (Total: {ConverterTool.SummarizeSizeSimple(requiredSpaceUncompressed)}) with {driveInfo.Name} remaining free space: {ConverterTool.SummarizeSizeSimple(diskFreeSpace)}",
                          LogType.Default, true);
 
-        #if DEBUG
+#if DEBUG
             double diskSpaceGb = Math.Round(ConverterTool.SummarizeSizeDouble(Convert.ToDouble(diskFreeSpace), 3), 4);
             double requiredSpaceGb = Convert.ToDouble(requiredSpaceUncompressed / (1L << 30));
             double existingPackageSizeGb = Convert.ToDouble(sizeDownloaded / (1L << 30));
@@ -3505,7 +3514,7 @@ private async ValueTask CheckDriveFreeSpace(List<GameInstallPackage> packageList
                          LogType.Debug);
             LogWriteLine($"Remaining Package Download Size (Compressed Size)(GB): {remainingDownloadSizeGb}",
                          LogType.Debug);
-        #endif
+#endif
 
             if (diskFreeSpace < remainedDownloadUncompressed)
             {
@@ -3550,9 +3559,9 @@ public void UpdateCompletenessStatus(CompletenessStatus status)
                     Status.IsRunning   = true;
                     Status.IsCompleted = false;
                     Status.IsCanceled  = false;
-                    #if !DISABLEDISCORD
+#if !DISABLEDISCORD
                     InnerLauncherConfig.AppDiscordPresence?.SetActivity(ActivityType.Update);
-                    #endif
+#endif
                     break;
                 case CompletenessStatus.Completed:
                     IsRunning          = false;
@@ -3561,9 +3570,9 @@ public void UpdateCompletenessStatus(CompletenessStatus status)
                     Status.IsCanceled  = false;
                     Status.IsProgressAllIndetermined = false;
                     Status.IsProgressPerFileIndetermined = false;
-                    #if !DISABLEDISCORD
+#if !DISABLEDISCORD
                     InnerLauncherConfig.AppDiscordPresence?.SetActivity(ActivityType.Idle);
-                    #endif
+#endif
                     // HACK: Fix the progress not achieving 100% while completed
                     lock (Progress)
                     {
@@ -3578,9 +3587,9 @@ public void UpdateCompletenessStatus(CompletenessStatus status)
                     Status.IsCanceled  = true;
                     Status.IsProgressAllIndetermined = false;
                     Status.IsProgressPerFileIndetermined = false;
-                    #if !DISABLEDISCORD
+#if !DISABLEDISCORD
                     InnerLauncherConfig.AppDiscordPresence?.SetActivity(ActivityType.Idle);
-                    #endif
+#endif
                     break;
                 case CompletenessStatus.Idle:
                     IsRunning          = false;
@@ -3589,9 +3598,9 @@ public void UpdateCompletenessStatus(CompletenessStatus status)
                     Status.IsCanceled  = false;
                     Status.IsProgressAllIndetermined = false;
                     Status.IsProgressPerFileIndetermined = false;
-                    #if !DISABLEDISCORD
+#if !DISABLEDISCORD
                     InnerLauncherConfig.AppDiscordPresence?.SetActivity(ActivityType.Idle);
-                    #endif
+#endif
                     break;
             }
 
diff --git a/CollapseLauncher/Classes/InstallManagement/Genshin/GenshinInstall.PkgVersion.cs b/CollapseLauncher/Classes/InstallManagement/Genshin/GenshinInstall.PkgVersion.cs
@@ -0,0 +1,170 @@
+﻿using CollapseLauncher.Helper.Metadata;
+using CollapseLauncher.Helper.StreamUtility;
+using CollapseLauncher.Interfaces;
+using Hi3Helper;
+using Hi3Helper.EncTool.Parser.AssetIndex;
+using Hi3Helper.Http;
+using Hi3Helper.Sophon;
+using Hi3Helper.Sophon.Structs;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+// ReSharper disable IdentifierTypo
+// ReSharper disable CommentTypo
+// ReSharper disable StringLiteralTypo
+
+namespace CollapseLauncher.InstallManager.Genshin;
+
+#nullable enable
+internal sealed partial class GenshinInstall
+{
+    protected override async Task<string> DownloadPkgVersion(DownloadClient downloadClient, RegionResourceVersion? packageLatestBase)
+    {
+        const string errorRaiseMsg = "Please raise this issue to our Github Repo or Official Discord";
+
+        // Note:
+        // Starting from Genshin 5.6 update, HoYo removed ScatteredFiles alongside Zip packages.
+        // This cause the pkg_version to be unavailable. As for alternative, we are replacing it
+        // by making a fake JSON response of pkg_version by fetching references from Sophon manifest.
+
+        // Get GameVersionManager and GamePreset
+        IGameVersion     gameVersion     = GameVersionManager;
+        PresetConfig     gamePreset      = gameVersion.GamePreset;
+        SophonChunkUrls? branchResources = gamePreset.LauncherResourceChunksURL;
+
+        // If branchResources is null, throw
+        if (branchResources == null)
+        {
+            throw new InvalidOperationException("Branch resources are unavailable! " + errorRaiseMsg);
+        }
+
+        // Try to get client and manifest info pair
+        HttpClient client = downloadClient.GetHttpClient();
+        SophonChunkManifestInfoPair manifestInfoPair = await SophonManifest
+            .CreateSophonChunkManifestInfoPair(client,
+                                               branchResources.MainUrl,
+                                               branchResources.MainBranchMatchingField,
+                                               Token.Token);
+
+        // Throw if main manifest pair is not found
+        if (!manifestInfoPair.IsFound)
+        {
+            throw new InvalidOperationException($"Sophon main manifest info pair is not found! " + errorRaiseMsg);
+        }
+
+        // Get the existing voice-over matching fields
+        List<string> availableVaMatchingFields = [];
+        await GetVoiceOverPkgVersionMatchingFields(availableVaMatchingFields);
+
+        // If any, then create them
+        if (availableVaMatchingFields.Count != 0)
+        {
+            foreach (var field in availableVaMatchingFields)
+            {
+                SophonChunkManifestInfoPair voManifestInfoPair = manifestInfoPair.GetOtherManifestInfoPair(field);
+                if (!voManifestInfoPair.IsFound)
+                {
+                    throw new InvalidOperationException($"Sophon voice-over manifest info pair for field: {field} is not found! " + errorRaiseMsg);
+                }
+
+                string languageString = GetLanguageStringByLocaleCode(field);
+                await CreateFakePkgVersionFromSophon(client,
+                                                     voManifestInfoPair,
+                                                     $"Audio_{languageString}_pkg_version",
+                                                     Token.Token);
+            }
+        }
+
+        // Create the main pkg_version
+        await CreateFakePkgVersionFromSophon(client,
+                                             manifestInfoPair,
+                                             "pkg_version",
+                                             Token.Token);
+
+        // Return the main pkg_version path
+        return Path.Combine(GamePath, "pkg_version");
+    }
+
+    private async Task CreateFakePkgVersionFromSophon(HttpClient                  client,
+                                                      SophonChunkManifestInfoPair manifestPair,
+                                                      string                      pkgVersionFilename,
+                                                      CancellationToken           token)
+    {
+        // Ensure and try to create examine FileInfo
+        string filePath = Path.Combine(GamePath, pkgVersionFilename);
+        FileInfo fileInfo = new FileInfo(filePath)
+                           .EnsureCreationOfDirectory()
+                           .EnsureNoReadOnly();
+
+        // Create file stream
+        await using FileStream stream = fileInfo.Create();
+
+        // Start enumerate the SophonAsset
+        byte[] newLineBytes = "\r\n"u8.ToArray();
+        await foreach (SophonAsset assetInfo in SophonManifest.EnumerateAsync(client,
+                                                                              manifestPair,
+                                                                              null,
+                                                                              token))
+        {
+            // Ignore stock pkg_version
+            if (assetInfo.AssetName.EndsWith("pkg_version", StringComparison.OrdinalIgnoreCase))
+            {
+                continue;
+            }
+
+            // Create pkg_version entry
+            PkgVersionProperties pkgVersionEntry = new PkgVersionProperties
+            {
+                remoteName = assetInfo.AssetName,
+                md5        = assetInfo.AssetHash,
+                fileSize   = assetInfo.AssetSize
+            };
+
+            // Serialize and write to stream
+            await pkgVersionEntry.SerializeAsync(stream, CoreLibraryJsonContext.Default.PkgVersionProperties, token);
+            await stream.WriteAsync(newLineBytes, token);
+        }
+    }
+
+    private async Task GetVoiceOverPkgVersionMatchingFields(List<string> matchingFields)
+    {
+        // Try to get audio lang list file and if null, ignore
+        string audioLangListPath = _gameAudioLangListPathStatic;
+        if (string.IsNullOrEmpty(audioLangListPath))
+        {
+            return;
+        }
+
+        // Try get existing audio lang file. If it doesn't exist, ignore
+        FileInfo audioLangFile = new FileInfo(audioLangListPath);
+        if (!audioLangFile.Exists)
+        {
+            return;
+        }
+
+        // Open the file and read the content
+        await using FileStream audioLangFileStream = audioLangFile.OpenRead();
+        using StreamReader reader = new StreamReader(audioLangFileStream);
+        while (await reader.ReadLineAsync(Token.Token) is { } line)
+        {
+            // Get locale code to be used as Sophon Manifest field later
+            string? currentLocaleId = GetLanguageLocaleCodeByLanguageString(line
+#if !DEBUG
+                , false
+#endif
+                );
+
+            // If it's empty or invalid, go to next line
+            if (string.IsNullOrEmpty(currentLocaleId))
+            {
+                continue;
+            }
+
+            // Otherwise, Add the field to the list
+            matchingFields.Add(currentLocaleId);
+        }
+    }
+}
diff --git a/Hi3Helper.Core/Classes/Shared/ClassStruct/Class/GameDataStructure.cs b/Hi3Helper.Core/Classes/Shared/ClassStruct/Class/GameDataStructure.cs
@@ -36,8 +36,10 @@ public string CRC
         public string                  M                 { get; set; }
         public FileType                FT                { get; set; }
         public List<XMFBlockList>      BlkC              { get; set; }
+#nullable enable
         public ManifestAudioPatchInfo? AudioPatchInfo    { get; set; }
         public BlockPatchInfo?         BlockPatchInfo    { get; set; }
+#nullable restore
         public long                    S                 { get; set; }
         public bool                    IsPatchApplicable { get; set; }
         public bool                    IsBlockNeedRepair { get; set; }
diff --git a/Hi3Helper.EncTool b/Hi3Helper.EncTool
@@ -1 +1 @@
-Subproject commit 7939ed72fc88184f67f4ede2935fe50300f24bfb
+Subproject commit db6818a3342068b1211ba24d86ea9e41840b3898
