using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; using System.IO; using System.IO.Compression; using System.Linq; using System.Numerics; using System.Reflection; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Text; using Dalamud.Configuration.Internal; using Dalamud.Data; using Dalamud.Game; using Dalamud.Game.ClientState.Objects.SubKinds; using Dalamud.Game.ClientState.Objects.Types; using Dalamud.Interface.Colors; using Dalamud.Interface.Utility; using Dalamud.Logging.Internal; using ImGuiNET; using Lumina.Excel.GeneratedSheets; using Serilog; using Windows.Win32.Storage.FileSystem; namespace Dalamud.Utility; /// /// Class providing various helper methods for use in Dalamud and plugins. /// public static class Util { private static string? gitHashInternal; private static int? gitCommitCountInternal; private static string? gitHashClientStructsInternal; private static ulong moduleStartAddr; private static ulong moduleEndAddr; /// /// Gets the assembly version of Dalamud. /// public static string AssemblyVersion { get; } = Assembly.GetAssembly(typeof(ChatHandlers)).GetName().Version.ToString(); /// /// Check two byte arrays for equality. /// /// The first byte array. /// The second byte array. /// Whether or not the byte arrays are equal. public static unsafe bool FastByteArrayCompare(byte[]? a1, byte[]? a2) { // Copyright (c) 2008-2013 Hafthor Stefansson // Distributed under the MIT/X11 software license // Ref: http://www.opensource.org/licenses/mit-license.php. // https://stackoverflow.com/a/8808245 if (a1 == a2) return true; if (a1 == null || a2 == null || a1.Length != a2.Length) return false; fixed (byte* p1 = a1, p2 = a2) { byte* x1 = p1, x2 = p2; var l = a1.Length; for (var i = 0; i < l / 8; i++, x1 += 8, x2 += 8) { if (*((long*)x1) != *((long*)x2)) return false; } if ((l & 4) != 0) { if (*((int*)x1) != *((int*)x2)) return false; x1 += 4; x2 += 4; } if ((l & 2) != 0) { if (*((short*)x1) != *((short*)x2)) return false; x1 += 2; x2 += 2; } if ((l & 1) != 0) { if (*((byte*)x1) != *((byte*)x2)) return false; } return true; } } /// /// Gets the git hash value from the assembly /// or null if it cannot be found. /// /// The git hash of the assembly. public static string GetGitHash() { if (gitHashInternal != null) return gitHashInternal; var asm = typeof(Util).Assembly; var attrs = asm.GetCustomAttributes(); gitHashInternal = attrs.First(a => a.Key == "GitHash").Value; return gitHashInternal; } /// /// Gets the amount of commits in the current branch, or null if undetermined. /// /// The amount of commits in the current branch. public static int? GetGitCommitCount() { if (gitCommitCountInternal != null) return gitCommitCountInternal.Value; var asm = typeof(Util).Assembly; var attrs = asm.GetCustomAttributes(); var value = attrs.First(a => a.Key == "GitCommitCount").Value; if (value == null) return null; gitCommitCountInternal = int.Parse(value); return gitCommitCountInternal.Value; } /// /// Gets the git hash value from the assembly /// or null if it cannot be found. /// /// The git hash of the assembly. public static string GetGitHashClientStructs() { if (gitHashClientStructsInternal != null) return gitHashClientStructsInternal; var asm = typeof(Util).Assembly; var attrs = asm.GetCustomAttributes(); gitHashClientStructsInternal = attrs.First(a => a.Key == "GitHashClientStructs").Value; return gitHashClientStructsInternal; } /// /// Read memory from an offset and hexdump them via Serilog. /// /// The offset to read from. /// The length to read. public static void DumpMemory(IntPtr offset, int len = 512) { try { SafeMemory.ReadBytes(offset, len, out var data); Log.Information(ByteArrayToHex(data)); } catch (Exception ex) { Log.Error(ex, "Read failed"); } } /// /// Create a hexdump of the provided bytes. /// /// The bytes to hexdump. /// The offset in the byte array to start at. /// The amount of bytes to display per line. /// The generated hexdump in string form. public static string ByteArrayToHex(byte[] bytes, int offset = 0, int bytesPerLine = 16) { if (bytes == null) return string.Empty; var hexChars = "0123456789ABCDEF".ToCharArray(); var offsetBlock = 8 + 3; var byteBlock = offsetBlock + (bytesPerLine * 3) + ((bytesPerLine - 1) / 8) + 2; var lineLength = byteBlock + bytesPerLine + Environment.NewLine.Length; var line = (new string(' ', lineLength - Environment.NewLine.Length) + Environment.NewLine).ToCharArray(); var numLines = (bytes.Length + bytesPerLine - 1) / bytesPerLine; var sb = new StringBuilder(numLines * lineLength); for (var i = 0; i < bytes.Length; i += bytesPerLine) { var h = i + offset; line[0] = hexChars[(h >> 28) & 0xF]; line[1] = hexChars[(h >> 24) & 0xF]; line[2] = hexChars[(h >> 20) & 0xF]; line[3] = hexChars[(h >> 16) & 0xF]; line[4] = hexChars[(h >> 12) & 0xF]; line[5] = hexChars[(h >> 8) & 0xF]; line[6] = hexChars[(h >> 4) & 0xF]; line[7] = hexChars[(h >> 0) & 0xF]; var hexColumn = offsetBlock; var charColumn = byteBlock; for (var j = 0; j < bytesPerLine; j++) { if (j > 0 && (j & 7) == 0) hexColumn++; if (i + j >= bytes.Length) { line[hexColumn] = ' '; line[hexColumn + 1] = ' '; line[charColumn] = ' '; } else { var by = bytes[i + j]; line[hexColumn] = hexChars[(by >> 4) & 0xF]; line[hexColumn + 1] = hexChars[by & 0xF]; line[charColumn] = by < 32 ? '.' : (char)by; } hexColumn += 3; charColumn++; } sb.Append(line); } return sb.ToString().TrimEnd(Environment.NewLine.ToCharArray()); } /// /// Show a structure in an ImGui context. /// /// The structure to show. /// The address to the structure. /// Whether or not this structure should start out expanded. /// The already followed path. public static void ShowStruct(object obj, ulong addr, bool autoExpand = false, IEnumerable? path = null) { ImGui.PushStyleVar(ImGuiStyleVar.ItemSpacing, new Vector2(3, 2)); path ??= new List(); if (moduleEndAddr == 0 && moduleStartAddr == 0) { try { var processModule = Process.GetCurrentProcess().MainModule; if (processModule != null) { moduleStartAddr = (ulong)processModule.BaseAddress.ToInt64(); moduleEndAddr = moduleStartAddr + (ulong)processModule.ModuleMemorySize; } else { moduleEndAddr = 1; } } catch { moduleEndAddr = 1; } } ImGui.PushStyleColor(ImGuiCol.Text, 0xFF00FFFF); if (autoExpand) { ImGui.SetNextItemOpen(true, ImGuiCond.Appearing); } if (ImGui.TreeNode($"{obj}##print-obj-{addr:X}-{string.Join("-", path)}")) { ImGui.PopStyleColor(); foreach (var f in obj.GetType() .GetFields(BindingFlags.Static | BindingFlags.Public | BindingFlags.Instance)) { var fixedBuffer = (FixedBufferAttribute)f.GetCustomAttribute(typeof(FixedBufferAttribute)); if (fixedBuffer != null) { ImGui.Text($"fixed"); ImGui.SameLine(); ImGui.TextColored(new Vector4(0.2f, 0.9f, 0.9f, 1), $"{fixedBuffer.ElementType.Name}[0x{fixedBuffer.Length:X}]"); } else { ImGui.TextColored(new Vector4(0.2f, 0.9f, 0.9f, 1), $"{f.FieldType.Name}"); } ImGui.SameLine(); ImGui.TextColored(new Vector4(0.2f, 0.9f, 0.4f, 1), $"{f.Name}: "); ImGui.SameLine(); ShowValue(addr, new List(path) {f.Name}, f.FieldType, f.GetValue(obj)); } foreach (var p in obj.GetType().GetProperties().Where(p => p.GetGetMethod()?.GetParameters().Length == 0)) { ImGui.TextColored(new Vector4(0.2f, 0.9f, 0.9f, 1), $"{p.PropertyType.Name}"); ImGui.SameLine(); ImGui.TextColored(new Vector4(0.2f, 0.6f, 0.4f, 1), $"{p.Name}: "); ImGui.SameLine(); ShowValue(addr, new List(path) {p.Name}, p.PropertyType, p.GetValue(obj)); } ImGui.TreePop(); } else { ImGui.PopStyleColor(); } ImGui.PopStyleVar(); } /// /// Show a structure in an ImGui context. /// /// The type of the structure. /// The pointer to the structure. /// Whether or not this structure should start out expanded. public static unsafe void ShowStruct(T* obj, bool autoExpand = false) where T : unmanaged { ShowStruct(*obj, (ulong)&obj, autoExpand); } /// /// Show a GameObject's internal data in an ImGui-context. /// /// The GameObject to show. /// Whether or not the struct should start as expanded. public static unsafe void ShowGameObjectStruct(GameObject go, bool autoExpand = true) { switch (go) { case BattleChara bchara: ShowStruct(bchara.Struct, autoExpand); break; case Character chara: ShowStruct(chara.Struct, autoExpand); break; default: ShowStruct(go.Struct, autoExpand); break; } } /// /// Show all properties and fields of the provided object via ImGui. /// /// The object to show. public static void ShowObject(object obj) { var type = obj.GetType(); ImGui.Text($"Object Dump({type.Name}) for {obj}({obj.GetHashCode()})"); ImGuiHelpers.ScaledDummy(5); ImGui.TextColored(ImGuiColors.DalamudOrange, "-> Properties:"); ImGui.Indent(); foreach (var propertyInfo in type.GetProperties().Where(p => p.GetGetMethod()?.GetParameters().Length == 0)) { var value = propertyInfo.GetValue(obj); var valueType = value?.GetType(); if (valueType == typeof(IntPtr)) ImGui.TextColored(ImGuiColors.DalamudOrange, $" {propertyInfo.Name}: 0x{value:X}"); else ImGui.TextColored(ImGuiColors.DalamudOrange, $" {propertyInfo.Name}: {value}"); } ImGui.Unindent(); ImGuiHelpers.ScaledDummy(5); ImGui.TextColored(ImGuiColors.HealerGreen, "-> Fields:"); ImGui.Indent(); foreach (var fieldInfo in type.GetFields()) { ImGui.TextColored(ImGuiColors.HealerGreen, $" {fieldInfo.Name}: {fieldInfo.GetValue(obj)}"); } ImGui.Unindent(); } /// /// Display an error MessageBox and exit the current process. /// /// MessageBox body. /// MessageBox caption (title). /// Specify whether to exit immediately. public static void Fatal(string message, string caption, bool exit = true) { var flags = NativeFunctions.MessageBoxType.Ok | NativeFunctions.MessageBoxType.IconError | NativeFunctions.MessageBoxType.Topmost; _ = NativeFunctions.MessageBoxW(Process.GetCurrentProcess().MainWindowHandle, message, caption, flags); if (exit) Environment.Exit(-1); } /// /// Transform byte count to human readable format. /// /// Number of bytes. /// Human readable version. public static string FormatBytes(long bytes) { string[] suffix = {"B", "KB", "MB", "GB", "TB"}; int i; double dblSByte = bytes; for (i = 0; i < suffix.Length && bytes >= 1024; i++, bytes /= 1024) { dblSByte = bytes / 1024.0; } return $"{dblSByte:0.00} {suffix[i]}"; } /// /// Retrieve a UTF8 string from a null terminated byte array. /// /// A null terminated UTF8 byte array. /// A UTF8 encoded string. public static string GetUTF8String(byte[] array) { var count = 0; for (; count < array.Length; count++) { if (array[count] == 0) break; } string text; if (count == array.Length) { text = Encoding.UTF8.GetString(array); Log.Warning($"Warning: text exceeds underlying array length ({text})"); } else { text = Encoding.UTF8.GetString(array, 0, count); } return text; } /// /// Compress a string using GZip. /// /// The input string. /// The compressed output bytes. public static byte[] CompressString(string str) { var bytes = Encoding.UTF8.GetBytes(str); using var msi = new MemoryStream(bytes); using var mso = new MemoryStream(); using (var gs = new GZipStream(mso, CompressionMode.Compress)) { msi.CopyTo(gs); } return mso.ToArray(); } /// /// Decompress a string using GZip. /// /// The input bytes. /// The compressed output string. public static string DecompressString(byte[] bytes) { using var msi = new MemoryStream(bytes); using var mso = new MemoryStream(); using (var gs = new GZipStream(msi, CompressionMode.Decompress)) { gs.CopyTo(mso); } return Encoding.UTF8.GetString(mso.ToArray()); } /// /// Determine if Dalamud is currently running within a Wine context (e.g. either on macOS or Linux). This method /// will not return information about the host operating system. /// /// Returns true if Wine is detected, false otherwise. public static bool IsWine() { if (EnvironmentConfiguration.XlWineOnLinux) return true; if (Environment.GetEnvironmentVariable("XL_PLATFORM") is not null and not "Windows") return true; var ntdll = NativeFunctions.GetModuleHandleW("ntdll.dll"); // Test to see if any Wine specific exports exist. If they do, then we are running on Wine. // The exports "wine_get_version", "wine_get_build_id", and "wine_get_host_version" will tend to be hidden // by most Linux users (else FFXIV will want a macOS license), so we will additionally check some lesser-known // exports as well. return AnyProcExists( ntdll, "wine_get_version", "wine_get_build_id", "wine_get_host_version", "wine_server_call", "wine_unix_to_nt_file_name"); bool AnyProcExists(nint handle, params string[] procs) => procs.Any(p => NativeFunctions.GetProcAddress(handle, p) != nint.Zero); } /// /// Gets the best guess for the current host's platform based on the XL_PLATFORM environment variable or /// heuristics. /// /// /// macOS users running without XL_PLATFORM being set will be reported as Linux users. Due to the way our /// Wines work, there isn't a great (consistent) way to split the two apart if we're not told. /// /// Returns the that Dalamud is currently running on. public static OSPlatform GetHostPlatform() { switch (Environment.GetEnvironmentVariable("XL_PLATFORM")) { case "Windows": return OSPlatform.Windows; case "MacOS": return OSPlatform.OSX; case "Linux": return OSPlatform.Linux; } // n.b. we had some fancy code here to check if the Wine host version returned "Darwin" but apparently // *all* our Wines report Darwin if exports aren't hidden. As such, it is effectively impossible (without some // (very cursed and inaccurate heuristics) to determine if we're on macOS or Linux unless we're explicitly told // by our launcher. See commit a7aacb15e4603a367e2f980578271a9a639d8852 for the old check. return IsWine() ? OSPlatform.Linux : OSPlatform.Windows; } /// /// Heuristically determine if the Windows version is higher than Windows 11's first build. /// /// If Windows 11 has been detected. public static bool IsWindows11() => Environment.OSVersion.Version.Build >= 22000; /// /// Open a link in the default browser. /// /// The link to open. public static void OpenLink(string url) { var process = new ProcessStartInfo(url) { UseShellExecute = true, }; Process.Start(process); } /// /// Perform a "zipper merge" (A, 1, B, 2, C, 3) of multiple enumerables, allowing for lists to end early. /// /// A set of enumerable sources to combine. /// The resulting type of the merged list to return. /// A new enumerable, consisting of the final merge of all lists. public static IEnumerable ZipperMerge(params IEnumerable[] sources) { // Borrowed from https://codereview.stackexchange.com/a/263451, thank you! var enumerators = new IEnumerator[sources.Length]; try { for (var i = 0; i < sources.Length; i++) { enumerators[i] = sources[i].GetEnumerator(); } var hasNext = new bool[enumerators.Length]; bool MoveNext() { var anyHasNext = false; for (var i = 0; i < enumerators.Length; i++) { anyHasNext |= hasNext[i] = enumerators[i].MoveNext(); } return anyHasNext; } while (MoveNext()) { for (var i = 0; i < enumerators.Length; i++) { if (hasNext[i]) { yield return enumerators[i].Current; } } } } finally { foreach (var enumerator in enumerators) { enumerator?.Dispose(); } } } /// /// Request that Windows flash the game window to grab the user's attention. /// /// Attempt to flash even if the game is currently focused. public static void FlashWindow(bool flashIfOpen = false) { if (NativeFunctions.ApplicationIsActivated() && !flashIfOpen) return; var flashInfo = new NativeFunctions.FlashWindowInfo { Size = (uint)Marshal.SizeOf(), Count = uint.MaxValue, Timeout = 0, Flags = NativeFunctions.FlashWindow.All | NativeFunctions.FlashWindow.TimerNoFG, Hwnd = Process.GetCurrentProcess().MainWindowHandle, }; NativeFunctions.FlashWindowEx(ref flashInfo); } /// /// Overwrite text in a file by first writing it to a temporary file, and then /// moving that file to the path specified. /// /// The path of the file to write to. /// The text to write. public static void WriteAllTextSafe(string path, string text) { WriteAllTextSafe(path, text, Encoding.UTF8); } /// /// Overwrite text in a file by first writing it to a temporary file, and then /// moving that file to the path specified. /// /// The path of the file to write to. /// The text to write. /// Encoding to use. public static void WriteAllTextSafe(string path, string text, Encoding encoding) { WriteAllBytesSafe(path, encoding.GetBytes(text)); } /// /// Overwrite data in a file by first writing it to a temporary file, and then /// moving that file to the path specified. /// /// The path of the file to write to. /// The data to write. public static unsafe void WriteAllBytesSafe(string path, byte[] bytes) { ArgumentException.ThrowIfNullOrEmpty(path); // Open the temp file var tempPath = path + ".tmp"; using var tempFile = Windows.Win32.PInvoke.CreateFile( tempPath, (uint)(FILE_ACCESS_RIGHTS.FILE_GENERIC_READ | FILE_ACCESS_RIGHTS.FILE_GENERIC_WRITE), FILE_SHARE_MODE.FILE_SHARE_NONE, null, FILE_CREATION_DISPOSITION.CREATE_ALWAYS, FILE_FLAGS_AND_ATTRIBUTES.FILE_ATTRIBUTE_NORMAL, null); if (tempFile.IsInvalid) throw new Win32Exception(); // Write the data uint bytesWritten = 0; if (!Windows.Win32.PInvoke.WriteFile(tempFile, new ReadOnlySpan(bytes), &bytesWritten, null)) throw new Win32Exception(); if (bytesWritten != bytes.Length) throw new Exception($"Could not write all bytes to temp file ({bytesWritten} of {bytes.Length})"); if (!Windows.Win32.PInvoke.FlushFileBuffers(tempFile)) throw new Win32Exception(); tempFile.Close(); if (!Windows.Win32.PInvoke.MoveFileEx(tempPath, path, MOVE_FILE_FLAGS.MOVEFILE_REPLACE_EXISTING | MOVE_FILE_FLAGS.MOVEFILE_WRITE_THROUGH)) throw new Win32Exception(); } /// /// Dispose this object. /// /// The object to dispose. /// The type of object to dispose. internal static void ExplicitDispose(this T obj) where T : IDisposable { obj.Dispose(); } /// /// Dispose this object. /// /// The object to dispose. /// Log message to print, if specified and an error occurs. /// Module logger, if any. /// The type of object to dispose. internal static void ExplicitDisposeIgnoreExceptions( this T obj, string? logMessage = null, ModuleLog? moduleLog = null) where T : IDisposable { try { obj.Dispose(); } catch (Exception e) { if (logMessage == null) return; if (moduleLog != null) moduleLog.Error(e, logMessage); else Log.Error(e, logMessage); } } /// /// Gets a random, inoffensive, human-friendly string. /// /// A random human-friendly name. internal static string GetRandomName() { var data = Service.Get(); var names = data.GetExcelSheet(ClientLanguage.English)!; var rng = new Random(); return names.ElementAt(rng.Next(0, names.Count() - 1)).Singular.RawString; } /// /// Print formatted GameObject Information to ImGui. /// /// Game Object to Display. /// Display Tag. /// If the GameObjects data should be resolved. internal static void PrintGameObject(GameObject actor, string tag, bool resolveGameData) { var actorString = $"{actor.Address.ToInt64():X}:{actor.ObjectId:X}[{tag}] - {actor.ObjectKind} - {actor.Name} - X{actor.Position.X} Y{actor.Position.Y} Z{actor.Position.Z} D{actor.YalmDistanceX} R{actor.Rotation} - Target: {actor.TargetObjectId:X}\n"; if (actor is Npc npc) actorString += $" DataId: {npc.DataId} NameId:{npc.NameId}\n"; if (actor is Character chara) { actorString += $" Level: {chara.Level} ClassJob: {(resolveGameData ? chara.ClassJob.GameData?.Name : chara.ClassJob.Id.ToString())} CHP: {chara.CurrentHp} MHP: {chara.MaxHp} CMP: {chara.CurrentMp} MMP: {chara.MaxMp}\n Customize: {BitConverter.ToString(chara.Customize).Replace("-", " ")} StatusFlags: {chara.StatusFlags}\n"; } if (actor is PlayerCharacter pc) { actorString += $" HomeWorld: {(resolveGameData ? pc.HomeWorld.GameData?.Name : pc.HomeWorld.Id.ToString())} CurrentWorld: {(resolveGameData ? pc.CurrentWorld.GameData?.Name : pc.CurrentWorld.Id.ToString())} FC: {pc.CompanyTag}\n"; } ImGui.TextUnformatted(actorString); ImGui.SameLine(); if (ImGui.Button($"C##{actor.Address.ToInt64()}")) { ImGui.SetClipboardText(actor.Address.ToInt64().ToString("X")); } } private static unsafe void ShowValue(ulong addr, IEnumerable path, Type type, object value) { if (type.IsPointer) { var val = (Pointer)value; var unboxed = Pointer.Unbox(val); if (unboxed != null) { var unboxedAddr = (ulong)unboxed; ImGuiHelpers.ClickToCopyText($"{(ulong)unboxed:X}"); if (moduleStartAddr > 0 && unboxedAddr >= moduleStartAddr && unboxedAddr <= moduleEndAddr) { ImGui.SameLine(); ImGui.PushStyleColor(ImGuiCol.Text, 0xffcbc0ff); ImGuiHelpers.ClickToCopyText($"ffxiv_dx11.exe+{unboxedAddr - moduleStartAddr:X}"); ImGui.PopStyleColor(); } try { var eType = type.GetElementType(); var ptrObj = SafeMemory.PtrToStructure(new IntPtr(unboxed), eType); ImGui.SameLine(); if (ptrObj == null) { ImGui.Text("null or invalid"); } else { ShowStruct(ptrObj, (ulong)unboxed, path: new List(path)); } } catch { // Ignored } } else { ImGui.Text("null"); } } else { if (!type.IsPrimitive) { ShowStruct(value, addr, path: new List(path)); } else { ImGui.Text($"{value}"); } } } }