Dalamud/Dalamud/Game/Text/SeStringHandling/Payload.cs

using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;

using Dalamud.Data;
using Dalamud.Game.Text.SeStringHandling.Payloads;
using Dalamud.Plugin.Services;

using Newtonsoft.Json;
using Serilog;

// TODOs:
//   - refactor integer handling now that we have multiple packed types
// Maybes:
//   - convert parsing to custom structs for each payload?  would make some code prettier and easier to work with
//     but also wouldn't work out as well for things that are dynamically-sized
//   - [SeString] some way to add surrounding formatting information as flags/data to text (or other?) payloads?
//     eg, if a text payload is surrounded by italics payloads, strip them out and mark the text payload as italicized

namespace Dalamud.Game.Text.SeStringHandling;

/// <summary>
/// This class represents a parsed SeString payload.
/// </summary>
public abstract partial class Payload
{
    // private for now, since subclasses shouldn't interact with this.
    // To force-invalidate it, Dirty can be set to true
    private byte[] encodedData;

    /// <summary>
    /// Gets the type of this payload.
    /// </summary>
    public abstract PayloadType Type { get; }

    /// <summary>
    /// Gets or sets a value indicating whether whether this payload has been modified since the last Encode().
    /// </summary>
    public bool Dirty { get; protected set; } = true;

    /// <summary>
    /// Gets the Lumina instance to use for any necessary data lookups.
    /// </summary>
    [JsonIgnore]
    // TODO: We should refactor this. It should not be possible to get IDataManager through here.
    protected IDataManager DataResolver => Service<DataManager>.Get();

    /// <summary>
    /// Decodes a binary representation of a payload into its corresponding nice object payload.
    /// </summary>
    /// <param name="reader">A reader positioned at the start of the payload, and containing at least one entire payload.</param>
    /// <returns>The constructed Payload-derived object that was decoded from the binary data.</returns>
    public static Payload Decode(BinaryReader reader)
    {
        var payloadStartPos = reader.BaseStream.Position;

        Payload payload;

        var initialByte = reader.ReadByte();
        reader.BaseStream.Position--;
        if (initialByte != START_BYTE)
        {
            payload = DecodeText(reader);
        }
        else
        {
            payload = DecodeChunk(reader);
        }

        // for now, cache off the actual binary data for this payload, so we don't have to
        // regenerate it if the payload isn't modified
        // TODO: probably better ways to handle this
        var payloadEndPos = reader.BaseStream.Position;

        reader.BaseStream.Position = payloadStartPos;
        payload.encodedData = reader.ReadBytes((int)(payloadEndPos - payloadStartPos));
        payload.Dirty = false;

        // Log.Verbose($"got payload bytes {BitConverter.ToString(payload.encodedData).Replace("-", " ")}");

        reader.BaseStream.Position = payloadEndPos;

        return payload;
    }

    /// <summary>
    /// Encode this payload object into a byte[] useable in-game for things like the chat log.
    /// </summary>
    /// <param name="force">If true, ignores any cached value and forcibly reencodes the payload from its internal representation.</param>
    /// <returns>A byte[] suitable for use with in-game handlers such as the chat log.</returns>
    public byte[] Encode(bool force = false)
    {
        if (this.Dirty || force)
        {
            this.encodedData = this.EncodeImpl();
            this.Dirty = false;
        }

        return this.encodedData;
    }

    /// <summary>
    /// Encodes the internal state of this payload into a byte[] suitable for sending to in-game
    /// handlers such as the chat log.
    /// </summary>
    /// <returns>Encoded binary payload data suitable for use with in-game handlers.</returns>
    protected abstract byte[] EncodeImpl();

    /// <summary>
    /// Decodes a byte stream from the game into a payload object.
    /// </summary>
    /// <param name="reader">A BinaryReader containing at least all the data for this payload.</param>
    /// <param name="endOfStream">The location holding the end of the data for this payload.</param>
    // TODO: endOfStream is somewhat legacy now that payload length is always handled correctly.
    // This could be changed to just take a straight byte[], but that would complicate reading
    // but we could probably at least remove the end param
    protected abstract void DecodeImpl(BinaryReader reader, long endOfStream);

    private static Payload DecodeChunk(BinaryReader reader)
    {
        Payload payload = null;

        reader.ReadByte(); // START_BYTE
        var chunkType = (SeStringChunkType)reader.ReadByte();
        var chunkLen = GetInteger(reader);

        var packetStart = reader.BaseStream.Position;

        // any unhandled payload types will be turned into a RawPayload with the exact same binary data
        switch (chunkType)
        {
            case SeStringChunkType.EmphasisItalic:
                payload = new EmphasisItalicPayload();
                break;

            case SeStringChunkType.NewLine:
                payload = NewLinePayload.Payload;
                break;

            case SeStringChunkType.SeHyphen:
                payload = SeHyphenPayload.Payload;
                break;

            case SeStringChunkType.Interactable:
                {
                    var subType = (EmbeddedInfoType)reader.ReadByte();
                    switch (subType)
                    {
                        case EmbeddedInfoType.PlayerName:
                            payload = new PlayerPayload();
                            break;

                        case EmbeddedInfoType.ItemLink:
                            payload = new ItemPayload();
                            break;

                        case EmbeddedInfoType.MapPositionLink:
                            payload = new MapLinkPayload();
                            break;

                        case EmbeddedInfoType.Status:
                            payload = new StatusPayload();
                            break;

                        case EmbeddedInfoType.QuestLink:
                            payload = new QuestPayload();
                            break;

                        case EmbeddedInfoType.DalamudLink:
                            payload = new DalamudLinkPayload();
                            break;

                        case EmbeddedInfoType.PartyFinderNotificationLink:
                        // this is handled by PartyFinderPayload, so let this fall through
                        case EmbeddedInfoType.PartyFinderLink:
                            payload = new PartyFinderPayload();
                            break;

                        case EmbeddedInfoType.LinkTerminator:
                        // this has no custom handling and so needs to fallthrough to ensure it is captured
                        default:
                            // but I'm also tired of this log
                            if (subType != EmbeddedInfoType.LinkTerminator)
                            {
                                Log.Verbose("Unhandled EmbeddedInfoType: {0}", subType);
                            }

                            // rewind so we capture the Interactable byte in the raw data
                            reader.BaseStream.Seek(-1, SeekOrigin.Current);
                            break;
                    }
                }

                break;

            case SeStringChunkType.AutoTranslateKey:
                payload = new AutoTranslatePayload();
                break;

            case SeStringChunkType.UIForeground:
                payload = new UIForegroundPayload();
                break;

            case SeStringChunkType.UIGlow:
                payload = new UIGlowPayload();
                break;

            case SeStringChunkType.Icon:
                payload = new IconPayload();
                break;
            
            default:
                // Log.Verbose("Unhandled SeStringChunkType: {0}", chunkType);
                break;
        }

        payload ??= new RawPayload((byte)chunkType);
        payload.DecodeImpl(reader, reader.BaseStream.Position + chunkLen - 1);

        // read through the rest of the packet
        var readBytes = (uint)(reader.BaseStream.Position - packetStart);
        reader.ReadBytes((int)(chunkLen - readBytes + 1)); // +1 for the END_BYTE marker

        return payload;
    }

    private static Payload DecodeText(BinaryReader reader)
    {
        var payload = new TextPayload();
        payload.DecodeImpl(reader, reader.BaseStream.Length);

        return payload;
    }
}

/// <summary>
/// Parsing helpers.
/// </summary>
public abstract partial class Payload
{
    /// <summary>
    /// The start byte of a payload.
    /// </summary>
    [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1310:Field names should not contain underscore", Justification = "This is preferred.")]
    protected const byte START_BYTE = 0x02;

    /// <summary>
    /// The end byte of a payload.
    /// </summary>
    [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1310:Field names should not contain underscore", Justification = "This is preferred.")]
    protected const byte END_BYTE = 0x03;

    /// <summary>
    /// This represents the type of embedded info in a payload.
    /// </summary>
    public enum EmbeddedInfoType
    {
        /// <summary>
        /// A player's name.
        /// </summary>
        PlayerName = 0x01,

        /// <summary>
        /// The link to an iteme.
        /// </summary>
        ItemLink = 0x03,

        /// <summary>
        /// The link to a map position.
        /// </summary>
        MapPositionLink = 0x04,

        /// <summary>
        /// The link to a quest.
        /// </summary>
        QuestLink = 0x05,

        /// <summary>
        /// The link to the party finder search conditions.
        /// </summary>
        PartyFinderNotificationLink = 0x08,

        /// <summary>
        /// A status effect.
        /// </summary>
        Status = 0x09,

        /// <summary>
        /// The link to a party finder listing.
        /// </summary>
        PartyFinderLink = 0x0A,

        /// <summary>
        /// A custom Dalamud link.
        /// </summary>
        DalamudLink = 0x0F,

        /// <summary>
        /// A link terminator.
        /// </summary>
        /// <remarks>
        /// It is not exactly clear what this is, but seems to always follow a link.
        /// </remarks>
        LinkTerminator = 0xCF,
    }

    /// <summary>
    /// This represents the type of payload and how it should be encoded.
    /// </summary>
    protected enum SeStringChunkType
    {
        /// <summary>
        /// See the <see cref="NewLinePayload"/>.
        /// </summary>
        NewLine = 0x10,
        
        /// <summary>
        /// See the <see cref="IconPayload"/> class.
        /// </summary>
        Icon = 0x12,

        /// <summary>
        /// See the <see cref="EmphasisItalicPayload"/> class.
        /// </summary>
        EmphasisItalic = 0x1A,

        /// <summary>
        /// See the <see cref="SeHyphenPayload"/> class.
        /// </summary>
        SeHyphen = 0x1F,

        /// <summary>
        /// See any of the link-type classes:
        /// <see cref="PlayerPayload"/>,
        /// <see cref="ItemPayload"/>,
        /// <see cref="MapLinkPayload"/>,
        /// <see cref="StatusPayload"/>,
        /// <see cref="QuestPayload"/>,
        /// <see cref="DalamudLinkPayload"/>.
        /// </summary>
        Interactable = 0x27,

        /// <summary>
        /// See the <see cref="AutoTranslatePayload"/> class.
        /// </summary>
        AutoTranslateKey = 0x2E,

        /// <summary>
        /// See the <see cref="UIForegroundPayload"/> class.
        /// </summary>
        UIForeground = 0x48,

        /// <summary>
        /// See the <see cref="UIGlowPayload"/> class.
        /// </summary>
        UIGlow = 0x49,
    }

    /// <summary>
    /// Retrieve the packed integer from SE's native data format.
    /// </summary>
    /// <param name="input">The BinaryReader instance.</param>
    /// <returns>An integer.</returns>
    // made protected, unless we actually want to use it externally
    // in which case it should probably go live somewhere else
    protected static uint GetInteger(BinaryReader input)
    {
        uint marker = input.ReadByte();
        if (marker < 0xD0)
            return marker - 1;

        // the game adds 0xF0 marker for values >= 0xCF
        // uasge of 0xD0-0xEF is unknown, should we throw here?
        // if (marker < 0xF0) throw new NotSupportedException();

        marker = (marker + 1) & 0b1111;

        var ret = new byte[4];
        for (var i = 3; i >= 0; i--)
        {
            ret[i] = (marker & (1 << i)) == 0 ? (byte)0 : input.ReadByte();
        }

        return BitConverter.ToUInt32(ret, 0);
    }

    /// <summary>
    /// Create a packed integer in Se's native data format.
    /// </summary>
    /// <param name="value">The value to pack.</param>
    /// <returns>A packed integer.</returns>
    protected static byte[] MakeInteger(uint value)
    {
        if (value < 0xCF)
        {
            return new byte[] { (byte)(value + 1) };
        }

        var bytes = BitConverter.GetBytes(value);

        var ret = new List<byte>() { 0xF0 };
        for (var i = 3; i >= 0; i--)
        {
            if (bytes[i] != 0)
            {
                ret.Add(bytes[i]);
                ret[0] |= (byte)(1 << i);
            }
        }

        ret[0] -= 1;

        return ret.ToArray();
    }

    /// <summary>
    /// From a binary packed integer, get the high and low bytes.
    /// </summary>
    /// <param name="input">The BinaryReader instance.</param>
    /// <returns>The high and low bytes.</returns>
    protected static (uint High, uint Low) GetPackedIntegers(BinaryReader input)
    {
        var value = GetInteger(input);
        return (value >> 16, value & 0xFFFF);
    }

    /// <summary>
    /// Create a packed integer from the given high and low bytes.
    /// </summary>
    /// <param name="high">The high order bytes.</param>
    /// <param name="low">The low order bytes.</param>
    /// <returns>A packed integer.</returns>
    protected static byte[] MakePackedInteger(uint high, uint low)
    {
        var value = (high << 16) | (low & 0xFFFF);
        return MakeInteger(value);
    }
}