From dc5b7b996c3f284d0e0f9f7685a8714f9d944ab6 Mon Sep 17 00:00:00 2001 From: Patric Stout Date: Mon, 23 Aug 2021 20:16:22 +0200 Subject: Fix: [Network] show query errors in the server listing instead of error popup (#9506) When you are query several servers at once, it is rather unclear for which server you got a popup. Instead, show any errors on the server itself. This is only true for the query-part. Joining a server still gives an error popup to tell you about any issue. --- src/lang/english.txt | 3 ++- src/network/network.cpp | 2 +- src/network/network_coordinator.cpp | 4 ++-- src/network/network_gamelist.h | 23 ++++++++++++++------- src/network/network_gui.cpp | 22 ++++++++++++++------ src/network/network_query.cpp | 40 +++++++++++++++++++++++-------------- 6 files changed, 62 insertions(+), 32 deletions(-) diff --git a/src/lang/english.txt b/src/lang/english.txt index 1c6eca55c..c5ccca20d 100644 --- a/src/lang/english.txt +++ b/src/lang/english.txt @@ -2046,6 +2046,8 @@ STR_NETWORK_SERVER_LIST_GAMESCRIPT :{SILVER}Game Sc STR_NETWORK_SERVER_LIST_PASSWORD :{SILVER}Password protected! STR_NETWORK_SERVER_LIST_SERVER_OFFLINE :{SILVER}SERVER OFFLINE STR_NETWORK_SERVER_LIST_SERVER_FULL :{SILVER}SERVER FULL +STR_NETWORK_SERVER_LIST_SERVER_BANNED :{SILVER}SERVER BANNED YOU +STR_NETWORK_SERVER_LIST_SERVER_TOO_OLD :{SILVER}SERVER TOO OLD STR_NETWORK_SERVER_LIST_VERSION_MISMATCH :{SILVER}VERSION MISMATCH STR_NETWORK_SERVER_LIST_GRF_MISMATCH :{SILVER}NEWGRF MISMATCH @@ -2226,7 +2228,6 @@ STR_NETWORK_ERROR_TIMEOUT_COMPUTER :{WHITE}Your com 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 diff --git a/src/network/network.cpp b/src/network/network.cpp index d3c51a539..dd4933356 100644 --- a/src/network/network.cpp +++ b/src/network/network.cpp @@ -632,7 +632,7 @@ public: void OnFailure() override { NetworkGameList *item = NetworkGameListAddItem(connection_string); - item->online = false; + item->status = NGLS_OFFLINE; UpdateNetworkGameWindow(); } diff --git a/src/network/network_coordinator.cpp b/src/network/network_coordinator.cpp index dd7911b57..c3fa2b5ce 100644 --- a/src/network/network_coordinator.cpp +++ b/src/network/network_coordinator.cpp @@ -152,7 +152,7 @@ bool ClientNetworkCoordinatorSocketHandler::Receive_GC_ERROR(Packet *p) /* Mark the server as offline. */ NetworkGameList *item = NetworkGameListAddItem(detail); - item->online = false; + item->status = NGLS_OFFLINE; UpdateNetworkGameWindow(); return true; @@ -257,7 +257,7 @@ bool ClientNetworkCoordinatorSocketHandler::Receive_GC_LISTING(Packet *p) /* Check for compatability with the client. */ CheckGameCompatibility(item->info); /* Mark server as online. */ - item->online = true; + item->status = NGLS_ONLINE; /* Mark the item as up-to-date. */ item->version = _network_game_list_version; } diff --git a/src/network/network_gamelist.h b/src/network/network_gamelist.h index 9a98207d9..24ce41bc8 100644 --- a/src/network/network_gamelist.h +++ b/src/network/network_gamelist.h @@ -14,17 +14,26 @@ #include "core/game_info.h" #include "network_type.h" +/** The status a server can be in. */ +enum NetworkGameListStatus { + NGLS_OFFLINE, ///< Server is offline (or cannot be queried). + NGLS_ONLINE, ///< Server is online. + NGLS_FULL, ///< Server is full and cannot be queried. + NGLS_BANNED, ///< You are banned from this server. + NGLS_TOO_OLD, ///< Server is too old to query. +}; + /** Structure with information shown in the game list (GUI) */ struct NetworkGameList { NetworkGameList(const std::string &connection_string) : connection_string(connection_string) {} - NetworkGameInfo info = {}; ///< The game information of this server - std::string connection_string; ///< Address of the server - bool online = false; ///< False if the server did not respond (default status) - bool manually = false; ///< True if the server was added manually - uint8 retries = 0; ///< Number of retries (to stop requerying) - int version = 0; ///< Used to see which servers are no longer available on the Game Coordinator and can be removed. - NetworkGameList *next = nullptr; ///< Next pointer to make a linked game list + NetworkGameInfo info = {}; ///< The game information of this server. + std::string connection_string; ///< Address of the server. + NetworkGameListStatus status = NGLS_OFFLINE; ///< Stats of the server. + bool manually = false; ///< True if the server was added manually. + uint8 retries = 0; ///< Number of retries (to stop requerying). + int version = 0; ///< Used to see which servers are no longer available on the Game Coordinator and can be removed. + NetworkGameList *next = nullptr; ///< Next pointer to make a linked game list. }; extern NetworkGameList *_network_game_list; diff --git a/src/network/network_gui.cpp b/src/network/network_gui.cpp index 6dd6c9c11..03fd0ce5c 100644 --- a/src/network/network_gui.cpp +++ b/src/network/network_gui.cpp @@ -407,7 +407,7 @@ protected: DrawString(nwi_name->pos_x + WD_FRAMERECT_LEFT, nwi_name->pos_x + nwi_name->current_x - WD_FRAMERECT_RIGHT, y + text_y_offset, cur_item->info.server_name, TC_BLACK); /* only draw details if the server is online */ - if (cur_item->online) { + if (cur_item->status == NGLS_ONLINE) { const NWidgetServerListHeader *nwi_header = this->GetWidget(WID_NG_HEADER); if (nwi_header->IsWidgetVisible(WID_NG_CLIENTS)) { @@ -609,13 +609,13 @@ public: this->SetWidgetDisabledState(WID_NG_REFRESH, sel == nullptr); /* 'Join' button disabling conditions */ this->SetWidgetDisabledState(WID_NG_JOIN, sel == nullptr || // no Selected Server - !sel->online || // Server offline + sel->status != NGLS_ONLINE || // Server offline sel->info.clients_on >= sel->info.clients_max || // Server full !sel->info.compatible); // Revision mismatch /* 'NewGRF Settings' button invisible if no NewGRF is used */ - this->GetWidget(WID_NG_NEWGRF_SEL)->SetDisplayedPlane(sel == nullptr || !sel->online || sel->info.grfconfig == nullptr); - this->GetWidget(WID_NG_NEWGRF_MISSING_SEL)->SetDisplayedPlane(sel == nullptr || !sel->online || sel->info.grfconfig == nullptr || !sel->info.version_compatible || sel->info.compatible); + this->GetWidget(WID_NG_NEWGRF_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NGLS_ONLINE || sel->info.grfconfig == nullptr); + this->GetWidget(WID_NG_NEWGRF_MISSING_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NGLS_ONLINE || sel->info.grfconfig == nullptr || !sel->info.version_compatible || sel->info.compatible); #ifdef __EMSCRIPTEN__ this->SetWidgetDisabledState(WID_NG_SEARCH_INTERNET, true); @@ -637,10 +637,20 @@ public: GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.top + detail_height - 1, PC_DARK_BLUE); if (sel == nullptr) { DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + 6 + 4 + FONT_HEIGHT_NORMAL, STR_NETWORK_SERVER_LIST_GAME_INFO, TC_FROMSTRING, SA_HOR_CENTER); - } else if (!sel->online) { + } else if (sel->status != NGLS_ONLINE) { DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + 6 + 4 + FONT_HEIGHT_NORMAL, sel->info.server_name, TC_ORANGE, SA_HOR_CENTER); // game name - DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + detail_height + 4, STR_NETWORK_SERVER_LIST_SERVER_OFFLINE, TC_FROMSTRING, SA_HOR_CENTER); // server offline + StringID message = INVALID_STRING_ID; + switch (sel->status) { + case NGLS_OFFLINE: message = STR_NETWORK_SERVER_LIST_SERVER_OFFLINE; break; + case NGLS_FULL: message = STR_NETWORK_SERVER_LIST_SERVER_FULL; break; + case NGLS_BANNED: message = STR_NETWORK_SERVER_LIST_SERVER_BANNED; break; + case NGLS_TOO_OLD: message = STR_NETWORK_SERVER_LIST_SERVER_TOO_OLD; break; + + /* Handled by the if-case above. */ + case NGLS_ONLINE: NOT_REACHED(); + } + DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + detail_height + 4, message, TC_FROMSTRING, SA_HOR_CENTER); // server offline } else { // show game info DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + 6, STR_NETWORK_SERVER_LIST_GAME_INFO, TC_FROMSTRING, SA_HOR_CENTER); diff --git a/src/network/network_query.cpp b/src/network/network_query.cpp index f46a35df1..033c32e7c 100644 --- a/src/network/network_query.cpp +++ b/src/network/network_query.cpp @@ -77,16 +77,22 @@ NetworkRecvStatus QueryNetworkGameSocketHandler::SendGameInfo() NetworkRecvStatus QueryNetworkGameSocketHandler::Receive_SERVER_FULL(Packet *p) { - /* We try to join a server which is full */ - ShowErrorMessage(STR_NETWORK_ERROR_SERVER_FULL, INVALID_STRING_ID, WL_CRITICAL); - return NETWORK_RECV_STATUS_SERVER_FULL; + NetworkGameList *item = NetworkGameListAddItem(this->connection_string); + item->status = NGLS_FULL; + + UpdateNetworkGameWindow(); + + return NETWORK_RECV_STATUS_CLOSE_QUERY; } NetworkRecvStatus QueryNetworkGameSocketHandler::Receive_SERVER_BANNED(Packet *p) { - /* We try to join a server where we are banned */ - ShowErrorMessage(STR_NETWORK_ERROR_SERVER_BANNED, INVALID_STRING_ID, WL_CRITICAL); - return NETWORK_RECV_STATUS_SERVER_BANNED; + NetworkGameList *item = NetworkGameListAddItem(this->connection_string); + item->status = NGLS_BANNED; + + UpdateNetworkGameWindow(); + + return NETWORK_RECV_STATUS_CLOSE_QUERY; } NetworkRecvStatus QueryNetworkGameSocketHandler::Receive_SERVER_GAME_INFO(Packet *p) @@ -100,7 +106,7 @@ NetworkRecvStatus QueryNetworkGameSocketHandler::Receive_SERVER_GAME_INFO(Packet /* Check for compatability with the client. */ CheckGameCompatibility(item->info); /* Ensure we consider the server online. */ - item->online = true; + item->status = NGLS_ONLINE; UpdateNetworkGameWindow(); @@ -111,17 +117,21 @@ NetworkRecvStatus QueryNetworkGameSocketHandler::Receive_SERVER_ERROR(Packet *p) { 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. - */ + NetworkGameList *item = NetworkGameListAddItem(this->connection_string); + if (error == NETWORK_ERROR_NOT_EXPECTED) { - ShowErrorMessage(STR_NETWORK_ERROR_SERVER_TOO_OLD, INVALID_STRING_ID, WL_CRITICAL); - return NETWORK_RECV_STATUS_CLOSE_QUERY; + /* 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 to the + * user this server is too old to query. + */ + item->status = NGLS_TOO_OLD; + } else { + item->status = NGLS_OFFLINE; } - ShowErrorMessage(STR_NETWORK_ERROR_LOSTCONNECTION, INVALID_STRING_ID, WL_CRITICAL); - return NETWORK_RECV_STATUS_SERVER_ERROR; + UpdateNetworkGameWindow(); + + return NETWORK_RECV_STATUS_CLOSE_QUERY; } /** -- cgit v1.2.3-54-g00ecf