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

//

    17

// This file handles all the LAN-stuff

    18

// Stuff like:

    19

//   - UDP search over the network

    20

//

    21

    22

typedef enum {

    23

	PACKET_UDP_CLIENT_FIND_SERVER,

    24

	PACKET_UDP_SERVER_RESPONSE,

    25

	PACKET_UDP_CLIENT_DETAIL_INFO,

    26

	PACKET_UDP_SERVER_DETAIL_INFO,   // Is not used in OpenTTD itself, only for external querying

    27

	PACKET_UDP_SERVER_REGISTER,      // Packet to register itself to the master server

    28

	PACKET_UDP_MASTER_ACK_REGISTER,  // Packet indicating registration has succedeed

    29

	PACKET_UDP_CLIENT_GET_LIST,      // Request for serverlist from master server

    30

	PACKET_UDP_MASTER_RESPONSE_LIST, // Response from master server with server ip's + port's

    31

	PACKET_UDP_SERVER_UNREGISTER,    // Request to be removed from the server-list

    32

	PACKET_UDP_CLIENT_GET_NEWGRFS,   // Requests the name for a list of GRFs (GRF_ID and MD5)

    33

	PACKET_UDP_SERVER_NEWGRFS,       // Sends the list of NewGRF's requested.

    34

	PACKET_UDP_END

    35

} PacketUDPType;

    36

    37

enum {

    38

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

    39

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

    40

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

    41

};

    42

    43

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

    44

static void NetworkSendUDP_Packet(SOCKET udp, Packet* p, struct sockaddr_in* recv);

    45

    46

static NetworkClientState _udp_cs;

    47

    48

/**

    49

 * Serializes the GRFIdentifier (GRF ID and MD5 checksum) to the packet

    50

 * @param p the packet to write the data to

    51

 * @param c the configuration to write the GRF ID and MD5 checksum from

    52

 */

    53

static void NetworkSend_GRFIdentifier(Packet *p, const GRFConfig *c)

    54

{

    55

	uint j;

    56

	NetworkSend_uint32(p, c->grfid);

    57

	for (j = 0; j < sizeof(c->md5sum); j++) {

    58

		NetworkSend_uint8 (p, c->md5sum[j]);

    59

	}

    60

}

    61

    62

/**

    63

 * Deserializes the GRFIdentifier (GRF ID and MD5 checksum) from the packet

    64

 * @param p the packet to read the data from

    65

 * @param c the configuration to write the GRF ID and MD5 checksum to

    66

 */

    67

static void NetworkRecv_GRFIdentifier(Packet *p, GRFConfig *c)

    68

{

    69

	uint j;

    70

	c->grfid = NetworkRecv_uint32(&_udp_cs, p);

    71

	for (j = 0; j < sizeof(c->md5sum); j++) {

    72

		c->md5sum[j] = NetworkRecv_uint8(&_udp_cs, p);

    73

	}

    74

}

    75

    76

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER)

    77

{

    78

	Packet *packet;

    79

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

    80

	if (!_network_udp_server)

    81

		return;

    82

    83

	packet = NetworkSend_Init(PACKET_UDP_SERVER_RESPONSE);

    84

    85

	// Update some game_info

    86

	_network_game_info.game_date = _date;

    87

	_network_game_info.map_width = MapSizeX();

    88

	_network_game_info.map_height = MapSizeY();

    89

	_network_game_info.map_set = _opt.landscape;

    90

    91

	NetworkSend_uint8 (packet, NETWORK_GAME_INFO_VERSION);

    92

    93

	/* NETWORK_GAME_INFO_VERSION = 4 */

    94

	{

    95

		/* Only send the GRF Identification (GRF_ID and MD5 checksum) of

    96

		 * the GRFs that are needed, i.e. the ones that the server has

    97

		 * selected in the NewGRF GUI and not the ones that are used due

    98

		 * to the fact that they are in [newgrf-static] in openttd.cfg */

    99

		const GRFConfig *c;

   100

		uint i = 0;

   101

   102

		/* Count number of GRFs to send information about */

   103

		for (c = _grfconfig; c != NULL; c = c->next) {

   104

			if (!HASBIT(c->flags, GCF_STATIC)) i++;

   105

		}

   106

		NetworkSend_uint8 (packet, i); // Send number of GRFs

   107

   108

		/* Send actual GRF Identifications */

   109

		for (c = _grfconfig; c != NULL; c = c->next) {

   110

			if (!HASBIT(c->flags, GCF_STATIC)) NetworkSend_GRFIdentifier(packet, c);

   111

		}

   112

	}

   113

   114

	/* NETWORK_GAME_INFO_VERSION = 3 */

   115

	NetworkSend_uint32(packet, _network_game_info.game_date);

   116

	NetworkSend_uint32(packet, _network_game_info.start_date);

   117

   118

	/* NETWORK_GAME_INFO_VERSION = 2 */

   119

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

   120

	NetworkSend_uint8 (packet, ActivePlayerCount());

   121

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

   122

   123

	/* NETWORK_GAME_INFO_VERSION = 1 */

   124

	NetworkSend_string(packet, _network_game_info.server_name);

   125

	NetworkSend_string(packet, _network_game_info.server_revision);

   126

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

   127

	NetworkSend_uint8 (packet, _network_game_info.use_password);

   128

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

   129

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

   130

	NetworkSend_uint8 (packet, NetworkSpectatorCount());

   131

	NetworkSend_string(packet, _network_game_info.map_name);

   132

	NetworkSend_uint16(packet, _network_game_info.map_width);

   133

	NetworkSend_uint16(packet, _network_game_info.map_height);

   134

	NetworkSend_uint8 (packet, _network_game_info.map_set);

   135

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

   136

   137

	// Let the client know that we are here

   138

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   139

   140

	free(packet);

   141

   142

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

   143

}

   144

   145

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

   146

{

   147

	extern const char _openttd_revision[];

   148

	NetworkGameList *item;

   149

	byte game_info_version;

   150

   151

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

   152

	if (_network_udp_server)

   153

		return;

   154

   155

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   156

   157

	if (_udp_cs.has_quit) return;

   158

   159

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

   160

   161

	// Find next item

   162

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

   163

   164

	item->info.compatible = true;

   165

	/* Please observer the order. In the order in which packets are sent

   166

	 * they are to be received */

   167

	switch (game_info_version) {

   168

		case 4: {

   169

			GRFConfig *c, **dst = &item->info.grfconfig;

   170

			const GRFConfig *f;

   171

			uint i;

   172

			uint num_grfs = NetworkRecv_uint8(&_udp_cs, p);

   173

   174

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

   175

				c = calloc(1, sizeof(*c));

   176

				NetworkRecv_GRFIdentifier(p, c);

   177

   178

				/* Find the matching GRF file */

   179

				f = FindGRFConfig(c->grfid, c->md5sum);

   180

				if (f == NULL) {

   181

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

   182

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

   183

					 * name of the GRF already */

   184

					item->info.compatible = false;

   185

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

   186

					SETBIT(c->flags, GCF_NOT_FOUND);

   187

				} else {

   188

					c->filename = f->filename;

   189

					c->name     = f->name;

   190

					c->info     = f->info;

   191

				}

   192

				SETBIT(c->flags, GCF_COPY);

   193

   194

				/* Append GRFConfig to the list */

   195

				*dst = c;

   196

				dst = &c->next;

   197

			}

   198

		} /* Fallthrough */

   199

		case 3:

   200

			item->info.game_date     = NetworkRecv_uint32(&_udp_cs, p);

   201

			item->info.start_date    = NetworkRecv_uint32(&_udp_cs, p);

   202

			/* Fallthrough */

   203

		case 2:

   204

			item->info.companies_max = NetworkRecv_uint8(&_udp_cs, p);

   205

			item->info.companies_on = NetworkRecv_uint8(&_udp_cs, p);

   206

			item->info.spectators_max = NetworkRecv_uint8(&_udp_cs, p);

   207

			/* Fallthrough */

   208

		case 1:

   209

			NetworkRecv_string(&_udp_cs, p, item->info.server_name, sizeof(item->info.server_name));

   210

			NetworkRecv_string(&_udp_cs, p, item->info.server_revision, sizeof(item->info.server_revision));

   211

			item->info.server_lang   = NetworkRecv_uint8(&_udp_cs, p);

   212

			item->info.use_password  = NetworkRecv_uint8(&_udp_cs, p);

   213

			item->info.clients_max   = NetworkRecv_uint8(&_udp_cs, p);

   214

			item->info.clients_on    = NetworkRecv_uint8(&_udp_cs, p);

   215

			item->info.spectators_on = NetworkRecv_uint8(&_udp_cs, p);

   216

			if (game_info_version < 3) { // 16 bits dates got scrapped and are read earlier

   217

				item->info.game_date     = NetworkRecv_uint16(&_udp_cs, p) + DAYS_TILL_ORIGINAL_BASE_YEAR;

   218

				item->info.start_date    = NetworkRecv_uint16(&_udp_cs, p) + DAYS_TILL_ORIGINAL_BASE_YEAR;

   219

			}

   220

			NetworkRecv_string(&_udp_cs, p, item->info.map_name, sizeof(item->info.map_name));

   221

			item->info.map_width     = NetworkRecv_uint16(&_udp_cs, p);

   222

			item->info.map_height    = NetworkRecv_uint16(&_udp_cs, p);

   223

			item->info.map_set       = NetworkRecv_uint8(&_udp_cs, p);

   224

			item->info.dedicated     = NetworkRecv_uint8(&_udp_cs, p);

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

   232

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

   233

			item->info.version_compatible =

   234

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

   235

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

   236

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

   237

			break;

   238

	}

   239

   240

	{

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

		 * due to the string comparisons. */

   248

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   249

		const GRFConfig *c;

   250

		uint in_request_count = 0;

   251

		struct sockaddr_in out_addr;

   252

   253

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

   254

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

   255

			in_request[in_request_count] = c;

   256

			in_request_count++;

   257

		}

   258

   259

		if (in_request_count > 0) {

   260

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

   261

			uint i;

   262

			Packet *packet = NetworkSend_Init(PACKET_UDP_CLIENT_GET_NEWGRFS);

   263

   264

			NetworkSend_uint8 (packet, in_request_count);

   265

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

   266

				NetworkSend_GRFIdentifier(packet, in_request[i]);

   267

			}

   268

   269

			out_addr.sin_family      = AF_INET;

   270

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

   271

			out_addr.sin_addr.s_addr = item->ip;

   272

			NetworkSendUDP_Packet(_udp_client_socket, packet, &out_addr);

   273

			free(packet);

   274

		}

   275

	}

   276

   277

	item->online = true;

   278

   279

	UpdateNetworkGameWindow(false);

   280

}

   281

   282

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   283

{

   284

	NetworkClientState *cs;

   285

	NetworkClientInfo *ci;

   286

	Packet *packet;

   287

	Player *player;

   288

	byte current = 0;

   289

	int i;

   290

   291

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

   292

	if (!_network_udp_server) return;

   293

   294

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   295

   296

	/* Send the amount of active companies */

   297

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   298

	NetworkSend_uint8 (packet, ActivePlayerCount());

   299

   300

	/* Fetch the latest version of everything */

   301

	NetworkPopulateCompanyInfo();

   302

   303

	/* Go through all the players */

   304

	FOR_ALL_PLAYERS(player) {

   305

		/* Skip non-active players */

   306

		if (!player->is_active) continue;

   307

   308

		current++;

   309

   310

		/* Send the information */

   311

		NetworkSend_uint8(packet, current);

   312

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

   320

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

   321

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

   322

			NetworkSend_uint8(packet, 1);

   323

		} else {

   324

			NetworkSend_uint8(packet, 0);

   325

		}

   326

   327

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

   328

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

   329

   330

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

   331

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

   332

   333

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

   334

		FOR_ALL_CLIENTS(cs) {

   335

			ci = DEREF_CLIENT_INFO(cs);

   336

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

   337

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

   338

				NetworkSend_uint8(packet, 1);

   339

				NetworkSend_string(packet, ci->client_name);

   340

				NetworkSend_string(packet, ci->unique_id);

   341

				NetworkSend_uint32(packet, ci->join_date);

   342

			}

   343

		}

   344

		/* Also check for the server itself */

   345

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   346

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

   347

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

   348

			NetworkSend_uint8(packet, 1);

   349

			NetworkSend_string(packet, ci->client_name);

   350

			NetworkSend_string(packet, ci->unique_id);

   351

			NetworkSend_uint32(packet, ci->join_date);

   352

		}

   353

   354

		/* Indicates end of client list */

   355

		NetworkSend_uint8(packet, 0);

   356

	}

   357

   358

	/* And check if we have any spectators */

   359

	FOR_ALL_CLIENTS(cs) {

   360

		ci = DEREF_CLIENT_INFO(cs);

   361

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

   362

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

   363

			NetworkSend_uint8(packet, 1);

   364

			NetworkSend_string(packet, ci->client_name);

   365

			NetworkSend_string(packet, ci->unique_id);

   366

			NetworkSend_uint32(packet, ci->join_date);

   367

		}

   368

	}

   369

   370

	/* Also check for the server itself */

   371

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   372

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

   373

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

   374

		NetworkSend_uint8(packet, 1);

   375

		NetworkSend_string(packet, ci->client_name);

   376

		NetworkSend_string(packet, ci->unique_id);

   377

		NetworkSend_uint32(packet, ci->join_date);

   378

	}

   379

   380

	/* Indicates end of client list */

   381

	NetworkSend_uint8(packet, 0);

   382

   383

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   384

   385

	free(packet);

   386

}

   387

   388

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST)

   389

{

   390

	int i;

   391

	struct in_addr ip;

   392

	uint16 port;

   393

	uint8 ver;

   394

   395

	/* packet begins with the protocol version (uint8)

   396

	 * then an uint16 which indicates how many

   397

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

   398

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

   399

	 */

   400

   401

	ver = NetworkRecv_uint8(&_udp_cs, p);

   402

   403

	if (_udp_cs.has_quit) return;

   404

   405

	if (ver == 1) {

   406

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

   407

			ip.s_addr = TO_LE32(NetworkRecv_uint32(&_udp_cs, p));

   408

			port = NetworkRecv_uint16(&_udp_cs, p);

   409

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   410

		}

   411

	}

   412

}

   413

   414

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER)

   415

{

   416

	_network_advertise_retries = 0;

   417

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

   418

   419

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

   420

	if (!_network_advertise) NetworkUDPRemoveAdvertise();

   421

}

   422

   423

/**

   424

 * A client has requested the names of some NewGRFs.

   425

 *

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

 * would be sent, the packet overflows.

   433

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

   434

 * send in the reply.

   435

 */

   436

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS)

   437

{

   438

	uint8 num_grfs;

   439

	uint i;

   440

   441

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   442

	Packet *packet;

   443

	uint8 in_reply_count = 0;

   444

	uint packet_len = 0;

   445

   446

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

   447

	if (_udp_cs.has_quit) return;

   448

   449

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

   450

   451

	num_grfs = NetworkRecv_uint8 (&_udp_cs, p);

   452

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   453

   454

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

   455

		GRFConfig c;

   456

		const GRFConfig *f;

   457

   458

		NetworkRecv_GRFIdentifier(p, &c);

   459

   460

		/* Find the matching GRF file */

   461

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

   462

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

   463

   464

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

   465

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

   466

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

   467

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

   468

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

   469

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

   470

			break;

   471

		}

   472

		in_reply[in_reply_count] = f;

   473

		in_reply_count++;

   474

	}

   475

   476

	if (in_reply_count == 0) return;

   477

   478

	packet = NetworkSend_Init(PACKET_UDP_SERVER_NEWGRFS);

   479

	NetworkSend_uint8 (packet, in_reply_count);

   480

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

   481

		char name[NETWORK_GRF_NAME_LENGTH];

   482

   483

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

   484

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

   485

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

   486

	 	NetworkSend_GRFIdentifier(packet, in_reply[i]);

   487

		NetworkSend_string(packet, name);

   488

	}

   489

   490

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   491

	free(packet);

   492

}