1

#include "stdafx.h"

     2

#include "debug.h"

     3

#include "string.h"

     4

#include "network_data.h"

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "map.h"

     9

#include "network_gamelist.h"

    10

#include "network_udp.h"

    11

    12

extern void UpdateNetworkGameWindow(bool unselect);

    13

extern void NetworkPopulateCompanyInfo(void);

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

    36

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

    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

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

    42

    43

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

	NetworkSend_string(packet, _network_game_info.server_name);

    62

	NetworkSend_string(packet, _network_game_info.server_revision);

    63

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    64

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    65

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    66

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    67

	NetworkSend_uint8 (packet, _network_game_info.spectators_on);

    68

	NetworkSend_uint16(packet, _network_game_info.game_date);

    69

	NetworkSend_uint16(packet, _network_game_info.start_date);

    70

	NetworkSend_string(packet, _network_game_info.map_name);

    71

	NetworkSend_uint16(packet, _network_game_info.map_width);

    72

	NetworkSend_uint16(packet, _network_game_info.map_height);

    73

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    74

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    75

    76

	// Let the client know that we are here

    77

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    78

    79

	free(packet);

    80

    81

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

    82

}

    83

    84

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    85

{

    86

	NetworkGameList *item;

    87

	byte game_info_version;

    88

    89

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

    90

	if (_network_udp_server)

    91

		return;

    92

    93

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

    94

    95

	if (_udp_cs.quited)

    96

		return;

    97

    98

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

    99

   100

	// Find next item

   101

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

   102

   103

	if (game_info_version == 1) {

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

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

   118

   119

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

   120

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

   121

	}

   122

   123

	item->online = true;

   124

   125

	UpdateNetworkGameWindow(false);

   126

}

   127

   128

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   129

{

   130

	NetworkClientState *cs;

   131

	NetworkClientInfo *ci;

   132

	Packet *packet;

   133

	Player *player;

   134

	byte active = 0;

   135

	byte current = 0;

   136

	int i;

   137

   138

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

   139

	if (!_network_udp_server)

   140

		return;

   141

   142

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   143

   144

	FOR_ALL_PLAYERS(player) {

   145

		if (player->is_active)

   146

			active++;

   147

	}

   148

   149

	/* Send the amount of active companies */

   150

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   151

	NetworkSend_uint8 (packet, active);

   152

   153

	/* Fetch the latest version of everything */

   154

	NetworkPopulateCompanyInfo();

   155

   156

	/* Go through all the players */

   157

	FOR_ALL_PLAYERS(player) {

   158

		/* Skip non-active players */

   159

		if (!player->is_active)

   160

			continue;

   161

   162

		current++;

   163

   164

		/* Send the information */

   165

		NetworkSend_uint8 (packet, current);

   166

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

   174

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

   175

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

   176

			NetworkSend_uint8 (packet, 1);

   177

		} else {

   178

			NetworkSend_uint8 (packet, 0);

   179

		}

   180

   181

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

   182

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

   183

   184

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

   185

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

   186

   187

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

   188

		FOR_ALL_CLIENTS(cs) {

   189

			ci = DEREF_CLIENT_INFO(cs);

   190

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

   191

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

   192

				NetworkSend_uint8(packet, 1);

   193

				NetworkSend_string(packet, ci->client_name);

   194

				NetworkSend_string(packet, ci->unique_id);

   195

				NetworkSend_uint16(packet, ci->join_date);

   196

			}

   197

		}

   198

		/* Also check for the server itself */

   199

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   200

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

   201

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

   202

			NetworkSend_uint8(packet, 1);

   203

			NetworkSend_string(packet, ci->client_name);

   204

			NetworkSend_string(packet, ci->unique_id);

   205

			NetworkSend_uint16(packet, ci->join_date);

   206

		}

   207

   208

		/* Indicates end of client list */

   209

		NetworkSend_uint8(packet, 0);

   210

	}

   211

   212

	/* And check if we have any spectators */

   213

	FOR_ALL_CLIENTS(cs) {

   214

		ci = DEREF_CLIENT_INFO(cs);

   215

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

   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) > MAX_PLAYERS) {

   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

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   237

   238

	free(packet);

   239

}

   240

   241

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST) {

   242

	int i;

   243

	struct in_addr ip;

   244

	uint16 port;

   245

	uint8 ver;

   246

   247

	/* packet begins with the protocol version (uint8)

   248

	 * then an uint16 which indicates how many

   249

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

   250

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

   251

	 */

   252

   253

	ver = NetworkRecv_uint8(&_udp_cs, p);

   254

   255

	if (_udp_cs.quited)

   256

		return;

   257

   258

	if (ver == 1) {

   259

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

   260

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

   261

			port = NetworkRecv_uint16(&_udp_cs, p);

   262

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   263

		}

   264

	}

   265

}

   266

   267

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER) {

   268

	_network_advertise_retries = 0;

   269

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

   270

   271

	if (!_network_advertise)

   272

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

   273

		NetworkUDPRemoveAdvertise();

   274

}

   275

   276

   277

// The layout for the receive-functions by UDP

   278

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

   279

   280

static NetworkUDPPacket* const _network_udp_packet[] = {

   281

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   282

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   283

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   284

	NULL,

   285

	NULL,

   286

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   287

	NULL,

   288

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   289

	NULL

   290

};

   291

   292

   293

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

   294

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   295

   296

   297

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

   298

{

   299

	byte type;

   300

   301

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

   302

	_udp_cs.socket = INVALID_SOCKET;

   303

	_udp_cs.quited = false;

   304

   305

	type = NetworkRecv_uint8(&_udp_cs, p);

   306

   307

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

   308

		_network_udp_packet[type](p, client_addr);

   309

	}	else {

   310

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

   311

	}

   312

}

   313

   314

   315

// Send a packet over UDP

   316

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

   317

{

   318

	int res;

   319

   320

	// Put the length in the buffer

   321

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

   322

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

   323

   324

	// Send the buffer

   325

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

   326

   327

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

   328

	if (res == -1) {

   329

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

   330

	}

   331

}

   332

   333

// Start UDP listener

   334

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

   335

{

   336

	struct sockaddr_in sin;

   337

   338

	// Make sure socket is closed

   339

	closesocket(*udp);

   340

   341

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

   342

	if (*udp == INVALID_SOCKET) {

   343

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

   344

		return false;

   345

	}

   346

   347

	// set nonblocking mode for socket

   348

	{

   349

		unsigned long blocking = 1;

   350

		ioctlsocket(*udp, FIONBIO, &blocking);

   351

	}

   352

   353

	sin.sin_family = AF_INET;

   354

	// Listen on all IPs

   355

	sin.sin_addr.s_addr = host;

   356

	sin.sin_port = htons(port);

   357

   358

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

   359

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

   360

		return false;

   361

	}

   362

   363

	if (broadcast) {

   364

		/* Enable broadcast */

   365

		unsigned long val = 1;

   366

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

   367

	}

   368

   369

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

   370

   371

	return true;

   372

}

   373

   374

// Close UDP connection

   375

void NetworkUDPClose(void)

   376

{

   377

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

   378

   379

	if (_network_udp_server) {

   380

		if (_udp_server_socket != INVALID_SOCKET) {

   381

			closesocket(_udp_server_socket);

   382

			_udp_server_socket = INVALID_SOCKET;

   383

		}

   384

   385

		if (_udp_master_socket != INVALID_SOCKET) {

   386

			closesocket(_udp_master_socket);

   387

			_udp_master_socket = INVALID_SOCKET;

   388

		}

   389

   390

		_network_udp_server = false;

   391

		_network_udp_broadcast = 0;

   392

	} else {

   393

		if (_udp_client_socket != INVALID_SOCKET) {

   394

			closesocket(_udp_client_socket);

   395

			_udp_client_socket = INVALID_SOCKET;

   396

		}

   397

		_network_udp_broadcast = 0;

   398

	}

   399

}

   400

   401

// Receive something on UDP level

   402

void NetworkUDPReceive(SOCKET udp)

   403

{

   404

	struct sockaddr_in client_addr;

   405

	socklen_t client_len;

   406

	int nbytes;

   407

	static Packet *p = NULL;

   408

	int packet_len;

   409

   410

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

   411

	if (p == NULL)

   412

		p = malloc(sizeof(Packet));

   413

   414

	packet_len = sizeof(p->buffer);

   415

	client_len = sizeof(client_addr);

   416

   417

	// Try to receive anything

   418

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

   419

   420

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

   421

	if (nbytes > 0) {

   422

		// Get the size of the buffer

   423

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

   424

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

   425

		// Put the position on the right place

   426

		p->pos = 2;

   427

		p->next = NULL;

   428

   429

		// Handle the packet

   430

		NetworkHandleUDPPacket(p, &client_addr);

   431

   432

		// Free the packet

   433

		free(p);

   434

		p = NULL;

   435

	}

   436

}

   437

   438

// Broadcast to all ips

   439

void NetworkUDPBroadCast(SOCKET udp)

   440

{

   441

	int i;

   442

	struct sockaddr_in out_addr;

   443

	byte *bcptr;

   444

	uint32 bcaddr;

   445

	Packet *p;

   446

   447

	// Init the packet

   448

	p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   449

   450

	// Go through all the ips on this pc

   451

	i = 0;

   452

	while (_network_ip_list[i] != 0) {

   453

		bcaddr = _network_ip_list[i];

   454

		bcptr = (byte *)&bcaddr;

   455

		// Make the address a broadcast address

   456

		bcptr[3] = 255;

   457

   458

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

   459

   460

		out_addr.sin_family = AF_INET;

   461

		out_addr.sin_port = htons(_network_server_port);

   462

		out_addr.sin_addr.s_addr = bcaddr;

   463

   464

		NetworkSendUDP_Packet(udp, p, &out_addr);

   465

   466

		i++;

   467

	}

   468

}

   469

   470

   471

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

   472

void NetworkUDPQueryMasterServer(void)

   473

{

   474

	struct sockaddr_in out_addr;

   475

	Packet *p;

   476

   477

	if (_udp_client_socket == INVALID_SOCKET)

   478

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

   479

			return;

   480

   481

	p = NetworkSend_Init(PACKET_UDP_CLIENT_GET_LIST);

   482

   483

	out_addr.sin_family = AF_INET;

   484

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   485

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   486

   487

	// packet only contains protocol version

   488

	NetworkSend_uint8(p, NETWORK_MASTER_SERVER_VERSION);

   489

   490

	NetworkSendUDP_Packet(_udp_client_socket, p, &out_addr);

   491

   492

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

   493

   494

	free(p);

   495

}

   496

   497

// Find all servers

   498

void NetworkUDPSearchGame(void)

   499

{

   500

	// We are still searching..

   501

	if (_network_udp_broadcast > 0)

   502

		return;

   503

   504

	// No UDP-socket yet..

   505