1

/* $Id$ */

     2

     3

/**

     4

 * @file network_udp.cpp This file handles the UDP related communication.

     5

 *

     6

 * This is the GameServer <-> MasterServer and GameServer <-> GameClient

     7

 * communication before the game is being joined.

     8

 */

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "../stdafx.h"

    13

#include "../debug.h"

    14

#include "network_data.h"

    15

#include "../date_func.h"

    16

#include "../map_func.h"

    17

#include "network_gamelist.h"

    18

#include "network_udp.h"

    19

#include "../variables.h"

    20

#include "../newgrf_config.h"

    21

#include "../core/endian_func.hpp"

    22

#include "../string_func.h"

    23

#include "../player_base.h"

    24

#include "../player_func.h"

    25

#include "../settings_type.h"

    26

    27

#include "core/udp.h"

    28

    29

enum {

    30

	ADVERTISE_NORMAL_INTERVAL = 30000, // interval between advertising in ticks (15 minutes)

    31

	ADVERTISE_RETRY_INTERVAL  =   300, // readvertise when no response after this many ticks (9 seconds)

    32

	ADVERTISE_RETRY_TIMES     =     3  // give up readvertising after this much failed retries

    33

};

    34

    35

NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    36

NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    37

NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    38

    39

///*** Communication with the masterserver ***/

    40

    41

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    42

protected:

    43

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    44

public:

    45

	virtual ~MasterNetworkUDPSocketHandler() {}

    46

};

    47

    48

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    49

{

    50

	_network_advertise_retries = 0;

    51

	DEBUG(net, 2, "[udp] advertising on master server successful");

    52

    53

	/* We are advertised, but we don't want to! */

    54

	if (!_network_advertise) NetworkUDPRemoveAdvertise();

    55

}

    56

    57

///*** Communication with clients (we are server) ***/

    58

    59

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    60

protected:

    61

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    62

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    63

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    64

public:

    65

	virtual ~ServerNetworkUDPSocketHandler() {}

    66

};

    67

    68

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    69

{

    70

	// Just a fail-safe.. should never happen

    71

	if (!_network_udp_server)

    72

		return;

    73

    74

	Packet packet(PACKET_UDP_SERVER_RESPONSE);

    75

    76

	// Update some game_info

    77

	_network_game_info.game_date     = _date;

    78

	_network_game_info.map_width     = MapSizeX();

    79

	_network_game_info.map_height    = MapSizeY();

    80

	_network_game_info.map_set       = _opt.landscape;

    81

	_network_game_info.companies_on  = ActivePlayerCount();

    82

	_network_game_info.spectators_on = NetworkSpectatorCount();

    83

	_network_game_info.grfconfig     = _grfconfig;

    84

    85

	this->Send_NetworkGameInfo(&packet, &_network_game_info);

    86

    87

	// Let the client know that we are here

    88

	this->SendPacket(&packet, client_addr);

    89

    90

	DEBUG(net, 2, "[udp] queried from '%s'", inet_ntoa(client_addr->sin_addr));

    91

}

    92

    93

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

    94

{

    95

	NetworkTCPSocketHandler *cs;

    96

	NetworkClientInfo *ci;

    97

	Player *player;

    98

	byte current = 0;

    99

	int i;

   100

   101

	// Just a fail-safe.. should never happen

   102

	if (!_network_udp_server) return;

   103

   104

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   105

   106

	/* Send the amount of active companies */

   107

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   108

	packet.Send_uint8 (ActivePlayerCount());

   109

   110

	/* Fetch the latest version of everything */

   111

	NetworkPopulateCompanyInfo();

   112

   113

	/* Go through all the players */

   114

	FOR_ALL_PLAYERS(player) {

   115

		/* Skip non-active players */

   116

		if (!player->is_active) continue;

   117

   118

		current++;

   119

   120

		/* Send the information */

   121

		packet.Send_uint8 (current);

   122

   123

		packet.Send_string(_network_player_info[player->index].company_name);

   124

		packet.Send_uint32(_network_player_info[player->index].inaugurated_year);

   125

		packet.Send_uint64(_network_player_info[player->index].company_value);

   126

		packet.Send_uint64(_network_player_info[player->index].money);

   127

		packet.Send_uint64(_network_player_info[player->index].income);

   128

		packet.Send_uint16(_network_player_info[player->index].performance);

   129

   130

		/* Send 1 if there is a passord for the company else send 0 */

   131

		packet.Send_bool  (!StrEmpty(_network_player_info[player->index].password));

   132

   133

		for (i = 0; i < NETWORK_VEHICLE_TYPES; i++)

   134

			packet.Send_uint16(_network_player_info[player->index].num_vehicle[i]);

   135

   136

		for (i = 0; i < NETWORK_STATION_TYPES; i++)

   137

			packet.Send_uint16(_network_player_info[player->index].num_station[i]);

   138

   139

		/* Find the clients that are connected to this player */

   140

		FOR_ALL_CLIENTS(cs) {

   141

			ci = DEREF_CLIENT_INFO(cs);

   142

			if (ci->client_playas == player->index) {

   143

				packet.Send_bool  (true);

   144

				packet.Send_string(ci->client_name);

   145

				packet.Send_string(ci->unique_id);

   146

				packet.Send_uint32(ci->join_date);

   147

			}

   148

		}

   149

		/* Also check for the server itself */

   150

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   151

		if (ci->client_playas == player->index) {

   152

			packet.Send_bool  (true);

   153

			packet.Send_string(ci->client_name);

   154

			packet.Send_string(ci->unique_id);

   155

			packet.Send_uint32(ci->join_date);

   156

		}

   157

   158

		/* Indicates end of client list */

   159

		packet.Send_bool(false);

   160

	}

   161

   162

	/* And check if we have any spectators */

   163

	FOR_ALL_CLIENTS(cs) {

   164

		ci = DEREF_CLIENT_INFO(cs);

   165

		if (!IsValidPlayer(ci->client_playas)) {

   166

			packet.Send_bool  (true);

   167

			packet.Send_string(ci->client_name);

   168

			packet.Send_string(ci->unique_id);

   169

			packet.Send_uint32(ci->join_date);

   170

		}

   171

	}

   172

   173

	/* Also check for the server itself */

   174

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   175

	if (!IsValidPlayer(ci->client_playas)) {

   176

		packet.Send_bool  (true);

   177

		packet.Send_string(ci->client_name);

   178

		packet.Send_string(ci->unique_id);

   179

		packet.Send_uint32(ci->join_date);

   180

	}

   181

   182

	/* Indicates end of client list */

   183

	packet.Send_bool(false);

   184

   185

	this->SendPacket(&packet, client_addr);

   186

}

   187

   188

/**

   189

 * A client has requested the names of some NewGRFs.

   190

 *

   191

 * Replying this can be tricky as we have a limit of SEND_MTU bytes

   192

 * in the reply packet and we can send up to 100 bytes per NewGRF

   193

 * (GRF ID, MD5sum and NETWORK_GRF_NAME_LENGTH bytes for the name).

   194

 * As SEND_MTU is _much_ less than 100 * NETWORK_MAX_GRF_COUNT, it

   195

 * could be that a packet overflows. To stop this we only reply

   196

 * with the first N NewGRFs so that if the first N + 1 NewGRFs

   197

 * would be sent, the packet overflows.

   198

 * in_reply and in_reply_count are used to keep a list of GRFs to

   199

 * send in the reply.

   200

 */

   201

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   202

{

   203

	uint8 num_grfs;

   204

	uint i;

   205

   206

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   207

	uint8 in_reply_count = 0;

   208

	uint packet_len = 0;

   209

   210

	DEBUG(net, 6, "[udp] newgrf data request from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   211

   212

	num_grfs = p->Recv_uint8 ();

   213

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   214

   215

	for (i = 0; i < num_grfs; i++) {

   216

		GRFConfig c;

   217

		const GRFConfig *f;

   218

   219

		this->Recv_GRFIdentifier(p, &c);

   220

   221

		/* Find the matching GRF file */

   222

		f = FindGRFConfig(c.grfid, c.md5sum);

   223

		if (f == NULL) continue; // The GRF is unknown to this server

   224

   225

		/* If the reply might exceed the size of the packet, only reply

   226

		 * the current list and do not send the other data.

   227

		 * The name could be an empty string, if so take the filename. */

   228

		packet_len += sizeof(c.grfid) + sizeof(c.md5sum) +

   229

				min(strlen((f->name != NULL && !StrEmpty(f->name)) ? f->name : f->filename) + 1, (size_t)NETWORK_GRF_NAME_LENGTH);

   230

		if (packet_len > SEND_MTU - 4) { // 4 is 3 byte header + grf count in reply

   231

			break;

   232

		}

   233

		in_reply[in_reply_count] = f;

   234

		in_reply_count++;

   235

	}

   236

   237

	if (in_reply_count == 0) return;

   238

   239

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   240

	packet.Send_uint8(in_reply_count);

   241

	for (i = 0; i < in_reply_count; i++) {

   242

		char name[NETWORK_GRF_NAME_LENGTH];

   243

   244

		/* The name could be an empty string, if so take the filename */

   245

		ttd_strlcpy(name, (in_reply[i]->name != NULL && !StrEmpty(in_reply[i]->name)) ?

   246

				in_reply[i]->name : in_reply[i]->filename, sizeof(name));

   247

		this->Send_GRFIdentifier(&packet, in_reply[i]);

   248

		packet.Send_string(name);

   249

	}

   250

   251

	this->SendPacket(&packet, client_addr);

   252

}

   253

   254

///*** Communication with servers (we are client) ***/

   255

   256

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   257

protected:

   258

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   259

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   260

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   261

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   262

public:

   263

	virtual ~ClientNetworkUDPSocketHandler() {}

   264

};

   265

   266

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   267

{

   268

	NetworkGameList *item;

   269

   270

	// Just a fail-safe.. should never happen

   271

	if (_network_udp_server) return;

   272

   273

	DEBUG(net, 4, "[udp] server response from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   274

   275

	// Find next item

   276

	item = NetworkGameListAddItem(inet_addr(inet_ntoa(client_addr->sin_addr)), ntohs(client_addr->sin_port));

   277

   278

	this->Recv_NetworkGameInfo(p, &item->info);

   279

   280

	item->info.compatible = true;

   281

	{

   282

		/* Checks whether there needs to be a request for names of GRFs and makes

   283

		 * the request if necessary. GRFs that need to be requested are the GRFs

   284

		 * that do not exist on the clients system and we do not have the name

   285

		 * resolved of, i.e. the name is still UNKNOWN_GRF_NAME_PLACEHOLDER.

   286

		 * The in_request array and in_request_count are used so there is no need

   287

		 * to do a second loop over the GRF list, which can be relatively expensive

   288

		 * due to the string comparisons. */

   289

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   290

		const GRFConfig *c;

   291

		uint in_request_count = 0;

   292

		struct sockaddr_in out_addr;

   293

   294

		for (c = item->info.grfconfig; c != NULL; c = c->next) {

   295

			if (c->status == GCS_NOT_FOUND) item->info.compatible = false;

   296

 			if (c->status != GCS_NOT_FOUND || strcmp(c->name, UNKNOWN_GRF_NAME_PLACEHOLDER) != 0) continue;

   297

			in_request[in_request_count] = c;

   298

			in_request_count++;

   299

		}

   300

   301

		if (in_request_count > 0) {

   302

			/* There are 'unknown' GRFs, now send a request for them */

   303

			uint i;

   304

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   305

   306

			packet.Send_uint8(in_request_count);

   307

			for (i = 0; i < in_request_count; i++) {

   308

				this->Send_GRFIdentifier(&packet, in_request[i]);

   309

			}

   310

   311

			out_addr.sin_family      = AF_INET;

   312

			out_addr.sin_port        = htons(item->port);

   313

			out_addr.sin_addr.s_addr = item->ip;

   314

			this->SendPacket(&packet, &out_addr);

   315

		}

   316

	}

   317

   318

	if (item->info.hostname[0] == '\0')

   319

		snprintf(item->info.hostname, sizeof(item->info.hostname), "%s", inet_ntoa(client_addr->sin_addr));

   320

   321

	/* Check if we are allowed on this server based on the revision-match */

   322

	item->info.version_compatible = IsNetworkCompatibleVersion(item->info.server_revision);

   323

	item->info.compatible &= item->info.version_compatible; // Already contains match for GRFs

   324

   325

	item->online = true;

   326

   327

	UpdateNetworkGameWindow(false);

   328

}

   329

   330

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   331

{

   332

	int i;

   333

	struct in_addr ip;

   334

	uint16 port;

   335

	uint8 ver;

   336

   337

	/* packet begins with the protocol version (uint8)

   338

	 * then an uint16 which indicates how many

   339

	 * ip:port pairs are in this packet, after that

   340

	 * an uint32 (ip) and an uint16 (port) for each pair

   341

	 */

   342

   343

	ver = p->Recv_uint8();

   344

   345

	if (ver == 1) {

   346

		for (i = p->Recv_uint16(); i != 0 ; i--) {

   347

			ip.s_addr = TO_LE32(p->Recv_uint32());

   348

			port = p->Recv_uint16();

   349

   350

			/* Somehow we reached the end of the packet */

   351

			if (this->HasClientQuit()) return;

   352

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   353

		}

   354

	}

   355

}

   356

   357

/** The return of the client's request of the names of some NewGRFs */

   358

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   359

{

   360

	uint8 num_grfs;

   361

	uint i;

   362

   363

	DEBUG(net, 6, "[udp] newgrf data reply from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   364

   365

	num_grfs = p->Recv_uint8 ();

   366

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   367

   368

	for (i = 0; i < num_grfs; i++) {

   369

		char *unknown_name;

   370

		char name[NETWORK_GRF_NAME_LENGTH];

   371

		GRFConfig c;

   372

   373

		this->Recv_GRFIdentifier(p, &c);

   374

		p->Recv_string(name, sizeof(name));

   375

   376

		/* An empty name is not possible under normal circumstances

   377

		 * and causes problems when showing the NewGRF list. */

   378

		if (StrEmpty(name)) continue;

   379

   380

		/* Finds the fake GRFConfig for the just read GRF ID and MD5sum tuple.

   381

		 * If it exists and not resolved yet, then name of the fake GRF is

   382

		 * overwritten with the name from the reply. */

   383

		unknown_name = FindUnknownGRFName(c.grfid, c.md5sum, false);

   384

		if (unknown_name != NULL && strcmp(unknown_name, UNKNOWN_GRF_NAME_PLACEHOLDER) == 0) {

   385

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   386

		}

   387

	}

   388

}

   389

   390

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   391

{

   392

	/* Find the matching GRF file */

   393

	const GRFConfig *f = FindGRFConfig(config->grfid, config->md5sum);

   394

	if (f == NULL) {

   395

		/* Don't know the GRF, so mark game incompatible and the (possibly)

   396

		 * already resolved name for this GRF (another server has sent the

   397

		 * name of the GRF already */

   398

		config->name   = FindUnknownGRFName(config->grfid, config->md5sum, true);

   399

		config->status = GCS_NOT_FOUND;

   400

	} else {

   401

		config->filename  = f->filename;

   402

		config->name      = f->name;

   403

		config->info      = f->info;

   404

	}

   405

	SetBit(config->flags, GCF_COPY);

   406

}

   407

   408

// Close UDP connection

   409

void NetworkUDPCloseAll()

   410

{

   411

	DEBUG(net, 1, "[udp] closed listeners");

   412

   413

	_udp_server_socket->Close();

   414

	_udp_master_socket->Close();

   415

	_udp_client_socket->Close();

   416

   417

	_network_udp_server = false;

   418

	_network_udp_broadcast = 0;

   419

}

   420

   421

// Broadcast to all ips

   422

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   423

{

   424

	uint i;

   425

   426

	for (i = 0; _broadcast_list[i] != 0; i++) {

   427

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   428

		struct sockaddr_in out_addr;

   429

   430

		out_addr.sin_family = AF_INET;

   431

		out_addr.sin_port = htons(_network_server_port);

   432

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   433

   434

		DEBUG(net, 4, "[udp] broadcasting to %s", inet_ntoa(out_addr.sin_addr));

   435

   436

		socket->SendPacket(&p, &out_addr);

   437

	}

   438

}

   439

   440

   441

// Request the the server-list from the master server

   442

void NetworkUDPQueryMasterServer()

   443

{

   444

	struct sockaddr_in out_addr;

   445

   446

	if (!_udp_client_socket->IsConnected()) {

   447

		if (!_udp_client_socket->Listen(0, 0, true)) return;

   448

	}

   449

   450

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   451

   452

	out_addr.sin_family = AF_INET;

   453

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   454

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   455

   456

	// packet only contains protocol version

   457

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   458

   459

	_udp_client_socket->SendPacket(&p, &out_addr);

   460

   461

	DEBUG(net, 2, "[udp] master server queried at %s:%d", inet_ntoa(out_addr.sin_addr), ntohs(out_addr.sin_port));

   462

}

   463

   464

// Find all servers

   465

void NetworkUDPSearchGame()

   466

{

   467

	// We are still searching..

   468

	if (_network_udp_broadcast > 0) return;

   469

   470

	// No UDP-socket yet..

   471

	if (!_udp_client_socket->IsConnected()) {

   472

		if (!_udp_client_socket->Listen(0, 0, true)) return;

   473

	}

   474

   475

	DEBUG(net, 0, "[udp] searching server");

   476

   477

	NetworkUDPBroadCast(_udp_client_socket);

   478

	_network_udp_broadcast = 300; // Stay searching for 300 ticks

   479

}

   480

   481

void NetworkUDPQueryServer(const char* host, unsigned short port, bool manually)

   482

{

   483

	struct sockaddr_in out_addr;

   484

	NetworkGameList *item;

   485

   486

	// No UDP-socket yet..

   487

	if (!_udp_client_socket->IsConnected()) {