[GEN][ZH] Implement Network Lobby support for multi instance clients (#906)

xezon · web-flow · commit 9e2df4e2bd31 · 2025-05-30T21:36:27.000+02:00
diff --git a/Generals/Code/GameEngine/Include/GameNetwork/IPEnumeration.h b/Generals/Code/GameEngine/Include/GameNetwork/IPEnumeration.h
@@ -73,6 +73,7 @@ class IPEnumeration
 	AsciiString getMachineName( void );			///< Return the Network Neighborhood machine name
 
 protected:
+	void addNewIP( UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d );
 
 	EnumeratedIP *m_IPlist;
 	Bool m_isWinsockInitialized;
diff --git a/Generals/Code/GameEngine/Include/GameNetwork/networkutil.h b/Generals/Code/GameEngine/Include/GameNetwork/networkutil.h
@@ -30,6 +30,7 @@
 #include "GameNetwork/NetworkDefs.h"
 #include "GameNetwork/NetworkInterface.h"
 
+UnsignedInt AssembleIp(UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d);
 UnsignedInt ResolveIP(AsciiString host);
 UnsignedShort GenerateNextCommandID();
 Bool DoesCommandRequireACommandID(NetCommandType type);
@@ -47,4 +48,12 @@ void dumpBufferToLog(const void *vBuf, Int len, const char *fname, Int line);
 #define LOGBUFFER(buf, len) {}
 #endif // DEBUG_LOGGING
 
+inline UnsignedInt AssembleIp(UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d)
+{
+    return ((UnsignedInt)(a) << 24) |
+           ((UnsignedInt)(b) << 16) |
+           ((UnsignedInt)(c) << 8) |
+           ((UnsignedInt)(d));
+}
+
 #endif
diff --git a/Generals/Code/GameEngine/Source/GameClient/ClientInstance.cpp b/Generals/Code/GameEngine/Source/GameClient/ClientInstance.cpp
@@ -36,7 +36,7 @@ bool ClientInstance::initialize()
 	// WARNING: DO NOT use this number for any other application except Generals.
 	while (true)
 	{
-#ifdef RTS_MULTI_INSTANCE
+#if defined(RTS_MULTI_INSTANCE)
 		std::string guidStr = getFirstInstanceName();
 		if (s_instanceIndex > 0u)
 		{
diff --git a/Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanLobbyMenu.cpp b/Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanLobbyMenu.cpp
@@ -96,23 +96,30 @@ Bool LANPreferences::loadFromIniFile()
 UnicodeString LANPreferences::getUserName(void)
 {
 	UnicodeString ret;
+
 	LANPreferences::const_iterator it = find("UserName");
-	if (it == end())
+	if (it != end())
 	{
-		IPEnumeration IPs;
-		ret.translate(IPs.getMachineName());
-		return ret;
+		// Found an user name. Use it if valid.
+		ret = QuotedPrintableToUnicodeString(it->second);
+		ret.trim();
+		if (!ret.isEmpty())
+		{
+			return ret;
+		}
 	}
 
-	ret = QuotedPrintableToUnicodeString(it->second);
-	ret.trim();
-	if (ret.isEmpty())
+	if (rts::ClientInstance::getInstanceId() > 1u)
 	{
-		IPEnumeration IPs;
-		ret.translate(IPs.getMachineName());
+		// TheSuperHackers @feature Use the instance id as default user name
+		// to avoid duplicate names for multiple client instances.
+		ret.format(L"Instance%.2d", rts::ClientInstance::getInstanceId());
 		return ret;
 	}
-	
+
+	// Use machine name as default user name.
+	IPEnumeration IPs;
+	ret.translate(IPs.getMachineName());
 	return ret;
 }
 
diff --git a/Generals/Code/GameEngine/Source/GameNetwork/IPEnumeration.cpp b/Generals/Code/GameEngine/Source/GameNetwork/IPEnumeration.cpp
@@ -25,6 +25,8 @@
 #include "PreRTS.h"	// This must go first in EVERY cpp file int the GameEngine
 
 #include "GameNetwork/IPEnumeration.h"
+#include "GameNetwork/networkutil.h"
+#include "GameClient/ClientInstance.h"
 
 IPEnumeration::IPEnumeration( void )
 {
@@ -84,7 +86,7 @@ EnumeratedIP * IPEnumeration::getAddresses( void )
 	HOSTENT* hostEnt = gethostbyname(hostname);
 	if (hostEnt == NULL)
 	{
-		DEBUG_LOG(("Failed call to gethostnyname; WSAGetLastError returned %d\n", WSAGetLastError()));
+		DEBUG_LOG(("Failed call to gethostbyname; WSAGetLastError returned %d\n", WSAGetLastError()));
 		return NULL;
 	}
 	
@@ -94,62 +96,70 @@ EnumeratedIP * IPEnumeration::getAddresses( void )
 		DEBUG_LOG(("gethostbyname returns oddly-sized IP addresses!\n"));
 		return NULL;
 	}
-	
+
+#if defined(RTS_MULTI_INSTANCE)
+	// TheSuperHackers @feature Add one unique local host IP address for each multi client instance.
+	const UnsignedInt id = rts::ClientInstance::getInstanceId();
+	addNewIP(
+		127,
+		(UnsignedByte)(id >> 16),
+		(UnsignedByte)(id >> 8),
+		(UnsignedByte)(id));
+#endif
+
 	// construct a list of addresses
 	int numAddresses = 0;
 	char *entry;
 	while ( (entry = hostEnt->h_addr_list[numAddresses++]) != 0 )
 	{
-		EnumeratedIP *newIP = newInstance(EnumeratedIP);
+		addNewIP(
+			(UnsignedByte)entry[0],
+			(UnsignedByte)entry[1],
+			(UnsignedByte)entry[2],
+			(UnsignedByte)entry[3]);
+	}
 
-		AsciiString str;
-		str.format("%d.%d.%d.%d", (unsigned char)entry[0], (unsigned char)entry[1], (unsigned char)entry[2], (unsigned char)entry[3]);
+	return m_IPlist;
+}
+
+void IPEnumeration::addNewIP( UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d )
+{
+	EnumeratedIP *newIP = newInstance(EnumeratedIP);
 
-		UnsignedInt testIP = *((UnsignedInt *)entry);
-		UnsignedInt ip = ntohl(testIP);
+	AsciiString str;
+	str.format("%d.%d.%d.%d", (int)a, (int)b, (int)c, (int)d);
 
-		/*
-		ip = *entry++;
-		ip <<= 8;
-		ip += *entry++;
-		ip <<= 8;
-		ip += *entry++;
-		ip <<= 8;
-		ip += *entry++;
-		*/
+	UnsignedInt ip = AssembleIp(a, b, c, d);
 
-		newIP->setIPstring(str);
-		newIP->setIP(ip);
+	newIP->setIPstring(str);
+	newIP->setIP(ip);
 
-		DEBUG_LOG(("IP: 0x%8.8X / 0x%8.8X (%s)\n", testIP, ip, str.str()));
+	DEBUG_LOG(("IP: 0x%8.8X (%s)\n", ip, str.str()));
 
-		// Add the IP to the list in ascending order
-		if (!m_IPlist)
+	// Add the IP to the list in ascending order
+	if (!m_IPlist)
+	{
+		m_IPlist = newIP;
+		newIP->setNext(NULL);
+	}
+	else
+	{
+		if (newIP->getIP() < m_IPlist->getIP())
 		{
+			newIP->setNext(m_IPlist);
 			m_IPlist = newIP;
-			newIP->setNext(NULL);
 		}
 		else
 		{
-			if (newIP->getIP() < m_IPlist->getIP())
+			EnumeratedIP *p = m_IPlist;
+			while (p->getNext() && p->getNext()->getIP() < newIP->getIP())
 			{
-				newIP->setNext(m_IPlist);
-				m_IPlist = newIP;
-			}
-			else
-			{
-				EnumeratedIP *p = m_IPlist;
-				while (p->getNext() && p->getNext()->getIP() < newIP->getIP())
-				{
-					p = p->getNext();
-				}
-				newIP->setNext(p->getNext());
-				p->setNext(newIP);
+				p = p->getNext();
 			}
+			newIP->setNext(p->getNext());
+			p->setNext(newIP);
 		}
 	}
-
-	return m_IPlist;
 }
 
 AsciiString IPEnumeration::getMachineName( void )
diff --git a/GeneralsMD/Code/GameEngine/Include/GameNetwork/IPEnumeration.h b/GeneralsMD/Code/GameEngine/Include/GameNetwork/IPEnumeration.h
@@ -73,6 +73,7 @@ class IPEnumeration
 	AsciiString getMachineName( void );			///< Return the Network Neighborhood machine name
 
 protected:
+	void addNewIP( UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d );
 
 	EnumeratedIP *m_IPlist;
 	Bool m_isWinsockInitialized;
diff --git a/GeneralsMD/Code/GameEngine/Include/GameNetwork/networkutil.h b/GeneralsMD/Code/GameEngine/Include/GameNetwork/networkutil.h
@@ -30,6 +30,7 @@
 #include "GameNetwork/NetworkDefs.h"
 #include "GameNetwork/NetworkInterface.h"
 
+UnsignedInt AssembleIp(UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d);
 UnsignedInt ResolveIP(AsciiString host);
 UnsignedShort GenerateNextCommandID();
 Bool DoesCommandRequireACommandID(NetCommandType type);
@@ -47,4 +48,12 @@ void dumpBufferToLog(const void *vBuf, Int len, const char *fname, Int line);
 #define LOGBUFFER(buf, len) {}
 #endif // DEBUG_LOGGING
 
+inline UnsignedInt AssembleIp(UnsignedByte a, UnsignedByte b, UnsignedByte c, UnsignedByte d)
+{
+    return ((UnsignedInt)(a) << 24) |
+           ((UnsignedInt)(b) << 16) |
+           ((UnsignedInt)(c) << 8) |
+           ((UnsignedInt)(d));
+}
+
 #endif
diff --git a/GeneralsMD/Code/GameEngine/Source/GameClient/ClientInstance.cpp b/GeneralsMD/Code/GameEngine/Source/GameClient/ClientInstance.cpp
@@ -36,7 +36,7 @@ bool ClientInstance::initialize()
 	// WARNING: DO NOT use this number for any other application except Generals.
 	while (true)
 	{
-#ifdef RTS_MULTI_INSTANCE
+#if defined(RTS_MULTI_INSTANCE)
 		std::string guidStr = getFirstInstanceName();
 		if (s_instanceIndex > 0u)
 		{
diff --git a/GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanLobbyMenu.cpp b/GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/LanLobbyMenu.cpp
@@ -96,23 +96,30 @@ Bool LANPreferences::loadFromIniFile()
 UnicodeString LANPreferences::getUserName(void)
 {
 	UnicodeString ret;
+
 	LANPreferences::const_iterator it = find("UserName");
-	if (it == end())
+	if (it != end())
 	{
-		IPEnumeration IPs;
-		ret.translate(IPs.getMachineName());
-		return ret;
+		// Found an user name. Use it if valid.
+		ret = QuotedPrintableToUnicodeString(it->second);
+		ret.trim();
+		if (!ret.isEmpty())
+		{
+			return ret;
+		}
 	}
 
-	ret = QuotedPrintableToUnicodeString(it->second);
-	ret.trim();
-	if (ret.isEmpty())
+	if (rts::ClientInstance::getInstanceId() > 1u)
 	{
-		IPEnumeration IPs;
-		ret.translate(IPs.getMachineName());
+		// TheSuperHackers @feature Use the instance id as default user name
+		// to avoid duplicate names for multiple client instances.
+		ret.format(L"Instance%.2d", rts::ClientInstance::getInstanceId());
 		return ret;
 	}
-	
+
+	// Use machine name as default user name.
+	IPEnumeration IPs;
+	ret.translate(IPs.getMachineName());
 	return ret;
 }
 
diff --git a/GeneralsMD/Code/GameEngine/Source/GameNetwork/IPEnumeration.cpp b/GeneralsMD/Code/GameEngine/Source/GameNetwork/IPEnumeration.cpp

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ bool ClientInstance::initialize()`
`36`	`36`	`// WARNING: DO NOT use this number for any other application except Generals.`
`37`	`37`	`while (true)`
`38`	`38`	`{`
`39`		`-#ifdef RTS_MULTI_INSTANCE`
	`39`	`+#if defined(RTS_MULTI_INSTANCE)`
`40`	`40`	`std::string guidStr = getFirstInstanceName();`
`41`	`41`	`if (s_instanceIndex > 0u)`
`42`	`42`	`{`