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

	NetworkSend_string(packet, _network_game_info.server_name);

    65

	NetworkSend_string(packet, _network_game_info.server_revision);

    66

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    67

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    68

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    69

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    70

	NetworkSend_uint8 (packet, _network_game_info.spectators_on);

    71

	NetworkSend_uint16(packet, _network_game_info.game_date);

    72

	NetworkSend_uint16(packet, _network_game_info.start_date);

    73

	NetworkSend_string(packet, _network_game_info.map_name);

    74

	NetworkSend_uint16(packet, _network_game_info.map_width);

    75

	NetworkSend_uint16(packet, _network_game_info.map_height);

    76

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    77

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    78

    79

	// Let the client know that we are here

    80

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    81

    82

	free(packet);

    83

    84

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

    85

}

    86

    87

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    88

{

    89

	NetworkGameList *item;

    90

	byte game_info_version;

    91

    92

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

    93

	if (_network_udp_server)

    94

		return;

    95

    96

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

    97

    98

	if (_udp_cs.quited)

    99

		return;

   100

   101

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

   102

   103

	// Find next item

   104

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

   105

   106

	if (game_info_version == 1) {

   107

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

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

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

   118

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

   119

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

   120

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

   121

   122

		str_validate(item->info.server_name);

   123

		str_validate(item->info.server_revision);

   124

		str_validate(item->info.map_name);

   125

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

   126

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

   127

   128

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

   129

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

   130

	}

   131

   132

	item->online = true;

   133

   134

	UpdateNetworkGameWindow(false);

   135

}

   136

   137

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   138

{

   139

	NetworkClientState *cs;

   140

	NetworkClientInfo *ci;

   141

	Packet *packet;

   142

	Player *player;

   143

	byte active = 0;

   144

	byte current = 0;

   145

	int i;

   146

   147

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

   148

	if (!_network_udp_server)

   149

		return;

   150

   151

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   152

   153

	FOR_ALL_PLAYERS(player) {

   154

		if (player->is_active)

   155

			active++;

   156

	}

   157

   158

	/* Send the amount of active companies */

   159

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   160

	NetworkSend_uint8 (packet, active);

   161

   162

	/* Fetch the latest version of everything */

   163

	NetworkPopulateCompanyInfo();

   164

   165

	/* Go through all the players */

   166

	FOR_ALL_PLAYERS(player) {

   167

		/* Skip non-active players */

   168

		if (!player->is_active)

   169

			continue;

   170

   171

		current++;

   172

   173

		/* Send the information */

   174

		NetworkSend_uint8 (packet, current);

   175

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

   183

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

   184

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

   185

			NetworkSend_uint8 (packet, 1);

   186

		} else {

   187

			NetworkSend_uint8 (packet, 0);

   188

		}

   189

   190

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

   191

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

   192

   193

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

   194

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

   195

   196

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

   197

		FOR_ALL_CLIENTS(cs) {

   198

			ci = DEREF_CLIENT_INFO(cs);

   199

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

   200

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

   201

				NetworkSend_uint8(packet, 1);

   202

				NetworkSend_string(packet, ci->client_name);

   203

				NetworkSend_string(packet, ci->unique_id);

   204

				NetworkSend_uint16(packet, ci->join_date);

   205

			}

   206

		}

   207

		/* Also check for the server itself */

   208

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   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

		/* Indicates end of client list */

   218

		NetworkSend_uint8(packet, 0);

   219

	}

   220

   221

	/* And check if we have any spectators */

   222

	FOR_ALL_CLIENTS(cs) {

   223

		ci = DEREF_CLIENT_INFO(cs);

   224

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

   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_uint16(packet, ci->join_date);

   230

		}

   231

	}

   232

	/* Also check for the server itself */

   233

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   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

	/* Indicates end of client list */

   243

	NetworkSend_uint8(packet, 0);

   244

   245

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   246

   247

	free(packet);

   248

}

   249

   250

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST) {

   251

	int i;

   252

	struct in_addr ip;

   253

	uint16 port;

   254

	uint8 ver;

   255

   256

	/* packet begins with the protocol version (uint8)

   257

	 * then an uint16 which indicates how many

   258

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

   259

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

   260

	 */

   261

   262

	ver = NetworkRecv_uint8(&_udp_cs, p);

   263

   264

	if (_udp_cs.quited)

   265

		return;

   266

   267

	if (ver == 1) {

   268

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

   269

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

   270

			port = NetworkRecv_uint16(&_udp_cs, p);

   271

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   272

		}

   273

	}

   274

}

   275

   276

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER) {

   277

	_network_advertise_retries = 0;

   278

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

   279

   280

	if (!_network_advertise)

   281

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

   282

		NetworkUDPRemoveAdvertise();

   283

}

   284

   285

   286

// The layout for the receive-functions by UDP

   287

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

   288

   289

static NetworkUDPPacket* const _network_udp_packet[] = {

   290

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   291

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   292

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   293

	NULL,

   294

	NULL,

   295

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   296

	NULL,

   297

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   298

	NULL

   299

};

   300

   301

   302

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

   303

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   304

   305

   306

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

   307

{

   308

	byte type;

   309

   310

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

   311

	_udp_cs.socket = INVALID_SOCKET;

   312

	_udp_cs.quited = false;

   313

   314

	type = NetworkRecv_uint8(&_udp_cs, p);

   315

   316

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

   317

		_network_udp_packet[type](p, client_addr);

   318

	}	else {

   319

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

   320

	}

   321

}

   322

   323

   324

// Send a packet over UDP

   325

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

   326

{

   327

	int res;

   328

   329

	// Put the length in the buffer

   330

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

   331

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

   332

   333

	// Send the buffer

   334

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

   335

   336

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

   337

	if (res == -1) {

   338

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

   339

	}

   340

}

   341

   342

// Start UDP listener

   343

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

   344

{

   345

	struct sockaddr_in sin;

   346

   347

	// Make sure socket is closed

   348

	closesocket(*udp);

   349

   350

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

   351

	if (*udp == INVALID_SOCKET) {

   352

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

   353

		return false;

   354

	}

   355

   356

	// set nonblocking mode for socket

   357

	{

   358

		unsigned long blocking = 1;

   359

#ifndef BEOS_NET_SERVER

   360

		ioctlsocket(*udp, FIONBIO, &blocking);

   361

#else

   362

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

   363

#endif

   364

	}

   365

   366

	sin.sin_family = AF_INET;

   367

	// Listen on all IPs

   368

	sin.sin_addr.s_addr = host;

   369

	sin.sin_port = htons(port);

   370

   371

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

   372

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

   373

		return false;

   374

	}

   375

   376

	if (broadcast) {

   377

		/* Enable broadcast */

   378

		unsigned long val = 1;

   379

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

   380

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

   381

#endif

   382

	}

   383

   384

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

   385

   386

	return true;

   387

}

   388

   389

// Close UDP connection

   390

void NetworkUDPClose(void)

   391

{

   392

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

   393

   394

	if (_network_udp_server) {

   395

		if (_udp_server_socket != INVALID_SOCKET) {

   396

			closesocket(_udp_server_socket);

   397

			_udp_server_socket = INVALID_SOCKET;

   398

		}

   399

   400

		if (_udp_master_socket != INVALID_SOCKET) {

   401

			closesocket(_udp_master_socket);

   402

			_udp_master_socket = INVALID_SOCKET;

   403

		}

   404

   405

		_network_udp_server = false;

   406

		_network_udp_broadcast = 0;

   407

	} else {

   408

		if (_udp_client_socket != INVALID_SOCKET) {

   409

			closesocket(_udp_client_socket);

   410

			_udp_client_socket = INVALID_SOCKET;

   411

		}

   412

		_network_udp_broadcast = 0;

   413

	}

   414

}

   415

   416

// Receive something on UDP level

   417

void NetworkUDPReceive(SOCKET udp)

   418

{

   419

	struct sockaddr_in client_addr;

   420

	socklen_t client_len;

   421

	int nbytes;

   422

	static Packet *p = NULL;

   423

	int packet_len;

   424

   425

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

   426

	if (p == NULL)

   427

		p = malloc(sizeof(Packet));

   428

   429

	packet_len = sizeof(p->buffer);

   430

	client_len = sizeof(client_addr);

   431

   432

	// Try to receive anything

   433

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

   434

   435

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

   436

	if (nbytes > 0) {

   437

		// Get the size of the buffer

   438

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

   439

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

   440

		// Put the position on the right place

   441

		p->pos = 2;

   442

		p->next = NULL;

   443

   444

		// Handle the packet

   445

		NetworkHandleUDPPacket(p, &client_addr);

   446

   447

		// Free the packet

   448

		free(p);

   449

		p = NULL;

   450

	}

   451

}

   452

   453

// Broadcast to all ips

   454

static void NetworkUDPBroadCast(SOCKET udp)

   455

{

   456

	int i;

   457

	struct sockaddr_in out_addr;

   458

	byte *bcptr;

   459

	uint32 bcaddr;

   460

	Packet *p;

   461

   462

	// Init the packet

   463

	p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   464

   465

	// Go through all the ips on this pc

   466

	i = 0;

   467

	while (_network_ip_list[i] != 0) {

   468

		bcaddr = _network_ip_list[i];

   469

		bcptr = (byte *)&bcaddr;

   470

		// Make the address a broadcast address

   471

		bcptr[3] = 255;

   472

   473

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

   474

   475

		out_addr.sin_family = AF_INET;

   476

		out_addr.sin_port = htons(_network_server_port);

   477

		out_addr.sin_addr.s_addr = bcaddr;

   478

   479

		NetworkSendUDP_Packet(udp, p, &out_addr);

   480

   481

		i++;

   482

	}

   483

}

   484

   485

   486

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

   487

void NetworkUDPQueryMasterServer(void)

   488

{

   489

	struct sockaddr_in out_addr;

   490

	Packet *p;

   491

   492

	if (_udp_client_socket == INVALID_SOCKET)

   493

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

   494

			return;

   495

   496

	p = NetworkSend_Init(PACKET_UDP_CLIENT_GET_LIST);

   497

   498

	out_addr.sin_family = AF_INET;

   499

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   500

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   501

   502

	// packet only contains protocol version

   503

	NetworkSend_uint8(p, NETWORK_MASTER_SERVER_VERSION);