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

    15

#include "../map_func.h"

    16

#include "network_gamelist.h"

    17

#include "network_udp.h"

    18

#include "network_internal.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

#include "../rev.h"

    27

    28

#include "core/udp.h"

    29

    30

enum {

    31

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

    32

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

    33

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

    34

};

    35

    36

NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    37

NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    38

NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    39

    40

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

    41

    42

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    43

protected:

    44

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    45

public:

    46

	virtual ~MasterNetworkUDPSocketHandler() {}

    47

};

    48

    49

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    50

{

    51

	_network_advertise_retries = 0;

    52

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

    53

    54

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

    56

}

    57

    58

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

    59

    60

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    61

protected:

    62

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    63

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    64

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    65

public:

    66

	virtual ~ServerNetworkUDPSocketHandler() {}

    67

};

    68

    69

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    70

{

    71

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

    72

	if (!_network_udp_server) {

    73

		return;

    74

	}

    75

    76

	NetworkGameInfo ngi;

    77

    78

	/* Update some game_info */

    79

	ngi.clients_on     = _network_game_info.clients_on;

    80

	ngi.start_date     = _network_game_info.start_date;

    81

    82

	ngi.server_lang    = _settings_client.network.server_lang;

    83

	ngi.use_password   = !StrEmpty(_settings_client.network.server_password);

    84

	ngi.clients_max    = _settings_client.network.max_clients;

    85

	ngi.companies_on   = ActivePlayerCount();

    86

	ngi.companies_max  = _settings_client.network.max_companies;

    87

	ngi.spectators_on  = NetworkSpectatorCount();

    88

	ngi.spectators_max = _settings_client.network.max_spectators;

    89

	ngi.game_date      = _date;

    90

	ngi.map_width      = MapSizeX();

    91

	ngi.map_height     = MapSizeY();

    92

	ngi.map_set        = _settings_game.game_creation.landscape;

    93

	ngi.dedicated      = _network_dedicated;

    94

	ngi.grfconfig      = _grfconfig;

    95

    96

	ttd_strlcpy(ngi.map_name, _network_game_info.map_name, lengthof(ngi.map_name));

    97

	ttd_strlcpy(ngi.server_name, _settings_client.network.server_name, lengthof(ngi.server_name));

    98

	ttd_strlcpy(ngi.server_revision, _openttd_revision, lengthof(ngi.server_revision));

    99

   100

	Packet packet(PACKET_UDP_SERVER_RESPONSE);

   101

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

   102

   103

	// Let the client know that we are here

   104

	this->SendPacket(&packet, client_addr);

   105

   106

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

   107

}

   108

   109

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

   110

{

   111

	NetworkTCPSocketHandler *cs;

   112

	NetworkClientInfo *ci;

   113

	Player *player;

   114

	byte current = 0;

   115

	int i;

   116

   117

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

   118

	if (!_network_udp_server) return;

   119

   120

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   121

   122

	/* Send the amount of active companies */

   123

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   124

	packet.Send_uint8 (ActivePlayerCount());

   125

   126

	/* Fetch the latest version of everything */

   127

	NetworkPopulateCompanyInfo();

   128

   129

	/* Go through all the players */

   130

	FOR_ALL_PLAYERS(player) {

   131

		/* Skip non-active players */

   132

		if (!player->is_active) continue;

   133

   134

		current++;

   135

   136

		/* Send the information */

   137

		packet.Send_uint8 (current);

   138

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

   146

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

   147

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

   148

   149

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

   150

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

   151

   152

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

   153

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

   154

   155

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

   156

		FOR_ALL_CLIENTS(cs) {

   157

			ci = DEREF_CLIENT_INFO(cs);

   158

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

   159

				packet.Send_bool  (true);

   160

				packet.Send_string(ci->client_name);

   161

				packet.Send_string(ci->unique_id);

   162

				packet.Send_uint32(ci->join_date);

   163

			}

   164

		}

   165

		/* Also check for the server itself */

   166

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   167

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

   168

			packet.Send_bool  (true);

   169

			packet.Send_string(ci->client_name);

   170

			packet.Send_string(ci->unique_id);

   171

			packet.Send_uint32(ci->join_date);

   172

		}

   173

   174

		/* Indicates end of client list */

   175

		packet.Send_bool(false);

   176

	}

   177

   178

	/* And check if we have any spectators */

   179

	FOR_ALL_CLIENTS(cs) {

   180

		ci = DEREF_CLIENT_INFO(cs);

   181

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

   182

			packet.Send_bool  (true);

   183

			packet.Send_string(ci->client_name);

   184

			packet.Send_string(ci->unique_id);

   185

			packet.Send_uint32(ci->join_date);

   186

		}

   187

	}

   188

   189

	/* Also check for the server itself */

   190

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   191

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

   192

		packet.Send_bool  (true);

   193

		packet.Send_string(ci->client_name);

   194

		packet.Send_string(ci->unique_id);

   195

		packet.Send_uint32(ci->join_date);

   196

	}

   197

   198

	/* Indicates end of client list */

   199

	packet.Send_bool(false);

   200

   201

	this->SendPacket(&packet, client_addr);

   202

}

   203

   204

/**

   205

 * A client has requested the names of some NewGRFs.

   206

 *

   207

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

   208

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

   209

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

   210

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

   211

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

   212

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

   213

 * would be sent, the packet overflows.

   214

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

   215

 * send in the reply.

   216

 */

   217

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   218

{

   219

	uint8 num_grfs;

   220

	uint i;

   221

   222

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   223

	uint8 in_reply_count = 0;

   224

	size_t packet_len = 0;

   225

   226

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

   227

   228

	num_grfs = p->Recv_uint8 ();

   229

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   230

   231

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

   232

		GRFConfig c;

   233

		const GRFConfig *f;

   234

   235

		this->Recv_GRFIdentifier(p, &c);

   236

   237

		/* Find the matching GRF file */

   238

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

   239

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

   240

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

			break;

   248

		}

   249

		in_reply[in_reply_count] = f;

   250

		in_reply_count++;

   251

	}

   252

   253

	if (in_reply_count == 0) return;

   254

   255

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   256

	packet.Send_uint8(in_reply_count);

   257

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

   258

		char name[NETWORK_GRF_NAME_LENGTH];

   259

   260

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

   261

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

   262

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

   263

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

   264

		packet.Send_string(name);

   265

	}

   266

   267

	this->SendPacket(&packet, client_addr);

   268

}

   269

   270

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

   271

   272

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   273

protected:

   274

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   275

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   276

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   277

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   278

public:

   279

	virtual ~ClientNetworkUDPSocketHandler() {}

   280

};

   281

   282

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   283

{

   284

	NetworkGameList *item;

   285

   286

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

   287

	if (_network_udp_server) return;

   288

   289

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

   290

   291

	// Find next item

   292

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

   293

   294

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

   295

   296

	item->info.compatible = true;

   297

	{

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

		 * due to the string comparisons. */

   305

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   306

		const GRFConfig *c;

   307

		uint in_request_count = 0;

   308

		struct sockaddr_in out_addr;

   309

   310

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

   311

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

   312

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

   313

			in_request[in_request_count] = c;

   314

			in_request_count++;

   315

		}

   316

   317

		if (in_request_count > 0) {

   318

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

   319

			uint i;

   320

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   321

   322

			packet.Send_uint8(in_request_count);

   323

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

   324

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

   325

			}

   326

   327

			out_addr.sin_family      = AF_INET;

   328

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

   329

			out_addr.sin_addr.s_addr = item->ip;

   330

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

   331

		}

   332

	}

   333

   334

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

   335

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

   336

   337

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

   338

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

   339

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

   340

   341

	item->online = true;

   342

   343

	UpdateNetworkGameWindow(false);

   344

}

   345

   346

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   347

{

   348

	int i;

   349

	struct in_addr ip;

   350

	uint16 port;

   351

	uint8 ver;

   352

   353

	/* packet begins with the protocol version (uint8)

   354

	 * then an uint16 which indicates how many

   355

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

   356

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

   357

	 */

   358

   359

	ver = p->Recv_uint8();

   360

   361

	if (ver == 1) {

   362

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

   363

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

   364

			port = p->Recv_uint16();

   365

   366

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

   367

			if (this->HasClientQuit()) return;

   368

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   369

		}

   370

	}

   371

}

   372

   373

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

   374

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   375

{

   376

	uint8 num_grfs;

   377

	uint i;

   378

   379

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

   380

   381

	num_grfs = p->Recv_uint8 ();

   382

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   383

   384

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

   385

		char *unknown_name;

   386

		char name[NETWORK_GRF_NAME_LENGTH];

   387

		GRFConfig c;

   388

   389

		this->Recv_GRFIdentifier(p, &c);

   390

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

   391

   392

		/* An empty name is not possible under normal circumstances

   393

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

   394

		if (StrEmpty(name)) continue;

   395

   396

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

   397

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

   398

		 * overwritten with the name from the reply. */

   399

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

   400

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

   401

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   402

		}

   403

	}

   404

}

   405

   406

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   407

{

   408

	/* Find the matching GRF file */

   409

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

   410

	if (f == NULL) {

   411

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

   412

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

   413

		 * name of the GRF already */

   414

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

   415

		config->status = GCS_NOT_FOUND;

   416

	} else {

   417

		config->filename  = f->filename;

   418

		config->name      = f->name;

   419

		config->info      = f->info;

   420

	}

   421

	SetBit(config->flags, GCF_COPY);

   422

}

   423

   424

// Close UDP connection

   425

void NetworkUDPCloseAll()

   426

{

   427

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

   428

   429

	_udp_server_socket->Close();

   430

	_udp_master_socket->Close();

   431

	_udp_client_socket->Close();

   432

   433

	_network_udp_server = false;

   434

	_network_udp_broadcast = 0;

   435

}

   436

   437

// Broadcast to all ips

   438

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   439

{

   440

	uint i;

   441

   442

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

   443

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   444

		struct sockaddr_in out_addr;

   445

   446

		out_addr.sin_family = AF_INET;

   447

		out_addr.sin_port = htons(_settings_client.network.server_port);

   448

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   449

   450

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

   451

   452

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

   453

	}

   454

}

   455

   456

   457

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

   458

void NetworkUDPQueryMasterServer()

   459

{

   460

	struct sockaddr_in out_addr;

   461

   462

	if (!_udp_client_socket->IsConnected()) {

   463

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

   464

	}

   465

   466

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   467

   468

	out_addr.sin_family = AF_INET;

   469

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   470

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   471

   472

	// packet only contains protocol version

   473

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   474

   475

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

   476

   477

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

   478

}

   479

   480

// Find all servers

   481

void NetworkUDPSearchGame()

   482

{

   483

	// We are still searching..

   484

	if (_network_udp_broadcast > 0) return;

   485

   486

	// No UDP-socket yet..

   487

	if (!_udp_client_socket->IsConnected()) {