Update favorite maps to use SHA1 instead of map name (CnCNet#839)

Author: 11EJDE11

ClientCore/Settings/UserINISettings.cs

@@ -318,14 +318,15 @@ public int GetValue(string section, string key, int defaultValue)
         public bool IsGameFollowed(string gameName)
             => SettingsIni.GetBooleanValue("Channels", gameName, false);
 
-        public bool ToggleFavoriteMap(string mapName, string gameModeName, bool isFavorite)
+        public bool ToggleFavoriteMap(string mapSHA1, string gameModeName, bool isFavorite)
         {
-            if (string.IsNullOrEmpty(mapName))
+            if (string.IsNullOrEmpty(mapSHA1))
                 return isFavorite;
 
-            string favoriteMapKey = FavoriteMapKey(mapName, gameModeName);
-            isFavorite = IsFavoriteMap(mapName, gameModeName);
-            if (isFavorite)
+            string favoriteMapKey = FavoriteMapKey(mapSHA1, gameModeName);
+
+            bool isCurrentlyFavorite = FavoriteMaps.Contains(favoriteMapKey);
+            if (isCurrentlyFavorite)
                 FavoriteMaps.Remove(favoriteMapKey);
             else
                 FavoriteMaps.Add(favoriteMapKey);
@@ -334,7 +335,7 @@ public bool ToggleFavoriteMap(string mapName, string gameModeName, bool isFavori
 
             WriteFavoriteMaps();
 
-            return !isFavorite;
+            return !isCurrentlyFavorite;
         }
 
         private void LoadFavoriteMaps(IniFile iniFile)
@@ -349,7 +350,7 @@ private void LoadFavoriteMaps(IniFile iniFile)
                 WriteFavoriteMaps();
         }
 
-        private void WriteFavoriteMaps()
+        public void WriteFavoriteMaps()
         {
             var favoriteMapsSection = SettingsIni.GetOrAddSection(FAVORITE_MAPS);
             favoriteMapsSection.RemoveAllKeys();
@@ -361,12 +362,41 @@ private void WriteFavoriteMaps()
 
         /// <summary>
         /// Checks if a specified map name and game mode name belongs to the favorite map list.
+        /// Name-based favorites are migrated to SHA1.
         /// </summary>
-        /// <param name="nameName">The name of the map.</param>
-        /// <param name="gameModeName">The name of the game mode</param>
-        public bool IsFavoriteMap(string nameName, string gameModeName) => FavoriteMaps.Contains(FavoriteMapKey(nameName, gameModeName));
+        /// <param name="mapSHA1">The SHA1 hash of the map.</param>
+        /// <param name="mapName">The name of the map.</param>
+        /// <param name="gameModeName">The name of the game mode.</param>
+        public bool IsFavoriteMap(string mapSHA1, string mapName, string gameModeName)
+        {
+            // SHA1-based lookup first
+            if (!string.IsNullOrEmpty(mapSHA1) && FavoriteMaps.Contains(FavoriteMapKey(mapSHA1, gameModeName)))
+                return true;
+
+            // Fallback to name-based
+            string nameKey = FavoriteMapKey(mapName, gameModeName);
+            if (FavoriteMaps.Contains(nameKey))
+            {
+                // Migrate to SHA1
+                if (!string.IsNullOrEmpty(mapSHA1))
+                {
+                    string sha1Key = FavoriteMapKey(mapSHA1, gameModeName);
+                    if (!FavoriteMaps.Contains(sha1Key))
+                    {
+                        FavoriteMaps.Add(sha1Key);
+                        WriteFavoriteMaps();
+                    }
+                    // Note: We don't remove the name-based entry here to allow other maps
+                    // with the same name to also migrate. The name-based entry will be
+                    // cleaned up when all maps with that name have been processed.
+                }
+                return true;
+            }
+
+            return false;
+        }
 
-        private string FavoriteMapKey(string nameName, string gameModeName) => $"{nameName}:{gameModeName}";
+        private string FavoriteMapKey(string identifier, string gameModeName) => $"{identifier}:{gameModeName}";
 
         public void ReloadSettings() => SettingsIni.Reload();
 

DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyBase.cs

@@ -783,7 +783,7 @@ protected virtual void ToggleFavoriteMap()
         {
             if (GameModeMap != null)
             { 
-                GameModeMap.IsFavorite = UserINISettings.Instance.ToggleFavoriteMap(Map.UntranslatedName, GameMode.Name, GameModeMap.IsFavorite);
+                GameModeMap.IsFavorite = UserINISettings.Instance.ToggleFavoriteMap(Map.SHA1, GameMode.Name, GameModeMap.IsFavorite);
                 MapPreviewBox.RefreshFavoriteBtn();
             }
         }

DXMainClient/DXGUI/Multiplayer/GameLobby/MapPreviewBox.cs

@@ -523,7 +523,7 @@ private void UpdateMap()
 
         public void RefreshFavoriteBtn()
         {
-            bool isFav = UserINISettings.Instance.IsFavoriteMap(GameModeMap?.Map.UntranslatedName, GameModeMap?.GameMode.Name);
+            bool isFav = UserINISettings.Instance.IsFavoriteMap(GameModeMap?.Map.SHA1, GameModeMap?.Map.UntranslatedName, GameModeMap?.GameMode.Name);
             var textureName = isFav ? "favActive.png" : "favInactive.png";
             var hoverTextureName = isFav ? "favActive_c.png" : "favInactive_c.png";
             var hoverTexture = AssetLoader.AssetExists(hoverTextureName) ? AssetLoader.LoadTexture(hoverTextureName) : null;

DXMainClient/Domain/Multiplayer/GameModeMapCollection.cs

@@ -8,7 +8,7 @@ public class GameModeMapCollection : List<GameModeMap>
     {
         public GameModeMapCollection(IEnumerable<GameMode> gameModes) :
             base(gameModes.SelectMany(gm => gm.Maps.Select(map =>
-                new GameModeMap(gm, map, UserINISettings.Instance.IsFavoriteMap(map.UntranslatedName, gm.Name)))).Distinct())
+                new GameModeMap(gm, map, UserINISettings.Instance.IsFavoriteMap(map.SHA1, map.UntranslatedName, gm.Name)))).Distinct())
         {
         }
 

DXMainClient/Domain/Multiplayer/MapLoader.cs

@@ -110,6 +110,9 @@ public void LoadMaps()
             GameModes.RemoveAll(g => g.Maps.Count < 1);
             GameModeMaps = new GameModeMapCollection(GameModes);
 
+            // Clean up any name-based favorite entries after migration (legacy: changed from name to sha1)
+            CleanupMigratedFavorites();
+
             MapLoadingComplete?.Invoke(this, EventArgs.Empty);
         }
 
@@ -611,5 +614,49 @@ private void AddMapToGameModes(Map map, bool enableLogging)
                 }
             }
         }
+
+        /// <summary>
+        /// Removes any name-based favorite entries that have been successfully migrated to SHA1.
+        /// This runs after all maps have been processed to ensure complete migration.
+        /// </summary>
+        private void CleanupMigratedFavorites()
+        {
+            var favoriteMaps = UserINISettings.Instance.FavoriteMaps;
+            if (favoriteMaps == null || !favoriteMaps.Any())
+                return;
+
+            var entriesToRemove = new List<string>();
+
+            foreach (string favoriteKey in favoriteMaps)
+            {
+                string[] parts = favoriteKey.Split(':');
+                if (parts.Length != 2)
+                    continue;
+
+                string mapName = parts[0];
+                string gameModeName = parts[1];
+
+                // Check if there's a corresponding SHA1-based entry for any map with this name
+                var gameMode = GameModes.FirstOrDefault(gm => gm.Name == gameModeName);
+                if (gameMode != null)
+                {
+                    bool hasMigratedVersion = gameMode.Maps
+                        .Where(m => m.UntranslatedName == mapName)
+                        .Any(m => favoriteMaps.Contains($"{m.SHA1}:{gameModeName}"));
+
+                    if (hasMigratedVersion)
+                        entriesToRemove.Add(favoriteKey);
+                }
+            }
+
+            // Remove the name-based entries
+            if (entriesToRemove.Any())
+            {
+                foreach (string entry in entriesToRemove)
+                    favoriteMaps.Remove(entry);
+
+                UserINISettings.Instance.WriteFavoriteMaps();
+            }
+        }
     }
 }