Redact player names in messages

jo3bingham · jo3bingham · commit 66416a485ed6 · 2020-07-08T14:55:16.000-04:00
diff --git a/Apps/Redact/Program.cs b/Apps/Redact/Program.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.IO;
+using System.Text.RegularExpressions;
 
 using OXGaming.TibiaAPI;
 using OXGaming.TibiaAPI.Constants;
@@ -9,6 +10,8 @@ namespace Redact
 {
     class Program
     {
+        static Regex _lookPlayerRx = new Regex(@"you see .*\(level \d+\).*(she|he) is", RegexOptions.Compiled | RegexOptions.IgnoreCase);
+
         static string _recordingName;
 
         static bool _keepClientPackets;
@@ -126,6 +129,7 @@ static void Redact()
             client.Connection.OnReceivedServerCreateOnMapPacket += Connection_OnReceivedServerCreateOnMapPacket;
             client.Connection.OnReceivedServerCreatureUpdatePacket += Connection_OnReceivedServerCreatureUpdatePacket;
             client.Connection.OnReceivedServerTalkPacket += Connection_OnReceivedServerTalkPacket;
+            client.Connection.OnReceivedServerMessagePacket += Connection_OnReceivedServerMessagePacket;
 
             // These packets aren't necessary in a redacted recording.
             if (_keepClientPackets)
@@ -165,21 +169,29 @@ static void Redact()
 
             writer.Write(version);
 
+            var clientSequenceNumber = 0u;
+            var serverSequenceNumber = 0u;
+
             while (reader.BaseStream.Position < reader.BaseStream.Length)
             {
                 var packetType = (PacketType)reader.ReadByte();
                 var timestamp = reader.ReadInt64();
                 var size = reader.ReadUInt32();
+
+                // If the Record app wasn't properly shutdown, a recording could
+                // possibly be missing data at the end.
+                if (reader.BaseStream.Length - reader.BaseStream.Position < size)
+                {
+                    break;
+                }
+
                 _ = reader.ReadUInt16(); // packet size
-                var sequenceNumber = reader.ReadUInt32();
+                _ = reader.ReadUInt32(); // sequence number
+                var outMessage = new NetworkMessage(client);
                 var message = new NetworkMessage(client)
                 {
                     Size = size
                 };
-                var outMessage = new NetworkMessage(client)
-                {
-                    SequenceNumber = sequenceNumber
-                };
 
                 reader.BaseStream.Position -= 6;
                 Array.Copy(reader.ReadBytes((int)message.Size), message.GetBuffer(), message.Size);
@@ -199,9 +211,10 @@ static void Redact()
                     continue;
                 }
 
-                // Prepare the message to send without an XTEA key so that the proper
+                // Prepare the message without an XTEA key so that the proper
                 // sizes are added to the packet data, but it stays unencrypted.
                 outMessage.PrepareToSend(null);
+                outMessage.SequenceNumber = packetType == PacketType.Client ? clientSequenceNumber++ : serverSequenceNumber++;
 
                 var data = outMessage.GetData();
 
@@ -221,17 +234,35 @@ private static bool Connection_OnReceivedClientTalkPacket(Packet packet)
             return true;
         }
 
+        private static bool Connection_OnReceivedServerMessagePacket(Packet packet)
+        {
+            var p = (OXGaming.TibiaAPI.Network.ServerPackets.Message)packet;
+            if (p.MessageMode == MessageModeType.Look)
+            {
+                if (_lookPlayerRx.IsMatch(p.Text) || p.Text.Contains("You see yourself."))
+                {
+                    p.Text = "Redacted";
+                }
+            }
+            return true;
+        }
+
         private static bool Connection_OnReceivedServerTalkPacket(Packet packet)
         {
             var p = (OXGaming.TibiaAPI.Network.ServerPackets.Talk)packet;
-            p.SpeakerName = "Redacted";
+            var creature = p.Client.CreatureStorage.GetCreature(p.SpeakerName);
+            if (creature is null || creature.Type == CreatureType.Player)
+            {
+                p.SpeakerLevel = 100;
+                p.SpeakerName = "Redacted";
+            }
             return true;
         }
 
         private static bool Connection_OnReceivedServerCreatureUpdatePacket(Packet packet)
         {
             var p = (OXGaming.TibiaAPI.Network.ServerPackets.CreatureUpdate)packet;
-            if (p.Creature is object)
+            if (p.Creature is object && p.Creature.Type == CreatureType.Player)
             {
                 p.Creature.Name = "Redacted";
             }
@@ -241,7 +272,7 @@ private static bool Connection_OnReceivedServerCreatureUpdatePacket(Packet packe
         private static bool Connection_OnReceivedServerCreateOnMapPacket(Packet packet)
         {
             var p = (OXGaming.TibiaAPI.Network.ServerPackets.CreateOnMap)packet;
-            if (p.Creature is object)
+            if (p.Creature is object && p.Creature.Type == CreatureType.Player)
             {
                 p.Creature.Name = "Redacted";
             }
diff --git a/TibiaAPI/Creatures/CreatureStorage.cs b/TibiaAPI/Creatures/CreatureStorage.cs
@@ -20,6 +20,15 @@ public Creature GetCreature(uint creatureId)
             return _creatures.FirstOrDefault(c => c.Id == creatureId);
         }
 
+        public Creature GetCreature(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+            {
+                return null;
+            }
+            return _creatures.FirstOrDefault(c => c.Name.Equals(name, StringComparison.OrdinalIgnoreCase));
+        }
+
         public void RemoveCreature(uint creatureId)
         {
             var creature = GetCreature(creatureId);
diff --git a/TibiaAPI/Network/NetworkMessage.cs b/TibiaAPI/Network/NetworkMessage.cs
@@ -1054,17 +1054,17 @@ public void Write(Creature value, CreatureInstanceType type)
                         Write(value.HealthPercent);
                         Write((byte)value.Direction);
 
-                        if (value.Outfit is OutfitInstance)
+                        if (value.Outfit is OutfitInstance instance)
                         {
-                            Write((OutfitInstance)value.Outfit);
+                            Write(instance);
                         }
                         else
                         {
                             Write((ushort)0);
                             Write((ushort)value.Outfit.Id);
                         }
 
-                        Write(value.Mount.Id);
+                        Write((ushort)value.Mount.Id);
                         Write(value.Brightness);
                         Write(value.LightColor);
                         Write(value.Speed);

Original file line number	Diff line number	Diff line change
`@@ -1054,17 +1054,17 @@ public void Write(Creature value, CreatureInstanceType type)`
`1054`	`1054`	`Write(value.HealthPercent);`
`1055`	`1055`	`Write((byte)value.Direction);`
`1056`	`1056`
`1057`		`- if (value.Outfit is OutfitInstance)`
	`1057`	`+ if (value.Outfit is OutfitInstance instance)`
`1058`	`1058`	`{`
`1059`		`- Write((OutfitInstance)value.Outfit);`
	`1059`	`+ Write(instance);`
`1060`	`1060`	`}`
`1061`	`1061`	`else`
`1062`	`1062`	`{`
`1063`	`1063`	`Write((ushort)0);`
`1064`	`1064`	`Write((ushort)value.Outfit.Id);`
`1065`	`1065`	`}`
`1066`	`1066`
`1067`		`- Write(value.Mount.Id);`
	`1067`	`+ Write((ushort)value.Mount.Id);`
`1068`	`1068`	`Write(value.Brightness);`
`1069`	`1069`	`Write(value.LightColor);`
`1070`	`1070`	`Write(value.Speed);`