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

			str_validate(item->info.server_name);

   138

			str_validate(item->info.server_revision);

   139

			str_validate(item->info.map_name);

   140

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

   141

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

   142

   143

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

   144

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

   145

   146

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

   147

			item->info.compatible = (

   148

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

   149

			strncmp(item->info.server_revision, NOREV_STRING, NETWORK_REVISION_LENGTH) == 0) ? true : false;

   150

   151

			break;

   152

	}

   153

   154

	item->online = true;

   155

   156

	UpdateNetworkGameWindow(false);

   157

}

   158

   159

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   160

{

   161

	NetworkClientState *cs;

   162

	NetworkClientInfo *ci;

   163

	Packet *packet;

   164

	Player *player;

   165

	byte current = 0;

   166

	int i;

   167

   168

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

   169

	if (!_network_udp_server)

   170

		return;

   171

   172

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   173

   174

	/* Send the amount of active companies */

   175

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   176

	NetworkSend_uint8 (packet, ActivePlayerCount());

   177

   178

	/* Fetch the latest version of everything */

   179

	NetworkPopulateCompanyInfo();

   180

   181

	/* Go through all the players */

   182

	FOR_ALL_PLAYERS(player) {

   183

		/* Skip non-active players */

   184

		if (!player->is_active)

   185

			continue;

   186

   187

		current++;

   188

   189

		/* Send the information */

   190

		NetworkSend_uint8 (packet, current);

   191

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

   199

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

   200

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

   201

			NetworkSend_uint8 (packet, 1);

   202

		} else {

   203

			NetworkSend_uint8 (packet, 0);

   204

		}

   205

   206

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

   207

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

   208

   209

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

   210

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

   211

   212

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

   213

		FOR_ALL_CLIENTS(cs) {

   214

			ci = DEREF_CLIENT_INFO(cs);

   215

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

   216

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

   217

				NetworkSend_uint8(packet, 1);

   218

				NetworkSend_string(packet, ci->client_name);

   219

				NetworkSend_string(packet, ci->unique_id);

   220

				NetworkSend_uint16(packet, ci->join_date);

   221

			}

   222

		}

   223

		/* Also check for the server itself */

   224

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   225

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

   226

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

   227

			NetworkSend_uint8(packet, 1);

   228

			NetworkSend_string(packet, ci->client_name);

   229

			NetworkSend_string(packet, ci->unique_id);

   230

			NetworkSend_uint16(packet, ci->join_date);

   231

		}

   232

   233

		/* Indicates end of client list */

   234

		NetworkSend_uint8(packet, 0);

   235

	}

   236

   237

	/* And check if we have any spectators */

   238

	FOR_ALL_CLIENTS(cs) {

   239

		ci = DEREF_CLIENT_INFO(cs);

   240

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

   241

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

   242

			NetworkSend_uint8(packet, 1);

   243

			NetworkSend_string(packet, ci->client_name);

   244

			NetworkSend_string(packet, ci->unique_id);

   245

			NetworkSend_uint16(packet, ci->join_date);

   246

		}

   247

	}

   248

	/* Also check for the server itself */

   249

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   250

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

   251

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

   252

		NetworkSend_uint8(packet, 1);

   253

		NetworkSend_string(packet, ci->client_name);

   254

		NetworkSend_string(packet, ci->unique_id);

   255

		NetworkSend_uint16(packet, ci->join_date);

   256

	}

   257

   258

	/* Indicates end of client list */

   259

	NetworkSend_uint8(packet, 0);

   260

   261

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   262

   263

	free(packet);

   264

}

   265

   266

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST) {

   267

	int i;

   268

	struct in_addr ip;

   269

	uint16 port;

   270

	uint8 ver;

   271

   272

	/* packet begins with the protocol version (uint8)

   273

	 * then an uint16 which indicates how many

   274

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

   275

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

   276

	 */

   277

   278

	ver = NetworkRecv_uint8(&_udp_cs, p);

   279

   280

	if (_udp_cs.quited)

   281

		return;

   282

   283

	if (ver == 1) {

   284

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

   285

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

   286

			port = NetworkRecv_uint16(&_udp_cs, p);

   287

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   288

		}

   289

	}

   290

}

   291

   292

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER) {

   293

	_network_advertise_retries = 0;

   294

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

   295

   296

	if (!_network_advertise)

   297

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

   298

		NetworkUDPRemoveAdvertise();

   299

}

   300

   301

   302

// The layout for the receive-functions by UDP

   303

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

   304

   305

static NetworkUDPPacket* const _network_udp_packet[] = {

   306

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   307

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   308

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   309

	NULL,

   310

	NULL,

   311

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   312

	NULL,

   313

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   314

	NULL

   315

};

   316

   317

   318

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

   319

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   320

   321

   322

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

   323

{

   324

	byte type;

   325

   326

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

   327

	_udp_cs.socket = INVALID_SOCKET;

   328

	_udp_cs.quited = false;

   329

   330

	type = NetworkRecv_uint8(&_udp_cs, p);

   331

   332

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

   333

		_network_udp_packet[type](p, client_addr);

   334

	}	else {

   335

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

   336

	}

   337

}

   338

   339

   340

// Send a packet over UDP

   341

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

   342

{

   343

	int res;

   344

   345

	// Put the length in the buffer

   346

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

   347

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

   348

   349

	// Send the buffer

   350

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

   351

   352

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

   353

	if (res == -1) {

   354

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

   355

	}

   356

}

   357

   358

// Start UDP listener

   359

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

   360

{

   361

	struct sockaddr_in sin;

   362

   363

	// Make sure socket is closed

   364

	closesocket(*udp);

   365

   366

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

   367

	if (*udp == INVALID_SOCKET) {

   368

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

   369

		return false;

   370

	}

   371

   372

	// set nonblocking mode for socket

   373

	{

   374

		unsigned long blocking = 1;

   375

#ifndef BEOS_NET_SERVER

   376

		ioctlsocket(*udp, FIONBIO, &blocking);

   377

#else

   378

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

   379

#endif

   380

	}

   381

   382

	sin.sin_family = AF_INET;

   383

	// Listen on all IPs

   384

	sin.sin_addr.s_addr = host;

   385

	sin.sin_port = htons(port);

   386

   387

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

   388

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

   389

		return false;

   390

	}

   391

   392

	if (broadcast) {

   393

		/* Enable broadcast */

   394

		unsigned long val = 1;

   395

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

   396

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

   397

#endif

   398

	}

   399

   400

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

   401

   402

	return true;

   403

}

   404

   405

// Close UDP connection

   406

void NetworkUDPClose(void)

   407

{

   408

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

   409

   410

	if (_network_udp_server) {

   411

		if (_udp_server_socket != INVALID_SOCKET) {

   412

			closesocket(_udp_server_socket);

   413

			_udp_server_socket = INVALID_SOCKET;

   414

		}

   415

   416

		if (_udp_master_socket != INVALID_SOCKET) {

   417

			closesocket(_udp_master_socket);

   418

			_udp_master_socket = INVALID_SOCKET;

   419

		}

   420

   421

		_network_udp_server = false;

   422

		_network_udp_broadcast = 0;

   423

	} else {

   424

		if (_udp_client_socket != INVALID_SOCKET) {

   425

			closesocket(_udp_client_socket);

   426

			_udp_client_socket = INVALID_SOCKET;

   427

		}

   428

		_network_udp_broadcast = 0;

   429

	}

   430

}

   431

   432

// Receive something on UDP level

   433

void NetworkUDPReceive(SOCKET udp)

   434

{

   435

	struct sockaddr_in client_addr;

   436

	socklen_t client_len;

   437

	int nbytes;

   438

	static Packet *p = NULL;

   439

	int packet_len;

   440

   441

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

   442

	if (p == NULL)

   443

		p = malloc(sizeof(Packet));

   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

	int i;

   473

	struct sockaddr_in out_addr;

   474

	byte *bcptr;

   475

	uint32 bcaddr;

   476

	Packet *p;

   477

   478

	// Init the packet

   479

	p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   480

   481

	// Go through all the ips on this pc

   482

	i = 0;

   483

	while (_network_ip_list[i] != 0) {

   484

		bcaddr = _network_ip_list[i];

   485

		bcptr = (byte *)&bcaddr;

   486

		// Make the address a broadcast address

   487

		bcptr[3] = 255;

   488

   489

		DEBUG(net, 6)("[NET][UDP] Broadcasting to %s", inet_ntoa(*(struct in_addr *)&bcaddr));

   490

   491

		out_addr.sin_family = AF_INET;

   492

		out_addr.sin_port = htons(_network_server_port);

   493

		out_addr.sin_addr.s_addr = bcaddr;

   494

   495

		NetworkSendUDP_Packet(udp, p, &out_addr);

   496

   497

		i++;

   498

	}

   499

}

   500

   501

   502

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