1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "debug.h"

     5

#include "string.h"

     6

#include "network_data.h"

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "map.h"

    11

#include "network_gamelist.h"

    12

#include "network_udp.h"

    13

#include "variables.h"

    14

    15

extern void UpdateNetworkGameWindow(bool unselect);

    16

extern void NetworkPopulateCompanyInfo(void);

    17

    18

//

    19

// This file handles all the LAN-stuff

    20

// Stuff like:

    21

//   - UDP search over the network

    22

//

    23

    24

typedef enum {

    25

	PACKET_UDP_CLIENT_FIND_SERVER,

    26

	PACKET_UDP_SERVER_RESPONSE,

    27

	PACKET_UDP_CLIENT_DETAIL_INFO,

    28

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

    29

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

    30

	PACKET_UDP_MASTER_ACK_REGISTER, // Packet indicating registration has succedeed

    31

	PACKET_UDP_CLIENT_GET_LIST, // Request for serverlist from master server

    32

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

    33

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

    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

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER)

    49

{

    50

	Packet *packet;

    51

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

    52

	if (!_network_udp_server)

    53

		return;

    54

    55

	packet = NetworkSend_Init(PACKET_UDP_SERVER_RESPONSE);

    56

    57

	// Update some game_info

    58

	_network_game_info.game_date = _date;

    59

	_network_game_info.map_width = MapSizeX();

    60

	_network_game_info.map_height = MapSizeY();

    61

	_network_game_info.map_set = _opt.landscape;

    62

    63

	NetworkSend_uint8 (packet, NETWORK_GAME_INFO_VERSION);

    64

    65

	/* NETWORK_GAME_INFO_VERSION = 2 */

    66

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

    67

	NetworkSend_uint8 (packet, ActivePlayerCount());

    68

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

    69

    70

	/* NETWORK_GAME_INFO_VERSION = 1 */

    71

	NetworkSend_string(packet, _network_game_info.server_name);

    72

	NetworkSend_string(packet, _network_game_info.server_revision);

    73

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    74

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    75

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    76

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    77

	NetworkSend_uint8 (packet, NetworkSpectatorCount());

    78

	NetworkSend_uint16(packet, _network_game_info.game_date);

    79

	NetworkSend_uint16(packet, _network_game_info.start_date);

    80

	NetworkSend_string(packet, _network_game_info.map_name);

    81

	NetworkSend_uint16(packet, _network_game_info.map_width);

    82

	NetworkSend_uint16(packet, _network_game_info.map_height);

    83

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    84

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    85

    86

	// Let the client know that we are here

    87

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    88

    89

	free(packet);

    90

    91

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

    92

}

    93

    94

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    95

{

    96

	extern const char _openttd_revision[];

    97

	NetworkGameList *item;

    98

	byte game_info_version;

    99

   100

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

   101

	if (_network_udp_server)

   102

		return;

   103

   104

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   105

   106

	if (_udp_cs.quited) return;

   107

   108

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

   109

   110

	// Find next item

   111

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

   112

   113

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

   114

	 * they are to be received */

   115

	switch (game_info_version) {

   116

		case 2:

   117

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

   118

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

   119

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

   120

			/* Fallthrough */

   121

		case 1:

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

   137

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

   138

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

   139

   140

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

   141

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

   142

   143

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

   144

			item->info.compatible =

   145

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

   146

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

   147

			break;

   148

	}

   149

   150

	item->online = true;

   151

   152

	UpdateNetworkGameWindow(false);

   153

}

   154

   155

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   156

{

   157

	NetworkClientState *cs;

   158

	NetworkClientInfo *ci;

   159

	Packet *packet;

   160

	Player *player;

   161

	byte current = 0;

   162

	int i;

   163

   164

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

   165

	if (!_network_udp_server) return;

   166

   167

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   168

   169

	/* Send the amount of active companies */

   170

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   171

	NetworkSend_uint8 (packet, ActivePlayerCount());

   172

   173

	/* Fetch the latest version of everything */

   174

	NetworkPopulateCompanyInfo();

   175

   176

	/* Go through all the players */

   177

	FOR_ALL_PLAYERS(player) {

   178

		/* Skip non-active players */

   179

		if (!player->is_active) continue;

   180

   181

		current++;

   182

   183

		/* Send the information */

   184

		NetworkSend_uint8(packet, current);

   185

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

   193

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

   194

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

   195

			NetworkSend_uint8(packet, 1);

   196

		} else {

   197

			NetworkSend_uint8(packet, 0);

   198

		}

   199

   200

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

   201

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

   202

   203

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

   204

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

   205

   206

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

   207

		FOR_ALL_CLIENTS(cs) {

   208

			ci = DEREF_CLIENT_INFO(cs);

   209

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

   210

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

   211

				NetworkSend_uint8(packet, 1);

   212

				NetworkSend_string(packet, ci->client_name);

   213

				NetworkSend_string(packet, ci->unique_id);

   214

				NetworkSend_uint16(packet, ci->join_date);

   215

			}

   216

		}

   217

		/* Also check for the server itself */

   218

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   219

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

   220

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

   221

			NetworkSend_uint8(packet, 1);

   222

			NetworkSend_string(packet, ci->client_name);

   223

			NetworkSend_string(packet, ci->unique_id);

   224

			NetworkSend_uint16(packet, ci->join_date);

   225

		}

   226

   227

		/* Indicates end of client list */

   228

		NetworkSend_uint8(packet, 0);

   229

	}

   230

   231

	/* And check if we have any spectators */

   232

	FOR_ALL_CLIENTS(cs) {

   233

		ci = DEREF_CLIENT_INFO(cs);

   234

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

   235

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

   236

			NetworkSend_uint8(packet, 1);

   237

			NetworkSend_string(packet, ci->client_name);

   238

			NetworkSend_string(packet, ci->unique_id);

   239

			NetworkSend_uint16(packet, ci->join_date);

   240

		}

   241

	}

   242

	/* Also check for the server itself */

   243

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   244

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

   245

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

   246

		NetworkSend_uint8(packet, 1);

   247

		NetworkSend_string(packet, ci->client_name);

   248

		NetworkSend_string(packet, ci->unique_id);

   249

		NetworkSend_uint16(packet, ci->join_date);

   250

	}

   251

   252

	/* Indicates end of client list */

   253

	NetworkSend_uint8(packet, 0);

   254

   255

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   256

   257

	free(packet);

   258

}

   259

   260

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST)

   261

{

   262

	int i;

   263

	struct in_addr ip;

   264

	uint16 port;

   265

	uint8 ver;

   266

   267

	/* packet begins with the protocol version (uint8)

   268

	 * then an uint16 which indicates how many

   269

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

   270

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

   271

	 */

   272

   273

	ver = NetworkRecv_uint8(&_udp_cs, p);

   274

   275

	if (_udp_cs.quited)

   276

		return;

   277

   278

	if (ver == 1) {

   279

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

   280

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

   281

			port = NetworkRecv_uint16(&_udp_cs, p);

   282

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   283

		}

   284

	}

   285

}

   286

   287

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER)

   288

{

   289

	_network_advertise_retries = 0;

   290

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

   291

   292

	if (!_network_advertise) {

   293

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

   294

		NetworkUDPRemoveAdvertise();

   295

	}

   296

}

   297

   298

   299

// The layout for the receive-functions by UDP

   300

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

   301

   302

static NetworkUDPPacket* const _network_udp_packet[] = {

   303

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   304

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   305

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   306

	NULL,

   307

	NULL,

   308

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   309

	NULL,

   310

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   311

	NULL

   312

};

   313

   314

   315

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

   316

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   317

   318

   319

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

   320

{

   321

	byte type;

   322

   323

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

   324

	_udp_cs.socket = INVALID_SOCKET;

   325

	_udp_cs.quited = false;

   326

   327

	type = NetworkRecv_uint8(&_udp_cs, p);

   328

   329

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

   330

		_network_udp_packet[type](p, client_addr);

   331

	} else {

   332

		if (!_udp_cs.quited) {

   333

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

   334

		} else {

   335

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

   336

		}

   337

	}

   338

}

   339

   340

   341

// Send a packet over UDP

   342

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

   343

{

   344

	int res;

   345

   346

	// Put the length in the buffer

   347

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

   348

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

   349

   350

	// Send the buffer

   351

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

   352

   353

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

   354

	if (res == -1) {

   355

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

   356

	}

   357

}

   358

   359

// Start UDP listener

   360

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

   361

{

   362

	struct sockaddr_in sin;

   363

   364

	// Make sure socket is closed

   365

	closesocket(*udp);

   366

   367

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

   368

	if (*udp == INVALID_SOCKET) {

   369

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

   370

		return false;

   371

	}

   372

   373

	// set nonblocking mode for socket

   374

	{

   375

		unsigned long blocking = 1;

   376

#ifndef BEOS_NET_SERVER

   377

		ioctlsocket(*udp, FIONBIO, &blocking);

   378

#else

   379

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

   380

#endif

   381

	}

   382

   383

	sin.sin_family = AF_INET;

   384

	// Listen on all IPs

   385

	sin.sin_addr.s_addr = host;

   386

	sin.sin_port = htons(port);

   387

   388

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

   389

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

   390

		return false;

   391

	}

   392

   393

	if (broadcast) {

   394

		/* Enable broadcast */

   395

		unsigned long val = 1;

   396

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

   397

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

   398

#endif

   399

	}

   400

   401

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

   402

   403

	return true;

   404

}

   405

   406

// Close UDP connection

   407

void NetworkUDPClose(void)

   408

{

   409

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

   410

   411

	if (_network_udp_server) {

   412

		if (_udp_server_socket != INVALID_SOCKET) {

   413

			closesocket(_udp_server_socket);

   414

			_udp_server_socket = INVALID_SOCKET;

   415

		}

   416

   417

		if (_udp_master_socket != INVALID_SOCKET) {

   418

			closesocket(_udp_master_socket);

   419

			_udp_master_socket = INVALID_SOCKET;

   420

		}

   421

   422

		_network_udp_server = false;

   423

		_network_udp_broadcast = 0;

   424

	} else {

   425

		if (_udp_client_socket != INVALID_SOCKET) {

   426

			closesocket(_udp_client_socket);

   427

			_udp_client_socket = INVALID_SOCKET;

   428

		}

   429

		_network_udp_broadcast = 0;

   430

	}

   431

}

   432

   433

// Receive something on UDP level

   434

void NetworkUDPReceive(SOCKET udp)

   435

{

   436

	struct sockaddr_in client_addr;

   437

	socklen_t client_len;

   438

	int nbytes;

   439

	static Packet *p = NULL;

   440

	int packet_len;

   441

   442

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

   443

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

   444

   445

	packet_len = sizeof(p->buffer);

   446

	client_len = sizeof(client_addr);

   447

   448

	// Try to receive anything

   449

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

   450

   451

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

   452

	if (nbytes > 0) {

   453

		// Get the size of the buffer

   454

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

   455

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

   456

		// Put the position on the right place

   457

		p->pos = 2;

   458

		p->next = NULL;

   459

   460

		// Handle the packet

   461

		NetworkHandleUDPPacket(p, &client_addr);

   462

   463

		// Free the packet

   464

		free(p);

   465

		p = NULL;

   466

	}

   467

}

   468

   469

// Broadcast to all ips

   470

static void NetworkUDPBroadCast(SOCKET udp)

   471

{

   472

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   473

	uint i;

   474

   475

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

   476

		struct sockaddr_in out_addr;

   477

   478

		out_addr.sin_family = AF_INET;

   479

		out_addr.sin_port = htons(_network_server_port);

   480

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   481

   482

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

   483

   484

		NetworkSendUDP_Packet(udp, p, &out_addr);

   485

	}

   486

   487

	free(p);

   488

}

   489

   490

   491

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

   492

void NetworkUDPQueryMasterServer(void)

   493

{

   494

	struct sockaddr_in out_addr;

   495

	Packet *p;

   496

   497

	if (_udp_client_socket == INVALID_SOCKET)

   498

		if (!NetworkUDPListen(&_udp_client_socket, 0, 0, true))