1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../string.h"

     8

#include "network_data.h"

     9

#include "../date.h"

    10

#include "../map.h"

    11

#include "network_gamelist.h"

    12

#include "network_udp.h"

    13

#include "../variables.h"

    14

#include "../newgrf_config.h"

    15

    16

#include "core/udp.h"

    17

    18

/**

    19

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

    20

 *

    21

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

    22

 * communication before the game is being joined.

    23

 */

    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

#define DEF_UDP_RECEIVE_COMMAND(cls, type) void cls ##NetworkUDPSocketHandler::NetworkPacketReceive_ ## type ## _command(Packet *p, const struct sockaddr_in *client_addr)

    36

    37

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

    38

    39

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    40

protected:

    41

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    42

public:

    43

	virtual ~MasterNetworkUDPSocketHandler() {}

    44

};

    45

    46

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    47

{

    48

	_network_advertise_retries = 0;

    49

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

    50

    51

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

    52

	if (!_network_advertise) NetworkUDPRemoveAdvertise();

    53

}

    54

    55

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

    56

    57

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    58

protected:

    59

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    60

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    61

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    62

public:

    63

	virtual ~ServerNetworkUDPSocketHandler() {}

    64

};

    65

    66

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    67

{

    68

	Packet *packet;

    69

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

    70

	if (!_network_udp_server)

    71

		return;

    72

    73

	packet = NetworkSend_Init(PACKET_UDP_SERVER_RESPONSE);

    74

    75

	// Update some game_info

    76

	_network_game_info.game_date     = _date;

    77

	_network_game_info.map_width     = MapSizeX();

    78

	_network_game_info.map_height    = MapSizeY();

    79

	_network_game_info.map_set       = _opt.landscape;

    80

	_network_game_info.companies_on  = ActivePlayerCount();

    81

	_network_game_info.spectators_on = NetworkSpectatorCount();

    82

	_network_game_info.grfconfig     = _grfconfig;

    83

    84

	this->Send_NetworkGameInfo(packet, &_network_game_info);

    85

    86

	// Let the client know that we are here

    87

	this->SendPacket(packet, client_addr);

    88

    89

	free(packet);

    90

    91

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

    92

}

    93

    94

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

    95

{

    96

	NetworkTCPSocketHandler *cs;

    97

	NetworkClientInfo *ci;

    98

	Packet *packet;

    99

	Player *player;

   100

	byte current = 0;

   101

	int i;

   102

   103

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

   104

	if (!_network_udp_server) return;

   105

   106

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   107

   108

	/* Send the amount of active companies */

   109

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   110

	NetworkSend_uint8 (packet, ActivePlayerCount());

   111

   112

	/* Fetch the latest version of everything */

   113

	NetworkPopulateCompanyInfo();

   114

   115

	/* Go through all the players */

   116

	FOR_ALL_PLAYERS(player) {

   117

		/* Skip non-active players */

   118

		if (!player->is_active) continue;

   119

   120

		current++;

   121

   122

		/* Send the information */

   123

		NetworkSend_uint8(packet, current);

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

   132

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

   133

		if (_network_player_info[player->index].password[0] != '\0') {

   134

			NetworkSend_uint8(packet, 1);

   135

		} else {

   136

			NetworkSend_uint8(packet, 0);

   137

		}

   138

   139

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

   140

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

   141

   142

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

   143

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

   144

   145

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

   146

		FOR_ALL_CLIENTS(cs) {

   147

			ci = DEREF_CLIENT_INFO(cs);

   148

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

   149

				/* The uint8 == 1 indicates that a client is following */

   150

				NetworkSend_uint8(packet, 1);

   151

				NetworkSend_string(packet, ci->client_name);

   152

				NetworkSend_string(packet, ci->unique_id);

   153

				NetworkSend_uint32(packet, ci->join_date);

   154

			}

   155

		}

   156

		/* Also check for the server itself */

   157

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   158

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

   159

			/* The uint8 == 1 indicates that a client is following */

   160

			NetworkSend_uint8(packet, 1);

   161

			NetworkSend_string(packet, ci->client_name);

   162

			NetworkSend_string(packet, ci->unique_id);

   163

			NetworkSend_uint32(packet, ci->join_date);

   164

		}

   165

   166

		/* Indicates end of client list */

   167

		NetworkSend_uint8(packet, 0);

   168

	}

   169

   170

	/* And check if we have any spectators */

   171

	FOR_ALL_CLIENTS(cs) {

   172

		ci = DEREF_CLIENT_INFO(cs);

   173

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

   174

			/* The uint8 == 1 indicates that a client is following */

   175

			NetworkSend_uint8(packet, 1);

   176

			NetworkSend_string(packet, ci->client_name);

   177

			NetworkSend_string(packet, ci->unique_id);

   178

			NetworkSend_uint32(packet, ci->join_date);

   179

		}

   180

	}

   181

   182

	/* Also check for the server itself */

   183

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   184

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

   185

		/* The uint8 == 1 indicates that a client is following */

   186

		NetworkSend_uint8(packet, 1);

   187

		NetworkSend_string(packet, ci->client_name);

   188

		NetworkSend_string(packet, ci->unique_id);

   189

		NetworkSend_uint32(packet, ci->join_date);

   190

	}

   191

   192

	/* Indicates end of client list */

   193

	NetworkSend_uint8(packet, 0);

   194

   195

	this->SendPacket(packet, client_addr);

   196

	free(packet);

   197

}

   198

   199

/**

   200

 * A client has requested the names of some NewGRFs.

   201

 *

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

 * would be sent, the packet overflows.

   209

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

   210

 * send in the reply.

   211

 */

   212

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   213

{

   214

	uint8 num_grfs;

   215

	uint i;

   216

   217

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   218

	Packet *packet;

   219

	uint8 in_reply_count = 0;

   220

	uint packet_len = 0;

   221

   222

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

   223

   224

	num_grfs = NetworkRecv_uint8 (this, p);

   225

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   226

   227

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

   228

		GRFConfig c;

   229

		const GRFConfig *f;

   230

   231

		this->Recv_GRFIdentifier(p, &c);

   232

   233

		/* Find the matching GRF file */

   234

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

   235

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

   236

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

			break;

   244

		}

   245

		in_reply[in_reply_count] = f;

   246

		in_reply_count++;

   247

	}

   248

   249

	if (in_reply_count == 0) return;

   250

   251

	packet = NetworkSend_Init(PACKET_UDP_SERVER_NEWGRFS);

   252

	NetworkSend_uint8 (packet, in_reply_count);

   253

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

   254

		char name[NETWORK_GRF_NAME_LENGTH];

   255

   256

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

   257

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

   258

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

   259

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

   260

		NetworkSend_string(packet, name);

   261

	}

   262

   263

	this->SendPacket(packet, client_addr);

   264

	free(packet);

   265

}

   266

   267

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

   268

   269

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   270

protected:

   271

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   272

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   273

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   274

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   275

public:

   276

	virtual ~ClientNetworkUDPSocketHandler() {}

   277

};

   278

   279

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   280

{

   281

	extern const char _openttd_revision[];

   282

	NetworkGameList *item;

   283

   284

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

   285

	if (_network_udp_server) return;

   286

   287

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

   288

   289

	// Find next item

   290

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

   291

   292

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

   293

   294

	item->info.compatible = true;

   295

	{

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

		 * due to the string comparisons. */

   303

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   304

		const GRFConfig *c;

   305

		uint in_request_count = 0;

   306

		struct sockaddr_in out_addr;

   307

   308

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

   309

			if (HASBIT(c->flags, GCF_NOT_FOUND)) item->info.compatible = false;

   310

			if (!HASBIT(c->flags, GCF_NOT_FOUND) || strcmp(c->name, UNKNOWN_GRF_NAME_PLACEHOLDER) != 0) continue;

   311

			in_request[in_request_count] = c;

   312

			in_request_count++;

   313

		}

   314

   315

		if (in_request_count > 0) {

   316

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

   317

			uint i;

   318

			Packet *packet = NetworkSend_Init(PACKET_UDP_CLIENT_GET_NEWGRFS);

   319

   320

			NetworkSend_uint8 (packet, in_request_count);

   321

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

   322

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

   323

			}

   324

   325

			out_addr.sin_family      = AF_INET;

   326

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

   327

			out_addr.sin_addr.s_addr = item->ip;

   328

			this->SendPacket(packet, &out_addr);

   329

			free(packet);

   330

		}

   331

	}

   332

   333

	if (item->info.server_lang >= NETWORK_NUM_LANGUAGES) item->info.server_lang = 0;

   334

	if (item->info.map_set >= NUM_LANDSCAPE ) item->info.map_set = 0;

   335

   336

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

   337

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

   338

   339

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

   340

	item->info.version_compatible =

   341

		strcmp(item->info.server_revision, _openttd_revision) == 0 ||

   342

		strcmp(item->info.server_revision, NOREV_STRING) == 0;

   343

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

   344

   345

	item->online = true;

   346

   347

	UpdateNetworkGameWindow(false);

   348

}

   349

   350

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   351

{

   352

	int i;

   353

	struct in_addr ip;

   354

	uint16 port;

   355

	uint8 ver;

   356

   357

	/* packet begins with the protocol version (uint8)

   358

	 * then an uint16 which indicates how many

   359

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

   360

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

   361

	 */

   362

   363

	ver = NetworkRecv_uint8(this, p);

   364

   365

	if (ver == 1) {

   366

		for (i = NetworkRecv_uint16(this, p); i != 0 ; i--) {

   367

			ip.s_addr = TO_LE32(NetworkRecv_uint32(this, p));

   368

			port = NetworkRecv_uint16(this, p);

   369

   370

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

   371

			if (this->HasClientQuit()) return;

   372

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   373

		}

   374

	}

   375

}

   376

   377

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

   378

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   379

{

   380

	uint8 num_grfs;

   381

	uint i;

   382

   383

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

   384

   385

	num_grfs = NetworkRecv_uint8 (this, p);

   386

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   387

   388

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

   389

		char *unknown_name;

   390

		char name[NETWORK_GRF_NAME_LENGTH];

   391

		GRFConfig c;

   392

   393

		this->Recv_GRFIdentifier(p, &c);

   394

		NetworkRecv_string(this, p, name, sizeof(name));

   395

   396

		/* An empty name is not possible under normal circumstances

   397

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

   398

		if (StrEmpty(name)) continue;

   399

   400

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

   401

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

   402

		 * overwritten with the name from the reply. */

   403

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

   404

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

   405

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   406

		}

   407

	}

   408

}

   409

   410

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   411

{

   412

	/* Find the matching GRF file */

   413

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

   414

	if (f == NULL) {

   415

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

   416

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

   417

		 * name of the GRF already */

   418

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

   419

		SETBIT(config->flags, GCF_NOT_FOUND);

   420

	} else {

   421

		config->filename = f->filename;

   422

		config->name     = f->name;

   423

		config->info     = f->info;

   424

	}

   425

	SETBIT(config->flags, GCF_COPY);

   426

}

   427

   428

// Close UDP connection

   429

void NetworkUDPCloseAll(void)

   430

{

   431

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

   432

   433

	_udp_server_socket->Close();

   434

	_udp_master_socket->Close();

   435

	_udp_client_socket->Close();

   436

   437

	_network_udp_server = false;

   438

	_network_udp_broadcast = 0;

   439

}

   440

   441

// Broadcast to all ips

   442

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   443

{

   444

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   445

	uint i;

   446

   447

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

   448

		struct sockaddr_in out_addr;

   449

   450

		out_addr.sin_family = AF_INET;

   451

		out_addr.sin_port = htons(_network_server_port);

   452

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   453

   454

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

   455

   456

		socket->SendPacket(p, &out_addr);

   457

	}

   458

   459

	free(p);

   460

}

   461

   462

   463

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

   464

void NetworkUDPQueryMasterServer(void)

   465

{

   466

	struct sockaddr_in out_addr;

   467

	Packet *p;

   468

   469

	if (!_udp_client_socket->IsConnected()) {

   470

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

   471

	}

   472

   473

	p = NetworkSend_Init(PACKET_UDP_CLIENT_GET_LIST);

   474

   475

	out_addr.sin_family = AF_INET;

   476

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   477

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   478

   479

	// packet only contains protocol version

   480

	NetworkSend_uint8(p, NETWORK_MASTER_SERVER_VERSION);

   481

   482

	_udp_client_socket->SendPacket(p, &out_addr);

   483

   484

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

   485

   486

	free(p);

   487

}

   488

   489

// Find all servers

   490

void NetworkUDPSearchGame(void)