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 = 2 */

    67

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

    68

	NetworkSend_uint8 (packet, ActivePlayerCount());

    69

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

    70

    71

	/* NETWORK_GAME_INFO_VERSION = 1 */

    72

	NetworkSend_string(packet, _network_game_info.server_name);

    73

	NetworkSend_string(packet, _network_game_info.server_revision);

    74

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    75

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    76

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    77

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    78

	NetworkSend_uint8 (packet, NetworkSpectatorCount());

    79

	NetworkSend_uint16(packet, _network_game_info.game_date);

    80

	NetworkSend_uint16(packet, _network_game_info.start_date);

    81

	NetworkSend_string(packet, _network_game_info.map_name);

    82

	NetworkSend_uint16(packet, _network_game_info.map_width);

    83

	NetworkSend_uint16(packet, _network_game_info.map_height);

    84

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    85

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    86

    87

	// Let the client know that we are here

    88

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    89

    90

	free(packet);

    91

    92

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

    93

}

    94

    95

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    96

{

    97

	extern const char _openttd_revision[];

    98

	NetworkGameList *item;

    99

	byte game_info_version;

   100

   101

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

   102

	if (_network_udp_server)

   103

		return;

   104

   105

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   106

   107

	if (_udp_cs.quited) return;

   108

   109

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

   110

   111

	// Find next item

   112

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

   113

   114

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

   115

	 * they are to be received */

   116

	switch (game_info_version) {

   117

		case 2:

   118

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

   119

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

   120

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

   121

			/* Fallthrough */

   122

		case 1:

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

   138

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

   139

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

   140

   141

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

   142

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

   143

   144

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

   145

			item->info.compatible =

   146

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

   147

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

   148

			break;

   149

	}

   150

   151

	item->online = true;

   152

   153

	UpdateNetworkGameWindow(false);

   154

}

   155

   156

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   157

{

   158

	NetworkClientState *cs;

   159

	NetworkClientInfo *ci;

   160

	Packet *packet;

   161

	Player *player;

   162

	byte current = 0;

   163

	int i;

   164

   165

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

   166

	if (!_network_udp_server) return;

   167

   168

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   169

   170

	/* Send the amount of active companies */

   171

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   172

	NetworkSend_uint8 (packet, ActivePlayerCount());

   173

   174

	/* Fetch the latest version of everything */

   175

	NetworkPopulateCompanyInfo();

   176

   177

	/* Go through all the players */

   178

	FOR_ALL_PLAYERS(player) {

   179

		/* Skip non-active players */

   180

		if (!player->is_active) continue;

   181

   182

		current++;

   183

   184

		/* Send the information */

   185

		NetworkSend_uint8(packet, current);

   186

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

   194

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

   195

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

   196

			NetworkSend_uint8(packet, 1);

   197

		} else {

   198

			NetworkSend_uint8(packet, 0);

   199

		}

   200

   201

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

   202

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

   203

   204

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

   205

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

   206

   207

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

   208

		FOR_ALL_CLIENTS(cs) {

   209

			ci = DEREF_CLIENT_INFO(cs);

   210

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

   211

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

   212

				NetworkSend_uint8(packet, 1);

   213

				NetworkSend_string(packet, ci->client_name);

   214

				NetworkSend_string(packet, ci->unique_id);

   215

				NetworkSend_uint16(packet, ci->join_date);

   216

			}

   217

		}

   218

		/* Also check for the server itself */

   219

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   220

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

   221

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

   222

			NetworkSend_uint8(packet, 1);

   223

			NetworkSend_string(packet, ci->client_name);

   224

			NetworkSend_string(packet, ci->unique_id);

   225

			NetworkSend_uint16(packet, ci->join_date);

   226

		}

   227

   228

		/* Indicates end of client list */

   229

		NetworkSend_uint8(packet, 0);

   230

	}

   231

   232

	/* And check if we have any spectators */

   233

	FOR_ALL_CLIENTS(cs) {

   234

		ci = DEREF_CLIENT_INFO(cs);

   235

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

   236

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

   237

			NetworkSend_uint8(packet, 1);

   238

			NetworkSend_string(packet, ci->client_name);

   239

			NetworkSend_string(packet, ci->unique_id);

   240

			NetworkSend_uint16(packet, ci->join_date);

   241

		}

   242

	}

   243

	/* Also check for the server itself */

   244

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   245

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

   246

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

   247

		NetworkSend_uint8(packet, 1);

   248

		NetworkSend_string(packet, ci->client_name);

   249

		NetworkSend_string(packet, ci->unique_id);

   250

		NetworkSend_uint16(packet, ci->join_date);

   251

	}

   252

   253

	/* Indicates end of client list */

   254

	NetworkSend_uint8(packet, 0);

   255

   256

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   257

   258

	free(packet);

   259

}

   260

   261

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST)

   262

{

   263

	int i;

   264

	struct in_addr ip;

   265

	uint16 port;

   266

	uint8 ver;

   267

   268

	/* packet begins with the protocol version (uint8)

   269

	 * then an uint16 which indicates how many

   270

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

   271

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

   272

	 */

   273

   274

	ver = NetworkRecv_uint8(&_udp_cs, p);

   275

   276

	if (_udp_cs.quited)

   277

		return;

   278

   279

	if (ver == 1) {

   280

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

   281

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

   282

			port = NetworkRecv_uint16(&_udp_cs, p);

   283

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   284

		}

   285

	}

   286

}

   287

   288

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER)

   289

{

   290

	_network_advertise_retries = 0;

   291

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

   292

   293

	if (!_network_advertise) {

   294

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

   295

		NetworkUDPRemoveAdvertise();

   296

	}

   297

}

   298

   299

   300

// The layout for the receive-functions by UDP

   301

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

   302

   303

static NetworkUDPPacket* const _network_udp_packet[] = {

   304

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   305

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   306

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   307

	NULL,

   308

	NULL,

   309

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   310

	NULL,

   311

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   312

	NULL

   313

};

   314

   315

   316

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

   317

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   318

   319

   320

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

   321

{

   322

	byte type;

   323

   324

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

   325

	_udp_cs.socket = INVALID_SOCKET;

   326

	_udp_cs.quited = false;

   327

   328

	type = NetworkRecv_uint8(&_udp_cs, p);

   329

   330

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

   331

		_network_udp_packet[type](p, client_addr);

   332

	} else {

   333

		if (!_udp_cs.quited) {

   334

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

   335

		} else {

   336

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

   337

		}

   338

	}

   339

}

   340

   341

   342

// Send a packet over UDP

   343

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

   344

{

   345

	int res;

   346

   347

	// Put the length in the buffer

   348

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

   349

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

   350

   351

	// Send the buffer

   352

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

   353

   354

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

   355

	if (res == -1) {

   356

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

   357

	}

   358

}

   359

   360

// Start UDP listener

   361

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

   362

{

   363

	struct sockaddr_in sin;

   364

   365

	// Make sure socket is closed

   366

	closesocket(*udp);

   367

   368

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

   369

	if (*udp == INVALID_SOCKET) {

   370

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

   371

		return false;

   372

	}

   373

   374

	// set nonblocking mode for socket

   375

	{

   376

		unsigned long blocking = 1;

   377

#ifndef BEOS_NET_SERVER

   378

		ioctlsocket(*udp, FIONBIO, &blocking);

   379

#else

   380

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

   381

#endif

   382

	}

   383

   384

	sin.sin_family = AF_INET;

   385

	// Listen on all IPs

   386

	sin.sin_addr.s_addr = host;

   387

	sin.sin_port = htons(port);

   388

   389

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

   390

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

   391

		return false;

   392

	}

   393

   394

	if (broadcast) {

   395

		/* Enable broadcast */

   396

		unsigned long val = 1;

   397

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

   398

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

   399

#endif

   400

	}

   401

   402

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

   403

   404

	return true;

   405

}

   406

   407

// Close UDP connection

   408

void NetworkUDPClose(void)

   409

{

   410

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

   411

   412

	if (_network_udp_server) {

   413

		if (_udp_server_socket != INVALID_SOCKET) {

   414

			closesocket(_udp_server_socket);

   415

			_udp_server_socket = INVALID_SOCKET;

   416

		}

   417

   418

		if (_udp_master_socket != INVALID_SOCKET) {

   419

			closesocket(_udp_master_socket);

   420

			_udp_master_socket = INVALID_SOCKET;

   421

		}

   422

   423

		_network_udp_server = false;

   424

		_network_udp_broadcast = 0;

   425

	} else {

   426

		if (_udp_client_socket != INVALID_SOCKET) {

   427

			closesocket(_udp_client_socket);

   428

			_udp_client_socket = INVALID_SOCKET;

   429

		}

   430

		_network_udp_broadcast = 0;

   431

	}

   432

}

   433

   434

// Receive something on UDP level

   435

void NetworkUDPReceive(SOCKET udp)

   436

{

   437

	struct sockaddr_in client_addr;

   438

	socklen_t client_len;

   439

	int nbytes;

   440

	static Packet *p = NULL;

   441

	int packet_len;

   442

   443

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

   444

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

   445

   446

	packet_len = sizeof(p->buffer);

   447

	client_len = sizeof(client_addr);

   448

   449

	// Try to receive anything

   450

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

   451

   452

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

   453

	if (nbytes > 0) {

   454

		// Get the size of the buffer

   455

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

   456

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

   457

		// Put the position on the right place

   458

		p->pos = 2;

   459

		p->next = NULL;

   460

   461

		// Handle the packet

   462

		NetworkHandleUDPPacket(p, &client_addr);

   463

   464

		// Free the packet

   465

		free(p);

   466

		p = NULL;

   467

	}

   468

}

   469

   470

// Broadcast to all ips

   471

static void NetworkUDPBroadCast(SOCKET udp)

   472

{

   473

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   474

	uint i;

   475

   476

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

   477

		struct sockaddr_in out_addr;

   478

   479

		out_addr.sin_family = AF_INET;

   480

		out_addr.sin_port = htons(_network_server_port);

   481

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   482

   483

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

   484

   485

		NetworkSendUDP_Packet(udp, p, &out_addr);

   486

	}

   487

   488

	free(p);

   489

}

   490

   491

   492

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

   493

void NetworkUDPQueryMasterServer(void)

   494

{

   495

	struct sockaddr_in out_addr;

   496

	Packet *p;

   497

   498

	if (_udp_client_socket == INVALID_SOCKET)