- support passworded lobbies

Author: x64-dev

GeneralsMD/Code/GameEngine/Include/GameNetwork/GeneralsOnline/OnlineServices_LobbyInterface.h

@@ -35,11 +35,22 @@ struct LobbyEntry
 	bool limit_superweapons;
 	bool track_stats;
 
+	bool passworded;
+	std::string password;
+
 	std::vector<BYTE> EncKey;
 	std::vector<BYTE> EncIV;
 	std::vector<LobbyMemberEntry> members;
 };
 
+enum class EJoinLobbyResult
+{
+	JoinLobbyResult_Success, // The room was joined.
+	JoinLobbyResult_FullRoom,       // The room is full.
+	JoinLobbyResult_BadPassword,    // An incorrect password (or none) was given for a passworded room.
+	JoinLobbyResult_JoinFailed // Generic failure.
+};
+
 struct LobbyMemberEntry;
 struct LobbyEntry;
 
@@ -103,7 +114,7 @@ class NGMP_OnlineServices_LobbyInterface
 	UnicodeString m_PendingCreation_LobbyName;
 	UnicodeString m_PendingCreation_InitialMapDisplayName;
 	AsciiString m_PendingCreation_InitialMapPath;
-	void CreateLobby(UnicodeString strLobbyName, UnicodeString strInitialMapName, AsciiString strInitialMapPath, int initialMaxSize, bool bVanillaTeamsOnly, bool bTrackStats, uint32_t startingCash);
+	void CreateLobby(UnicodeString strLobbyName, UnicodeString strInitialMapName, AsciiString strInitialMapPath, int initialMaxSize, bool bVanillaTeamsOnly, bool bTrackStats, uint32_t startingCash, bool bPassworded, const char* szPassword);
 
 	void OnJoinedOrCreatedLobby(bool bAlreadyUpdatedDetails = false);
 
@@ -241,7 +252,7 @@ class NGMP_OnlineServices_LobbyInterface
 		m_OnChatCallback = cb;
 	}
 
-	void RegisterForJoinLobbyCallback(std::function<void(bool)> cb)
+	void RegisterForJoinLobbyCallback(std::function<void(EJoinLobbyResult)> cb)
 	{
 		m_callbackJoinedLobby = cb;
 	}
@@ -283,7 +294,8 @@ class NGMP_OnlineServices_LobbyInterface
 
 	NetworkMesh* GetNetworkMesh() { return m_pLobbyMesh; }
 
-	void JoinLobby(int index);
+	void JoinLobby(int index, const char* szPassword);
+	void JoinLobby(LobbyEntry lobby, const char* szPassword);
 
 	void LeaveCurrentLobby();
 
@@ -309,10 +321,25 @@ class NGMP_OnlineServices_LobbyInterface
 		return m_timeStartAutoReadyCountdown != -1;
 	}
 
+	void SetLobbyTryingToJoin(LobbyEntry lobby)
+	{
+		m_LobbyTryingToJoin = lobby;
+	}
+
+	void ResetLobbyTryingToJoin()
+	{
+		m_LobbyTryingToJoin = LobbyEntry();
+	}
+
+	LobbyEntry GetLobbyTryingToJoin()
+	{
+		return m_LobbyTryingToJoin;
+	}
+
 private:
 	std::vector<std::function<void(bool)>> m_vecCreateLobby_PendingCallbacks = std::vector<std::function<void(bool)>>();
 
-	std::function<void(bool)> m_callbackJoinedLobby = nullptr;
+	std::function<void(EJoinLobbyResult)> m_callbackJoinedLobby = nullptr;
 
 	LobbyEntry m_CurrentLobby;
 
@@ -324,4 +351,6 @@ class NGMP_OnlineServices_LobbyInterface
 	bool m_bLobbyListDirty = false;
 
 	int64_t m_timeStartAutoReadyCountdown = -1;
+
+	LobbyEntry m_LobbyTryingToJoin;
 };

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/PopupHostGame.cpp

@@ -595,8 +595,11 @@ void createGame( void )
 
 	UnicodeString gameName = GadgetTextEntryGetText(textEntryGameName);
 
+	AsciiString passwd;
+	passwd.translate(GadgetTextEntryGetText(textEntryGamePassword));
+
 	// NGMP:NOTE: We count money here because mods etc sometimes change the starting money, so we dont want to hard code it, just create with whatever the client is telling us is a sensible amount
-	NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->CreateLobby(gameName, md->m_displayName, md->m_fileName, md->m_numPlayers, limitArmies, useStats, TheGlobalData->m_defaultStartingCash.countMoney());
+	NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->CreateLobby(gameName, md->m_displayName, md->m_fileName, md->m_numPlayers, limitArmies, useStats, TheGlobalData->m_defaultStartingCash.countMoney(), passwd.isNotEmpty(), passwd.str());
 
 	GSMessageBoxCancel(UnicodeString(L"Creating Lobby"), UnicodeString(L"Lobby Creation is in progress..."), nullptr);
 

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/PopupJoinGame.cpp

@@ -62,6 +62,8 @@
 #include "GameNetwork/GameSpy/PeerDefs.h"
 #include "GameNetwork/GameSpy/PeerThread.h"
 #include "GameNetwork/GameSpyOverlay.h"
+#include "../ngmp_include.h"
+#include "../ngmp_interfaces.h"
 
 
 //-----------------------------------------------------------------------------
@@ -99,9 +101,10 @@ void PopupJoinGameInit( WindowLayout *layout, void *userData )
 
 	buttonCancelID = NAMEKEY("PopupJoinGame.wnd:ButtonCancel");
 
-	GameSpyStagingRoom *ourRoom = TheGameSpyInfo->findStagingRoomByID(TheGameSpyInfo->getCurrentStagingRoomID());
-	if (ourRoom)
-		GadgetStaticTextSetText(staticTextGameName, ourRoom->getGameName());
+	LobbyEntry lobbyTryingToJoin = NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->GetLobbyTryingToJoin();
+	UnicodeString lobbyName;
+	lobbyName.translate(lobbyTryingToJoin.name.c_str());
+	GadgetStaticTextSetText(staticTextGameName, lobbyName);
 
 	TheWindowManager->winSetFocus( parentPopup );
 	TheWindowManager->winSetModal( parentPopup );
@@ -243,21 +246,19 @@ WindowMsgHandledType PopupJoinGameSystem( GameWindow *window, UnsignedInt msg, W
 
 static void joinGame( AsciiString password )
 {
-	GameSpyStagingRoom *ourRoom = TheGameSpyInfo->findStagingRoomByID(TheGameSpyInfo->getCurrentStagingRoomID());
-	if (!ourRoom)
+	LobbyEntry lobbyTryingToJoin = NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->GetLobbyTryingToJoin();
+
+	if (lobbyTryingToJoin.lobbyID == -1)
 	{
 		GameSpyCloseOverlay(GSOVERLAY_GAMEPASSWORD);
-		SetLobbyAttemptHostJoin( FALSE );
+		SetLobbyAttemptHostJoin(FALSE);
 		parentPopup = NULL;
 		return;
 	}
-	PeerRequest req;
-	req.peerRequestType = PeerRequest::PEERREQUEST_JOINSTAGINGROOM;
-	req.text = ourRoom->getGameName().str();
-	req.stagingRoom.id = ourRoom->getID();
-	req.password = password.str();
-	TheGameSpyPeerMessageQueue->addRequest(req);
-	DEBUG_LOG(("Attempting to join game %d(%ls) with password [%s]\n", ourRoom->getID(), ourRoom->getGameName().str(), password.str()));
+
+	NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->JoinLobby(lobbyTryingToJoin, password.str());
+	
+	DEBUG_LOG(("Attempting to join game %d(%s) with password [%s]\n", lobbyTryingToJoin.lobbyID, lobbyTryingToJoin.name.c_str(), password.str()));
 	GameSpyCloseOverlay(GSOVERLAY_GAMEPASSWORD);
 	parentPopup = NULL;
 }

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/WOLLobbyMenu.cpp

@@ -704,12 +704,12 @@ void NGMP_WOLLobbyMenu_CreateLobbyCallback(bool bSuccess)
 	//TheGameSpyInfo->setGameOptions();
 }
 
-void NGMP_WOLLobbyMenu_JoinLobbyCallback(bool bSuccess)
+void NGMP_WOLLobbyMenu_JoinLobbyCallback(EJoinLobbyResult result)
 {
 	// TODO_NGMP: Show accurate errors again
 
 	SetLobbyAttemptHostJoin(FALSE);
-	if (bSuccess)
+	if (result == EJoinLobbyResult::JoinLobbyResult_Success)
 	{
 		// Woohoo!  On to our next screen!
 		buttonPushed = true;
@@ -718,35 +718,43 @@ void NGMP_WOLLobbyMenu_JoinLobbyCallback(bool bSuccess)
 	}
 	else
 	{
-		GSMessageBoxOk(TheGameText->fetch("GUI:JoinFailedDefault"), UnicodeString(L"TODO_NGMP"));
-		/*
 		UnicodeString s;
 
-		switch (resp.joinStagingRoom.result)
+		switch (result)
 		{
-		case PEERFullRoom:        // The room is full.
+		case EJoinLobbyResult::JoinLobbyResult_FullRoom:        // The room is full.
 			s = TheGameText->fetch("GUI:JoinFailedRoomFull");
 			break;
+
+		// NOTE: Commented out ones are no longer supported. Seems like these we GS concepts but not part of the game
+		/*
 		case PEERInviteOnlyRoom:  // The room is invite only.
 			s = TheGameText->fetch("GUI:JoinFailedInviteOnly");
 			break;
 		case PEERBannedFromRoom:  // The local user is banned from the room.
 			s = TheGameText->fetch("GUI:JoinFailedBannedFromRoom");
 			break;
-		case PEERBadPassword:     // An incorrect password (or none) was given for a passworded room.
+			*/
+		case EJoinLobbyResult::JoinLobbyResult_BadPassword:     // An incorrect password (or none) was given for a passworded room.
 			s = TheGameText->fetch("GUI:JoinFailedBadPassword");
 			break;
+		/*
 		case PEERAlreadyInRoom:   // The local user is already in or entering a room of the same type.
 			s = TheGameText->fetch("GUI:JoinFailedAlreadyInRoom");
 			break;
 		case PEERNoConnection:    // Can't join a room if there's no chat connection.
 			s = TheGameText->fetch("GUI:JoinFailedNoConnection");
 			break;
+			*/
 		default:
 			s = TheGameText->fetch("GUI:JoinFailedDefault");
 			break;
 		}
+
 		GSMessageBoxOk(TheGameText->fetch("GUI:JoinFailedDefault"), s);
+
+		// NGMP: We don't need to do this anymore, the service does it for us
+		/*
 		if (groupRoomToJoin)
 		{
 			DEBUG_LOG(("WOLLobbyMenuUpdate() - rejoining group room %d\n", groupRoomToJoin));
@@ -1814,11 +1822,27 @@ WindowMsgHandledType WOLLobbyMenuSystem( GameWindow *window, UnsignedInt msg,
 						//Int selectedID = (Int)GadgetListBoxGetItemData(GetGameListBox(), selected);
 						//if (selectedID > 0)
 						{
-							NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->JoinLobby(selected);
+							// TODO_NGMP: Enforce this on the host too, vanilla game did not...
+
+							auto Lobby = NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->GetLobbyFromIndex(selected);
+							NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->SetLobbyTryingToJoin(Lobby);
+
+							if (Lobby.passworded)
+							{
+								GameSpyOpenOverlay(GSOVERLAY_GAMEPASSWORD);
+							}
+							else
+							{
+								NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->JoinLobby(selected, nullptr);
 
-							SetLobbyAttemptHostJoin(TRUE);
+								SetLobbyAttemptHostJoin(TRUE);
+							}
 						}
 					}
+					else
+					{
+						GSMessageBoxOk(TheGameText->fetch("GUI:Error"), TheGameText->fetch("GUI:NoGameSelected"), NULL);
+					}
 					// TODO_NGMP: Start using StagingRoomInfo again, it'll make this easier and cleaner
 					/*
 					if (s_tryingToHostOrJoin)

GeneralsMD/Code/GameEngine/Source/GameNetwork/GameSpy/LobbyUtils.cpp

@@ -573,7 +573,9 @@ static Int insertGame(GameWindow* win, LobbyEntry& lobbyInfo, Bool showMap)
 	USHORT ladderPort = 1;
 	int gameID = 0;
 
-	bool bHasPassword = false;
+	bool bHasPassword = lobbyInfo.passworded;
+
+	// TODO_NGMP
 	bool bAllowSpectators = true;
 	int latency = 5;
 

GeneralsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/OnlineServices_LobbyInterface.cpp

@@ -665,10 +665,15 @@ void NGMP_OnlineServices_LobbyInterface::UpdateRoomDataCache(std::function<void(
 	*/
 }
 
-void NGMP_OnlineServices_LobbyInterface::JoinLobby(int index)
+void NGMP_OnlineServices_LobbyInterface::JoinLobby(int index, const char* szPassword)
 {
-	m_CurrentLobby = LobbyEntry();
 	LobbyEntry lobbyInfo = GetLobbyFromIndex(index);
+	JoinLobby(lobbyInfo, szPassword);
+}
+
+void NGMP_OnlineServices_LobbyInterface::JoinLobby(LobbyEntry lobbyInfo, const char* szPassword)
+{
+	m_CurrentLobby = LobbyEntry();
 
 	std::string strURI = std::format("{}/{}", NGMP_OnlineServicesManager::GetAPIEndpoint("Lobby", true), lobbyInfo.lobbyID);
 	std::map<std::string, std::string> mapHeaders;
@@ -677,16 +682,35 @@ void NGMP_OnlineServices_LobbyInterface::JoinLobby(int index)
 
 	nlohmann::json j;
 	j["preferred_port"] = NGMP_OnlineServicesManager::GetInstance()->GetPortMapper().GetOpenPort();
+
+	if (szPassword != nullptr && strlen(szPassword) > 0)
+	{
+		j["password"] = szPassword;
+	}
+
 	std::string strPostData = j.dump();
 
 	// convert
 	NGMP_OnlineServicesManager::GetInstance()->GetHTTPManager()->SendPUTRequest(strURI.c_str(), EIPProtocolVersion::DONT_CARE, mapHeaders, strPostData.c_str(), [=](bool bSuccess, int statusCode, std::string strBody)
 		{
+			// reset trying to join
+			ResetLobbyTryingToJoin();
+
 			// TODO_NGMP: Dont do extra get here, just return it in the put...
-			bool bJoinSuccess = statusCode == 200;
+			EJoinLobbyResult JoinResult = EJoinLobbyResult::JoinLobbyResult_JoinFailed;
 
-			// no response body from this, just http codes
 			if (statusCode == 200)
+			{
+				JoinResult = EJoinLobbyResult::JoinLobbyResult_Success;
+			}
+			else if (statusCode == 401)
+			{
+				JoinResult = EJoinLobbyResult::JoinLobbyResult_BadPassword;
+			}
+			// TODO_NGMP: Handle room full error (JoinLobbyResult_FullRoom, can we even get that?
+
+			// no response body from this, just http codes
+			if (JoinResult == EJoinLobbyResult::JoinLobbyResult_Success)
 			{
 				NetworkLog("[NGMP] Joined lobby");
 
@@ -729,7 +753,7 @@ void NGMP_OnlineServices_LobbyInterface::JoinLobby(int index)
 			}
 			else if (statusCode == 401)
 			{
-				NetworkLog("[NGMP] Couldn't join lobby");
+				NetworkLog("[NGMP] Couldn't join lobby, unauthorized, probably the wrong password");
 			}
 			else if (statusCode == 404)
 			{
@@ -742,7 +766,7 @@ void NGMP_OnlineServices_LobbyInterface::JoinLobby(int index)
 
 			if (NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->m_callbackJoinedLobby != nullptr)
 			{
-				NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->m_callbackJoinedLobby(bJoinSuccess);
+				NGMP_OnlineServicesManager::GetInstance()->GetLobbyInterface()->m_callbackJoinedLobby(JoinResult);
 			}
 		});
 
@@ -915,7 +939,7 @@ struct CreateLobbyResponse
 	NLOHMANN_DEFINE_TYPE_INTRUSIVE(CreateLobbyResponse, result, lobby_id)
 };
 
-void NGMP_OnlineServices_LobbyInterface::CreateLobby(UnicodeString strLobbyName, UnicodeString strInitialMapName, AsciiString strInitialMapPath, int initialMaxSize, bool bVanillaTeamsOnly, bool bTrackStats, uint32_t startingCash)
+void NGMP_OnlineServices_LobbyInterface::CreateLobby(UnicodeString strLobbyName, UnicodeString strInitialMapName, AsciiString strInitialMapPath, int initialMaxSize, bool bVanillaTeamsOnly, bool bTrackStats, uint32_t startingCash, bool bPassworded, const char* szPassword)
 {
 	m_CurrentLobby = LobbyEntry();	
 	std::string strURI = NGMP_OnlineServicesManager::GetAPIEndpoint("Lobbies", true);
@@ -937,6 +961,8 @@ void NGMP_OnlineServices_LobbyInterface::CreateLobby(UnicodeString strLobbyName,
 	j["vanilla_teams"] = bVanillaTeamsOnly;
 	j["track_stats"] = bTrackStats;
 	j["starting_cash"] = startingCash;
+	j["passworded"] = bPassworded;
+	j["password"] = szPassword;
 	std::string strPostData = j.dump();
 
 	NGMP_OnlineServicesManager::GetInstance()->GetHTTPManager()->SendPUTRequest(strURI.c_str(), EIPProtocolVersion::DONT_CARE, mapHeaders, strPostData.c_str(), [=](bool bSuccess, int statusCode, std::string strBody)
@@ -962,6 +988,8 @@ void NGMP_OnlineServices_LobbyInterface::CreateLobby(UnicodeString strLobbyName,
 					m_CurrentLobby.map_path = std::string(strInitialMapPath.str());
 					m_CurrentLobby.current_players = 1;
 					m_CurrentLobby.max_players = initialMaxSize;
+					m_CurrentLobby.passworded = bPassworded;
+					m_CurrentLobby.password = std::string(szPassword);
 
 					LobbyMemberEntry me;