feat: engine version indicator (AscensionGameDev#2537)

- add `IsDeveloper` to the application context, this is true when the client host is non-public or failed to be resolved and false in all other cases
- Version indicator is shown in bottom left corner of main menu
- Version indicator is shown in bottom left corner of in-game escape menu (not including the simplified menu)
- make version label copy version string to clipboard on click

Author: pandinocoder

Framework/Intersect.Framework.Core/Color.cs

@@ -1,3 +1,6 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
+using Intersect.Framework;
 using Intersect.Localization;
 using MessagePack;
 
@@ -232,7 +235,61 @@ public static Color FromRgba(int rgba)
 
     public static string ToString(Color clr) => clr?.ToString() ?? string.Empty;
 
-    public static Color FromString(string val, Color defaultColor = null)
+    [return: NotNullIfNotNull(nameof(defaultColor))]
+    public static Color? FromHex(string hexString, Color? defaultColor = default)
+    {
+        const NumberStyles hexStyles = NumberStyles.HexNumber | NumberStyles.AllowHexSpecifier;
+
+        if (string.IsNullOrWhiteSpace(hexString))
+        {
+            return defaultColor;
+        }
+
+        hexString = hexString.Trim();
+
+        if (hexString.StartsWith('#'))
+        {
+            hexString = hexString[1..];
+        }
+
+        string reversedHexString = hexString.Reverse();
+
+        if (!uint.TryParse(reversedHexString, hexStyles, CultureInfo.InvariantCulture, out var abgr))
+        {
+            return defaultColor;
+        }
+
+        int a, g, b, r;
+
+        if (reversedHexString.Length <= 4)
+        {
+            a = (int)(abgr >> 12 & 0xf);
+            b = (int)(abgr >> 8 & 0xf);
+            g = (int)(abgr >> 4 & 0xf);
+            r = (int)(abgr & 0xf);
+            a |= a << 4;
+            b |= b << 4;
+            g |= g << 4;
+            r |= r << 4;
+        }
+        else
+        {
+            a = (int)(abgr >> 28 & 0xf | (abgr >> 24 & 0xf) << 4);
+            b = (int)(abgr >> 20 & 0xf | (abgr >> 16 & 0xf) << 4);
+            g = (int)(abgr >> 12 & 0xf | (abgr >> 8 & 0xf) << 4);
+            r = (int)(abgr >> 4 & 0xf | (abgr & 0xf) << 4);
+        }
+
+        a = reversedHexString.Length switch
+        {
+            < 4 or > 4 and < 8 => 0xff,
+            _ => a,
+        };
+
+        return new Color(a: a, r: r, g: g, b: b);
+    }
+
+    public static Color? FromString(string val, Color? defaultColor = default)
     {
         if (string.IsNullOrEmpty(val))
         {

Framework/Intersect.Framework.Core/Core/IApplicationContext.cs

@@ -1,4 +1,5 @@
 
+using Intersect.Framework.Reflection;
 using Intersect.Plugins.Interfaces;
 using Intersect.Threading;
 using Microsoft.Extensions.Logging;
@@ -15,6 +16,26 @@ public interface IApplicationContext : IDisposable
     /// </summary>
     bool HasErrors { get; }
 
+    /// <summary>
+    /// If the application is a debug build.
+    /// </summary>
+    bool IsDebug
+    {
+        get
+        {
+#if !DEBUG
+            return true;
+#else
+            return false;
+#endif
+        }
+    }
+
+    /// <summary>
+    /// If the application is being run in developer mode.
+    /// </summary>
+    bool IsDeveloper => false;
+
     /// <summary>
     /// If the application has been disposed.
     /// </summary>
@@ -50,6 +71,11 @@ public interface IApplicationContext : IDisposable
     /// </summary>
     List<IApplicationService> Services { get; }
 
+    /// <summary>
+    /// The human-friendly version string.
+    /// </summary>
+    string VersionName => GetType().Assembly.GetMetadataVersionName();
+
     /// <summary>
     /// Gets a service of type <typeparamref name="TApplicationService"/> if one has been registered.
     /// </summary>

Framework/Intersect.Framework/Reflection/AssemblyExtensions.cs

@@ -56,6 +56,9 @@ public static string GetMetadataVersion(this Assembly assembly, bool excludeComm
         return GetMetadataVersionFrom(assembly, assemblyName, excludeCommitSha);
     }
 
+    public static string GetMetadataVersionName(this Assembly assembly, bool excludeCommitSha = false) =>
+        $"v{GetMetadataVersion(assembly: assembly, excludeCommitSha: excludeCommitSha)}";
+
     private static string GetMetadataVersionFrom(Assembly assembly, AssemblyName assemblyName, bool excludeCommitSha)
     {
         var assemblyVersion = assemblyName.Version ?? new Version(0, 0, 0, 0);

Framework/Intersect.Framework/StringExtensions.cs

@@ -0,0 +1,27 @@
+using System.Text;
+
+namespace Intersect.Framework;
+
+public static class StringExtensions
+{
+    public static string Reverse(this string @string)
+    {
+        var codepoints = new int[@string.Length];
+        var numCodepoints = 0;
+        for (var index = 0; index < @string.Length; ++index)
+        {
+            ++numCodepoints;
+
+            codepoints[index] = char.ConvertToUtf32(@string, index);
+            if (char.IsSurrogatePair(@string, index))
+            {
+                ++index;
+            }
+        }
+
+        codepoints = codepoints[..numCodepoints];
+        Array.Reverse(codepoints);
+
+        return codepoints.Aggregate(string.Empty, (current, codepoint) => current + char.ConvertFromUtf32(codepoint));
+    }
+}

Intersect.Client.Core/Core/Bootstrapper.cs

@@ -78,7 +78,28 @@ public static void Start(params string[] args)
         var clientConfiguration = ClientConfiguration.LoadAndSave();
         loggingLevelSwitch.MinimumLevel = LevelConvert.ToSerilogLevel(clientConfiguration.LogLevel);
 
-        var context = new ClientContext(commandLineOptions, logger, packetHelper);
+        if (commandLineOptions.Server is { } server)
+        {
+            var serverParts = server.Split(':', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
+            var host = serverParts.First();
+
+            var portPart = serverParts.Skip(1).FirstOrDefault();
+            if (string.IsNullOrEmpty(portPart))
+            {
+                portPart = "5400";
+            }
+            var port = ushort.Parse(portPart);
+
+            clientConfiguration.Host = host;
+            clientConfiguration.Port = port;
+        }
+
+        commandLineOptions = commandLineOptions with
+        {
+            Server = $"{clientConfiguration.Host}:{clientConfiguration.Port}",
+        };
+
+        ClientContext context = new(commandLineOptions, clientConfiguration, logger, packetHelper);
         context.Start();
     }
 

Intersect.Client.Core/Core/ClientCommandLineOptions.cs

@@ -6,6 +6,7 @@ namespace Intersect.Client.Core;
 
 internal readonly partial struct ClientCommandLineOptions : ICommandLineOptions
 {
+    // ReSharper disable once ConvertToPrimaryConstructor
     public ClientCommandLineOptions(
         bool borderlessWindow,
         int screenWidth,
@@ -33,7 +34,7 @@ IEnumerable<string> pluginDirectories
     public int ScreenHeight { get; }
 
     [Option('S', "server", Default = null, Required = false)]
-    public string Server { get; }
+    public string Server { get; init; }
 
     [Option("working-directory", Default = null, Required = false)]
     public string WorkingDirectory { get; }

Intersect.Client.Core/Core/ClientContext.cs

@@ -1,7 +1,12 @@
+using System.Net;
+using System.Net.Sockets;
 using Intersect.Client.Networking;
 using Intersect.Client.Plugins.Contexts;
+using Intersect.Configuration;
 using Intersect.Core;
 using Intersect.Factories;
+using Intersect.Framework.Net;
+using Intersect.Network;
 using Intersect.Plugins;
 using Intersect.Plugins.Interfaces;
 using Intersect.Reflection;
@@ -18,13 +23,33 @@ internal sealed partial class ClientContext : ApplicationContext<ClientContext,
 
     private IPlatformRunner? mPlatformRunner;
 
-    internal ClientContext(ClientCommandLineOptions startupOptions, ILogger logger, IPacketHelper packetHelper) : base(
+    internal ClientContext(ClientCommandLineOptions startupOptions, ClientConfiguration clientConfiguration, ILogger logger, IPacketHelper packetHelper) : base(
         startupOptions, logger, packetHelper
     )
     {
+        var hostNameOrAddress = clientConfiguration.Host;
+        try
+        {
+            var address = Dns.GetHostAddresses(hostNameOrAddress).FirstOrDefault();
+            IsDeveloper = !(address?.IsPublic() ?? false);
+        }
+        catch (SocketException socketException)
+        {
+            if (socketException.SocketErrorCode != SocketError.HostNotFound)
+            {
+                throw;
+            }
+
+            ClientNetwork.UnresolvableHostNames.Add(startupOptions.Server);
+            ApplicationContext.Context.Value?.Logger.LogError(socketException, $"Failed to resolve host: '{hostNameOrAddress}'");
+            IsDeveloper = true;
+        }
+
         _ = FactoryRegistry<IPluginContext>.RegisterFactory(new ClientPluginContext.Factory());
     }
 
+    public bool IsDeveloper { get; }
+
     protected override bool UsesMainThread => true;
 
     public IPlatformRunner PlatformRunner

Intersect.Client.Core/Interface/Game/EscapeMenu.cs

@@ -13,6 +13,7 @@ public partial class EscapeMenu : ImagePanel
 {
     private readonly SettingsWindow _settingsWindow;
     private readonly Button _buttonCharacterSelect;
+    private readonly Panel _versionPanel;
 
     public EscapeMenu(Canvas gameCanvas) : base(gameCanvas, nameof(EscapeMenu))
     {
@@ -76,6 +77,8 @@ public EscapeMenu(Canvas gameCanvas) : base(gameCanvas, nameof(EscapeMenu))
         {
             _buttonCharacterSelect.IsDisabled = true;
         }
+
+        _versionPanel = new VersionPanel(this, name: nameof(_versionPanel));
     }
 
     public override void Invalidate()

Intersect.Client.Core/Interface/Menu/MenuGuiBase.cs

@@ -1,8 +1,11 @@
 using Intersect.Client.Core;
 using Intersect.Client.Framework.File_Management;
+using Intersect.Client.Framework.Gwen;
 using Intersect.Client.Framework.Gwen.Control;
+using Intersect.Client.Interface.Shared;
 using Intersect.Client.Localization;
 using Intersect.Client.Networking;
+using Intersect.Core;
 
 namespace Intersect.Client.Interface.Menu;
 
@@ -11,6 +14,7 @@ public partial class MenuGuiBase : IMutableInterface
     private readonly Canvas _menuCanvas;
     private readonly ImagePanel _serverStatusArea;
     private readonly Label _serverStatusLabel;
+    private readonly VersionPanel _versionPanel;
 
     public MainMenu MainMenu { get; }
 
@@ -21,6 +25,9 @@ public MenuGuiBase(Canvas myCanvas)
         _menuCanvas = myCanvas;
 
         MainMenu = new MainMenu(_menuCanvas);
+
+        _versionPanel = new VersionPanel(_menuCanvas, name: nameof(_versionPanel));
+
         _serverStatusArea = new ImagePanel(_menuCanvas, "ServerStatusArea")
         {
             IsHidden = ClientContext.IsSinglePlayer,

Intersect.Client.Core/Interface/Shared/VersionLabel.cs

@@ -0,0 +1,34 @@
+using Intersect.Client.Framework.Gwen;
+using Intersect.Client.Framework.Gwen.Control;
+using Intersect.Client.Framework.Gwen.Platform;
+using Intersect.Client.Framework.Input;
+
+namespace Intersect.Client.Interface.Shared;
+
+public partial class VersionLabel : Label
+{
+    public VersionLabel(Base parent, string name = nameof(VersionLabel)) : base(parent: parent, name: name)
+    {
+        AutoSizeToContents = true;
+        Dock = Pos.Top;
+        MouseInputEnabled = true;
+        TextPadding = new Padding(2, 0);
+    }
+
+    protected override void Layout(Framework.Gwen.Skin.Base skin)
+    {
+        base.Layout(skin);
+
+        SizeToContents();
+    }
+
+    protected override void OnMouseClicked(MouseButton mouseButton, Point mousePosition, bool userAction = true)
+    {
+        base.OnMouseClicked(mouseButton, mousePosition, userAction);
+
+        if (Text is { } text && !string.IsNullOrWhiteSpace(text))
+        {
+            Neutral.SetClipboardText(text);
+        }
+    }
+}