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 "../string.h"

    15

#include "network_data.h"

    17

#include "../map_func.h"

    18

#include "network_gamelist.h"

    19

#include "network_udp.h"

    20

#include "../variables.h"

    21

#include "../newgrf_config.h"

    22

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

    23

    24

#include "core/udp.h"

    25

    26

enum {

    27

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

    28

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

    29

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

    30

};

    31

    32

NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    33

NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    34

NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    35

    36

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

    37

    38

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    39

protected:

    40

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    41

public:

    42

	virtual ~MasterNetworkUDPSocketHandler() {}

    43

};

    44

    45

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    46

{

    47

	_network_advertise_retries = 0;

    48

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

    49

    50

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

    51

	if (!_network_advertise) NetworkUDPRemoveAdvertise();

    52

}

    53

    54

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

    55

    56

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    57

protected:

    58

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    59

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    60

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    61

public:

    62

	virtual ~ServerNetworkUDPSocketHandler() {}

    63

};

    64

    65

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    66

{

    67

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

    68

	if (!_network_udp_server)

    69

		return;

    70

    71

	Packet packet(PACKET_UDP_SERVER_RESPONSE);

    72

    73

	// Update some game_info

    74

	_network_game_info.game_date     = _date;

    75

	_network_game_info.map_width     = MapSizeX();

    76

	_network_game_info.map_height    = MapSizeY();

    77

	_network_game_info.map_set       = _opt.landscape;

    78

	_network_game_info.companies_on  = ActivePlayerCount();

    79

	_network_game_info.spectators_on = NetworkSpectatorCount();

    80

	_network_game_info.grfconfig     = _grfconfig;

    81

    82

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

    83

    84

	// Let the client know that we are here

    85

	this->SendPacket(&packet, client_addr);

    86

    87

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

    88

}

    89

    90

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

    91

{

    92

	NetworkTCPSocketHandler *cs;

    93

	NetworkClientInfo *ci;

    94

	Player *player;

    95

	byte current = 0;

    96

	int i;

    97

    98

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

    99

	if (!_network_udp_server) return;

   100

   101

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   102

   103

	/* Send the amount of active companies */

   104

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   105

	packet.Send_uint8 (ActivePlayerCount());

   106

   107

	/* Fetch the latest version of everything */

   108

	NetworkPopulateCompanyInfo();

   109

   110

	/* Go through all the players */

   111

	FOR_ALL_PLAYERS(player) {

   112

		/* Skip non-active players */

   113

		if (!player->is_active) continue;

   114

   115

		current++;

   116

   117

		/* Send the information */

   118

		packet.Send_uint8 (current);

   119

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

   127

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

   128

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

   129

   130

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

   131

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

   132

   133

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

   134

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

   135

   136

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

   137

		FOR_ALL_CLIENTS(cs) {

   138

			ci = DEREF_CLIENT_INFO(cs);

   139

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

   140

				packet.Send_bool  (true);

   141

				packet.Send_string(ci->client_name);

   142

				packet.Send_string(ci->unique_id);

   143

				packet.Send_uint32(ci->join_date);

   144

			}

   145

		}

   146

		/* Also check for the server itself */

   147

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   148

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

   149

			packet.Send_bool  (true);

   150

			packet.Send_string(ci->client_name);

   151

			packet.Send_string(ci->unique_id);

   152

			packet.Send_uint32(ci->join_date);

   153

		}

   154

   155

		/* Indicates end of client list */

   156

		packet.Send_bool(false);

   157

	}

   158

   159

	/* And check if we have any spectators */

   160

	FOR_ALL_CLIENTS(cs) {

   161

		ci = DEREF_CLIENT_INFO(cs);

   162

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

   163

			packet.Send_bool  (true);

   164

			packet.Send_string(ci->client_name);

   165

			packet.Send_string(ci->unique_id);

   166

			packet.Send_uint32(ci->join_date);

   167

		}

   168

	}

   169

   170

	/* Also check for the server itself */

   171

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   172

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

   173

		packet.Send_bool  (true);

   174

		packet.Send_string(ci->client_name);

   175

		packet.Send_string(ci->unique_id);

   176

		packet.Send_uint32(ci->join_date);

   177

	}

   178

   179

	/* Indicates end of client list */

   180

	packet.Send_bool(false);

   181

   182

	this->SendPacket(&packet, client_addr);

   183

}

   184

   185

/**

   186

 * A client has requested the names of some NewGRFs.

   187

 *

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

 * would be sent, the packet overflows.

   195

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

   196

 * send in the reply.

   197

 */

   198

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   199

{

   200

	uint8 num_grfs;

   201

	uint i;

   202

   203

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   204

	uint8 in_reply_count = 0;

   205

	uint packet_len = 0;

   206

   207

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

   208

   209

	num_grfs = p->Recv_uint8 ();

   210

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   211

   212

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

   213

		GRFConfig c;

   214

		const GRFConfig *f;

   215

   216

		this->Recv_GRFIdentifier(p, &c);

   217

   218

		/* Find the matching GRF file */

   219

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

   220

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

   221

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

			break;

   229

		}

   230

		in_reply[in_reply_count] = f;

   231

		in_reply_count++;

   232

	}

   233

   234

	if (in_reply_count == 0) return;

   235

   236

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   237

	packet.Send_uint8(in_reply_count);

   238

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

   239

		char name[NETWORK_GRF_NAME_LENGTH];

   240

   241

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

   242

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

   243

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

   244

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

   245

		packet.Send_string(name);

   246

	}

   247

   248

	this->SendPacket(&packet, client_addr);

   249

}

   250

   251

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

   252

   253

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   254

protected:

   255

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   256

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   257

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   258

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   259

public:

   260

	virtual ~ClientNetworkUDPSocketHandler() {}

   261

};

   262

   263

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   264

{

   265

	NetworkGameList *item;

   266

   267

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

   268

	if (_network_udp_server) return;

   269

   270

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

   271

   272

	// Find next item

   273

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

   274

   275

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

   276

   277

	item->info.compatible = true;

   278

	{

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

		 * due to the string comparisons. */

   286

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   287

		const GRFConfig *c;

   288

		uint in_request_count = 0;

   289

		struct sockaddr_in out_addr;

   290

   291

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

   292

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

   293

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

   294

			in_request[in_request_count] = c;

   295

			in_request_count++;

   296

		}

   297

   298

		if (in_request_count > 0) {

   299

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

   300

			uint i;

   301

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   302

   303

			packet.Send_uint8(in_request_count);

   304

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

   305

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

   306

			}

   307

   308

			out_addr.sin_family      = AF_INET;

   309

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

   310

			out_addr.sin_addr.s_addr = item->ip;

   311

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

   312

		}

   313

	}

   314

   315

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

   316

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

   317

   318

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

   319

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

   320

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

   321

   322

	item->online = true;

   323

   324

	UpdateNetworkGameWindow(false);

   325

}

   326

   327

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   328

{

   329

	int i;

   330

	struct in_addr ip;

   331

	uint16 port;

   332

	uint8 ver;

   333

   334

	/* packet begins with the protocol version (uint8)

   335

	 * then an uint16 which indicates how many

   336

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

   337

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

   338

	 */

   339

   340

	ver = p->Recv_uint8();

   341

   342

	if (ver == 1) {

   343

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

   344

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

   345

			port = p->Recv_uint16();

   346

   347

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

   348

			if (this->HasClientQuit()) return;

   349

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   350

		}

   351

	}

   352

}

   353

   354

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

   355

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   356

{

   357

	uint8 num_grfs;

   358

	uint i;

   359

   360

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

   361

   362

	num_grfs = p->Recv_uint8 ();

   363

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   364

   365

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

   366

		char *unknown_name;

   367

		char name[NETWORK_GRF_NAME_LENGTH];

   368

		GRFConfig c;

   369

   370

		this->Recv_GRFIdentifier(p, &c);

   371

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

   372

   373

		/* An empty name is not possible under normal circumstances

   374

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

   375

		if (StrEmpty(name)) continue;

   376

   377

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

   378

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

   379

		 * overwritten with the name from the reply. */

   380

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

   381

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

   382

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   383

		}

   384

	}

   385

}

   386

   387

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   388

{

   389

	/* Find the matching GRF file */

   390

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

   391

	if (f == NULL) {

   392

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

   393

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

   394

		 * name of the GRF already */

   395

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

   396

		config->status = GCS_NOT_FOUND;

   397

	} else {

   398

		config->filename  = f->filename;

   399

		config->name      = f->name;

   400

		config->info      = f->info;

   401

	}

   402

	SetBit(config->flags, GCF_COPY);

   403

}

   404

   405

// Close UDP connection

   406

void NetworkUDPCloseAll()

   407

{

   408

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

   409

   410

	_udp_server_socket->Close();

   411

	_udp_master_socket->Close();

   412

	_udp_client_socket->Close();

   413

   414

	_network_udp_server = false;

   415

	_network_udp_broadcast = 0;

   416

}

   417

   418

// Broadcast to all ips

   419

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   420

{

   421

	uint i;

   422

   423

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

   424

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   425

		struct sockaddr_in out_addr;

   426

   427

		out_addr.sin_family = AF_INET;

   428

		out_addr.sin_port = htons(_network_server_port);

   429

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   430

   431

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

   432

   433

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

   434

	}

   435

}

   436

   437

   438

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

   439

void NetworkUDPQueryMasterServer()

   440

{

   441

	struct sockaddr_in out_addr;

   442

   443

	if (!_udp_client_socket->IsConnected()) {

   444

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

   445

	}

   446

   447

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   448

   449

	out_addr.sin_family = AF_INET;

   450

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   451

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   452

   453

	// packet only contains protocol version

   454

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   455

   456

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

   457

   458

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

   459

}

   460

   461

// Find all servers

   462

void NetworkUDPSearchGame()

   463

{

   464

	// We are still searching..

   465

	if (_network_udp_broadcast > 0) return;

   466

   467

	// No UDP-socket yet..

   468

	if (!_udp_client_socket->IsConnected()) {

   469

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

   470

	}

   471

   472

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

   473

   474

	NetworkUDPBroadCast(_udp_client_socket);

   475

	_network_udp_broadcast = 300; // Stay searching for 300 ticks

   476

}

   477

   478

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

   479

{

   480

	struct sockaddr_in out_addr;

   481

	NetworkGameList *item;

   482

   483

	// No UDP-socket yet..

   484

	if (!_udp_client_socket->IsConnected()) {

   485

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

   486

	}

   487