[Sophon] Add API on SophonPatch, Reverts and Refactors

+ Adding SophonPatch.EnumerateRemovableAsync()
+ Refactor SophonPatch.EnumerateUpdateAsync() on how to enumerating assets.
  > Assets with SophonPatchMethod.Remove will no longer be enumerated. Instead, use SophonPatch.EnumerateRemovableAsync() to enumerate them.
  > Remove unused re-enumeration on async SophonPatch.SophonPatch.EnumerateUpdateAsync() overloads.
  > Accepts assets with no patch available
  > This due to changes on how Sophon for ZZZ behaves. The files won't always be indexed if the next version has no changes to that files. But this comes with a risk of that files being ignored (or no longer being downloaded). So instead of indexing from its patch info manifest counterparts, we changed the source to its main info manifest instead.
+ Fix the update mechanism mistakenly removed old, but still in use files.

Author: neon-nyan

CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.Sophon.cs

@@ -249,7 +249,7 @@ await GameVersionManager.GamePreset
                                                                              Token.Token);
 
                         // Ensure that the manifest is ordered based on _gameVoiceLanguageLocaleIdOrdered
-                        RearrangeDataListLocaleOrder(sophonMainInfoPair.OtherSophonBuildData.ManifestIdentityList,
+                        RearrangeDataListLocaleOrder(sophonMainInfoPair.OtherSophonBuildData!.ManifestIdentityList,
                                                      x => x.MatchingField);
 
                         // Add the manifest to the pair list
@@ -356,8 +356,8 @@ await SimpleDialogs.Dialog_ChooseAudioLanguageChoice(
                             Token.Token);
 
                         // Get the remote total size and current total size
-                        ProgressAllCountTotal  = sophonInfoPairList.Sum(x => x.ChunksInfo.FilesCount);
-                        ProgressAllSizeTotal   = sophonInfoPairList.Sum(x => x.ChunksInfo.TotalSize);
+                        ProgressAllCountTotal  = sophonInfoPairList.Sum(x => x.ChunksInfo!.FilesCount);
+                        ProgressAllSizeTotal   = sophonInfoPairList.Sum(x => x.ChunksInfo!.TotalSize);
                         ProgressAllSizeCurrent = 0;
 
                         // Check for the disk space requirement first and ensure that the space is sufficient
@@ -501,7 +501,7 @@ private async Task<List<SophonAsset>> GetSophonAssetListFromPair(
             foreach (SophonChunkManifestInfoPair sophonDownloadInfoPair in sophonInfoPairs)
             {
                 // Try add and if the hashset already contains the same Manifest ID registered, then skip
-                if (!currentlyProcessedPair.Add(sophonDownloadInfoPair.ManifestInfo.ManifestId))
+                if (!currentlyProcessedPair.Add(sophonDownloadInfoPair.ManifestInfo!.ManifestId))
                 {
                     Logger.LogWriteLine($"Found duplicate operation for {sophonDownloadInfoPair.ManifestInfo.ManifestId}! Skipping...",
                                         LogType.Warning, true);
@@ -542,9 +542,9 @@ protected async Task ConfirmAdditionalInstallDataPackageFiles(
                 return;
             }
 
-            List<string> matchingFieldsList = installManifest.Select(x => x.MatchingField).ToList();
+            List<string> matchingFieldsList = installManifest.Select(x => x.MatchingField).ToList()!;
 
-            List<SophonManifestBuildIdentity> otherManifestIdentity = installManifestFirst.OtherSophonBuildData.ManifestIdentityList
+            List<SophonManifestBuildIdentity> otherManifestIdentity = installManifestFirst.OtherSophonBuildData!.ManifestIdentityList
                .Where(x => !commonPackageMatchingFields.Contains(x.MatchingField, StringComparer.OrdinalIgnoreCase))
                .ToList();
 
@@ -1027,7 +1027,7 @@ private async Task TryGetAdditionalPackageForSophonDiff(HttpClient
                 return;
             }
 
-            List<string> additionalPackageMatchingFields = manifestPair.OtherSophonBuildData.ManifestIdentityList
+            List<string> additionalPackageMatchingFields = manifestPair.OtherSophonBuildData!.ManifestIdentityList
                .Where(x => !CommonSophonPackageMatchingFields.Contains(x.MatchingField, StringComparer.OrdinalIgnoreCase))
                .Select(x => x.MatchingField)
                .ToList();
@@ -1081,13 +1081,13 @@ private async Task<bool> AddSophonDiffAssetsToList(HttpClient                 ht
                 return false;
             }
 
-            RearrangeDataListLocaleOrder(requestPairTo.OtherSophonBuildData.ManifestIdentityList,
+            RearrangeDataListLocaleOrder(requestPairTo.OtherSophonBuildData!.ManifestIdentityList,
                                          x => x.MatchingField);
 
             if (requestPairFrom.IsFound)
             {
                 // Ensure that the manifest is ordered based on _gameVoiceLanguageLocaleIdOrdered
-                RearrangeDataListLocaleOrder(requestPairFrom.OtherSophonBuildData.ManifestIdentityList,
+                RearrangeDataListLocaleOrder(requestPairFrom.OtherSophonBuildData!.ManifestIdentityList,
                                              x => x.MatchingField);
 
                 // Add asset to the list

CollapseLauncher/Classes/InstallManagement/Base/InstallManagerBase.SophonPatch.cs

@@ -108,7 +108,7 @@ await SophonPatch.CreateSophonChunkManifestInfoPair(httpClient,
                 SophonDownloadSpeedLimiter.CreateInstance(LauncherConfig.DownloadSpeedLimitCached);
 
             // Get the patch assets to download
-            (List<SophonPatchAsset>, List<SophonChunkManifestInfoPair>) patchAssets =
+            (List<SophonPatchAsset> AssetList, List<SophonChunkManifestInfoPair> InfoPairs, bool IsAllowRemoveOldFile) patchAssets =
                 await GetAlterSophonPatchAssets(httpClient,
                                                 branchResources.PatchUrl,
                                                 (isPreloadMode ? branchResources.PreloadUrl : branchResources.MainUrl) ?? "",
@@ -120,8 +120,9 @@ await GetAlterSophonPatchAssets(httpClient,
             // Start the patch pipeline
             await StartAlterSophonPatch(httpClient,
                                         isPreloadMode,
-                                        patchAssets.Item1,
-                                        patchAssets.Item2,
+                                        patchAssets.AssetList,
+                                        patchAssets.InfoPairs,
+                                        patchAssets.IsAllowRemoveOldFile,
                                         downloadSpeedLimiter,
                                         maxThread,
                                         Token.Token);
@@ -135,7 +136,7 @@ protected virtual async Task ConfirmAdditionalPatchDataPackageFiles(SophonChunkM
         {
             string currentVersion = GameVersion.ToString();
 
-            List<SophonManifestPatchIdentity> otherManifestIdentity = patchManifest.OtherSophonPatchData.ManifestIdentityList
+            List<SophonManifestPatchIdentity> otherManifestIdentity = patchManifest.OtherSophonPatchData!.ManifestIdentityList
                                                                                    .Where(x => !CommonSophonPackageMatchingFields.Contains(x.MatchingField, StringComparer.OrdinalIgnoreCase))
                                                                                    .ToList();
 
@@ -303,7 +304,7 @@ protected async Task<bool> SpawnAdditionalPackageDownloadDialog(long baseDownloa
             return confirmAdditionalTag == ContentDialogResult.Primary;
         }
 
-        protected virtual async Task<(List<SophonPatchAsset>, List<SophonChunkManifestInfoPair>)>
+        protected virtual async Task<(List<SophonPatchAsset> AssetList, List<SophonChunkManifestInfoPair> InfoPairs, bool IsAllowRemoveOldFile)>
             GetAlterSophonPatchAssets(HttpClient httpClient,
                                       string manifestUrl,
                                       string downloadOverUrl,
@@ -315,6 +316,7 @@ protected async Task<bool> SpawnAdditionalPackageDownloadDialog(long baseDownloa
             SophonChunkManifestInfoPair?      rootPatchManifest = null;
             SophonChunkManifestInfoPair?      rootMainManifest  = null;
             List<(SophonChunkManifestInfoPair Patch, SophonChunkManifestInfoPair Main, bool IsCommon)> patchManifestList = [];
+            bool isAlowRemoveOldFile = true;
 
             // Iterate matching fields and get the patch metadata
             foreach (string matchingField in matchingFields)
@@ -344,6 +346,7 @@ protected async Task<bool> SpawnAdditionalPackageDownloadDialog(long baseDownloa
                     Logger.LogWriteLine($"[InstallManagerBase::GetAlterSophonPatchAssets] Cannot find past-version patch manifest for matching field: {matchingField}, Skipping!",
                                         LogType.Warning,
                                         true);
+                    isAlowRemoveOldFile = false;
                     continue;
                 }
 
@@ -370,18 +373,38 @@ protected async Task<bool> SpawnAdditionalPackageDownloadDialog(long baseDownloa
             {
                 // Get the asset and add it to the list
                 await foreach (SophonPatchAsset patchAsset in SophonPatch
-                    .EnumerateUpdateAsync(httpClient,
-                                          manifestPair.Patch,
-                                          manifestPair.Main,
-                                          updateVersionfrom,
-                                          downloadLimiter,
-                                          token))
+                                  .EnumerateUpdateAsync(httpClient,
+                                                        manifestPair.Patch,
+                                                        manifestPair.Main,
+                                                        updateVersionfrom,
+                                                        downloadLimiter,
+                                                        token))
                 {
                     patchAssets.Add(patchAsset);
                 }
             }
 
-            return (patchAssets, patchManifestList.Select(x => x.Patch).ToList());
+            // Find the removable assets and compare with the added list.
+            List<SophonPatchAsset> removableAssets = [];
+            foreach (var manifestPair in patchManifestList)
+            {
+                // Get the asset and add it to the list
+                await foreach (SophonPatchAsset patchAsset in SophonPatch
+                                  .EnumerateRemovableAsync(httpClient,
+                                                           manifestPair.Patch,
+                                                           manifestPair.Main,
+                                                           updateVersionfrom,
+                                                           patchAssets,
+                                                           token))
+                {
+                    removableAssets.Add(patchAsset);
+                }
+            }
+
+            // Add the removable list to patch assets.
+            patchAssets.AddRange(removableAssets);
+
+            return (patchAssets, patchManifestList.Select(x => x.Patch).ToList(), isAlowRemoveOldFile);
         }
 
         protected virtual async Task<List<string>> GetAlterSophonPatchVOMatchingFields(CancellationToken token)
@@ -409,13 +432,14 @@ protected virtual async Task<List<string>> GetAlterSophonPatchVOMatchingFields(C
             return voAudioMatchingFields;
         }
 
-        protected virtual async Task StartAlterSophonPatch(HttpClient httpClient,
-                                                           bool isPreloadMode,
-                                                           List<SophonPatchAsset> patchAssets,
+        protected virtual async Task StartAlterSophonPatch(HttpClient                        httpClient,
+                                                           bool                              isPreloadMode,
+                                                           List<SophonPatchAsset>            patchAssets,
                                                            List<SophonChunkManifestInfoPair> patchManifestInfoPairs,
-                                                           SophonDownloadSpeedLimiter downloadLimiter,
-                                                           int threadNum,
-                                                           CancellationToken token)
+                                                           bool                              isAllowRemoveOldFile,
+                                                           SophonDownloadSpeedLimiter        downloadLimiter,
+                                                           int                               threadNum,
+                                                           CancellationToken                 token)
         {
             Dictionary<string, int> downloadedPatchHashSet = new();
             Lock dictionaryLock = new();
@@ -556,7 +580,7 @@ async ValueTask ImplPatchUpdate(Tuple<SophonPatchAsset, Dictionary<string, int>>
                 await patchAsset.ApplyPatchUpdateAsync(httpClient,
                                                        GamePath,
                                                        patchOutputDir,
-                                                       true,
+                                                       isAllowRemoveOldFile,
                                                        read =>
                                                        {
                                                            UpdateSophonFileDownloadProgress(0, read);