cpp/openttd-patchpack/source Changeset - r25313:a5c6f5530336

Changeset - r25313:a5c6f5530336

Parent rev.

Child rev.

[Not reviewed]

master

0 8 0

Patric Stout - 4 years ago 2021-04-30 09:34:47
truebrain@openttd.org

Change: use TCP for everything except for master-server and initial server scan (#9130)

This means that pressing Refresh button and adding servers manually
now uses TCP.

The master-server and initial scan are still UDP as they will be
replaced by Game Coordinator; no need to change this now.

If we query a server that is too old, show a proper warning to the
user informing him the server is too old.

8 files changed with 74 insertions and 39 deletions:

os/emscripten/pre.js

src/lang/english.txt

src/network/network.cpp

src/network/network_client.cpp

src/network/network_client.h

src/network/network_gamelist.cpp

src/network/network_gui.cpp

src/network/network_internal.h

0 comments (0 inline, 0 general)

os/emscripten/pre.js

➞

Show inline comments

@@ @@ -62,16 +62,20 @@ Module.preRun.push(function() { @@
     window.openttd_abort = function() {
         Module.onAbort();
+    }
     window.openttd_server_list = function() {
-        add_server = Module.cwrap("em_openttd_add_server", null, ["string", "number"]);
         add_server = Module.cwrap("em_openttd_add_server", null, ["string"]);
         /* Add servers that support WebSocket here. Example:
          *  add_server("localhost", 3979); */
         /* Add servers that support WebSocket here. Examples:
          *  add_server("localhost");
          *  add_server("localhost:3979");
          *  add_server("127.0.0.1:3979");
          *  add_server("[::1]:3979");
          */
+    }
     var leftButtonDown = false;
     document.addEventListener("mousedown", e => {
         if (e.button == 0) {
             leftButtonDown = true;

src/lang/english.txt

➞

Show inline comments

@@ @@ -2214,12 +2214,13 @@ STR_NETWORK_ERROR_CHEATER @@
 STR_NETWORK_ERROR_TOO_MANY_COMMANDS                             :{WHITE}You were sending too many commands to the server
 STR_NETWORK_ERROR_TIMEOUT_PASSWORD                              :{WHITE}You took too long to enter the password
 STR_NETWORK_ERROR_TIMEOUT_COMPUTER                              :{WHITE}Your computer is too slow to keep up with the server
 STR_NETWORK_ERROR_TIMEOUT_MAP                                   :{WHITE}Your computer took too long to download the map
 STR_NETWORK_ERROR_TIMEOUT_JOIN                                  :{WHITE}Your computer took too long to join the server
 STR_NETWORK_ERROR_INVALID_CLIENT_NAME                           :{WHITE}Your player name is not valid
 STR_NETWORK_ERROR_SERVER_TOO_OLD                                :{WHITE}The queried server is too old for this client
 ############ Leave those lines in this order!!
 STR_NETWORK_ERROR_CLIENT_GENERAL                                :general error
 STR_NETWORK_ERROR_CLIENT_DESYNC                                 :desync error
 STR_NETWORK_ERROR_CLIENT_SAVEGAME                               :could not load map
 STR_NETWORK_ERROR_CLIENT_CONNECTION_LOST                        :connection lost

src/network/network.cpp

➞

Show inline comments

@@ @@ -599,53 +599,73 @@ static void NetworkInitialize(bool close @@
 	_network_reconnect = 0;
+}
 /** Non blocking connection create to query servers */
 class TCPQueryConnecter : TCPConnecter {
 private:
 	bool request_company_info;
 public:
 	TCPQueryConnecter(const NetworkAddress &address) : TCPConnecter(address) {}
+	TCPQueryConnecter(const NetworkAddress &address, bool request_company_info) : TCPConnecter(address), request_company_info(request_company_info) {}
 	void OnFailure() override
+	{
 		NetworkDisconnect();
+	}
 	void OnConnect(SOCKET s) override
+	{
 		_networking = true;
 		new ClientNetworkGameSocketHandler(s);
 		MyClient::SendInformationQuery();
 		new ClientNetworkGameSocketHandler(s, address);
 		MyClient::SendInformationQuery(request_company_info);
+	}
 };
 /**
  * Query a server to fetch his game-info.
  * @param address the address to query.
  * @param request_company_info Whether to request company info too.
  */
 void NetworkTCPQueryServer(NetworkAddress address)
+void NetworkTCPQueryServer(NetworkAddress address, bool request_company_info)
+{
 	if (!_network_available) return;
 	NetworkDisconnect();
 	NetworkInitialize();
 	new TCPQueryConnecter(address);
+	new TCPQueryConnecter(address, request_company_info);
+}
 /**
  * Validates an address entered as a string and adds the server to
  * the list. If you use this function, the games will be marked
  * as manually added.
  * @param connection_string The IP:port to add to the list.
  * @param connection_string The IP:port of the server to add.
  * @return The entry on the game list.
  */
-void NetworkAddServer(const char *connection_string)
+NetworkGameList *NetworkAddServer(const std::string &connection_string)
+{
 	if (StrEmpty(connection_string)) return;
 	if (connection_string.empty()) return nullptr;
 	NetworkAddress address = ParseConnectionString(connection_string, NETWORK_DEFAULT_PORT);
 	NetworkUDPQueryServer(ParseConnectionString(connection_string, NETWORK_DEFAULT_PORT), true);
 	/* Ensure the item already exists in the list */
 	NetworkGameList *item = NetworkGameListAddItem(address);
 	if (StrEmpty(item->info.server_name)) {
 		ClearGRFConfigList(&item->info.grfconfig);
 		address.GetAddressAsString(item->info.server_name, lastof(item->info.server_name));
 		item->manually = true;
 		NetworkRebuildHostList();
 		UpdateNetworkGameWindow();
+	}
 	NetworkTCPQueryServer(address);
 	return item;
+}
 /**
  * Get the addresses to bind to.
  * @param addresses the list to write to.
  * @param port the port to bind to.
@@ @@ -684,13 +704,13 @@ public: @@
 		NetworkError(STR_NETWORK_ERROR_NOCONNECTION);
+	}
 	void OnConnect(SOCKET s) override
+	{
 		_networking = true;
 		new ClientNetworkGameSocketHandler(s);
+		new ClientNetworkGameSocketHandler(s, this->address);
 		IConsoleCmdExec("exec scripts/on_client.scr 0");
 		NetworkClient_Connected();
+	}
 };
 void NetworkClientConnectGame(const std::string &connection_string, CompanyID default_company, const char *join_server_password, const char *join_company_password)
@@ @@ -1129,13 +1149,13 @@ void NetworkShutDown() @@
 	NetworkCoreShutdown();
+}
 #ifdef __EMSCRIPTEN__
 extern "C" {
-void CDECL em_openttd_add_server(const char *host, int port)
+void CDECL em_openttd_add_server(const char *connection_string)
+{
-	NetworkUDPQueryServer(NetworkAddress(host, port), true);
+	NetworkAddServer(connection_string);
+}
+}
 #endif

src/network/network_client.cpp

➞

Show inline comments

@@ @@ -142,13 +142,13 @@ void ClientNetworkEmergencySave() @@
 /**
  * Create a new socket for the client side of the game connection.
  * @param s The socket to connect with.
  */
 ClientNetworkGameSocketHandler::ClientNetworkGameSocketHandler(SOCKET s) : NetworkGameSocketHandler(s), savegame(nullptr), status(STATUS_INACTIVE)
+ClientNetworkGameSocketHandler::ClientNetworkGameSocketHandler(SOCKET s, NetworkAddress address) : NetworkGameSocketHandler(s), address(address), savegame(nullptr), status(STATUS_INACTIVE)
+{
 	assert(ClientNetworkGameSocketHandler::my_client == nullptr);
 	ClientNetworkGameSocketHandler::my_client = this;
+}
 /** Clear whatever we assigned. */
@@ @@ -342,20 +342,24 @@ static_assert(NETWORK_SERVER_ID_LENGTH = @@
  *   DEF_CLIENT_SEND_COMMAND has no parameters
  ************/
 /**
  * Query the server for server information.
  */
 NetworkRecvStatus ClientNetworkGameSocketHandler::SendInformationQuery()
+NetworkRecvStatus ClientNetworkGameSocketHandler::SendInformationQuery(bool request_company_info)
+{
 	my_client->status = STATUS_GAME_INFO;
 	my_client->SendPacket(new Packet(PACKET_CLIENT_GAME_INFO));
 	if (request_company_info) {
 	my_client->status = STATUS_COMPANY_INFO;
 	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;
 	SetWindowDirty(WC_NETWORK_STATUS_WINDOW, WN_NETWORK_STATUS_WINDOW_JOIN);
 	my_client->SendPacket(new Packet(PACKET_CLIENT_GAME_INFO));
 	my_client->SendPacket(new Packet(PACKET_CLIENT_COMPANY_INFO));
+	}
 	return NETWORK_RECV_STATUS_OKAY;
+}
 /** Tell the server we would like to join. */
 NetworkRecvStatus ClientNetworkGameSocketHandler::SendJoin()
@@ @@ -574,25 +578,31 @@ NetworkRecvStatus ClientNetworkGameSocke @@
 	return NETWORK_RECV_STATUS_SERVER_BANNED;
+}
 NetworkRecvStatus ClientNetworkGameSocketHandler::Receive_SERVER_GAME_INFO(Packet *p)
+{
-	if (this->status != STATUS_COMPANY_INFO && this->status != STATUS_INACTIVE) return NETWORK_RECV_STATUS_MALFORMED_PACKET;
+	if (this->status != STATUS_COMPANY_INFO && this->status != STATUS_GAME_INFO) return NETWORK_RECV_STATUS_MALFORMED_PACKET;
 	NetworkGameList *item = GetLobbyGameInfo();
 	if (item == nullptr) {
 		/* This is not the lobby, so add it to the game list. */
 		item = NetworkGameListAddItem(this->address);
+	}
 	/* Clear any existing GRFConfig chain. */
 	ClearGRFConfigList(&item->info.grfconfig);
 	/* Retrieve the NetworkGameInfo from the packet. */
 	DeserializeNetworkGameInfo(p, &item->info);
 	/* Check for compatability with the client. */
 	CheckGameCompatibility(item->info);
 	/* Ensure we consider the server online. */
 	item->online = true;
 	/* It could be either window, but only one is open, so redraw both. */
 	SetWindowDirty(WC_NETWORK_WINDOW, WN_NETWORK_WINDOW_GAME);
 	SetWindowDirty(WC_NETWORK_WINDOW, WN_NETWORK_WINDOW_LOBBY);
 	/* We will receive company info next, so keep connection open. */
 	if (this->status == STATUS_COMPANY_INFO) return NETWORK_RECV_STATUS_OKAY;
 	return NETWORK_RECV_STATUS_CLOSE_QUERY;
+}
@@ @@ -724,12 +734,21 @@ NetworkRecvStatus ClientNetworkGameSocke @@
 		STR_NETWORK_ERROR_INVALID_CLIENT_NAME, // NETWORK_ERROR_INVALID_CLIENT_NAME
 	};
 	static_assert(lengthof(network_error_strings) == NETWORK_ERROR_END);
 	NetworkErrorCode error = (NetworkErrorCode)p->Recv_uint8();
 	/* If we query a server that is 1.11.1 or older, we get an
 	 * NETWORK_ERROR_NOT_EXPECTED on requesting the game info. Show a special
 	 * error popup in that case.
 	 */
 	if (error == NETWORK_ERROR_NOT_EXPECTED && (this->status == STATUS_GAME_INFO || this->status == STATUS_COMPANY_INFO)) {
 		ShowErrorMessage(STR_NETWORK_ERROR_SERVER_TOO_OLD, INVALID_STRING_ID, WL_CRITICAL);
 		return NETWORK_RECV_STATUS_CLOSE_QUERY;
+	}
 	StringID err = STR_NETWORK_ERROR_LOSTCONNECTION;
 	if (error < (ptrdiff_t)lengthof(network_error_strings)) err = network_error_strings[error];
 	/* In case of kicking a client, we assume there is a kick message in the packet if we can read one byte */
 	if (error == NETWORK_ERROR_KICKED && p->CanReadFromPacket(1)) {
 		char kick_msg[255];
 		p->Recv_string(kick_msg, sizeof(kick_msg));

src/network/network_client.h

➞

Show inline comments

@@ @@ -12,18 +12,20 @@ @@
 #include "network_internal.h"
 /** Class for handling the client side of the game connection. */
 class ClientNetworkGameSocketHandler : public ZeroedMemoryAllocator, public NetworkGameSocketHandler {
 private:
 	NetworkAddress address;        ///< Address we are connected to.
 	struct PacketReader *savegame; ///< Packet reader for reading the savegame.
 	byte token;                    ///< The token we need to send back to the server to prove we're the right client.
 	/** Status of the connection with the server. */
 	enum ServerStatus {
 		STATUS_INACTIVE,      ///< The client is not connected nor active.
 		STATUS_GAME_INFO,     ///< We are trying to get the game information.
 		STATUS_COMPANY_INFO,  ///< We are trying to get company information.
 		STATUS_JOIN,          ///< We are trying to join a server.
 		STATUS_NEWGRFS_CHECK, ///< Last action was checking NewGRFs.
 		STATUS_AUTH_GAME,     ///< Last action was requesting game (server) password.
 		STATUS_AUTH_COMPANY,  ///< Last action was requesting company password.
 		STATUS_AUTHORIZED,    ///< The client is authorized at the server.
@@ @@ -71,19 +73,19 @@ protected: @@
 	static NetworkRecvStatus SendNewGRFsOk();
 	static NetworkRecvStatus SendGetMap();
 	static NetworkRecvStatus SendMapOk();
 	void CheckConnection();
 public:
 	ClientNetworkGameSocketHandler(SOCKET s);
+	ClientNetworkGameSocketHandler(SOCKET s, NetworkAddress address);
 	~ClientNetworkGameSocketHandler();
 	NetworkRecvStatus CloseConnection(NetworkRecvStatus status) override;
 	void ClientError(NetworkRecvStatus res);
 	static NetworkRecvStatus SendInformationQuery();
+	static NetworkRecvStatus SendInformationQuery(bool request_company_info);
 	static NetworkRecvStatus SendJoin();
 	static NetworkRecvStatus SendCommand(const CommandPacket *cp);
 	static NetworkRecvStatus SendError(NetworkErrorCode errorno);
 	static NetworkRecvStatus SendQuit();
 	static NetworkRecvStatus SendAck();

src/network/network_gamelist.cpp

➞

Show inline comments

@@ @@ -66,21 +66,12 @@ static void NetworkGameListHandleDelayed @@
  * return the existing item instead of adding it again
  * @param address the address of the to-be added item
  * @return a point to the newly added or already existing item
  */
 NetworkGameList *NetworkGameListAddItem(NetworkAddress address)
+{
 	const char *hostname = address.GetHostname();
 	/* Do not query the 'any' address. */
 	if (StrEmpty(hostname) ||
 			strcmp(hostname, "0.0.0.0") == 0 ||
 			strcmp(hostname, "::") == 0) {
 		return nullptr;
+	}
 	NetworkGameList *item, *prev_item;
 	prev_item = nullptr;
 	for (item = _network_game_list; item != nullptr; item = item->next) {
 		if (item->address == address) return item;
 		prev_item = item;
@@ @@ -92,13 +83,12 @@ NetworkGameList *NetworkGameListAddItem( @@
 	if (prev_item == nullptr) {
 		_network_game_list = item;
 	} else {
 		prev_item->next = item;
+	}
 	DEBUG(net, 4, "[gamelist] added server to list");
 	UpdateNetworkGameWindow();
 	return item;
+}

src/network/network_gui.cpp

➞

Show inline comments

@@ @@ -469,15 +469,14 @@ public: @@
 		 * join. This means the serverlist is curated for now, but it is the
 		 * best we can offer. */
 #ifdef __EMSCRIPTEN__
 		EM_ASM(if (window["openttd_server_list"]) openttd_server_list());
 #endif
-		this->last_joined = NetworkGameListAddItem(ParseConnectionString(_settings_client.network.last_joined, NETWORK_DEFAULT_PORT));
+		this->last_joined = NetworkAddServer(_settings_client.network.last_joined);
 		this->server = this->last_joined;
 		if (this->last_joined != nullptr) NetworkUDPQueryServer(this->last_joined->address);
 		this->requery_timer.SetInterval(MILLISECONDS_PER_TICK);
 		this->servers.SetListing(this->last_sorting);
 		this->servers.SetSortFuncs(this->sorter_funcs);
 		this->servers.SetFilterFuncs(this->filter_funcs);
@@ @@ -747,13 +746,13 @@ public: @@
 				if (this->server != nullptr) {
 					ShowNetworkLobbyWindow(this->server);
+				}
 				break;
 			case WID_NG_REFRESH: // Refresh
-				if (this->server != nullptr) NetworkUDPQueryServer(this->server->address);
+				if (this->server != nullptr) NetworkTCPQueryServer(this->server->address);
 				break;
 			case WID_NG_NEWGRF: // NewGRF Settings
 				if (this->server != nullptr) ShowNewGRFSettings(false, false, false, &this->server->info.grfconfig);
 				break;
@@ @@ -968,13 +967,13 @@ void ShowNetworkGameWindow() @@
 	/* Only show once */
 	if (first) {
 		first = false;
 		/* Add all servers from the config file to our list. */
 		for (const auto &iter : _network_host_list) {
-			NetworkAddServer(iter.c_str());
 			NetworkAddServer(iter);
+		}
+	}
 	new NetworkGameWindow(&_network_game_window_desc);
+}
@@ @@ -1482,13 +1481,13 @@ struct NetworkLobbyWindow : public Windo @@
 				break;
 			case WID_NL_REFRESH:  // Refresh
 				/* Clear the information so removed companies don't remain */
 				for (auto &company : this->company_info) company = {};
 				NetworkTCPQueryServer(this->server->address);
+				NetworkTCPQueryServer(this->server->address, true);
 				break;
+		}
+	}
 	void OnResize() override
+	{
@@ @@ -1552,13 +1551,13 @@ static void ShowNetworkLobbyWindow(Netwo @@
 	DeleteWindowById(WC_NETWORK_WINDOW, WN_NETWORK_WINDOW_START);
 	DeleteWindowById(WC_NETWORK_WINDOW, WN_NETWORK_WINDOW_GAME);
 	strecpy(_settings_client.network.last_joined, ngl->address.GetAddressAsString(false).c_str(), lastof(_settings_client.network.last_joined));
 	NetworkTCPQueryServer(ngl->address);
+	NetworkTCPQueryServer(ngl->address, true);
 	new NetworkLobbyWindow(&_network_lobby_window_desc, ngl);
+}
 /**
  * Get the company information of a given company to fill for the lobby.

src/network/network_internal.h

➞

Show inline comments

@@ @@ -84,16 +84,16 @@ extern uint32 _network_join_bytes; @@
 extern uint32 _network_join_bytes_total;
 extern uint8 _network_reconnect;
 extern CompanyMask _network_company_passworded;
 void NetworkTCPQueryServer(NetworkAddress address);
+void NetworkTCPQueryServer(NetworkAddress address, bool request_company_info = false);
 void GetBindAddresses(NetworkAddressList *addresses, uint16 port);
-void NetworkAddServer(const char *b);
+struct NetworkGameList *NetworkAddServer(const std::string &connection_string);
 void NetworkRebuildHostList();
 void UpdateNetworkGameWindow();
 /* From network_command.cpp */
 /**
  * Everything we need to know about a command to be able to execute it.

0 comments (0 inline, 0 general)