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 = 450,	// interval between advertising in days

    39

	ADVERTISE_RETRY_INTERVAL = 5,			// readvertise when no response after this amount of days

    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

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

    45

    46

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

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

   123

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

   124

	}

   125

   126

	item->online = true;

   127

   128

	UpdateNetworkGameWindow(false);

   129

}

   130

   131

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   132

{

   133

	NetworkClientState *cs;

   134

	NetworkClientInfo *ci;

   135

	Packet *packet;

   136

	Player *player;

   137

	byte active = 0;

   138

	byte current = 0;

   139

	int i;

   140

   141

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

   142

	if (!_network_udp_server)

   143

		return;

   144

   145

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   146

   147

	FOR_ALL_PLAYERS(player) {

   148

		if (player->is_active)

   149

			active++;

   150

	}

   151

   152

	/* Send the amount of active companies */

   153

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   154

	NetworkSend_uint8 (packet, active);

   155

   156

	/* Fetch the latest version of everything */

   157

	NetworkPopulateCompanyInfo();

   158

   159

	/* Go through all the players */

   160

	FOR_ALL_PLAYERS(player) {

   161

		/* Skip non-active players */

   162

		if (!player->is_active)

   163

			continue;

   164

   165

		current++;

   166

   167

		/* Send the information */

   168

		NetworkSend_uint8 (packet, current);

   169

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

   177

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

   178

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

   179

			NetworkSend_uint8 (packet, 1);

   180

		} else {

   181

			NetworkSend_uint8 (packet, 0);

   182

		}

   183

   184

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

   185

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

   186

   187

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

   188

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

   189

   190

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

   191

		FOR_ALL_CLIENTS(cs) {

   192

			ci = DEREF_CLIENT_INFO(cs);

   193

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

   194

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

   195

				NetworkSend_uint8(packet, 1);

   196

				NetworkSend_string(packet, ci->client_name);

   197

				NetworkSend_string(packet, ci->unique_id);

   198

				NetworkSend_uint16(packet, ci->join_date);

   199

			}

   200

		}

   201

		/* Also check for the server itself */

   202

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   203

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

   204

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

   205

			NetworkSend_uint8(packet, 1);

   206

			NetworkSend_string(packet, ci->client_name);

   207

			NetworkSend_string(packet, ci->unique_id);

   208

			NetworkSend_uint16(packet, ci->join_date);

   209

		}

   210

   211

		/* Indicates end of client list */

   212

		NetworkSend_uint8(packet, 0);

   213

	}

   214

   215

	/* And check if we have any spectators */

   216

	FOR_ALL_CLIENTS(cs) {

   217

		ci = DEREF_CLIENT_INFO(cs);

   218

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

   219

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

   220

			NetworkSend_uint8(packet, 1);

   221

			NetworkSend_string(packet, ci->client_name);

   222

			NetworkSend_string(packet, ci->unique_id);

   223

			NetworkSend_uint16(packet, ci->join_date);

   224

		}

   225

	}

   226

	/* Also check for the server itself */

   227

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   228

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

   229

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

   230

		NetworkSend_uint8(packet, 1);

   231

		NetworkSend_string(packet, ci->client_name);

   232

		NetworkSend_string(packet, ci->unique_id);

   233

		NetworkSend_uint16(packet, ci->join_date);

   234

	}

   235

   236

	/* Indicates end of client list */

   237

	NetworkSend_uint8(packet, 0);

   238

   239

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   240

   241

	free(packet);

   242

}

   243

   244

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST) {

   245

	int i;

   246

	struct in_addr ip;

   247

	uint16 port;

   248

	uint8 ver;

   249

   250

	/* packet begins with the protocol version (uint8)

   251

	 * then an uint16 which indicates how many

   252

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

   253

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

   254

	 */

   255

   256

	ver = NetworkRecv_uint8(&_udp_cs, p);

   257

   258

	if (_udp_cs.quited)

   259

		return;

   260

   261

	if (ver == 1) {

   262

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

   263

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

   264

			port = NetworkRecv_uint16(&_udp_cs, p);

   265

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   266

		}

   267

	}

   268

}

   269

   270

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER) {

   271

	_network_advertise_retries = 0;

   272

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

   273

   274

	if (!_network_advertise)

   275

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

   276

		NetworkUDPRemoveAdvertise();

   277

}

   278

   279

   280

// The layout for the receive-functions by UDP

   281

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

   282

   283

static NetworkUDPPacket* const _network_udp_packet[] = {

   284

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   285

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   286

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   287

	NULL,

   288

	NULL,

   289

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   290

	NULL,

   291

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   292

	NULL

   293

};

   294

   295

   296

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

   297

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   298

   299

   300

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

   301

{

   302

	byte type;

   303

   304

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

   305

	_udp_cs.socket = INVALID_SOCKET;

   306

	_udp_cs.quited = false;

   307

   308

	type = NetworkRecv_uint8(&_udp_cs, p);

   309

   310

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

   311

		_network_udp_packet[type](p, client_addr);

   312

	}	else {

   313

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

   314

	}

   315

}

   316

   317

   318

// Send a packet over UDP

   319

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

   320

{

   321

	int res;

   322

   323

	// Put the length in the buffer

   324

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

   325

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

   326

   327

	// Send the buffer

   328

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

   329

   330

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

   331

	if (res == -1) {

   332

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

   333

	}

   334

}

   335

   336

// Start UDP listener

   337

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

   338

{

   339

	struct sockaddr_in sin;

   340

   341

	// Make sure socket is closed

   342

	closesocket(*udp);

   343

   344

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

   345

	if (*udp == INVALID_SOCKET) {

   346

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

   347

		return false;

   348

	}

   349

   350

	// set nonblocking mode for socket

   351

	{

   352

		unsigned long blocking = 1;

   354

		ioctlsocket(*udp, FIONBIO, &blocking);

   358

	}

   359

   360

	sin.sin_family = AF_INET;

   361

	// Listen on all IPs

   362

	sin.sin_addr.s_addr = host;

   363

	sin.sin_port = htons(port);

   364

   365

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

   366

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

   367

		return false;

   368

	}

   369

   370

	if (broadcast) {

   371

		/* Enable broadcast */

   372

		unsigned long val = 1;

   374

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

   376

	}

   377

   378

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

   379

   380

	return true;

   381

}

   382

   383

// Close UDP connection

   384

void NetworkUDPClose(void)

   385

{

   386

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

   387

   388

	if (_network_udp_server) {

   389

		if (_udp_server_socket != INVALID_SOCKET) {

   390

			closesocket(_udp_server_socket);

   391

			_udp_server_socket = INVALID_SOCKET;

   392

		}

   393

   394

		if (_udp_master_socket != INVALID_SOCKET) {

   395

			closesocket(_udp_master_socket);

   396

			_udp_master_socket = INVALID_SOCKET;

   397

		}

   398

   399

		_network_udp_server = false;

   400

		_network_udp_broadcast = 0;

   401

	} else {

   402

		if (_udp_client_socket != INVALID_SOCKET) {

   403

			closesocket(_udp_client_socket);

   404

			_udp_client_socket = INVALID_SOCKET;

   405

		}

   406

		_network_udp_broadcast = 0;

   407

	}

   408

}

   409

   410

// Receive something on UDP level

   411

void NetworkUDPReceive(SOCKET udp)

   412

{

   413

	struct sockaddr_in client_addr;

   414

	socklen_t client_len;

   415

	int nbytes;

   416

	static Packet *p = NULL;

   417

	int packet_len;

   418

   419

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

   420

	if (p == NULL)

   421

		p = malloc(sizeof(Packet));

   422

   423

	packet_len = sizeof(p->buffer);

   424

	client_len = sizeof(client_addr);

   425

   426

	// Try to receive anything

   427

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

   428

   429

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

   430

	if (nbytes > 0) {

   431

		// Get the size of the buffer

   432

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

   433

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

   434

		// Put the position on the right place

   435

		p->pos = 2;

   436

		p->next = NULL;

   437

   438

		// Handle the packet

   439

		NetworkHandleUDPPacket(p, &client_addr);

   440

   441

		// Free the packet

   442

		free(p);

   443

		p = NULL;

   444

	}

   445

}

   446

   447

// Broadcast to all ips

   448

void NetworkUDPBroadCast(SOCKET udp)

   449

{

   450

	int i;

   451

	struct sockaddr_in out_addr;

   452

	byte *bcptr;

   453

	uint32 bcaddr;

   454

	Packet *p;

   455

   456

	// Init the packet

   457

	p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   458

   459

	// Go through all the ips on this pc

   460

	i = 0;

   461

	while (_network_ip_list[i] != 0) {

   462

		bcaddr = _network_ip_list[i];

   463

		bcptr = (byte *)&bcaddr;

   464

		// Make the address a broadcast address

   465

		bcptr[3] = 255;

   466

   467

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

   468

   469

		out_addr.sin_family = AF_INET;

   470

		out_addr.sin_port = htons(_network_server_port);

   471

		out_addr.sin_addr.s_addr = bcaddr;

   472

   473

		NetworkSendUDP_Packet(udp, p, &out_addr);

   474

   475

		i++;

   476

	}

   477

}

   478

   479

   480

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

   481

void NetworkUDPQueryMasterServer(void)

   482

{

   483

	struct sockaddr_in out_addr;

   484

	Packet *p;

   485

   486

	if (_udp_client_socket == INVALID_SOCKET)

   487

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

   488

			return;

   489

   490

	p = NetworkSend_Init(PACKET_UDP_CLIENT_GET_LIST);

   491

   492

	out_addr.sin_family = AF_INET;

   493

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   494

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   495

   496

	// packet only contains protocol version

   497

	NetworkSend_uint8(p, NETWORK_MASTER_SERVER_VERSION);

   498

   499

	NetworkSendUDP_Packet(_udp_client_socket, p, &out_addr);

   500

   501

	DEBUG(net, 2)("[NET][UDP] Queried Master Server at %s:%d", inet_ntoa(out_addr.sin_addr),ntohs(out_addr.sin_port));

   502

   503

	free(p);

   504

}