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"

    16

#include "../date.h"

    17

#include "../map.h"

    18

#include "network_gamelist.h"

    19

#include "network_udp.h"

    20

#include "../variables.h"

    21

#include "../newgrf_config.h"

    22

    23

#include "core/udp.h"

    24

    25

enum {

    26

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

    27

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

    28

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

    29

};

    30

    31

NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    32

NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    33

NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    34

    35

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

    36

    37

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    38

protected:

    39

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    40

public:

    41

	virtual ~MasterNetworkUDPSocketHandler() {}

    42

};

    43

    44

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    45

{

    46

	_network_advertise_retries = 0;

    47

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

    48

    49

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

    50

	if (!_network_advertise) NetworkUDPRemoveAdvertise();

    51

}

    52

    53

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

    54

    55

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    56

protected:

    57

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    58

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    59

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    60

public:

    61

	virtual ~ServerNetworkUDPSocketHandler() {}

    62

};

    63

    64

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    65

{

    66

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

    67

	if (!_network_udp_server)

    68

		return;

    69

    70

	Packet packet(PACKET_UDP_SERVER_RESPONSE);

    71

    72

	// Update some game_info

    73

	_network_game_info.game_date     = _date;

    74

	_network_game_info.map_width     = MapSizeX();

    75

	_network_game_info.map_height    = MapSizeY();

    76

	_network_game_info.map_set       = _opt.landscape;

    77

	_network_game_info.companies_on  = ActivePlayerCount();

    78

	_network_game_info.spectators_on = NetworkSpectatorCount();

    79

	_network_game_info.grfconfig     = _grfconfig;

    80

    81

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

    82

    83

	// Let the client know that we are here

    84

	this->SendPacket(&packet, client_addr);

    85

    86

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

    87

}

    88

    89

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

    90

{

    91

	NetworkTCPSocketHandler *cs;

    92

	NetworkClientInfo *ci;

    93

	Player *player;

    94

	byte current = 0;

    95

	int i;

    96

    97

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

    98

	if (!_network_udp_server) return;

    99

   100

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   101

   102

	/* Send the amount of active companies */

   103

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   104

	packet.Send_uint8 (ActivePlayerCount());

   105

   106

	/* Fetch the latest version of everything */

   107

	NetworkPopulateCompanyInfo();

   108

   109

	/* Go through all the players */

   110

	FOR_ALL_PLAYERS(player) {

   111

		/* Skip non-active players */

   112

		if (!player->is_active) continue;

   113

   114

		current++;

   115

   116

		/* Send the information */

   117

		packet.Send_uint8 (current);

   118

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

   126

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

   128

   129

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

   130

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

   131

   132

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

   133

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

   134

   135

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

   136

		FOR_ALL_CLIENTS(cs) {

   137

			ci = DEREF_CLIENT_INFO(cs);

   138

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

   139

				packet.Send_bool  (true);

   140

				packet.Send_string(ci->client_name);

   141

				packet.Send_string(ci->unique_id);

   142

				packet.Send_uint32(ci->join_date);

   143

			}

   144

		}

   145

		/* Also check for the server itself */

   146

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   147

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

   148

			packet.Send_bool  (true);

   149

			packet.Send_string(ci->client_name);

   150

			packet.Send_string(ci->unique_id);

   151

			packet.Send_uint32(ci->join_date);

   152

		}

   153

   154

		/* Indicates end of client list */

   155

		packet.Send_bool(false);

   156

	}

   157

   158

	/* And check if we have any spectators */

   159

	FOR_ALL_CLIENTS(cs) {

   160

		ci = DEREF_CLIENT_INFO(cs);

   161

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

   162

			packet.Send_bool  (true);

   163

			packet.Send_string(ci->client_name);

   164

			packet.Send_string(ci->unique_id);

   165

			packet.Send_uint32(ci->join_date);

   166

		}

   167

	}

   168

   169

	/* Also check for the server itself */

   170

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   171

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

   172

		packet.Send_bool  (true);

   173

		packet.Send_string(ci->client_name);

   174

		packet.Send_string(ci->unique_id);

   175

		packet.Send_uint32(ci->join_date);

   176

	}

   177

   178

	/* Indicates end of client list */

   179

	packet.Send_bool(false);

   180

   181

	this->SendPacket(&packet, client_addr);

   182

}

   183

   184

/**

   185

 * A client has requested the names of some NewGRFs.

   186

 *

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

 * would be sent, the packet overflows.

   194

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

   195

 * send in the reply.

   196

 */

   197

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   198

{

   199

	uint8 num_grfs;

   200

	uint i;

   201

   202

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   203

	uint8 in_reply_count = 0;

   204

	uint packet_len = 0;

   205

   206

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

   207

   208

	num_grfs = p->Recv_uint8 ();

   209

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   210

   211

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

   212

		GRFConfig c;

   213

		const GRFConfig *f;

   214

   215

		this->Recv_GRFIdentifier(p, &c);

   216

   217

		/* Find the matching GRF file */

   218

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

   219

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

   220

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

			break;

   228

		}

   229

		in_reply[in_reply_count] = f;

   230

		in_reply_count++;

   231

	}

   232

   233

	if (in_reply_count == 0) return;

   234

   235

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   236

	packet.Send_uint8(in_reply_count);

   237

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

   238

		char name[NETWORK_GRF_NAME_LENGTH];

   239

   240

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

   241

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

   242

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

   243

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

   244

		packet.Send_string(name);

   245

	}

   246

   247

	this->SendPacket(&packet, client_addr);

   248

}

   249

   250

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

   251

   252

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   253

protected:

   254

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   255

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   256

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   257

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   258

public:

   259

	virtual ~ClientNetworkUDPSocketHandler() {}

   260

};

   261

   262

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   263

{

   264

	NetworkGameList *item;

   265

   266

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

   267

	if (_network_udp_server) return;

   268

   269

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

   270

   271

	// Find next item

   272

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

   273

   274

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

   275

   276

	item->info.compatible = true;

   277

	{

   278

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

   279

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

   280

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

   281

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

   282

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

   283

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

   284

		 * due to the string comparisons. */

   285

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   286

		const GRFConfig *c;

   287

		uint in_request_count = 0;

   288

		struct sockaddr_in out_addr;

   289

   290

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

   291

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

   292

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

   293

			in_request[in_request_count] = c;

   294

			in_request_count++;

   295

		}

   296

   297

		if (in_request_count > 0) {

   298

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

   299

			uint i;

   300

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   301

   302

			packet.Send_uint8(in_request_count);

   303

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

   304

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

   305

			}

   306

   307

			out_addr.sin_family      = AF_INET;

   308

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

   309

			out_addr.sin_addr.s_addr = item->ip;

   310

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

   311

		}

   312

	}

   313

   314

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

   315

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

   316

   317

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

   318

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

   319

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

   320

   321

	item->online = true;

   322

   323

	UpdateNetworkGameWindow(false);

   324

}

   325

   326

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   327

{

   328

	int i;

   329

	struct in_addr ip;

   330

	uint16 port;

   331

	uint8 ver;

   332

   333

	/* packet begins with the protocol version (uint8)

   334

	 * then an uint16 which indicates how many

   335

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

   336

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

   337

	 */

   338

   339

	ver = p->Recv_uint8();

   340

   341

	if (ver == 1) {

   342

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

   343

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

   344

			port = p->Recv_uint16();

   345

   346

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

   347

			if (this->HasClientQuit()) return;

   348

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   349

		}

   350

	}

   351

}

   352

   353

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

   354

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   355

{

   356

	uint8 num_grfs;

   357

	uint i;

   358

   359

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

   360

   361

	num_grfs = p->Recv_uint8 ();

   362

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   363

   364

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

   365

		char *unknown_name;

   366

		char name[NETWORK_GRF_NAME_LENGTH];

   367

		GRFConfig c;

   368

   369

		this->Recv_GRFIdentifier(p, &c);

   370

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

   371

   372

		/* An empty name is not possible under normal circumstances

   373

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

   374

		if (StrEmpty(name)) continue;

   375

   376

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

   377

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

   378

		 * overwritten with the name from the reply. */

   379

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

   380

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

   381

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   382

		}

   383

	}

   384

}

   385

   386

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   387

{

   388

	/* Find the matching GRF file */

   389

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

   390

	if (f == NULL) {

   391

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

   392

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

   393

		 * name of the GRF already */

   394

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

   395

		config->status = GCS_NOT_FOUND;

   396

	} else {

   397

		config->filename  = f->filename;

   398

		config->name      = f->name;

   399

		config->info      = f->info;

   400

	}

   401

	SETBIT(config->flags, GCF_COPY);

   402

}

   403

   404

// Close UDP connection

   405

void NetworkUDPCloseAll()

   406

{

   407

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

   408

   409

	_udp_server_socket->Close();

   410

	_udp_master_socket->Close();

   411

	_udp_client_socket->Close();

   412

   413

	_network_udp_server = false;

   414

	_network_udp_broadcast = 0;

   415

}

   416

   417

// Broadcast to all ips

   418

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   419

{

   420

	uint i;

   421

   422

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

   423

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   424

		struct sockaddr_in out_addr;

   425

   426

		out_addr.sin_family = AF_INET;

   427

		out_addr.sin_port = htons(_network_server_port);

   428

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   429

   430

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

   431

   432

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

   433

	}

   434

}

   435

   436

   437

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

   438

void NetworkUDPQueryMasterServer()

   439

{

   440

	struct sockaddr_in out_addr;

   441

   442

	if (!_udp_client_socket->IsConnected()) {

   443

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

   444

	}

   445

   446

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   447

   448

	out_addr.sin_family = AF_INET;

   449

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   450

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   451

   452

	// packet only contains protocol version

   453

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   454

   455

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

   456

   457

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

   458

}

   459

   460

// Find all servers

   461

void NetworkUDPSearchGame()

   462

{

   463

	// We are still searching..

   464

	if (_network_udp_broadcast > 0) return;

   465

   466

	// No UDP-socket yet..

   467

	if (!_udp_client_socket->IsConnected()) {

   468

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

   469

	}

   470

   471

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

   472

   473

	NetworkUDPBroadCast(_udp_client_socket);

   474

	_network_udp_broadcast = 300; // Stay searching for 300 ticks

   475

}

   476

   477

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

   478

{

   479

	struct sockaddr_in out_addr;

   480

	NetworkGameList *item;

   481

   482

	// No UDP-socket yet..

   483

	if (!_udp_client_socket->IsConnected()) {

   484

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

   485

	}

   486

   487

	out_addr.sin_family = AF_INET;

   488

	out_addr.sin_port = htons(port);