Added per-connection comm logging in debug mode.

It is meant for debugging only, so it is compiled only into debug mode. It is activated by starting the server with "/logcomm" parameter.

src/Protocol/Protocol17x.cpp

@@ -53,6 +53,18 @@ Implements the 1.7.x protocol classes:
 
 
 
+#ifdef _DEBUG
+// fwd: main.cpp:
+extern bool g_ShouldLogComm;
+#endif
+
+
+
+
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// cProtocol172:
+
 cProtocol172::cProtocol172(cClientHandle * a_Client, const AString & a_ServerAddress, UInt16 a_ServerPort, UInt32 a_State) :
 	super(a_Client),
 	m_ServerAddress(a_ServerAddress),
@@ -63,6 +75,15 @@ cProtocol172::cProtocol172(cClientHandle * a_Client, const AString & a_ServerAdd
 	m_OutPacketLenBuffer(20),  // 20 bytes is more than enough for one VarInt
 	m_IsEncrypted(false)
 {
+	// Create the comm log file, if so requested:
+	#ifdef _DEBUG
+	if (g_ShouldLogComm)
+	{
+		cFile::CreateFolder("CommLogs");
+		AString FileName = Printf("CommLogs/%x__%s.log", (unsigned)time(NULL), a_Client->GetIPString().c_str());
+		m_CommLogFile.Open(FileName, cFile::fmWrite);
+	}
+	#endif  // _DEBUG
 }
 
 
@@ -1065,6 +1086,18 @@ void cProtocol172::SendWindowProperty(const cWindow & a_Window, short a_Property
 
 void cProtocol172::AddReceivedData(const char * a_Data, int a_Size)
 {
+	// Write the incoming data into the comm log file:
+	#ifdef _DEBUG
+	if (g_ShouldLogComm)
+	{
+		AString Hex;
+		CreateHexDump(Hex, a_Data, a_Size, 16);
+		m_CommLogFile.Printf("Incoming data: %d bytes. %d bytes unparsed already present in buffer.\n%s\n",
+			a_Size, m_ReceivedData.GetReadableSpace(), Hex.c_str()
+		);
+	}
+	#endif
+	
 	if (!m_ReceivedData.Write(a_Data, a_Size))
 	{
 		// Too much data in the incoming queue, report to caller:
@@ -1100,6 +1133,24 @@ void cProtocol172::AddReceivedData(const char * a_Data, int a_Size)
 			return;
 		}
 
+		// Log the packet info into the comm log file:
+		#ifdef _DEBUG
+		if (g_ShouldLogComm)
+		{
+			AString PacketData;
+			bb.ReadAll(PacketData);
+			bb.ResetRead();
+			bb.ReadVarInt(PacketType);
+			ASSERT(PacketData.size() > 0);
+			PacketData.resize(PacketData.size() - 1);
+			AString PacketDataHex;
+			CreateHexDump(PacketDataHex, PacketData.data(), PacketData.size(), 16);
+			m_CommLogFile.Printf("Next incoming packet is type %u (0x%x), length %u (0x%x) at state %d. Payload:\n%s\n",
+				PacketType, PacketType, PacketLen, PacketLen, m_State, PacketDataHex.c_str()
+			);
+		}
+		#endif  // _DEBUG
+		
 		if (!HandlePacket(bb, PacketType))
 		{
 			// Unknown packet, already been reported, but without the length. Log the length here:
@@ -1807,6 +1858,19 @@ cProtocol172::cPacketizer::~cPacketizer()
 	m_Out.ReadAll(DataToSend);
 	m_Protocol.SendData(DataToSend.data(), DataToSend.size());
 	m_Out.CommitRead();
+	
+	// Log the comm into logfile:
+	#ifdef _DEBUG
+	if (g_ShouldLogComm)
+	{
+		AString Hex;
+		ASSERT(DataToSend.size() > 0);
+		CreateHexDump(Hex, DataToSend.data() + 1, DataToSend.size() - 1, 16);
+		m_Protocol.m_CommLogFile.Printf("Outgoing packet: type %d (0x%x), length %u (0x%x), state %d. Payload:\n%s\n",
+			DataToSend[0], DataToSend[0], PacketLen, PacketLen, m_Protocol.m_State, Hex.c_str()
+		);
+	}
+	#endif  // _DEBUG
 }
 
 

src/Protocol/Protocol17x.h

@@ -223,6 +223,11 @@ protected:
 	CryptoPP::CFB_Mode<CryptoPP::AES>::Decryption m_Decryptor;
 	CryptoPP::CFB_Mode<CryptoPP::AES>::Encryption m_Encryptor;
 	
+	#ifdef _DEBUG
+	/** The logfile where the comm is logged, when g_ShouldLogComm is true */
+	cFile m_CommLogFile;
+	#endif
+	
 	
 	/// Adds the received (unencrypted) data to m_ReceivedData, parses complete packets
 	void AddReceivedData(const char * a_Data, int a_Size);

src/main.cpp

@@ -19,6 +19,15 @@ bool g_SERVER_TERMINATED = false; // Set to true when the server terminates, so
 
 
 
+#ifdef _DEBUG
+/** If set to true, the protocols will log each player's communication to a separate logfile */
+bool g_ShouldLogComm;
+#endif
+
+
+
+
+
 /// If defined, a thorough leak finder will be used (debug MSVC only); leaks will be output to the Output window
 #define ENABLE_LEAK_FINDER
 
@@ -222,6 +231,20 @@ int main( int argc, char **argv )
 	// DEBUG: test the dumpfile creation:
 	// *((int *)0) = 0;
 	
+	// Check if comm logging is to be enabled:
+	#ifdef _DEBUG
+	for (int i = 0; i < argc; i++)
+	{
+		if (
+			(_stricmp(argv[i], "/commlog") == 0) ||
+			(_stricmp(argv[i], "/logcomm") == 0)
+		)
+		{
+			g_ShouldLogComm = true;
+		}
+	}
+	#endif  // _DEBUG
+	
 	#if !defined(ANDROID_NDK)
 	try
 	#endif