[GEN][ZH] Improve Network logging (#406)

Add DEBUG_LOG message when sending packet is incomplete, when an unknown packet is received and when a packet cannot be sent. Add PRINTF_IP_AS_4_INTS macro to simplify printing of IP addresses. Also change logs in LANAPI::update to print proper IP addresses.

Author: helmutbuhler

Generals/Code/GameEngine/Include/GameNetwork/NetworkDefs.h

@@ -212,5 +212,6 @@ static const Int NETWORK_BASE_PORT_NUMBER = 8088;
 class NetworkInterface;
 extern NetworkInterface *TheNetwork;
 
+#define PRINTF_IP_AS_4_INTS(ip) ((ip) >> 24) & 0xff, ((ip) >> 16) & 0xff, ((ip) >> 8 ) & 0xff, (ip) & 0xff
 
 #endif

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanGameOptionsMenu.cpp

@@ -221,6 +221,12 @@ static void playerTooltip(GameWindow *window,
 	}
 	UnicodeString tooltip;
 	tooltip.format(TheGameText->fetch("TOOLTIP:LANPlayer"), player->getName().str(), player->getLogin().str(), player->getHost().str());
+#if defined(_DEBUG) || defined(_INTERNAL)
+	UnicodeString ip;
+	ip.format(L" - %d.%d.%d.%d", PRINTF_IP_AS_4_INTS(player->getIP()));
+	tooltip.concat(ip);
+#endif
+
 	TheMouse->setCursorTooltip( tooltip );
 }
 

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanLobbyMenu.cpp

@@ -312,6 +312,11 @@ static void playerTooltip(GameWindow *window,
 	}
 	UnicodeString tooltip;
 	tooltip.format(TheGameText->fetch("TOOLTIP:LANPlayer"), player->getName().str(), player->getLogin().str(), player->getHost().str());
+#if defined(_DEBUG) || defined(_INTERNAL)
+	UnicodeString ip;
+	ip.format(L" - %d.%d.%d.%d", PRINTF_IP_AS_4_INTS(player->getIP()));
+	tooltip.concat(ip);
+#endif
 	TheMouse->setCursorTooltip( tooltip );
 }
 
@@ -377,7 +382,7 @@ void LanLobbyMenuInit( WindowLayout *layout, void *userData )
 	// Choose an IP address, then initialize the LAN singleton
 	UnsignedInt IP = TheGlobalData->m_defaultIP;
 	IPEnumeration IPs;
-
+	const WideChar* IPSource;
 	if (!IP)
 	{
 		EnumeratedIP *IPlist = IPs.getAddresses();
@@ -393,23 +398,18 @@ void LanLobbyMenuInit( WindowLayout *layout, void *userData )
 			/// @todo: display error and exit lan lobby if no IPs are found
 		}
 
-		//UnicodeString str;
-		//str.format(L"Local IP chosen: %hs", IPlist->getIPstring().str());
-		//GadgetListBoxAddEntryText(listboxChatWindow, str, chatSystemColor, -1, 0);
+		IPSource = L"Local IP chosen";
 		IP = IPlist->getIP();
 	}
 	else
 	{
-		/*
-		UnicodeString str;
-		str.format(L"Default local IP: %d.%d.%d.%d",
-			(IP >> 24),
-			(IP >> 16) & 0xFF,
-			(IP >> 8) & 0xFF,
-			IP & 0xFF);
-		GadgetListBoxAddEntryText(listboxChatWindow, str, chatSystemColor, -1, 0);
-		*/
+		IPSource = L"Default local IP";
 	}
+#if defined(_DEBUG) || defined(_INTERNAL)
+	UnicodeString str;
+	str.format(L"%s: %d.%d.%d.%d", IPSource, PRINTF_IP_AS_4_INTS(IP));
+	GadgetListBoxAddEntryText(listboxChatWindow, str, chatSystemColor, -1, 0);
+#endif
 
 	// TheLAN->init() sets us to be in a LAN menu screen automatically.
 	TheLAN->init();

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/NetworkDirectConnect.cpp

@@ -193,7 +193,7 @@ void HostDirectConnectGame()
 
 	UnsignedInt localIP = TheLAN->GetLocalIP();
 	UnicodeString localIPString;
-	localIPString.format(L"%d.%d.%d.%d", localIP >> 24, (localIP & 0xff0000) >> 16, (localIP & 0xff00) >> 8, localIP & 0xff);
+	localIPString.format(L"%d.%d.%d.%d", PRINTF_IP_AS_4_INTS(localIP));
 
 	UnicodeString name;
 	name = GadgetTextEntryGetText(editPlayerName);
@@ -347,7 +347,7 @@ void NetworkDirectConnectInit( WindowLayout *layout, void *userData )
 	}
 
 	UnsignedInt ip = TheLAN->GetLocalIP();
-	ipstr.format(L"%d.%d.%d.%d", ip >> 24, (ip & 0xff0000) >> 16, (ip & 0xff00) >> 8, ip & 0xff);
+	ipstr.format(L"%d.%d.%d.%d", PRINTF_IP_AS_4_INTS(ip));
 	GadgetStaticTextSetText(staticLocalIP, ipstr);
 
 	TheLAN->RequestLobbyLeave(true);

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -289,7 +289,7 @@ void OptionPreferences::setLANIPAddress( AsciiString IP )
 void OptionPreferences::setLANIPAddress( UnsignedInt IP )
 {
 	AsciiString tmp;
-	tmp.format("%d.%d.%d.%d", ((IP & 0xff000000) >> 24), ((IP & 0xff0000) >> 16), ((IP & 0xff00) >> 8), (IP & 0xff));
+	tmp.format("%d.%d.%d.%d", PRINTF_IP_AS_4_INTS(IP));
 	(*this)["IPAddress"] = tmp;
 }
 
@@ -317,7 +317,7 @@ void OptionPreferences::setOnlineIPAddress( AsciiString IP )
 void OptionPreferences::setOnlineIPAddress( UnsignedInt IP )
 {
 	AsciiString tmp;
-	tmp.format("%d.%d.%d.%d", ((IP & 0xff000000) >> 24), ((IP & 0xff0000) >> 16), ((IP & 0xff00) >> 8), (IP & 0xff));
+	tmp.format("%d.%d.%d.%d", PRINTF_IP_AS_4_INTS(IP));
 	(*this)["GameSpyIPAddress"] = tmp;
 }
 

Generals/Code/GameEngine/Source/GameNetwork/ConnectionManager.cpp

@@ -1946,10 +1946,7 @@ void ConnectionManager::parseUserList(const GameInfo *game)
 	char *listPos;
 
 	DEBUG_LOG(("ConnectionManager::parseUserList - looking for local user at %d.%d.%d.%d:%d\n",
-		(m_localAddr >> 24) & 0xff,
-		(m_localAddr >> 16) & 0xff,
-		(m_localAddr >> 8) & 0xff,
-		m_localAddr & 0xff,
+		PRINTF_IP_AS_4_INTS(m_localAddr),
 		m_localPort));
 
 	int numUsers = 0;

Generals/Code/GameEngine/Source/GameNetwork/FirewallHelper.cpp

@@ -364,10 +364,7 @@ Bool FirewallHelperClass::sendToManglerFromPort(UnsignedInt address, UnsignedSho
 	packet.length = sizeof(ManglerData);
 
 	DEBUG_LOG(("FirewallHelperClass::sendToManglerFromPort - Sending from port %d to %d.%d.%d.%d:%d\n", (UnsignedInt)port,
-		(address & 0xFF000000) >> 24,
-		(address & 0xFF0000) >> 16,
-		(address & 0xFF00) >> 8,
-		(address & 0xFF), MANGLER_PORT));
+		PRINTF_IP_AS_4_INTS(address), MANGLER_PORT));
 /*
 	DEBUG_LOG(("Buffer = "));
 	for (i = 0; i < sizeof(ManglerData); ++i) {

Generals/Code/GameEngine/Source/GameNetwork/GameInfo.cpp

@@ -440,7 +440,7 @@ void GameInfo::setSlot( Int slotNum, GameSlot slotInfo )
 #endif
 
 	DEBUG_LOG(("GameInfo::setSlot - setting slot %d to be player %ls with IP %d.%d.%d.%d\n", slotNum, slotInfo.getName().str(),
-							ip >> 24, (ip >> 16) & 0xff, (ip >> 8) & 0xff, ip & 0xff));
+							PRINTF_IP_AS_4_INTS(ip)));
 }
 
 GameSlot* GameInfo::getSlot( Int slotNum )

Generals/Code/GameEngine/Source/GameNetwork/GameSpyGameInfo.cpp

@@ -537,10 +537,7 @@ void GameSpyLaunchGame( void )
 				*/
 				{
 				user.format(",%s@%d.%d.%d.%d:%d", tmpUserName.str(),
-					((ip & 0xff000000) >> 24),
-					((ip & 0xff0000) >> 16),
-					((ip & 0xff00) >> 8),
-					((ip & 0xff)),
+					PRINTF_IP_AS_4_INTS(ip),
 					TheNAT->getSlotPort(i)
 					);
 				}

Generals/Code/GameEngine/Source/GameNetwork/LANAPI.cpp

@@ -359,43 +359,43 @@ void LANAPI::update( void )
 			{
 				// Location specification
 			case LANMessage::MSG_REQUEST_LOCATIONS:		// Hey, where is everybody?
-//				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_LOCATIONS from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_LOCATIONS from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleRequestLocations( msg, senderIP );
 				break;
 			case LANMessage::MSG_GAME_ANNOUNCE:				// Here someone is, and here's his game info!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_GAME_ANNOUNCE from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_GAME_ANNOUNCE from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleGameAnnounce( msg, senderIP );
 				break;
 			case LANMessage::MSG_LOBBY_ANNOUNCE:			// Hey, I'm in the lobby!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_LOBBY_ANNOUNCE from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_LOBBY_ANNOUNCE from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleLobbyAnnounce( msg, senderIP );
 				break;
 			case LANMessage::MSG_REQUEST_GAME_INFO:
-//				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_GAME_INFO from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_GAME_INFO from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleRequestGameInfo( msg, senderIP );
 				break;
 
 				// Joining games
 			case LANMessage::MSG_REQUEST_JOIN:				// Let me in!  Let me in!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_JOIN from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_JOIN from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleRequestJoin( msg, senderIP );
 				break;
 			case LANMessage::MSG_JOIN_ACCEPT:					// Okay, you can join.
-//				DEBUG_LOG(("LANAPI::update - got a MSG_JOIN_ACCEPT from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_JOIN_ACCEPT from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleJoinAccept( msg, senderIP );
 				break;
 			case LANMessage::MSG_JOIN_DENY:						// Go away!  We don't want any!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_JOIN_DENY from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_JOIN_DENY from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleJoinDeny( msg, senderIP );
 				break;
 
 				// Leaving games, lobby
 			case LANMessage::MSG_REQUEST_GAME_LEAVE:				// I'm outa here!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_GAME_LEAVE from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_GAME_LEAVE from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleRequestGameLeave( msg, senderIP );
 				break;
 			case LANMessage::MSG_REQUEST_LOBBY_LEAVE:				// I'm outa here!
-//				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_LOBBY_LEAVE from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_REQUEST_LOBBY_LEAVE from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleRequestLobbyLeave( msg, senderIP );
 				break;
 
@@ -416,7 +416,7 @@ void LANAPI::update( void )
 				handleGameStartTimer( msg, senderIP );
 				break;
 			case LANMessage::MSG_GAME_OPTIONS:				// Here's some info about the game.
-//				DEBUG_LOG(("LANAPI::update - got a MSG_GAME_OPTIONS from 0x%08x\n", senderIP));
+				DEBUG_LOG(("LANAPI::update - got a MSG_GAME_OPTIONS from %d.%d.%d.%d\n", PRINTF_IP_AS_4_INTS(senderIP)));
 				handleGameOptions( msg, senderIP );
 				break;
 			case LANMessage::MSG_INACTIVE:		// someone is telling us that we're inactive.