src/network/network_gamelist.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /**
   9  * @file network_gamelist.cpp This file handles the GameList
  10  * Also, it handles the request to a server for data about the server
  11  */
  12
  13 #include "../stdafx.h"
  14 #include "../debug.h"
  15 #include "../window_func.h"
  16 #include "network_internal.h"
  17 #include "network_udp.h"
  18 #include "network_gamelist.h"
  19 #include <atomic>
  20
  21 #include "../safeguards.h"
  22
  23 NetworkGameList *_network_game_list = nullptr; ///< Game list of this client.
  24 int _network_game_list_version = 0; ///< Current version of all items in the list.
  25
  26 /**
  27  * Add a new item to the linked gamelist. If the IP and Port match
  28  * return the existing item instead of adding it again
  29  * @param connection_string the address of the to-be added item
  30  * @return a point to the newly added or already existing item
  31  */
  32 NetworkGameList *NetworkGameListAddItem(const std::string &connection_string)
  33 {
  34         NetworkGameList *item, *prev_item;
  35
  36         /* Parse the connection string to ensure the default port is there. */
  37         const std::string resolved_connection_string = ServerAddress::Parse(connection_string, NETWORK_DEFAULT_PORT).connection_string;
  38
  39         prev_item = nullptr;
  40         for (item = _network_game_list; item != nullptr; item = item->next) {
  41                 if (item->connection_string == resolved_connection_string) return item;
  42                 prev_item = item;
  43         }
  44
  45         item = new NetworkGameList(resolved_connection_string);
  46         item->info.gamescript_version = -1;
  47         item->version = _network_game_list_version;
  48
  49         if (prev_item == nullptr) {
  50                 _network_game_list = item;
  51         } else {
  52                 prev_item->next = item;
  53         }
  54
  55         UpdateNetworkGameWindow();
  56
  57         return item;
  58 }
  59
  60 /**
  61  * Remove an item from the gamelist linked list
  62  * @param remove pointer to the item to be removed
  63  */
  64 void NetworkGameListRemoveItem(NetworkGameList *remove)
  65 {
  66         NetworkGameList *prev_item = nullptr;
  67         for (NetworkGameList *item = _network_game_list; item != nullptr; item = item->next) {
  68                 if (remove == item) {
  69                         if (prev_item == nullptr) {
  70                                 _network_game_list = remove->next;
  71                         } else {
  72                                 prev_item->next = remove->next;
  73                         }
  74
  75                         /* Remove GRFConfig information */
  76                         ClearGRFConfigList(&remove->info.grfconfig);
  77                         delete remove;
  78
  79                         NetworkRebuildHostList();
  80                         UpdateNetworkGameWindow();
  81                         return;
  82                 }
  83                 prev_item = item;
  84         }
  85 }
  86
  87 /**
  88  * Remove all servers that have not recently been updated.
  89  * Call this after you received all the servers from the Game Coordinator, so
  90  * the ones that are no longer listed are removed.
  91  */
  92 void NetworkGameListRemoveExpired()
  93 {
  94         NetworkGameList **prev_item = &_network_game_list;
  95
  96         for (NetworkGameList *item = _network_game_list; item != nullptr;) {
  97                 if (!item->manually && item->version < _network_game_list_version) {
  98                         NetworkGameList *remove = item;
  99                         item = item->next;
 100                         *prev_item = item;
 101
 102                         /* Remove GRFConfig information */
 103                         ClearGRFConfigList(&remove->info.grfconfig);
 104                         delete remove;
 105                 } else {
 106                         prev_item = &item->next;
 107                         item = item->next;
 108                 }
 109         }
 110
 111         UpdateNetworkGameWindow();
 112 }
 113
 114 /**
 115  * Rebuild the GRFConfig's of the servers in the game list as we did
 116  * a rescan and might have found new NewGRFs.
 117  */
 118 void NetworkAfterNewGRFScan()
 119 {
 120         for (NetworkGameList *item = _network_game_list; item != nullptr; item = item->next) {
 121                 /* Reset compatibility state */
 122                 item->info.compatible = item->info.version_compatible;
 123
 124                 for (GRFConfig *c = item->info.grfconfig; c != nullptr; c = c->next) {
 125                         assert(HasBit(c->flags, GCF_COPY));
 126
 127                         const GRFConfig *f = FindGRFConfig(c->ident.grfid, FGCM_EXACT, &c->ident.md5sum);
 128                         if (f == nullptr) {
 129                                 /* Don't know the GRF (anymore), so mark game incompatible. */
 130                                 c->status = GCS_NOT_FOUND;
 131
 132                                 /* If we miss a file, we're obviously incompatible. */
 133                                 item->info.compatible = false;
 134                         } else {
 135                                 c->filename = f->filename;
 136                                 c->name = f->name;
 137                                 c->info = f->info;
 138                                 c->status = GCS_UNKNOWN;
 139                         }
 140                 }
 141         }
 142
 143         InvalidateWindowClassesData(WC_NETWORK_WINDOW);
 144 }