00001
00002
00003
00004
00005
00006
00007
00008
00009
00017 #ifdef ENABLE_NETWORK
00018
00019 #include "../stdafx.h"
00020 #include "../date_func.h"
00021 #include "../map_func.h"
00022 #include "../debug.h"
00023 #include "network_gamelist.h"
00024 #include "network_internal.h"
00025 #include "network_udp.h"
00026 #include "network.h"
00027 #include "../core/endian_func.hpp"
00028 #include "../company_base.h"
00029 #include "../thread/thread.h"
00030 #include "../rev.h"
00031 #include "../newgrf_text.h"
00032 #include "../strings_func.h"
00033 #include "table/strings.h"
00034
00035 #include "core/udp.h"
00036
00038 static ThreadMutex *_network_udp_mutex = ThreadMutex::New();
00039
00041 static uint64 _session_key = 0;
00042
00043 static const uint ADVERTISE_NORMAL_INTERVAL = 30000;
00044 static const uint ADVERTISE_RETRY_INTERVAL = 300;
00045 static const uint ADVERTISE_RETRY_TIMES = 3;
00046
00047 NetworkUDPSocketHandler *_udp_client_socket = NULL;
00048 NetworkUDPSocketHandler *_udp_server_socket = NULL;
00049 NetworkUDPSocketHandler *_udp_master_socket = NULL;
00050
00052
00054 class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {
00055 protected:
00056 virtual void Receive_MASTER_ACK_REGISTER(Packet *p, NetworkAddress *client_addr);
00057 virtual void Receive_MASTER_SESSION_KEY(Packet *p, NetworkAddress *client_addr);
00058 public:
00063 MasterNetworkUDPSocketHandler(NetworkAddressList *addresses) : NetworkUDPSocketHandler(addresses) {}
00064 virtual ~MasterNetworkUDPSocketHandler() {}
00065 };
00066
00067 void MasterNetworkUDPSocketHandler::Receive_MASTER_ACK_REGISTER(Packet *p, NetworkAddress *client_addr)
00068 {
00069 _network_advertise_retries = 0;
00070 DEBUG(net, 2, "[udp] advertising on master server successful (%s)", NetworkAddress::AddressFamilyAsString(client_addr->GetAddress()->ss_family));
00071
00072
00073 if (!_settings_client.network.server_advertise) NetworkUDPRemoveAdvertise(false);
00074 }
00075
00076 void MasterNetworkUDPSocketHandler::Receive_MASTER_SESSION_KEY(Packet *p, NetworkAddress *client_addr)
00077 {
00078 _session_key = p->Recv_uint64();
00079 DEBUG(net, 2, "[udp] received new session key from master server (%s)", NetworkAddress::AddressFamilyAsString(client_addr->GetAddress()->ss_family));
00080 }
00081
00083
00085 class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {
00086 protected:
00087 virtual void Receive_CLIENT_FIND_SERVER(Packet *p, NetworkAddress *client_addr);
00088 virtual void Receive_CLIENT_DETAIL_INFO(Packet *p, NetworkAddress *client_addr);
00089 virtual void Receive_CLIENT_GET_NEWGRFS(Packet *p, NetworkAddress *client_addr);
00090 public:
00095 ServerNetworkUDPSocketHandler(NetworkAddressList *addresses) : NetworkUDPSocketHandler(addresses) {}
00096 virtual ~ServerNetworkUDPSocketHandler() {}
00097 };
00098
00099 void ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(Packet *p, NetworkAddress *client_addr)
00100 {
00101
00102 if (!_network_udp_server) {
00103 return;
00104 }
00105
00106 NetworkGameInfo ngi;
00107
00108
00109 ngi.clients_on = _network_game_info.clients_on;
00110 ngi.start_date = ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1);
00111
00112 ngi.server_lang = _settings_client.network.server_lang;
00113 ngi.use_password = !StrEmpty(_settings_client.network.server_password);
00114 ngi.clients_max = _settings_client.network.max_clients;
00115 ngi.companies_on = (byte)Company::GetNumItems();
00116 ngi.companies_max = _settings_client.network.max_companies;
00117 ngi.spectators_on = NetworkSpectatorCount();
00118 ngi.spectators_max = _settings_client.network.max_spectators;
00119 ngi.game_date = _date;
00120 ngi.map_width = MapSizeX();
00121 ngi.map_height = MapSizeY();
00122 ngi.map_set = _settings_game.game_creation.landscape;
00123 ngi.dedicated = _network_dedicated;
00124 ngi.grfconfig = _grfconfig;
00125
00126 strecpy(ngi.map_name, _network_game_info.map_name, lastof(ngi.map_name));
00127 strecpy(ngi.server_name, _settings_client.network.server_name, lastof(ngi.server_name));
00128 strecpy(ngi.server_revision, _openttd_revision, lastof(ngi.server_revision));
00129
00130 Packet packet(PACKET_UDP_SERVER_RESPONSE);
00131 this->SendNetworkGameInfo(&packet, &ngi);
00132
00133
00134 this->SendPacket(&packet, client_addr);
00135
00136 DEBUG(net, 2, "[udp] queried from %s", client_addr->GetHostname());
00137 }
00138
00139 void ServerNetworkUDPSocketHandler::Receive_CLIENT_DETAIL_INFO(Packet *p, NetworkAddress *client_addr)
00140 {
00141
00142 if (!_network_udp_server) return;
00143
00144 Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);
00145
00146
00147 packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);
00148 packet.Send_uint8 ((uint8)Company::GetNumItems());
00149
00150
00151 NetworkCompanyStats company_stats[MAX_COMPANIES];
00152 NetworkPopulateCompanyStats(company_stats);
00153
00154
00155 static const uint MIN_CI_SIZE = 54;
00156 uint max_cname_length = NETWORK_COMPANY_NAME_LENGTH;
00157
00158 if (Company::GetNumItems() * (MIN_CI_SIZE + NETWORK_COMPANY_NAME_LENGTH) >= (uint)SEND_MTU - packet.size) {
00159
00160 assert(Company::GetNumItems() * MIN_CI_SIZE < (uint)SEND_MTU - packet.size);
00161
00162
00163
00164
00165 for (;;) {
00166 int free = SEND_MTU - packet.size;
00167 Company *company;
00168 FOR_ALL_COMPANIES(company) {
00169 char company_name[NETWORK_COMPANY_NAME_LENGTH];
00170 SetDParam(0, company->index);
00171 GetString(company_name, STR_COMPANY_NAME, company_name + max_cname_length - 1);
00172 free -= MIN_CI_SIZE;
00173 free -= (int)strlen(company_name);
00174 }
00175 if (free >= 0) break;
00176
00177
00178 assert(max_cname_length > 0);
00179 max_cname_length--;
00180 }
00181 }
00182
00183 Company *company;
00184
00185 FOR_ALL_COMPANIES(company) {
00186
00187 this->SendCompanyInformation(&packet, company, &company_stats[company->index], max_cname_length);
00188 }
00189
00190 this->SendPacket(&packet, client_addr);
00191 }
00192
00206 void ServerNetworkUDPSocketHandler::Receive_CLIENT_GET_NEWGRFS(Packet *p, NetworkAddress *client_addr)
00207 {
00208 uint8 num_grfs;
00209 uint i;
00210
00211 const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];
00212 uint8 in_reply_count = 0;
00213 size_t packet_len = 0;
00214
00215 DEBUG(net, 6, "[udp] newgrf data request from %s", client_addr->GetAddressAsString());
00216
00217 num_grfs = p->Recv_uint8 ();
00218 if (num_grfs > NETWORK_MAX_GRF_COUNT) return;
00219
00220 for (i = 0; i < num_grfs; i++) {
00221 GRFIdentifier c;
00222 const GRFConfig *f;
00223
00224 this->ReceiveGRFIdentifier(p, &c);
00225
00226
00227 f = FindGRFConfig(c.grfid, FGCM_EXACT, c.md5sum);
00228 if (f == NULL) continue;
00229
00230
00231
00232
00233 packet_len += sizeof(c.grfid) + sizeof(c.md5sum) +
00234 min(strlen(f->GetName()) + 1, (size_t)NETWORK_GRF_NAME_LENGTH);
00235 if (packet_len > SEND_MTU - 4) {
00236 break;
00237 }
00238 in_reply[in_reply_count] = f;
00239 in_reply_count++;
00240 }
00241
00242 if (in_reply_count == 0) return;
00243
00244 Packet packet(PACKET_UDP_SERVER_NEWGRFS);
00245 packet.Send_uint8(in_reply_count);
00246 for (i = 0; i < in_reply_count; i++) {
00247 char name[NETWORK_GRF_NAME_LENGTH];
00248
00249
00250 strecpy(name, in_reply[i]->GetName(), lastof(name));
00251 this->SendGRFIdentifier(&packet, &in_reply[i]->ident);
00252 packet.Send_string(name);
00253 }
00254
00255 this->SendPacket(&packet, client_addr);
00256 }
00257
00259
00261 class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {
00262 protected:
00263 virtual void Receive_SERVER_RESPONSE(Packet *p, NetworkAddress *client_addr);
00264 virtual void Receive_MASTER_RESPONSE_LIST(Packet *p, NetworkAddress *client_addr);
00265 virtual void Receive_SERVER_NEWGRFS(Packet *p, NetworkAddress *client_addr);
00266 virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);
00267 public:
00268 virtual ~ClientNetworkUDPSocketHandler() {}
00269 };
00270
00271 void ClientNetworkUDPSocketHandler::Receive_SERVER_RESPONSE(Packet *p, NetworkAddress *client_addr)
00272 {
00273 NetworkGameList *item;
00274
00275
00276 if (_network_udp_server) return;
00277
00278 DEBUG(net, 4, "[udp] server response from %s", client_addr->GetAddressAsString());
00279
00280
00281 item = NetworkGameListAddItem(*client_addr);
00282
00283 ClearGRFConfigList(&item->info.grfconfig);
00284 this->ReceiveNetworkGameInfo(p, &item->info);
00285
00286 item->info.compatible = true;
00287 {
00288
00289
00290
00291
00292
00293
00294
00295 const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];
00296 const GRFConfig *c;
00297 uint in_request_count = 0;
00298
00299 for (c = item->info.grfconfig; c != NULL; c = c->next) {
00300 if (c->status == GCS_NOT_FOUND) item->info.compatible = false;
00301 if (c->status != GCS_NOT_FOUND || strcmp(c->GetName(), UNKNOWN_GRF_NAME_PLACEHOLDER) != 0) continue;
00302 in_request[in_request_count] = c;
00303 in_request_count++;
00304 }
00305
00306 if (in_request_count > 0) {
00307
00308 uint i;
00309 Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);
00310
00311 packet.Send_uint8(in_request_count);
00312 for (i = 0; i < in_request_count; i++) {
00313 this->SendGRFIdentifier(&packet, &in_request[i]->ident);
00314 }
00315
00316 this->SendPacket(&packet, &item->address);
00317 }
00318 }
00319
00320 if (item->info.hostname[0] == '\0') {
00321 snprintf(item->info.hostname, sizeof(item->info.hostname), "%s", client_addr->GetHostname());
00322 }
00323
00324 if (client_addr->GetAddress()->ss_family == AF_INET6) {
00325 strecat(item->info.server_name, " (IPv6)", lastof(item->info.server_name));
00326 }
00327
00328
00329 item->info.version_compatible = IsNetworkCompatibleVersion(item->info.server_revision);
00330 item->info.compatible &= item->info.version_compatible;
00331
00332 item->online = true;
00333
00334 UpdateNetworkGameWindow(false);
00335 }
00336
00337 void ClientNetworkUDPSocketHandler::Receive_MASTER_RESPONSE_LIST(Packet *p, NetworkAddress *client_addr)
00338 {
00339
00340
00341
00342
00343
00344
00345 ServerListType type = (ServerListType)(p->Recv_uint8() - 1);
00346
00347 if (type < SLT_END) {
00348 for (int i = p->Recv_uint16(); i != 0 ; i--) {
00349 sockaddr_storage addr_storage;
00350 memset(&addr_storage, 0, sizeof(addr_storage));
00351
00352 if (type == SLT_IPv4) {
00353 addr_storage.ss_family = AF_INET;
00354 ((sockaddr_in*)&addr_storage)->sin_addr.s_addr = TO_LE32(p->Recv_uint32());
00355 } else {
00356 assert(type == SLT_IPv6);
00357 addr_storage.ss_family = AF_INET6;
00358 byte *addr = (byte*)&((sockaddr_in6*)&addr_storage)->sin6_addr;
00359 for (uint i = 0; i < sizeof(in6_addr); i++) *addr++ = p->Recv_uint8();
00360 }
00361 NetworkAddress addr(addr_storage, type == SLT_IPv4 ? sizeof(sockaddr_in) : sizeof(sockaddr_in6));
00362 addr.SetPort(p->Recv_uint16());
00363
00364
00365 if (this->HasClientQuit()) return;
00366
00367 NetworkUDPQueryServer(addr);
00368 }
00369 }
00370 }
00371
00373 void ClientNetworkUDPSocketHandler::Receive_SERVER_NEWGRFS(Packet *p, NetworkAddress *client_addr)
00374 {
00375 uint8 num_grfs;
00376 uint i;
00377
00378 DEBUG(net, 6, "[udp] newgrf data reply from %s", client_addr->GetAddressAsString());
00379
00380 num_grfs = p->Recv_uint8 ();
00381 if (num_grfs > NETWORK_MAX_GRF_COUNT) return;
00382
00383 for (i = 0; i < num_grfs; i++) {
00384 char name[NETWORK_GRF_NAME_LENGTH];
00385 GRFIdentifier c;
00386
00387 this->ReceiveGRFIdentifier(p, &c);
00388 p->Recv_string(name, sizeof(name));
00389
00390
00391
00392 if (StrEmpty(name)) continue;
00393
00394
00395
00396
00397 GRFTextWrapper *unknown_name = FindUnknownGRFName(c.grfid, c.md5sum, false);
00398 if (unknown_name != NULL && strcmp(GetGRFStringFromGRFText(unknown_name->text), UNKNOWN_GRF_NAME_PLACEHOLDER) == 0) {
00399 AddGRFTextToList(&unknown_name->text, name);
00400 }
00401 }
00402 }
00403
00404 void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)
00405 {
00406
00407 const GRFConfig *f = FindGRFConfig(config->ident.grfid, FGCM_EXACT, config->ident.md5sum);
00408 if (f == NULL) {
00409
00410
00411
00412 config->name->Release();
00413 config->name = FindUnknownGRFName(config->ident.grfid, config->ident.md5sum, true);
00414 config->name->AddRef();
00415 config->status = GCS_NOT_FOUND;
00416 } else {
00417 config->filename = f->filename;
00418 config->name->Release();
00419 config->name = f->name;
00420 config->name->AddRef();
00421 config->info->Release();
00422 config->info = f->info;
00423 config->info->AddRef();
00424 }
00425 SetBit(config->flags, GCF_COPY);
00426 }
00427
00429 static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)
00430 {
00431 for (NetworkAddress *addr = _broadcast_list.Begin(); addr != _broadcast_list.End(); addr++) {
00432 Packet p(PACKET_UDP_CLIENT_FIND_SERVER);
00433
00434 DEBUG(net, 4, "[udp] broadcasting to %s", addr->GetHostname());
00435
00436 socket->SendPacket(&p, addr, true, true);
00437 }
00438 }
00439
00440
00442 void NetworkUDPQueryMasterServer()
00443 {
00444 Packet p(PACKET_UDP_CLIENT_GET_LIST);
00445 NetworkAddress out_addr(NETWORK_MASTER_SERVER_HOST, NETWORK_MASTER_SERVER_PORT);
00446
00447
00448 p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);
00449 p.Send_uint8(SLT_AUTODETECT);
00450
00451 _udp_client_socket->SendPacket(&p, &out_addr, true);
00452
00453 DEBUG(net, 2, "[udp] master server queried at %s", out_addr.GetAddressAsString());
00454 }
00455
00457 void NetworkUDPSearchGame()
00458 {
00459
00460 if (_network_udp_broadcast > 0) return;
00461
00462 DEBUG(net, 0, "[udp] searching server");
00463
00464 NetworkUDPBroadCast(_udp_client_socket);
00465 _network_udp_broadcast = 300;
00466 }
00467
00469 struct NetworkUDPQueryServerInfo : NetworkAddress {
00470 bool manually;
00471
00477 NetworkUDPQueryServerInfo(const NetworkAddress &address, bool manually) :
00478 NetworkAddress(address),
00479 manually(manually)
00480 {
00481 }
00482 };
00483
00488 static void NetworkUDPQueryServerThread(void *pntr)
00489 {
00490 NetworkUDPQueryServerInfo *info = (NetworkUDPQueryServerInfo*)pntr;
00491
00492
00493 NetworkGameList *item = CallocT<NetworkGameList>(1);
00494 info->GetAddressAsString(item->info.server_name, lastof(item->info.server_name));
00495 strecpy(item->info.hostname, info->GetHostname(), lastof(item->info.hostname));
00496 item->address = *info;
00497 item->manually = info->manually;
00498 NetworkGameListAddItemDelayed(item);
00499
00500 _network_udp_mutex->BeginCritical();
00501
00502 Packet p(PACKET_UDP_CLIENT_FIND_SERVER);
00503 if (_udp_client_socket != NULL) _udp_client_socket->SendPacket(&p, info);
00504 _network_udp_mutex->EndCritical();
00505
00506 delete info;
00507 }
00508
00514 void NetworkUDPQueryServer(NetworkAddress address, bool manually)
00515 {
00516 NetworkUDPQueryServerInfo *info = new NetworkUDPQueryServerInfo(address, manually);
00517 if (address.IsResolved() || !ThreadObject::New(NetworkUDPQueryServerThread, info)) {
00518 NetworkUDPQueryServerThread(info);
00519 }
00520 }
00521
00526 static void NetworkUDPRemoveAdvertiseThread(void *pntr)
00527 {
00528 DEBUG(net, 1, "[udp] removing advertise from master server");
00529
00530
00531 NetworkAddress out_addr(NETWORK_MASTER_SERVER_HOST, NETWORK_MASTER_SERVER_PORT);
00532
00533
00534 Packet p(PACKET_UDP_SERVER_UNREGISTER);
00535
00536 p.Send_uint8 (NETWORK_MASTER_SERVER_VERSION);
00537 p.Send_uint16(_settings_client.network.server_port);
00538
00539 _network_udp_mutex->BeginCritical();
00540 if (_udp_master_socket != NULL) _udp_master_socket->SendPacket(&p, &out_addr, true);
00541 _network_udp_mutex->EndCritical();
00542 }
00543
00548 void NetworkUDPRemoveAdvertise(bool blocking)
00549 {
00550
00551 if (!_networking || !_network_server || !_network_udp_server) return;
00552
00553 if (blocking || !ThreadObject::New(NetworkUDPRemoveAdvertiseThread, NULL)) {
00554 NetworkUDPRemoveAdvertiseThread(NULL);
00555 }
00556 }
00557
00562 static void NetworkUDPAdvertiseThread(void *pntr)
00563 {
00564
00565 NetworkAddress out_addr(NETWORK_MASTER_SERVER_HOST, NETWORK_MASTER_SERVER_PORT);
00566
00567 DEBUG(net, 1, "[udp] advertising to master server");
00568
00569
00570 static byte session_key_retries = 0;
00571 if (_session_key == 0 && session_key_retries++ == 2) {
00572 DEBUG(net, 0, "[udp] advertising to the master server is failing");
00573 DEBUG(net, 0, "[udp] we are not receiving the session key from the server");
00574 DEBUG(net, 0, "[udp] please allow udp packets from %s to you to be delivered", out_addr.GetAddressAsString(false));
00575 DEBUG(net, 0, "[udp] please allow udp packets from you to %s to be delivered", out_addr.GetAddressAsString(false));
00576 }
00577 if (_session_key != 0 && _network_advertise_retries == 0) {
00578 DEBUG(net, 0, "[udp] advertising to the master server is failing");
00579 DEBUG(net, 0, "[udp] we are not receiving the acknowledgement from the server");
00580 DEBUG(net, 0, "[udp] this usually means that the master server cannot reach us");
00581 DEBUG(net, 0, "[udp] please allow udp and tcp packets to port %u to be delivered", _settings_client.network.server_port);
00582 DEBUG(net, 0, "[udp] please allow udp and tcp packets from port %u to be delivered", _settings_client.network.server_port);
00583 }
00584
00585
00586 Packet p(PACKET_UDP_SERVER_REGISTER);
00587
00588 p.Send_string(NETWORK_MASTER_SERVER_WELCOME_MESSAGE);
00589 p.Send_uint8 (NETWORK_MASTER_SERVER_VERSION);
00590 p.Send_uint16(_settings_client.network.server_port);
00591 p.Send_uint64(_session_key);
00592
00593 _network_udp_mutex->BeginCritical();
00594 if (_udp_master_socket != NULL) _udp_master_socket->SendPacket(&p, &out_addr, true);
00595 _network_udp_mutex->EndCritical();
00596 }
00597
00602 void NetworkUDPAdvertise()
00603 {
00604
00605 if (!_networking || !_network_server || !_network_udp_server || !_settings_client.network.server_advertise) return;
00606
00607 if (_network_need_advertise) {
00608 _network_need_advertise = false;
00609 _network_advertise_retries = ADVERTISE_RETRY_TIMES;
00610 } else {
00611
00612 if (_network_advertise_retries == 0) {
00613 if ((_network_last_advertise_frame + ADVERTISE_NORMAL_INTERVAL) > _frame_counter) return;
00614
00615 _network_advertise_retries = ADVERTISE_RETRY_TIMES;
00616 }
00617
00618 if ((_network_last_advertise_frame + ADVERTISE_RETRY_INTERVAL) > _frame_counter) return;
00619 }
00620
00621 _network_advertise_retries--;
00622 _network_last_advertise_frame = _frame_counter;
00623
00624 if (!ThreadObject::New(NetworkUDPAdvertiseThread, NULL)) {
00625 NetworkUDPAdvertiseThread(NULL);
00626 }
00627 }
00628
00630 void NetworkUDPInitialize()
00631 {
00632
00633 if (_udp_server_socket != NULL) NetworkUDPClose();
00634
00635 DEBUG(net, 1, "[udp] initializing listeners");
00636 assert(_udp_client_socket == NULL && _udp_server_socket == NULL && _udp_master_socket == NULL);
00637
00638 _network_udp_mutex->BeginCritical();
00639
00640 _udp_client_socket = new ClientNetworkUDPSocketHandler();
00641
00642 NetworkAddressList server;
00643 GetBindAddresses(&server, _settings_client.network.server_port);
00644 _udp_server_socket = new ServerNetworkUDPSocketHandler(&server);
00645
00646 server.Clear();
00647 GetBindAddresses(&server, 0);
00648 _udp_master_socket = new MasterNetworkUDPSocketHandler(&server);
00649
00650 _network_udp_server = false;
00651 _network_udp_broadcast = 0;
00652 _network_udp_mutex->EndCritical();
00653 }
00654
00656 void NetworkUDPClose()
00657 {
00658 _network_udp_mutex->BeginCritical();
00659 _udp_server_socket->Close();
00660 _udp_master_socket->Close();
00661 _udp_client_socket->Close();
00662 delete _udp_client_socket;
00663 delete _udp_server_socket;
00664 delete _udp_master_socket;
00665 _udp_client_socket = NULL;
00666 _udp_server_socket = NULL;
00667 _udp_master_socket = NULL;
00668 _network_udp_mutex->EndCritical();
00669
00670 _network_udp_server = false;
00671 _network_udp_broadcast = 0;
00672 DEBUG(net, 1, "[udp] closed listeners");
00673 }
00674
00675 #endif