1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "debug.h"

     5

#include "string.h"

     6

#include "network_data.h"

     7

#include "date.h"

     8

     9

#ifdef ENABLE_NETWORK

    10

    11

#include "map.h"

    12

#include "network_gamelist.h"

    13

#include "network_udp.h"

    14

#include "variables.h"

    15

    16

extern void UpdateNetworkGameWindow(bool unselect);

    17

extern void NetworkPopulateCompanyInfo(void);

    18

    19

//

    20

// This file handles all the LAN-stuff

    21

// Stuff like:

    22

//   - UDP search over the network

    23

//

    24

    25

typedef enum {

    26

	PACKET_UDP_CLIENT_FIND_SERVER,

    27

	PACKET_UDP_SERVER_RESPONSE,

    28

	PACKET_UDP_CLIENT_DETAIL_INFO,

    29

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

    30

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

    31

	PACKET_UDP_MASTER_ACK_REGISTER,  // Packet indicating registration has succedeed

    32

	PACKET_UDP_CLIENT_GET_LIST,      // Request for serverlist from master server

    33

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

    34

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

    35

	PACKET_UDP_END

    36

} PacketUDPType;

    37

    38

enum {

    39

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

    40

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

    41

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

    42

};

    43

    44

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

    45

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

    46

    47

static NetworkClientState _udp_cs;

    48

    49

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER)

    50

{

    51

	Packet *packet;

    52

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

    53

	if (!_network_udp_server)

    54

		return;

    55

    56

	packet = NetworkSend_Init(PACKET_UDP_SERVER_RESPONSE);

    57

    58

	// Update some game_info

    59

	_network_game_info.game_date = _date;

    60

	_network_game_info.map_width = MapSizeX();

    61

	_network_game_info.map_height = MapSizeY();

    62

	_network_game_info.map_set = _opt.landscape;

    63

    64

	NetworkSend_uint8 (packet, NETWORK_GAME_INFO_VERSION);

    65

    66

	/* NETWORK_GAME_INFO_VERSION = 3 */

    67

	NetworkSend_uint32(packet, _network_game_info.game_date);

    68

	NetworkSend_uint32(packet, _network_game_info.start_date);

    69

    70

	/* NETWORK_GAME_INFO_VERSION = 2 */

    71

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

    72

	NetworkSend_uint8 (packet, ActivePlayerCount());

    73

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

    74

    75

	/* NETWORK_GAME_INFO_VERSION = 1 */

    76

	NetworkSend_string(packet, _network_game_info.server_name);

    77

	NetworkSend_string(packet, _network_game_info.server_revision);

    78

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    79

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    80

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    81

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    82

	NetworkSend_uint8 (packet, NetworkSpectatorCount());

    83

	NetworkSend_string(packet, _network_game_info.map_name);

    84

	NetworkSend_uint16(packet, _network_game_info.map_width);

    85

	NetworkSend_uint16(packet, _network_game_info.map_height);

    86

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    87

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    88

    89

	// Let the client know that we are here

    90

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    91

    92

	free(packet);

    93

    94

	DEBUG(net, 2)("[NET][UDP] Queried from %s", inet_ntoa(client_addr->sin_addr));

    95

}

    96

    97

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    98

{

    99

	extern const char _openttd_revision[];

   100

	NetworkGameList *item;

   101

	byte game_info_version;

   102

   103

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

   104

	if (_network_udp_server)

   105

		return;

   106

   107

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   108

   109

	if (_udp_cs.quited) return;

   110

   111

	DEBUG(net, 6)("[NET][UDP] Server response from %s:%d", inet_ntoa(client_addr->sin_addr),ntohs(client_addr->sin_port));

   112

   113

	// Find next item

   114

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

   115

   116

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

   117

	 * they are to be received */

   118

	switch (game_info_version) {

   119

		case 3:

   120

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

   121

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

   122

			/* Fallthrough */

   123

		case 2:

   124

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

   125

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

   126

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

   127

			/* Fallthrough */

   128

		case 1:

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

			}

   140

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

   141

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

   142

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

   143

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

   144

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

   145

   146

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

   147

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

   148

   149

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

   150

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

   151

   152

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

   153

			item->info.compatible =

   154

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

   155

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

   156

			break;

   157

	}

   158

   159

	item->online = true;

   160

   161

	UpdateNetworkGameWindow(false);

   162

}

   163

   164

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   165

{

   166

	NetworkClientState *cs;

   167

	NetworkClientInfo *ci;

   168

	Packet *packet;

   169

	Player *player;

   170

	byte current = 0;

   171

	int i;

   172

   173

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

   174

	if (!_network_udp_server) return;

   175

   176

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   177

   178

	/* Send the amount of active companies */

   179

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   180

	NetworkSend_uint8 (packet, ActivePlayerCount());

   181

   182

	/* Fetch the latest version of everything */

   183

	NetworkPopulateCompanyInfo();

   184

   185

	/* Go through all the players */

   186

	FOR_ALL_PLAYERS(player) {

   187

		/* Skip non-active players */

   188

		if (!player->is_active) continue;

   189

   190

		current++;

   191

   192

		/* Send the information */

   193

		NetworkSend_uint8(packet, current);

   194

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

   202

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

   203

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

   204

			NetworkSend_uint8(packet, 1);

   205

		} else {

   206

			NetworkSend_uint8(packet, 0);

   207

		}

   208

   209

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

   210

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

   211

   212

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

   213

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

   214

   215

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

   216

		FOR_ALL_CLIENTS(cs) {

   217

			ci = DEREF_CLIENT_INFO(cs);

   218

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

   219

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

   220

				NetworkSend_uint8(packet, 1);

   221

				NetworkSend_string(packet, ci->client_name);

   222

				NetworkSend_string(packet, ci->unique_id);

   223

				NetworkSend_uint32(packet, ci->join_date);

   224

			}

   225

		}

   226

		/* Also check for the server itself */

   227

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   228

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

   229

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

   230

			NetworkSend_uint8(packet, 1);

   231

			NetworkSend_string(packet, ci->client_name);

   232

			NetworkSend_string(packet, ci->unique_id);

   233

			NetworkSend_uint32(packet, ci->join_date);

   234

		}

   235

   236

		/* Indicates end of client list */

   237

		NetworkSend_uint8(packet, 0);

   238

	}

   239

   240

	/* And check if we have any spectators */

   241

	FOR_ALL_CLIENTS(cs) {

   242

		ci = DEREF_CLIENT_INFO(cs);

   243

		if (ci->client_playas - 1 > MAX_PLAYERS) {

   244

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

   245

			NetworkSend_uint8(packet, 1);

   246

			NetworkSend_string(packet, ci->client_name);

   247

			NetworkSend_string(packet, ci->unique_id);

   248

			NetworkSend_uint32(packet, ci->join_date);

   249

		}

   250

	}

   251

	/* Also check for the server itself */

   252

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   253

	if (ci->client_playas - 1 > MAX_PLAYERS) {

   254

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

   255

		NetworkSend_uint8(packet, 1);

   256

		NetworkSend_string(packet, ci->client_name);

   257

		NetworkSend_string(packet, ci->unique_id);

   258

		NetworkSend_uint32(packet, ci->join_date);

   259

	}

   260

   261

	/* Indicates end of client list */

   262

	NetworkSend_uint8(packet, 0);

   263

   264

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   265

   266

	free(packet);

   267

}

   268

   269

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST)

   270

{

   271

	int i;

   272

	struct in_addr ip;

   273

	uint16 port;

   274

	uint8 ver;

   275

   276

	/* packet begins with the protocol version (uint8)

   277

	 * then an uint16 which indicates how many

   278

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

   279

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

   280

	 */

   281

   282

	ver = NetworkRecv_uint8(&_udp_cs, p);

   283

   284

	if (_udp_cs.quited)

   285

		return;

   286

   287

	if (ver == 1) {

   288

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

   289

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

   290

			port = NetworkRecv_uint16(&_udp_cs, p);

   291

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   292

		}

   293

	}

   294

}

   295

   296

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER)

   297

{

   298

	_network_advertise_retries = 0;

   299

	DEBUG(net, 2)("[NET][UDP] We are advertised on the master-server!");

   300

   301

	if (!_network_advertise) {

   302

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

   303

		NetworkUDPRemoveAdvertise();

   304

	}

   305

}

   306

   307

   308

// The layout for the receive-functions by UDP

   309

typedef void NetworkUDPPacket(Packet *p, struct sockaddr_in *client_addr);

   310

   311

static NetworkUDPPacket* const _network_udp_packet[] = {

   312

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   313

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   314

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   315

	NULL,

   316

	NULL,

   317

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   318

	NULL,

   319

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   320

	NULL

   321

};

   322

   323

   324

// If this fails, check the array above with network_data.h

   325

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   326

   327

   328

static void NetworkHandleUDPPacket(Packet* p, struct sockaddr_in* client_addr)

   329

{

   330

	byte type;

   331

   332

	/* Fake a client, so we can see when there is an illegal packet */

   333

	_udp_cs.socket = INVALID_SOCKET;

   334

	_udp_cs.quited = false;

   335

   336

	type = NetworkRecv_uint8(&_udp_cs, p);

   337

   338

	if (type < PACKET_UDP_END && _network_udp_packet[type] != NULL && !_udp_cs.quited) {

   339

		_network_udp_packet[type](p, client_addr);

   340

	} else {

   341

		if (!_udp_cs.quited) {

   342

			DEBUG(net, 0)("[NET][UDP] Received invalid packet type %d", type);

   343

		} else {

   344

			DEBUG(net, 0)("[NET][UDP] Received illegal packet");

   345

		}

   346

	}

   347

}

   348

   349

   350

// Send a packet over UDP

   351

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

   352

{

   353

	int res;

   354

   355

	// Put the length in the buffer

   356

	p->buffer[0] = p->size & 0xFF;

   357

	p->buffer[1] = p->size >> 8;

   358

   359

	// Send the buffer

   360

	res = sendto(udp, p->buffer, p->size, 0, (struct sockaddr *)recv, sizeof(*recv));

   361

   362

	// Check for any errors, but ignore it for the rest

   363

	if (res == -1) {

   364

		DEBUG(net, 1)("[NET][UDP] Send error: %i", GET_LAST_ERROR());

   365

	}

   366

}

   367

   368

// Start UDP listener

   369

bool NetworkUDPListen(SOCKET *udp, uint32 host, uint16 port, bool broadcast)

   370

{

   371

	struct sockaddr_in sin;

   372

   373

	// Make sure socket is closed

   374

	closesocket(*udp);

   375

   376

	*udp = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);

   377

	if (*udp == INVALID_SOCKET) {

   378

		DEBUG(net, 1)("[NET][UDP] Failed to start UDP support");

   379

		return false;

   380

	}

   381

   382

	// set nonblocking mode for socket

   383

	{

   384

		unsigned long blocking = 1;

   385

#ifndef BEOS_NET_SERVER

   386

		ioctlsocket(*udp, FIONBIO, &blocking);

   387

#else

   388

		setsockopt(*udp, SOL_SOCKET, SO_NONBLOCK, &blocking, NULL);

   389

#endif

   390

	}

   391

   392

	sin.sin_family = AF_INET;

   393

	// Listen on all IPs

   394

	sin.sin_addr.s_addr = host;

   395

	sin.sin_port = htons(port);

   396

   397

	if (bind(*udp, (struct sockaddr*)&sin, sizeof(sin)) != 0) {

   398

		DEBUG(net, 1) ("[NET][UDP] error: bind failed on %s:%i", inet_ntoa(*(struct in_addr *)&host), port);

   399

		return false;

   400

	}

   401

   402

	if (broadcast) {

   403

		/* Enable broadcast */

   404

		unsigned long val = 1;

   405

#ifndef BEOS_NET_SERVER // will work around this, some day; maybe.

   406

		setsockopt(*udp, SOL_SOCKET, SO_BROADCAST, (char *) &val , sizeof(val));

   407

#endif

   408

	}

   409

   410

	DEBUG(net, 1)("[NET][UDP] Listening on port %s:%d", inet_ntoa(*(struct in_addr *)&host), port);

   411

   412

	return true;

   413

}

   414

   415

// Close UDP connection

   416

void NetworkUDPClose(void)

   417

{

   418

	DEBUG(net, 1) ("[NET][UDP] Closed listeners");

   419

   420

	if (_network_udp_server) {

   421

		if (_udp_server_socket != INVALID_SOCKET) {

   422

			closesocket(_udp_server_socket);

   423

			_udp_server_socket = INVALID_SOCKET;

   424

		}

   425

   426

		if (_udp_master_socket != INVALID_SOCKET) {

   427

			closesocket(_udp_master_socket);

   428

			_udp_master_socket = INVALID_SOCKET;

   429

		}

   430

   431

		_network_udp_server = false;

   432

		_network_udp_broadcast = 0;

   433

	} else {

   434

		if (_udp_client_socket != INVALID_SOCKET) {

   435

			closesocket(_udp_client_socket);

   436

			_udp_client_socket = INVALID_SOCKET;

   437

		}

   438

		_network_udp_broadcast = 0;

   439

	}

   440

}

   441

   442

// Receive something on UDP level

   443

void NetworkUDPReceive(SOCKET udp)

   444

{

   445

	struct sockaddr_in client_addr;

   446

	socklen_t client_len;

   447

	int nbytes;

   448

	static Packet *p = NULL;

   449

	int packet_len;

   450

   451

	// If p is NULL, malloc him.. this prevents unneeded mallocs

   452

	if (p == NULL) p = malloc(sizeof(*p));

   453

   454

	packet_len = sizeof(p->buffer);

   455

	client_len = sizeof(client_addr);

   456

   457

	// Try to receive anything

   458

	nbytes = recvfrom(udp, p->buffer, packet_len, 0, (struct sockaddr *)&client_addr, &client_len);

   459

   460

	// We got some bytes.. just asume we receive the whole packet

   461

	if (nbytes > 0) {

   462

		// Get the size of the buffer

   463

		p->size = (uint16)p->buffer[0];

   464

		p->size += (uint16)p->buffer[1] << 8;

   465

		// Put the position on the right place

   466

		p->pos = 2;

   467

		p->next = NULL;

   468

   469

		// Handle the packet

   470

		NetworkHandleUDPPacket(p, &client_addr);

   471

   472

		// Free the packet

   473

		free(p);

   474

		p = NULL;

   475

	}

   476

}

   477

   478

// Broadcast to all ips

   479

static void NetworkUDPBroadCast(SOCKET udp)

   480

{

   481

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   482

	uint i;

   483

   484

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

   485

		struct sockaddr_in out_addr;

   486

   487

		out_addr.sin_family = AF_INET;

   488

		out_addr.sin_port = htons(_network_server_port);

   489

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   490

   491

		DEBUG(net, 6)("[NET][UDP] Broadcasting to %s", inet_ntoa(out_addr.sin_addr));

   492

   493

		NetworkSendUDP_Packet(udp, p, &out_addr);

   494

	}

   495

   496

	free(p);

   497

}