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

    15

//

    16

// This file handles all the LAN-stuff

    17

// Stuff like:

    18

//   - UDP search over the network

    19

//

    20

    21

typedef enum {

    22

	PACKET_UDP_CLIENT_FIND_SERVER,

    23

	PACKET_UDP_SERVER_RESPONSE,

    24

	PACKET_UDP_CLIENT_DETAIL_INFO,

    25

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

    26

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

    27

	PACKET_UDP_MASTER_ACK_REGISTER,  // Packet indicating registration has succedeed

    28

	PACKET_UDP_CLIENT_GET_LIST,      // Request for serverlist from master server

    29

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

    30

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

    31

	PACKET_UDP_END

    32

} PacketUDPType;

    33

    34

enum {

    35

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

    36

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

    37

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

    38

};

    39

    40

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

    41

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

    42

    43

static NetworkClientState _udp_cs;

    44

    45

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER)

    46

{

    47

	Packet *packet;

    48

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

    49

	if (!_network_udp_server)

    50

		return;

    51

    52

	packet = NetworkSend_Init(PACKET_UDP_SERVER_RESPONSE);

    53

    54

	// Update some game_info

    55

	_network_game_info.game_date = _date;

    56

	_network_game_info.map_width = MapSizeX();

    57

	_network_game_info.map_height = MapSizeY();

    58

	_network_game_info.map_set = _opt.landscape;

    59

    60

	NetworkSend_uint8 (packet, NETWORK_GAME_INFO_VERSION);

    61

    62

	/* NETWORK_GAME_INFO_VERSION = 3 */

    63

	NetworkSend_uint32(packet, _network_game_info.game_date);

    64

	NetworkSend_uint32(packet, _network_game_info.start_date);

    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_string(packet, _network_game_info.map_name);

    80

	NetworkSend_uint16(packet, _network_game_info.map_width);

    81

	NetworkSend_uint16(packet, _network_game_info.map_height);

    82

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    83

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    84

    85

	// Let the client know that we are here

    86

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    87

    88

	free(packet);

    89

    90

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

    91

}

    92

    93

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    94

{

    95

	extern const char _openttd_revision[];

    96

	NetworkGameList *item;

    97

	byte game_info_version;

    98

    99

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

   100

	if (_network_udp_server)

   101

		return;

   102

   103

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   104

   105

	if (_udp_cs.has_quit) return;

   106

   107

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

   108

   109

	// Find next item

   110

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

   111

   112

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

   113

	 * they are to be received */

   114

	switch (game_info_version) {

   115

		case 3:

   116

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

   117

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

   118

			/* Fallthrough */

   119

		case 2:

   120

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

   121

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

   122

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

   123

			/* Fallthrough */

   124

		case 1:

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

			}

   136

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

   137

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

   138

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

   139

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

   140

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

   141

   142

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

   143

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

   144

   145

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

   146

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

   147

   148

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

   149

			item->info.compatible =

   150

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

   151

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

   152

			break;

   153

	}

   154

   155

	item->online = true;

   156

   157

	UpdateNetworkGameWindow(false);

   158

}

   159

   160

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   161

{

   162

	NetworkClientState *cs;

   163

	NetworkClientInfo *ci;

   164

	Packet *packet;

   165

	Player *player;

   166

	byte current = 0;

   167

	int i;

   168

   169

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

   170

	if (!_network_udp_server) 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) continue;

   185

   186

		current++;

   187

   188

		/* Send the information */

   189

		NetworkSend_uint8(packet, current);

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

   198

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

   199

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

   200

			NetworkSend_uint8(packet, 1);

   201

		} else {

   202

			NetworkSend_uint8(packet, 0);

   203

		}

   204

   205

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

   206

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

   207

   208

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

   209

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

   210

   211

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

   212

		FOR_ALL_CLIENTS(cs) {

   213

			ci = DEREF_CLIENT_INFO(cs);

   214

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

   215

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

   216

				NetworkSend_uint8(packet, 1);

   217

				NetworkSend_string(packet, ci->client_name);

   218

				NetworkSend_string(packet, ci->unique_id);

   219

				NetworkSend_uint32(packet, ci->join_date);

   220

			}

   221

		}

   222

		/* Also check for the server itself */

   223

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   224

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

   225

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

   226

			NetworkSend_uint8(packet, 1);

   227

			NetworkSend_string(packet, ci->client_name);

   228

			NetworkSend_string(packet, ci->unique_id);

   229

			NetworkSend_uint32(packet, ci->join_date);

   230

		}

   231

   232

		/* Indicates end of client list */

   233

		NetworkSend_uint8(packet, 0);

   234

	}

   235

   236

	/* And check if we have any spectators */

   237

	FOR_ALL_CLIENTS(cs) {

   238

		ci = DEREF_CLIENT_INFO(cs);

   239

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

   240

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

   241

			NetworkSend_uint8(packet, 1);

   242

			NetworkSend_string(packet, ci->client_name);

   243

			NetworkSend_string(packet, ci->unique_id);

   244

			NetworkSend_uint32(packet, ci->join_date);

   245

		}

   246

	}

   247

   248

	/* Also check for the server itself */

   249

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   250

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

   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_uint32(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

{

   268

	int i;

   269

	struct in_addr ip;

   270

	uint16 port;

   271

	uint8 ver;

   272

   273

	/* packet begins with the protocol version (uint8)

   274

	 * then an uint16 which indicates how many

   275

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

   276

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

   277

	 */

   278

   279

	ver = NetworkRecv_uint8(&_udp_cs, p);

   280

   281

	if (_udp_cs.has_quit) 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

{

   294

	_network_advertise_retries = 0;

   295

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

   296

   297

	if (!_network_advertise) {

   298

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

   299

		NetworkUDPRemoveAdvertise();

   300

	}

   301

}

   302

   303

   304

// The layout for the receive-functions by UDP

   305

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

   306

   307

static NetworkUDPPacket* const _network_udp_packet[] = {

   308

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   309

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   310

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   311

	NULL,

   312

	NULL,

   313

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   314

	NULL,

   315

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   316

	NULL

   317

};

   318

   319

   320

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

   321

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   322

   323

   324

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

   325

{

   326

	byte type;

   327

   328

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

   329

	_udp_cs.socket = INVALID_SOCKET;

   330

	_udp_cs.has_quit = false;

   331

   332

	type = NetworkRecv_uint8(&_udp_cs, p);

   333

   334

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

   335

		_network_udp_packet[type](p, client_addr);

   336

	} else {

   337

		if (!_udp_cs.has_quit) {

   338

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

   339

		} else {

   340

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

   341

		}

   342

	}

   343

}

   344

   345

   346

// Send a packet over UDP

   347

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

   348

{

   349

	int res;

   350

   351

	// Put the length in the buffer

   352

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

   353

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

   354

   355

	// Send the buffer

   356

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

   357

   358

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

   359

	if (res == -1) {

   360

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

   361

	}

   362

}

   363

   364

// Start UDP listener

   365

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

   366

{

   367

	struct sockaddr_in sin;

   368

   369

	// Make sure socket is closed

   370

	closesocket(*udp);

   371

   372

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

   373

	if (*udp == INVALID_SOCKET) {

   374

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

   375

		return false;

   376

	}

   377

   378

	// set nonblocking mode for socket

   379

	{

   380

		unsigned long blocking = 1;

   381

#ifndef BEOS_NET_SERVER

   382

		ioctlsocket(*udp, FIONBIO, &blocking);

   383

#else

   384

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

   385

#endif

   386

	}

   387

   388

	sin.sin_family = AF_INET;

   389

	// Listen on all IPs

   390

	sin.sin_addr.s_addr = host;

   391

	sin.sin_port = htons(port);

   392

   393

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

   394

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

   395

		return false;

   396

	}

   397

   398

	if (broadcast) {

   399

		/* Enable broadcast */

   400

		unsigned long val = 1;

   401

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

   402

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

   403

#endif

   404

	}

   405

   406

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

   407

   408

	return true;

   409

}

   410

   411

// Close UDP connection

   412

void NetworkUDPClose(void)

   413

{

   414

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

   415

   416

	if (_network_udp_server) {

   417

		if (_udp_server_socket != INVALID_SOCKET) {

   418

			closesocket(_udp_server_socket);

   419

			_udp_server_socket = INVALID_SOCKET;

   420

		}

   421

   422

		if (_udp_master_socket != INVALID_SOCKET) {

   423

			closesocket(_udp_master_socket);

   424

			_udp_master_socket = INVALID_SOCKET;

   425

		}

   426

   427

		_network_udp_server = false;

   428

		_network_udp_broadcast = 0;

   429

	} else {

   430

		if (_udp_client_socket != INVALID_SOCKET) {

   431

			closesocket(_udp_client_socket);

   432

			_udp_client_socket = INVALID_SOCKET;

   433

		}

   434

		_network_udp_broadcast = 0;

   435

	}

   436

}

   437

   438

// Receive something on UDP level

   439

void NetworkUDPReceive(SOCKET udp)

   440

{

   441

	struct sockaddr_in client_addr;

   442

	socklen_t client_len;

   443

	int nbytes;

   444

	static Packet *p = NULL;

   445

	int packet_len;

   446

   447

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

   448

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

   449

   450

	packet_len = sizeof(p->buffer);

   451

	client_len = sizeof(client_addr);

   452

   453

	// Try to receive anything

   454

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

   455

   456

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

   457

	if (nbytes > 0) {

   458

		// Get the size of the buffer

   459

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

   460

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

   461

		// Put the position on the right place

   462

		p->pos = 2;

   463

		p->next = NULL;

   464

   465

		// Handle the packet

   466

		NetworkHandleUDPPacket(p, &client_addr);

   467

   468

		// Free the packet

   469

		free(p);

   470

		p = NULL;

   471

	}

   472

}

   473

   474

// Broadcast to all ips

   475

static void NetworkUDPBroadCast(SOCKET udp)

   476

{

   477

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   478

	uint i;

   479

   480

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

   481

		struct sockaddr_in out_addr;

   482

   483

		out_addr.sin_family = AF_INET;

   484

		out_addr.sin_port = htons(_network_server_port);

   485

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   486

   487

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

   488

   489

		NetworkSendUDP_Packet(udp, p, &out_addr);

   490

	}

   491

   492

	free(p);

   493

}

   494

   495

   496

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