## Summary - Adds proper Latin1 encoding support, replacing CP1252 usage throughout the codebase - Adds specialized, optimized string decoding methods with safe string filtering for each encoding type - Filters invalid Unicode characters (C0/C1 control codes, non-characters) by removal rather than replacement since the UO client renders nothing for these characters - Fixes UTF-16 null terminator position handling to correctly advance by 2 bytes ## Changes TextEncoding.cs - Added SearchValues-based invalid byte/char detection for efficient filtering - Added encoding-specific GetString methods: GetStringAscii, GetStringLatin1, GetStringUtf8, GetStringBigUni, GetStringLittleUni - Each method supports a safeString parameter for filtering invalid characters - Little-endian UTF-16 uses direct memory cast for zero-copy decoding on LE systems - Invalid characters are removed (not replaced with U+FFFD) since the client renders nothing for them SpanReader.cs - Added ReadLatin1() and ReadLatin1Safe() methods - Rewrote encoding-specific read methods to use optimized TextEncoding.GetString* methods - Fixed UTF-16 null terminator handling: position now correctly advances by byteLength (2) instead of 1 SpanWriter.cs - Added WriteLatin1 and WriteLatin1Null methods ## Packet Updates - Updated all packet code to use Latin1 encoding instead of CP1252 - Affected: account packets, equipment packets, menu packets, message packets, mobile packets, player packets, secure trade packets, vendor packets, gump packets, book packets, mahjong packets ## Filtering Behavior Invalid characters filtered in safe mode: ``` ┌───────────────┬────────────────────────┐ │ Range │ Description │ ├───────────────┼────────────────────────┤ │ 0x00-0x1F │ C0 control codes │ ├───────────────┼────────────────────────┤ │ 0x7F │ DEL │ ├───────────────┼────────────────────────┤ │ 0x80-0x9F │ C1 control codes │ ├───────────────┼────────────────────────┤ │ 0xFFFE-0xFFFF │ Unicode non-characters │ └───────────────┴────────────────────────┘ ``` Note: Surrogate pairs (0xD800-0xDFFF) are not filtered because proper validation requires context checking for paired vs unpaired surrogates. The UO client renders nothing for these anyway. ## Test Plan - All 631 Server.Tests pass - Verified client rendering behavior using TestUnicodeGump command (pages 1-5) - Confirmed U+FFFD, unpaired surrogates, and non-characters all render as blank in client - Verified Latin1 characters (0xA0-0xFF) display correctly - Verified C1 control codes (0x80-0x9F) are filtered and don't display
149 lines
4.3 KiB
C#
149 lines
4.3 KiB
C#
/*************************************************************************
|
|
* ModernUO *
|
|
* Copyright 2019-2024 - ModernUO Development Team *
|
|
* Email: hi@modernuo.com *
|
|
* File: OutgoingMenuPackets.cs *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
*************************************************************************/
|
|
|
|
using System;
|
|
using System.Buffers;
|
|
using System.IO;
|
|
using Server.Menus.ItemLists;
|
|
using Server.Menus.Questions;
|
|
|
|
namespace Server.Network;
|
|
|
|
[Flags]
|
|
public enum CMEFlags
|
|
{
|
|
None = 0x00,
|
|
Disabled = 0x01,
|
|
Arrow = 0x02,
|
|
Highlighted = 0x04,
|
|
Colored = 0x20
|
|
}
|
|
|
|
public static class OutgoingMenuPackets
|
|
{
|
|
public static void SendDisplayItemListMenu(this NetState ns, ItemListMenu menu)
|
|
{
|
|
if (ns == null || menu == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
var question = menu.Question?.Trim();
|
|
var questionLength = question?.Length ?? 0;
|
|
|
|
var entries = menu.Entries;
|
|
int entriesLength = (byte)entries.Length;
|
|
|
|
var maxLength = 11 + questionLength;
|
|
for (var i = 0; i < entriesLength; i++)
|
|
{
|
|
maxLength += 5 + entries[i].Name?.Length ?? 0; // could be trimmed
|
|
}
|
|
|
|
var writer = new SpanWriter(stackalloc byte[maxLength]);
|
|
writer.Write((byte)0x7C); // Packet ID
|
|
writer.Seek(2, SeekOrigin.Current);
|
|
writer.Write(menu.Serial);
|
|
writer.Write((ushort)0);
|
|
|
|
writer.Write((byte)questionLength);
|
|
|
|
if (question != null)
|
|
{
|
|
writer.WriteLatin1(question);
|
|
}
|
|
|
|
writer.Write((byte)entriesLength);
|
|
|
|
for (var i = 0; i < entriesLength; ++i)
|
|
{
|
|
var e = entries[i];
|
|
|
|
writer.Write((ushort)e.ItemID);
|
|
writer.Write((short)e.Hue);
|
|
|
|
var name = e.Name?.Trim();
|
|
|
|
if (name == null)
|
|
{
|
|
writer.Write((byte)0);
|
|
}
|
|
else
|
|
{
|
|
var nameLength = name.Length;
|
|
writer.Write((byte)nameLength);
|
|
writer.WriteLatin1(name);
|
|
}
|
|
}
|
|
|
|
writer.WritePacketLength();
|
|
ns.Send(writer.Span);
|
|
}
|
|
|
|
public static void SendDisplayQuestionMenu(this NetState ns, QuestionMenu menu)
|
|
{
|
|
if (ns == null || menu == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
var question = menu.Question?.Trim();
|
|
var questionLength = question?.Length ?? 0;
|
|
|
|
var answers = menu.Answers;
|
|
int answersLength = (byte)answers.Length;
|
|
|
|
var maxLength = 11 + questionLength;
|
|
for (var i = 0; i < answersLength; i++)
|
|
{
|
|
maxLength += 5 + answers[i]?.Length ?? 0; // could be trimmed
|
|
}
|
|
|
|
var writer = new SpanWriter(stackalloc byte[maxLength]);
|
|
writer.Write((byte)0x7C); // Packet ID
|
|
writer.Seek(2, SeekOrigin.Current);
|
|
writer.Write(menu.Serial);
|
|
writer.Write((ushort)0);
|
|
writer.Write((byte)questionLength);
|
|
|
|
if (question != null)
|
|
{
|
|
writer.WriteLatin1(question);
|
|
}
|
|
|
|
writer.Write((byte)answersLength);
|
|
|
|
for (var i = 0; i < answersLength; ++i)
|
|
{
|
|
writer.Write(0);
|
|
|
|
var answer = answers[i]?.Trim();
|
|
|
|
if (answer == null)
|
|
{
|
|
writer.Write((byte)0);
|
|
}
|
|
else
|
|
{
|
|
var nameLength = answer.Length;
|
|
writer.Write((byte)nameLength);
|
|
writer.WriteLatin1(answer);
|
|
}
|
|
}
|
|
|
|
writer.WritePacketLength();
|
|
ns.Send(writer.Span);
|
|
}
|
|
}
|