Fix UTF-8 with BOM is introduced in the generated spawnmap.ini file (CnCNet#738)

* Fix UTF-8 BOM is introduced in the generated spawnmap.ini file

* Provide UTF-8 without BOM encoding into EncodingExt class

Author: SadPencil

ClientCore/FileHelper.cs

@@ -8,6 +8,7 @@
 using System.Threading.Tasks;
 
 using ClientCore.Extensions;
+using ClientCore.PlatformShim;
 
 using Rampastring.Tools;
 
@@ -91,17 +92,22 @@ public static void CreateHardLinkFromSource(string source, string destination, b
             }
         }
 
-        public static Encoding GetEncoding(string filename)
+        public static Encoding GetEncoding(string filename, float minimalConfidence = 0.5f)
         {
-            Encoding encoding = new UTF8Encoding(false);
+            Encoding encoding = EncodingExt.UTF8NoBOM;
 
             using (FileStream fs = File.OpenRead(filename))
             {
                 Ude.CharsetDetector cdet = new Ude.CharsetDetector();
                 cdet.Feed(fs);
                 cdet.DataEnd();
-                if (cdet.Charset != null)
-                    encoding = Encoding.GetEncoding(cdet.Charset);
+                if (cdet.Charset != null && cdet.Confidence > minimalConfidence)
+                {
+                    Encoding detectedEncoding = Encoding.GetEncoding(cdet.Charset);
+
+                    if (detectedEncoding is not UTF8Encoding and not ASCIIEncoding)
+                        encoding = detectedEncoding;
+                }
             }
 
             return encoding;

ClientCore/PlatformShim/EncodingExt.cs

@@ -16,4 +16,6 @@ static EncodingExt()
     /// ANSI doesn't mean a specific codepage, it means the default non-Unicode codepage which can be changed from Control Panel.
     /// </summary>
     public static Encoding ANSI { get; }
+
+    public static Encoding UTF8NoBOM { get; } = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 }

DXMainClient/DXGUI/Multiplayer/GameLobby/MapCodeHelper.cs

@@ -1,8 +1,13 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
+
 using ClientCore;
+using ClientCore.PlatformShim;
+
 using DTAClient.Domain.Multiplayer;
+
 using Rampastring.Tools;
 
 namespace DTAClient.DXGUI.Multiplayer.GameLobby
@@ -17,14 +22,20 @@ public static class MapCodeHelper
         /// <param name="gameMode">Currently selected gamemode, if set.</param>
         public static void ApplyMapCode(IniFile mapIni, string customIniPath, GameMode gameMode)
         {
-            IniFile associatedIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, customIniPath));
+            string associatedIniPath = SafePath.CombineFilePath(ProgramConstants.GamePath, customIniPath);
+            Encoding associatedIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(associatedIniPath) : EncodingExt.UTF8NoBOM;
+            IniFile associatedIni = new IniFile(associatedIniPath, associatedIniEncoding);
             string extraIniName = null;
             if (gameMode != null)
                 extraIniName = associatedIni.GetStringValue("GameModeIncludes", gameMode.Name, null);
             associatedIni.EraseSectionKeys("GameModeIncludes");
             ApplyMapCode(mapIni, associatedIni);
             if (!String.IsNullOrEmpty(extraIniName))
-                ApplyMapCode(mapIni, new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, extraIniName)));
+            {
+                string extraIniPath = SafePath.CombineFilePath(ProgramConstants.GamePath, extraIniName);
+                Encoding extraIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(extraIniPath) : EncodingExt.UTF8NoBOM;
+                ApplyMapCode(mapIni, new IniFile(extraIniPath, extraIniEncoding));
+            }
         }
 
         /// <summary>

DXMainClient/Domain/Multiplayer/Map.cs

@@ -14,6 +14,7 @@
 using Point = Microsoft.Xna.Framework.Point;
 using System.Diagnostics;
 using System.Text;
+using ClientCore.PlatformShim;
 
 namespace DTAClient.Domain.Multiplayer
 {
@@ -607,15 +608,15 @@ public Texture2D LoadPreviewTexture()
 
         public IniFile GetMapIni()
         {
-            Encoding encoding = FileHelper.GetEncoding(CompleteFilePath);
+            Encoding mapIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(CompleteFilePath) : EncodingExt.UTF8NoBOM;
 
-            var mapIni = new IniFile(CompleteFilePath, encoding);
+            var mapIni = new IniFile(CompleteFilePath, mapIniEncoding);
 
             if (!string.IsNullOrEmpty(ExtraININame))
             {
                 string extraIniPath = SafePath.CombineFilePath(ProgramConstants.GamePath, "INI", "Map Code", ExtraININame);
-                encoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(extraIniPath) : new UTF8Encoding(false);
-                var extraIni = new IniFile(extraIniPath, encoding);
+                Encoding extraIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(extraIniPath) : EncodingExt.UTF8NoBOM;
+                var extraIni = new IniFile(extraIniPath, extraIniEncoding);
                 IniFile.ConsolidateIniFiles(mapIni, extraIni);
             }