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! */

    55

	if (!_settings_client.network.server_advertise) NetworkUDPRemoveAdvertise();

    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

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

   112

	if (!_network_udp_server) return;

   113

   114

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   115

   116

	/* Send the amount of active companies */

   117

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   118

	packet.Send_uint8 (ActivePlayerCount());

   119

   120

	/* Fetch the latest version of everything */

   121

	NetworkPopulateCompanyInfo();

   122

   123

	Player *player;

   124

	byte current = 0;

   125

	/* Go through all the players */

   126

	FOR_ALL_PLAYERS(player) {

   127

		current++;

   128

   129

		/* Send the information */

   130

		packet.Send_uint8 (current);

   131

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

   139

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

   140

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

   141

   142

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

   143

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

   144

		}

   145

   146

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

   147

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

   148

		}

   149

	}

   150

   151

	this->SendPacket(&packet, client_addr);

   152

}

   153

   154

/**

   155

 * A client has requested the names of some NewGRFs.

   156

 *

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

 * would be sent, the packet overflows.

   164

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

   165

 * send in the reply.

   166

 */

   167

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   168

{

   169

	uint8 num_grfs;

   170

	uint i;

   171

   172

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   173

	uint8 in_reply_count = 0;

   174

	size_t packet_len = 0;

   175

   176

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

   177

   178

	num_grfs = p->Recv_uint8 ();

   179

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   180

   181

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

   182

		GRFConfig c;

   183

		const GRFConfig *f;

   184

   185

		this->Recv_GRFIdentifier(p, &c);

   186

   187

		/* Find the matching GRF file */

   188

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

   189

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

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

			break;

   198

		}

   199

		in_reply[in_reply_count] = f;

   200

		in_reply_count++;

   201

	}

   202

   203

	if (in_reply_count == 0) return;

   204

   205

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   206

	packet.Send_uint8(in_reply_count);

   207

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

   208

		char name[NETWORK_GRF_NAME_LENGTH];

   209

   210

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

   211

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

   212

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

   213

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

   214

		packet.Send_string(name);

   215

	}

   216

   217

	this->SendPacket(&packet, client_addr);

   218

}

   219

   220

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

   221

   222

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   223

protected:

   224

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   225

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   226

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   227

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   228

public:

   229

	virtual ~ClientNetworkUDPSocketHandler() {}

   230

};

   231

   232

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   233

{

   234

	NetworkGameList *item;

   235

   236

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

   237

	if (_network_udp_server) return;

   238

   239

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

   240

   241

	// Find next item

   242

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

   243

   244

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

   245

   246

	item->info.compatible = true;

   247

	{

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

		 * due to the string comparisons. */

   255

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   256

		const GRFConfig *c;

   257

		uint in_request_count = 0;

   258

		struct sockaddr_in out_addr;

   259

   260

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

   261

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

   262

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

   263

			in_request[in_request_count] = c;

   264

			in_request_count++;

   265

		}

   266

   267

		if (in_request_count > 0) {

   268

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

   269

			uint i;

   270

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   271

   272

			packet.Send_uint8(in_request_count);

   273

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

   274

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

   275

			}

   276

   277

			out_addr.sin_family      = AF_INET;

   278

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

   279

			out_addr.sin_addr.s_addr = item->ip;

   280

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

   281

		}

   282

	}

   283

   284

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

   285

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

   286

   287

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

   288

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

   289

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

   290

   291

	item->online = true;

   292

   293

	UpdateNetworkGameWindow(false);

   294

}

   295

   296

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   297

{

   298

	int i;

   299

	struct in_addr ip;

   300

	uint16 port;

   301

	uint8 ver;

   302

   303

	/* packet begins with the protocol version (uint8)

   304

	 * then an uint16 which indicates how many

   305

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

   306

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

   307

	 */

   308

   309

	ver = p->Recv_uint8();

   310

   311

	if (ver == 1) {

   312

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

   313

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

   314

			port = p->Recv_uint16();

   315

   316

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

   317

			if (this->HasClientQuit()) return;

   318

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   319

		}

   320

	}

   321

}

   322

   323

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

   324

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   325

{

   326

	uint8 num_grfs;

   327

	uint i;

   328

   329

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

   330

   331

	num_grfs = p->Recv_uint8 ();

   332

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   333

   334

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

   335

		char *unknown_name;

   336

		char name[NETWORK_GRF_NAME_LENGTH];

   337

		GRFConfig c;

   338

   339

		this->Recv_GRFIdentifier(p, &c);

   340

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

   341

   342

		/* An empty name is not possible under normal circumstances

   343

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

   344

		if (StrEmpty(name)) continue;

   345

   346

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

   347

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

   348

		 * overwritten with the name from the reply. */

   349

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

   350

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

   351

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   352

		}

   353

	}

   354

}

   355

   356

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   357

{

   358

	/* Find the matching GRF file */

   359

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

   360

	if (f == NULL) {

   361

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

   362

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

   363

		 * name of the GRF already */

   364

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

   365

		config->status = GCS_NOT_FOUND;

   366

	} else {

   367

		config->filename  = f->filename;

   368

		config->name      = f->name;

   369

		config->info      = f->info;

   370

	}

   371

	SetBit(config->flags, GCF_COPY);

   372

}

   373

   374

// Close UDP connection

   375

void NetworkUDPCloseAll()

   376

{

   377

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

   378

   379

	_udp_server_socket->Close();

   380

	_udp_master_socket->Close();

   381

	_udp_client_socket->Close();

   382

   383

	_network_udp_server = false;

   384

	_network_udp_broadcast = 0;

   385

}

   386

   387

// Broadcast to all ips

   388

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   389

{

   390

	uint i;

   391

   392

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

   393

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   394

		struct sockaddr_in out_addr;

   395

   396

		out_addr.sin_family = AF_INET;

   397

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

   398

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   399

   400

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

   401

   402

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

   403

	}

   404

}

   405

   406

   407

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

   408

void NetworkUDPQueryMasterServer()

   409

{

   410

	struct sockaddr_in out_addr;

   411

   412

	if (!_udp_client_socket->IsConnected()) {

   413

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

   414

	}

   415

   416

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   417

   418

	out_addr.sin_family = AF_INET;

   419

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   420

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   421

   422

	// packet only contains protocol version

   423

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   424

   425

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

   426

   427

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

   428

}

   429

   430

// Find all servers

   431

void NetworkUDPSearchGame()

   432

{

   433

	// We are still searching..

   434

	if (_network_udp_broadcast > 0) return;

   435

   436

	// No UDP-socket yet..

   437

	if (!_udp_client_socket->IsConnected()) {

   438

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

   439

	}

   440

   441

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

   442

   443

	NetworkUDPBroadCast(_udp_client_socket);

   444

	_network_udp_broadcast = 300; // Stay searching for 300 ticks

   445

}

   446

   447

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

   448

{

   449

	struct sockaddr_in out_addr;

   450

	NetworkGameList *item;

   451

   452

	// No UDP-socket yet..

   453

	if (!_udp_client_socket->IsConnected()) {

   454

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

   455

	}

   456

   457

	out_addr.sin_family = AF_INET;

   458

	out_addr.sin_port = htons(port);

   459

	out_addr.sin_addr.s_addr = NetworkResolveHost(host);

   460

   461

	// Clear item in gamelist

   462

	item = NetworkGameListAddItem(inet_addr(inet_ntoa(out_addr.sin_addr)), ntohs(out_addr.sin_port));

   463

	if (item == NULL) return;

   464

   465

	if (StrEmpty(item->info.server_name)) {

   466

		memset(&item->info, 0, sizeof(item->info));

   467

		ttd_strlcpy(item->info.server_name, host, lengthof(item->info.server_name));

   468

		ttd_strlcpy(item->info.hostname, host, lengthof(item->info.hostname));

   469

		item->online = false;

   470

	}

   471

	item->manually = manually;

   472

   473

	// Init the packet

   474

	Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   475

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

   476

   477

	UpdateNetworkGameWindow(false);

   478

}

   479

   480

/* Remove our advertise from the master-server */

   481

void NetworkUDPRemoveAdvertise()

   482

{

   483

	struct sockaddr_in out_addr;

   484

   485

	/* Check if we are advertising */

   486

	if (!_networking || !_network_server || !_network_udp_server) return;

   487

   488

	/* check for socket */