Merge pull request #742 from CnCNet/develop

SadPencil · web-flow · commit 8c8352725891 · 2025-06-01T05:14:55.000+08:00
Release 2.12.4
diff --git a/ClientCore/ClientConfiguration.cs b/ClientCore/ClientConfiguration.cs
@@ -260,6 +260,10 @@ public void RefreshSettings()
 
         public string StatisticsLogFileName => clientDefinitionsIni.GetStringValue(SETTINGS, "StatisticsLogFileName", "DTA.LOG");
 
+        public string[] TrustedDomains => clientDefinitionsIni.GetStringValue(SETTINGS, "TrustedDomains", string.Empty).Split(',');
+
+        public string[] AlwaysTrustedDomains = {"cncnet.org", "gamesurge.net", "dronebl.org", "discord.com", "youtube.com", "youtu.be"};
+
         public (string Name, string Path) GetThemeInfoFromIndex(int themeIndex) => clientDefinitionsIni.GetStringValue("Themes", themeIndex.ToString(), ",").Split(',').AsTuple2();
 
         /// <summary>
diff --git a/ClientCore/FileHelper.cs b/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;
diff --git a/ClientCore/PlatformShim/EncodingExt.cs b/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);
 }
diff --git a/DXMainClient/DXGUI/Generic/MainMenu.cs b/DXMainClient/DXGUI/Generic/MainMenu.cs
@@ -438,7 +438,7 @@ private void CheckRequiredFiles()
             if (absentFiles.Count > 0)
             {
                 string description = string.Empty;
-                if (ClientConfiguration.Instance.ClientGameType == ClientType.YR)
+                if (ClientConfiguration.Instance.ClientGameType == ClientType.Ares)
                 {
                     description = ("You are missing Yuri's Revenge files that are required\n" +
                         "to play this mod! Yuri's Revenge mods are not standalone,\n" +
diff --git a/DXMainClient/DXGUI/Multiplayer/ChatListBox.cs b/DXMainClient/DXGUI/Multiplayer/ChatListBox.cs
@@ -5,6 +5,9 @@
 using System;
 using ClientCore;
 using ClientCore.Extensions;
+using ClientGUI;
+using System.Linq;
+using Rampastring.Tools;
 
 namespace DTAClient.DXGUI.Multiplayer
 {
@@ -24,11 +27,53 @@ private void ChatListBox_DoubleLeftClick(object sender, EventArgs e)
             if (SelectedIndex < 0 || SelectedIndex >= Items.Count)
                 return;
 
-            var link = Items[SelectedIndex].Text?.GetLink();
+            // Get the clicked link
+            string link = Items[SelectedIndex].Text?.GetLink();
             if (link == null)
                 return;
 
-            ProcessLauncher.StartShellProcess(link);
+            // Determine if the link is trusted
+            bool isTrusted = false;
+            try
+            {
+                string domain = new Uri(link).Host;
+                var trustedDomains = ClientConfiguration.Instance.TrustedDomains.Concat(ClientConfiguration.Instance.AlwaysTrustedDomains);
+                isTrusted = trustedDomains.Contains(domain, StringComparer.InvariantCultureIgnoreCase)
+                    || trustedDomains.Any(trustedDomain => domain.EndsWith("." + trustedDomain, StringComparison.InvariantCultureIgnoreCase));
+            }
+            catch (Exception ex)
+            {
+                isTrusted = false;
+                Logger.Log($"Error in parsing the URL \"{link}\": {ex.ToString()}");
+            }
+
+            if (isTrusted)
+            {
+                ProcessLink(link);
+                return;
+            }
+
+            // Show the warning if the link is not trusted
+            var msgBox = new XNAMessageBox(WindowManager,
+                "Open Link Confirmation".L10N("Client:Main:OpenLinkConfirmationTitle"),
+                """
+                You're about to open a link shared in chat.
+
+                Please note that this link hasn't been verified,
+                and CnCNet is not responsible for its content.
+
+                Would you like to open the following link in your browser?
+                """.L10N("Client:Main:OpenLinkConfirmationText")
+                + Environment.NewLine + Environment.NewLine + link,
+                XNAMessageBoxButtons.YesNo);
+            msgBox.YesClickedAction = (msgBox) => ProcessLink(link);
+            msgBox.Show();
+        }
+
+        private void ProcessLink(string link)
+        {
+            if (link != null)
+                ProcessLauncher.StartShellProcess(link);
         }
 
         public void AddMessage(string message)
@@ -49,7 +94,7 @@ public void AddMessage(ChatMessage message)
                 Selectable = true,
                 Tag = message
             };
-            
+
             if (message.SenderName == null)
             {
                 listBoxItem.Text = Renderer.GetSafeString(string.Format("[{0}] {1}",
@@ -61,7 +106,7 @@ public void AddMessage(ChatMessage message)
                 listBoxItem.Text = Renderer.GetSafeString(string.Format("[{0}] {1}: {2}",
                     message.DateTime.ToShortTimeString(), message.SenderName, message.Message), FontIndex);
             }
-            
+
             AddItem(listBoxItem);
 
             if (LastIndex >= Items.Count - 2)
diff --git a/DXMainClient/DXGUI/Multiplayer/GameLobby/MapCodeHelper.cs b/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>
diff --git a/DXMainClient/DXMainClient.csproj b/DXMainClient/DXMainClient.csproj
@@ -6,7 +6,8 @@
     <Prefer32Bit Condition="'$(Engine)' == 'WindowsXNA' And '$(TargetFrameworkIdentifier)' == '.NETFramework'">true</Prefer32Bit>
     <UseAppHost>false</UseAppHost>
     <SelfContained>false</SelfContained>
-    <Description>CnCNet Main Client Library</Description>
+    <Description>CnCNet Main Client</Description>
+    <AssemblyTitle>CnCNet Client</AssemblyTitle>
     <RootNamespace>DTAClient</RootNamespace>
     <ApplicationIcon>clienticon.ico</ApplicationIcon>
     <ApplicationHighDpiMode Condition="'$(Engine)' == 'UniversalGL' OR '$(Engine)' == 'WindowsGL'">SystemAware</ApplicationHighDpiMode>
diff --git a/DXMainClient/Domain/Multiplayer/Map.cs b/DXMainClient/Domain/Multiplayer/Map.cs
@@ -16,6 +16,7 @@
 using static System.Collections.Specialized.BitVector32;
 using System.Diagnostics;
 using System.Text;
+using ClientCore.PlatformShim;
 
 namespace DTAClient.Domain.Multiplayer
 {
@@ -712,15 +713,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);
             }
 
diff --git a/Docs/INISystem.md b/Docs/INISystem.md
@@ -505,3 +505,19 @@ Children of [XNAWindow](https://github.com/CnCNet/xna-cncnet-client/blob/develop
 RandomBackgroundTextures=  ; comma-separated list of strings,
                            ; paths of files to use randomly as BackgroundTexture
 ```
+
+# Global Config Files
+
+## [ClientDefinition](https://github.com/CnCNet/xna-cncnet-client/blob/develop/ClientCore/ClientConfiguration.cs)
+> [!NOTE]
+> _TODO work in progress_
+
+The `ClientDefinitions.ini` file defines the client's global settings, including the game type, recommended resolutions and the executable file used to launch the game.
+
+In `ClientDefinitions.ini`:
+```ini
+[Settings]
+TrustedDomains=  ; comma-separated list of strings,
+                 ; domain names to match links and prevent the message box from appearing before they open by default browser
+                 ; example: cncnet.org,github.com,moddb.com
+```
diff --git a/Docs/Migration-INI.md b/Docs/Migration-INI.md
@@ -904,7 +904,7 @@ Location=12,189
 
 ## Appendix
 
-For completion's sake, below are additional steps required for a complete migration (beyond INI changes) to client version [2.11.0.0][client] from pre-2.11.0.0.
+For completion's sake, below are additional steps required for a complete migration (beyond INI changes) to client version [2.11.0.0][client_2.11] from pre-2.11.0.0.
 
 ### Update client binary files
 
diff --git a/Docs/Migration.md b/Docs/Migration.md
@@ -1,7 +1,15 @@
 Migrating from older versions
 -----------------------------
 
-## Migrating from pre-2.11.0.0
+This document lists all the breaking changes and how to address them. Each section corresponds to the migration steps that are required to upgrade to the selected version. If you're skipping multiple versions in the upgrade process - you have to apply all corresponding migration steps.
+
+## 2.12.0
+
+- The client now has unified different builds among game types. The game type must be defined in the `ClientDefinitions.ini` file. Please specify `ClientGameType` in `[Settings]` section of the `ClientDefinitions.ini` file, e.g., `ClientGameType=Ares`. See [this file](https://github.com/CnCNet/xna-cncnet-client/blob/0554d7974cb741170c881116568144265e6cbabb/ClientCore/Enums/ClientType.cs) for a list of available values.
+
+- The `trbScrollRate` component in `GameOptionsPanel` was mistakenly named as `trbClientVolume` in the INI configuration file from the beginning. This has been fixed. No action is needed unless this component was explicitly modified in your configuration (rare).
+
+## 2.11.0.0 and earlier
 
 - `CustomSettingFileCheckBox` and `CustomSettingFileDropDown` have been renamed to simply `FileSettingCheckBox` and `FileSettingDropDown`. This requires adjusting the control names in `OptionsWindow.ini`. `FileSettingCheckBox` has a fallback to legacy behaviour if the control has any files defined with `FileX`.
 
@@ -11,13 +19,11 @@ Migrating from older versions
 
 - Updater DLL filename has been changed from `DTAUpdater.dll` to `ClientUpdater.dll` and second-stage updater from `clientupdt.dat` to `SecondStageUpdater.exe` for .NET 4.8 and has been moved from base folder to `Resources/Binaries/Updater`.
 
-    - **Note:** If you want end-users to be able to update via the old client, it is necessary to preserve a copy of the old second-stage updater (`clientupdt.dat`) in the client base directory. In other words, *don't* modify or delete `clientupdt.dat` with either of the [update server scripts](https://github.com/CnCNet/xna-cncnet-client/blob/develop/Docs/Updater.md).
+    - **Note:** If you want end-users to be able to update via the old client, it is necessary to preserve a copy of the old second-stage updater (`clientupdt.dat`) in the client base directory. In other words, *don't* modify or delete `clientupdt.dat` with either of the [update server scripts](/Docs/Updater.md).
 
 - Second-stage updater is now automatically copied to `Resources/Binaries/Updater` folder by build scripts.
 
-- To support launching the game on Linux the file defined as `UnixGameExecutableName` (defaults to `wine-dta.sh`) in `ClientDefinitions.ini` must be set up correctly. E.g. for launching a game with wine the file could contain `wine gamemd-spawn.exe $*` where `gamemd-spawn.exe` is replaced with the game executable. Note that users might need to execute `chmod u+x wine-dta.sh` once to allow it to be launched.
-
-- Due to the unification of client builds, it is now required to define client behavior depending on the game using the `ClientGameType` key in the `ClientDefinitions.ini` file in the `Settings` section.
+- To support launching the game on Linux the file defined as `UnixGameExecutableName` (defaults to `wine-dta.sh`) in `ClientDefinitions.ini` must be set up correctly. E.g. for launching a game with wine the file could contain `wine gamemd-spawn.exe $*` where `gamemd-spawn.exe` is replaced with the game executable. Note that users might need to execute `chmod +x wine-dta.sh` once to allow it to be launched.
 
 - The use of `*.cur` mouse cursor files is not supported on the cross-platform `UniversalGL` build. To ensure the intended cursor is shown instead of a missing texture (pink square) all themes need to contain a `cursor.png` file. Existing `*.cur` files will still be used by the Windows-only builds.
 
@@ -47,5 +53,3 @@ Migrating from older versions
 - The [Tiberian Sun Client v6 Changes](https://github.com/CnCNet/xna-cncnet-client/pull/275) changes the license to GPLv3. This means that if your client is a private fork, you must either stop releasing the modified client or provide the modified source code to public with GPLv3 license.
 
 - `BtnSaveLoadGameOptions` in game lobbies was renamed to `btnSaveLoadGameOptions` for consistency. See [this change](https://github.com/CnCNet/cncnet-ts-client-package/commit/2ac97c68978431e94e320299e0168119f75a849f) to TSC for an example of addressing this.
-
-- Since v2.12, the client has unified different builds among game types. The game type must be defined in the `ClientDefinitions.ini` file. Please specify 'ClientGameType' in `[Settings]` section of the 'ClientDefinitions.ini' file, e.g., 'ClientGameType=Ares'.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ When using the included build scripts PowerShell 7.2 or newer is required.[^inst
 * If you switch among different solution configurations in Visual Studio (e.g. switch to `UniversalGLRelease` from `WindowsDXDebug`), especially switching between .NET 4.8 and .NET 8.0 variants, it is recommended to restart Visual Studio after switching configurations to prevent unexpected error messages. If restarting Visual Studio do not work as intended, try deleting all `obj` folders in each project. Due to the same reason, it is highly advised to close Visual Studio when building the client using the scripts in `Scripts` folder.
 * Some dependencies are stored in `References` folder instead of the official NuGet source. This folder is also useful if you are working on modifying a dependency and debugging in your local machine without publishing the modification to NuGet. However, if you have replaced the `.(s)nupkg` files of a package, without altering the package version, be sure to remove the corresponding package from `%USERPROFILE%\.nuget\packages` folder (Windows) to purge the old version. 
 
-Refer to [Docs/Build.md](https://github.com/CnCNet/xna-cncnet-client/blob/develop/Docs/Build.md) for more information about building the client.
+Refer to [Docs/Build.md](/Docs/Build.md) for more information about building the client.
 
 </details>
 

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`using System.Threading.Tasks;`
`9`	`9`
`10`	`10`	`using ClientCore.Extensions;`
	`11`	`+using ClientCore.PlatformShim;`
`11`	`12`
`12`	`13`	`using Rampastring.Tools;`
`13`	`14`
`@@ -91,17 +92,22 @@ public static void CreateHardLinkFromSource(string source, string destination, b`
`91`	`92`	`}`
`92`	`93`	`}`
`93`	`94`
`94`		`- public static Encoding GetEncoding(string filename)`
	`95`	`+ public static Encoding GetEncoding(string filename, float minimalConfidence = 0.5f)`
`95`	`96`	`{`
`96`		`- Encoding encoding = new UTF8Encoding(false);`
	`97`	`+ Encoding encoding = EncodingExt.UTF8NoBOM;`
`97`	`98`
`98`	`99`	`using (FileStream fs = File.OpenRead(filename))`
`99`	`100`	`{`
`100`	`101`	`Ude.CharsetDetector cdet = new Ude.CharsetDetector();`
`101`	`102`	`cdet.Feed(fs);`
`102`	`103`	`cdet.DataEnd();`
`103`		`- if (cdet.Charset != null)`
`104`		`- encoding = Encoding.GetEncoding(cdet.Charset);`
	`104`	`+ if (cdet.Charset != null && cdet.Confidence > minimalConfidence)`
	`105`	`+ {`
	`106`	`+ Encoding detectedEncoding = Encoding.GetEncoding(cdet.Charset);`
	`107`	`+`
	`108`	`+ if (detectedEncoding is not UTF8Encoding and not ASCIIEncoding)`
	`109`	`+ encoding = detectedEncoding;`
	`110`	`+ }`
`105`	`111`	`}`
`106`	`112`
`107`	`113`	`return encoding;`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,6 @@ static EncodingExt()`
`16`	`16`	`/// ANSI doesn't mean a specific codepage, it means the default non-Unicode codepage which can be changed from Control Panel.`
`17`	`17`	`/// </summary>`
`18`	`18`	`public static Encoding ANSI { get; }`
	`19`	`+`
	`20`	`+ public static Encoding UTF8NoBOM { get; } = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -438,7 +438,7 @@ private void CheckRequiredFiles()`
`438`	`438`	`if (absentFiles.Count > 0)`
`439`	`439`	`{`
`440`	`440`	`string description = string.Empty;`
`441`		`- if (ClientConfiguration.Instance.ClientGameType == ClientType.YR)`
	`441`	`+ if (ClientConfiguration.Instance.ClientGameType == ClientType.Ares)`
`442`	`442`	`{`
`443`	`443`	`description = ("You are missing Yuri's Revenge files that are required\n" +`
`444`	`444`	`"to play this mod! Yuri's Revenge mods are not standalone,\n" +`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`using static System.Collections.Specialized.BitVector32;`
`17`	`17`	`using System.Diagnostics;`
`18`	`18`	`using System.Text;`
	`19`	`+using ClientCore.PlatformShim;`
`19`	`20`
`20`	`21`	`namespace DTAClient.Domain.Multiplayer`
`21`	`22`	`{`
`@@ -712,15 +713,15 @@ public Texture2D LoadPreviewTexture()`
`712`	`713`
`713`	`714`	`public IniFile GetMapIni()`
`714`	`715`	`{`
`715`		`- Encoding encoding = FileHelper.GetEncoding(CompleteFilePath);`
	`716`	`+ Encoding mapIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(CompleteFilePath) : EncodingExt.UTF8NoBOM;`
`716`	`717`
`717`		`- var mapIni = new IniFile(CompleteFilePath, encoding);`
	`718`	`+ var mapIni = new IniFile(CompleteFilePath, mapIniEncoding);`
`718`	`719`
`719`	`720`	`if (!string.IsNullOrEmpty(ExtraININame))`
`720`	`721`	`{`
`721`	`722`	`string extraIniPath = SafePath.CombineFilePath(ProgramConstants.GamePath, "INI", "Map Code", ExtraININame);`
`722`		`- encoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(extraIniPath) : new UTF8Encoding(false);`
`723`		`- var extraIni = new IniFile(extraIniPath, encoding);`
	`723`	`+ Encoding extraIniEncoding = ClientConfiguration.Instance.ClientGameType == ClientCore.Enums.ClientType.TS ? FileHelper.GetEncoding(extraIniPath) : EncodingExt.UTF8NoBOM;`
	`724`	`+ var extraIni = new IniFile(extraIniPath, extraIniEncoding);`
`724`	`725`	`IniFile.ConsolidateIniFiles(mapIni, extraIni);`
`725`	`726`	`}`
`726`	`727`