Implement Migration Tool

DXClient.slnx

@@ -42,6 +42,7 @@
     <BuildType Solution="WindowsXNADebug|*" Project="Debug" />
     <BuildType Solution="WindowsXNARelease|*" Project="Release" />
   </Project>
+  <Project Path="MigrationTool/MigrationTool.csproj" />
   <Project Path="Rampastring.XNAUI/Rampastring.XNAUI.csproj" />
   <Project Path="SecondStageUpdater/SecondStageUpdater.csproj" />
   <Project Path="TranslationNotifierGenerator/TranslationNotifierGenerator.csproj" />

Directory.Build.props

@@ -58,6 +58,14 @@
     <Platforms>AnyCPU</Platforms>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(MSBuildProjectName)' == 'MigrationTool'">
+    <TargetFrameworks>net8.0;net48</TargetFrameworks>
+    <RuntimeIdentifiers Condition="'$(TargetFramework)' == 'net48'">win-x86</RuntimeIdentifiers>
+    <Platforms>AnyCPU</Platforms>
+    <Nullable>enable</Nullable>
+    <OutputType>Exe</OutputType>
+  </PropertyGroup>
+
   <!-- For Constants -->
   <PropertyGroup>
     <!-- Is Debug -->

Directory.Build.targets

@@ -23,6 +23,19 @@
       Projects="$(MSBuildThisFileDirectory)SecondStageUpdater\SecondStageUpdater.csproj"
       Properties="TargetFramework=$(TargetFramework.Split('-')[0]);Platform=AnyCPU;RuntimeIdentifier=" />
   </Target>
+
+  <Target Name="RestoreMigrationTool" AfterTargets="Restore" Condition="'$(PublishDir)' != '' AND '$(MSBuildProjectName)' == 'MigrationTool'">
+    <MSBuild
+      Projects="$(MSBuildThisFileDirectory)MigrationTool\MigrationTool.csproj"
+      Properties="TargetFramework=$(TargetFramework);Platform=$(Platform);RuntimeIdentifier="
+      Targets="Restore" />
+  </Target>
+
+  <Target Name="BuildMigrationTool" AfterTargets="Build" Condition="'$(PublishDir)' != '' AND '$(MSBuildProjectName)' == 'MigrationTool'">
+    <MSBuild
+      Projects="$(MSBuildThisFileDirectory)MigrationTool\MigrationTool.csproj"
+      Properties="TargetFramework=$(TargetFramework);Platform=$(Platform);RuntimeIdentifier=" />
+  </Target>
 
   <Target Name="MakeDirectoryStructure" AfterTargets="Publish" Condition="'$(MSBuildProjectName)' == 'DXMainClient'">
     <CallTarget Targets="PublishNetFrameworkWindowsGLNative;RemoveNetFrameworkWindowsGLNative;RemoveWindowsDXNonWindowsBinaries;RemoveWindowsGLNonWindowsBinaries;RemoveGLMobileBinaries" />
@@ -138,6 +151,22 @@
     <Delete Files="%(CNCNetUpdaterOutputFile.Identity)" Condition="Exists('$(CNCNetUpdaterCopyTo)%(CNCNetUpdaterOutputFile.Identity)')" />
   </Target>
 
+  <Target Name="CopyMigrationTool" AfterTargets="Build" Condition="'$(PublishDir)' != '' AND '$(MSBuildProjectName)' == 'MigrationTool'">
+    <PropertyGroup>
+      <CNCNetMigrationToolCopyTo>$(PublishDir)\..\MigrationTool\</CNCNetMigrationToolCopyTo>
+    </PropertyGroup>
+    <ItemGroup>
+        <CNCNetMigrationToolOutputFile Include="$(OutputPath)\*.*" />
+    </ItemGroup>
+    <Copy SourceFiles="@(CNCNetMigrationToolOutputFile)" DestinationFolder="$(CNCNetMigrationToolCopyTo)" />
+  </Target>
+
+  <Target Name="MoveMigrationTool" Condition="'$(MSBuildProjectName)' == 'MigrationTool'">
+    <Message Importance="high" Text="Moving migration tool executables" />
+    <Move SourceFiles="%(CNCNetMigrationToolOutputFile.Identity)" DestinationFolder="$(CNCNetMigrationToolCopyTo)" Condition="!Exists('$(CNCNetMigrationToolCopyTo)%(CNCNetMigrationToolOutputFile.Identity)')" />
+    <Delete Files="%(CNCNetMigrationToolOutputFile.Identity)" Condition="Exists('$(CNCNetMigrationToolCopyTo)%(CNCNetMigrationToolOutputFile.Identity)')" />
+  </Target>
+
   <!-- Allow a game specific build prop file to be imported, if available -->
   <Import Project="$(MSBuildThisFileDirectory)Directory.targets" Condition="Exists('$(MSBuildThisFileDirectory)Directory.targets')" />
 

Directory.Packages.props

@@ -24,11 +24,14 @@
     <PackageVersion Include="System.Text.Json" Version="8.0.6" />
     <PackageVersion Include="Ude.NetStandard" Version="1.2.0" />
   </ItemGroup>
-  <ItemGroup Condition="'$(MSBuildProjectName)' == 'ClientCore' Or '$(MSBuildProjectName)' == 'ClientGUI' Or '$(MSBuildProjectName)' == 'DTAConfig' Or '$(MSBuildProjectName)' == 'DXMainClient' Or '$(MSBuildProjectName)' == 'ClientUpdater'">
+  <ItemGroup Condition="'$(MSBuildProjectName)' == 'ClientCore' 
+                         Or '$(MSBuildProjectName)' == 'ClientGUI' 
+                         Or '$(MSBuildProjectName)' == 'ClientUpdater' 
+                         Or '$(MSBuildProjectName)' == 'DXMainClient'">
     <ProjectReference Include="$(MSBuildThisFileDirectory)TranslationNotifierGenerator\TranslationNotifierGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>
-  <!-- Polyfill on .NET 4.8 (SecondStageUpdater excluded) -->
-  <ItemGroup Condition="'$(MSBuildProjectName)' != 'SecondStageUpdater' And $(TargetFrameworkIdentifier) == '.NETFramework'">
+  <!-- Polyfill on .NET 4.8 (SecondStageUpdater and MigrationTool excluded) -->
+  <ItemGroup Condition="'$(MSBuildProjectName)' != 'SecondStageUpdater' and '$(MSBuildProjectName)' != 'MigrationTool' and $(TargetFrameworkIdentifier) == '.NETFramework'">
     <GlobalPackageReference Include="Polyfill" Version="6.14.0" />
     <PackageReference Include="System.ValueTuple" Condition="$(TargetFramework.StartsWith('net46'))" />
     <PackageVersion Include="System.ValueTuple" Version="4.5.0" />

Docs/Migration-INI.md

@@ -724,7 +724,7 @@ DrawBorders=true
 Size=1230,750
 ```
 
-## Edit `GlobalThemeSettings.ini`
+## Edit `DTACnCNetClient.ini`
 
 This file now also contains the `ParserConstants` section, which lists user-defined constants used for positioning controls within panels and windows. **Without this section, the client will crash with new `GameLobbyBase.ini` layout**.
 
@@ -806,6 +806,8 @@ Location=470,137
 Location=0,200
 
 [btnForceUpdate]
+Location=407,213
+Size=133,23
 ```
 
 2. **OPTIONAL** Add sections:

Docs/Migration.md

@@ -1,6 +1,14 @@
 Migrating from older versions
 -----------------------------
 
+> [!NOTE]
+> CnCNet has a program called `Migration Tool` that implements all the instructions described down below notices to automate the migration process.
+> To use this tool, download the latest nightly build and run `Resources\BinariesNET8\MigrationTool\MigrationTool.exe` with older client path as the first argument. 
+> 
+> Example: `MigrationTool.exe C:\TiberianSunClient`
+> 
+> It is recommended that you back up the client configuration before running the migration tool.
+
 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.
 
 > [!NOTE]

MigrationTool/MigrationTool.csproj

@@ -0,0 +1,29 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <Title>CnCNet.MigrationTool</Title>
+    <Description>CnCNet Client Migration Tool</Description>
+    <Product>CnCNet.MigrationTool</Product>
+  </PropertyGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="Pictures\favActive.png" />
+    <EmbeddedResource Include="Pictures\favActive_c.png" />
+    <EmbeddedResource Include="Pictures\favInactive.png" />
+    <EmbeddedResource Include="Pictures\noMapPreview.png" />
+    <EmbeddedResource Include="Pictures\sortAlphaActive.png" />
+    <EmbeddedResource Include="Pictures\sortAlphaAsc.png" />
+    <EmbeddedResource Include="Pictures\sortAlphaDesc.png" />
+    <EmbeddedResource Include="Pictures\sortAlphaInactive.png" />
+    <EmbeddedResource Include="Pictures\sortAlphaNone.png" />
+    <EmbeddedResource Include="Pictures\statusAI.png" />
+    <EmbeddedResource Include="Pictures\statusClear.png" />
+    <EmbeddedResource Include="Pictures\statusEmpty.png" />
+    <EmbeddedResource Include="Pictures\statusError.png" />
+    <EmbeddedResource Include="Pictures\statusInProgress.png" />
+    <EmbeddedResource Include="Pictures\statusOk.png" />
+    <EmbeddedResource Include="Pictures\statusUnavailable.png" />
+    <EmbeddedResource Include="Pictures\statusWarning.png" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\ClientCore\ClientCore.csproj" />
+  </ItemGroup>
+</Project>

MigrationTool/Patch.cs

@@ -0,0 +1,156 @@
+using System.IO;
+using System.Linq;
+using System.Collections.Generic;
+
+using Rampastring.Tools;
+using ClientCore.Enums;
+namespace MigrationTool;
+
+internal abstract class Patch
+{
+    public Version ClientVersion { get; protected set; }
+    public ClientType Game { get; protected set; }
+    public DirectoryInfo ClientDir { get; protected set; }
+    public DirectoryInfo ResouresDir { get; protected set; }
+
+    public Patch(string clientPath)
+    {
+        ClientDir = SafePath.GetDirectory(clientPath);
+        ResouresDir = SafePath.GetDirectory(SafePath.CombineFilePath(clientPath, "Resources"));
+
+        // Predict client type by guessing game engine files
+        Game = ClientType.TS;
+
+        if (SafePath.GetFile(SafePath.CombineFilePath(ClientDir.FullName, "Ares.dll")).Exists)
+        {
+            Game = ClientType.Ares;
+        }
+        else if (SafePath.GetFile(SafePath.CombineFilePath(ClientDir.FullName, "gamemd-spawn.dll")).Exists)
+        {
+            Game = ClientType.YR;
+        }
+    }
+
+    public virtual void Apply()
+    {
+        Logger.Log($"Applying patch for client version {ClientVersion.ToString().Replace('_', '.')}...");
+    }
+
+    public Patch AddKeyWithLog(IniFile src, string section, string key, string value)
+    {
+        if (src.KeyExists(section, key))
+        {
+            Logger.Log($"Update {src.FileName}: Skip adding [{section}]->{key}, reason: already exist");
+        }
+        else
+        {
+            Logger.Log($"Update {src.FileName}: Add [{section}]->{key}={value}");
+
+            if (!src.SectionExists(section))
+                src.AddSection(section);
+
+            src.GetSection(section).AddKey(key, value);
+        }
+
+        return this;
+    }
+
+    public Patch RemoveKeyWithLog(IniFile src, string section, string key)
+    {
+        if (!src.KeyExists(section, key))
+        {
+            Logger.Log($"Update {src.FileName}: Skip removing [{section}]->{key}, reason: doesn't exist");
+        }
+        else
+        {
+            Logger.Log($"Update {src.FileName}: Remove [{section}]->{key}={src.GetSection(section).Keys.First(kvp => kvp.Key == key).Value}");
+            src.GetSection(section).RemoveKey(key);
+        }
+
+        return this;
+    }
+
+    public void CalculatePositions(IniFile ini, string parent, string child)
+    {
+        int parentX, parentY, childX, childY;
+        parentX = parentY = childX = childY = 0;
+
+        var parentKeys = ini.GetSectionKeys(parent);
+        var childKeys = ini.GetSectionKeys(child);
+
+        var positionKeys = new List<string>() { "$X", "$Y", "X", "Y", "Location" };
+
+        Logger.Log($"Update {ini.FileName}: Fix position for {child} control in {parent}");
+
+        foreach (var control in new List<List<string>>() { parentKeys, childKeys })
+        {
+            int tmpX, tmpY;
+            tmpX = tmpY = 0;
+
+            foreach (var key in control.Where(key => positionKeys.Contains(key)))
+            {
+                switch (key)
+                {
+                    case ("$X"):
+                    case ("X"):
+                        tmpX = ini.GetIntValue(control == parentKeys ? parent : child, key, tmpX);
+                        continue;
+                    case ("$Y"):
+                    case ("Y"):
+                        tmpY = ini.GetIntValue(control == parentKeys ? parent : child, key, tmpY);
+                        continue;
+                    case ("Location"):
+                        var value = ini.GetStringValue(control == parentKeys ? parent : child, key, string.Empty).Split(',');
+                        tmpX = Conversions.IntFromString(value[0], tmpX);
+                        tmpY = Conversions.IntFromString(value[1], tmpY);
+                        break;
+                    default:
+                        break;
+                }
+            }
+
+            if (control == parentKeys)
+            {
+                parentX = tmpX;
+                parentY = tmpY;
+            }
+            else
+            {
+                childX = tmpX;
+                childY = tmpY;
+            }
+        }
+
+        positionKeys.ForEach(key => ini.RemoveKey(child, key));
+
+        childX = childX - parentX;
+        childY = childY - parentY;
+
+        ini.GetSection(child).AddKey("$X", $"{childX}");
+        ini.GetSection(child).AddKey("$Y", $"{childY}");
+    }
+
+    public Patch TransferKeys(IniFile srcIni, string srcSection, IniFile desIni, string? desSection = null)
+    {
+        desSection ??= srcSection;
+
+        srcIni.GetSectionKeys(srcSection)
+            .ForEach(key => AddKeyWithLog(desIni, desSection, key, srcIni.GetStringValue(srcSection, key, string.Empty)));
+
+        return this;
+    }
+
+    public bool TryApply()
+    {
+        try
+        {
+            Apply();
+            return true;
+        }
+        catch
+        {
+            return false;
+        }
+    }
+}
+

MigrationTool/Patch_Latest.cs

@@ -0,0 +1,21 @@
+using System.Linq;
+
+using Rampastring.Tools;
+
+namespace MigrationTool;
+
+internal class Patch_Latest : Patch
+{
+    public Patch_Latest(string clientPath) : base(clientPath)
+    {
+        ClientVersion = Version.Latest;
+    }
+
+    public override void Apply()
+    {
+        base.Apply();
+
+        // Write latest patch there
+    }
+}
+