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

    65

	/* NETWORK_GAME_INFO_VERSION = 2 */

    66

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

    67

	NetworkSend_uint8 (packet, _network_game_info.companies_on);

    68

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

    69

    70

	/* NETWORK_GAME_INFO_VERSION = 1 */

    71

	NetworkSend_string(packet, _network_game_info.server_name);

    72

	NetworkSend_string(packet, _network_game_info.server_revision);

    73

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    74

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    75

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    76

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    77

	NetworkSend_uint8 (packet, _network_game_info.spectators_on);

    78

	NetworkSend_uint16(packet, _network_game_info.game_date);

    79

	NetworkSend_uint16(packet, _network_game_info.start_date);

    80

	NetworkSend_string(packet, _network_game_info.map_name);

    81

	NetworkSend_uint16(packet, _network_game_info.map_width);

    82

	NetworkSend_uint16(packet, _network_game_info.map_height);

    83

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    84

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    85

    86

	// Let the client know that we are here

    87

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    88

    89

	free(packet);

    90

    91

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

    92

}

    93

    94

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    95

{

    96

	extern const char _openttd_revision[];

    97

	NetworkGameList *item;

    98

	byte game_info_version;

    99

   100

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

   101

	if (_network_udp_server)

   102

		return;

   103

   104

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   105

   106

	if (_udp_cs.quited) return;

   107

   108

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

   109

   110

	// Find next item

   111

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

   112

   113

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

   114

	 * they are to be received */

   115

	switch (game_info_version) {

   116

		case 2:

   117

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

   118

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

   119

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

   120

			/* Fallthrough */

   121

		case 1:

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

   137

			str_validate(item->info.server_name);

   138

			str_validate(item->info.server_revision);

   139

			str_validate(item->info.map_name);

   140

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

   141

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

   142

   143

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

   144

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

   145

   146

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

   147

			item->info.compatible = (

   148

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

   149

			strncmp(item->info.server_revision, NOREV_STRING, NETWORK_REVISION_LENGTH) == 0) ? true : false;

   150

   151

			break;

   152

	}

   153

   154

	item->online = true;

   155

   156

	UpdateNetworkGameWindow(false);

   157

}

   158

   159

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   160

{

   161

	NetworkClientState *cs;

   162

	NetworkClientInfo *ci;

   163

	Packet *packet;

   164

	Player *player;

   165

	byte active = 0;

   166

	byte current = 0;

   167

	int i;

   168

   169

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

   170

	if (!_network_udp_server)

   171

		return;

   172

   173

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   174

   175

	FOR_ALL_PLAYERS(player) {

   176

		if (player->is_active)

   177

			active++;

   178

	}

   179

   180

	/* Send the amount of active companies */

   181

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   182

	NetworkSend_uint8 (packet, active);

   183

   184

	/* Fetch the latest version of everything */

   185

	NetworkPopulateCompanyInfo();

   186

   187

	/* Go through all the players */

   188

	FOR_ALL_PLAYERS(player) {

   189

		/* Skip non-active players */

   190

		if (!player->is_active)

   191

			continue;

   192

   193

		current++;

   194

   195

		/* Send the information */

   196

		NetworkSend_uint8 (packet, current);

   197

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

   205

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

   206

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

   207

			NetworkSend_uint8 (packet, 1);

   208

		} else {

   209

			NetworkSend_uint8 (packet, 0);

   210

		}

   211

   212

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

   213

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

   214

   215

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

   216

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

   217

   218

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

   219

		FOR_ALL_CLIENTS(cs) {

   220

			ci = DEREF_CLIENT_INFO(cs);

   221

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

   222

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

   223

				NetworkSend_uint8(packet, 1);

   224

				NetworkSend_string(packet, ci->client_name);

   225

				NetworkSend_string(packet, ci->unique_id);

   226

				NetworkSend_uint16(packet, ci->join_date);

   227

			}

   228

		}

   229

		/* Also check for the server itself */

   230

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   231

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

   232

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

   233

			NetworkSend_uint8(packet, 1);

   234

			NetworkSend_string(packet, ci->client_name);

   235

			NetworkSend_string(packet, ci->unique_id);

   236

			NetworkSend_uint16(packet, ci->join_date);

   237

		}

   238

   239

		/* Indicates end of client list */

   240

		NetworkSend_uint8(packet, 0);

   241

	}

   242

   243

	/* And check if we have any spectators */

   244

	FOR_ALL_CLIENTS(cs) {

   245

		ci = DEREF_CLIENT_INFO(cs);

   246

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

   247

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

   248

			NetworkSend_uint8(packet, 1);

   249

			NetworkSend_string(packet, ci->client_name);

   250

			NetworkSend_string(packet, ci->unique_id);

   251

			NetworkSend_uint16(packet, ci->join_date);

   252

		}

   253

	}

   254

	/* Also check for the server itself */

   255

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   256

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

   257

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

   258

		NetworkSend_uint8(packet, 1);

   259

		NetworkSend_string(packet, ci->client_name);

   260

		NetworkSend_string(packet, ci->unique_id);

   261

		NetworkSend_uint16(packet, ci->join_date);

   262

	}

   263

   264

	/* Indicates end of client list */

   265

	NetworkSend_uint8(packet, 0);

   266

   267

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   268

   269

	free(packet);

   270

}

   271

   272

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST) {

   273

	int i;

   274

	struct in_addr ip;

   275

	uint16 port;

   276

	uint8 ver;

   277

   278

	/* packet begins with the protocol version (uint8)

   279

	 * then an uint16 which indicates how many

   280

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

   281

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

   282

	 */

   283

   284

	ver = NetworkRecv_uint8(&_udp_cs, p);

   285

   286

	if (_udp_cs.quited)

   287

		return;

   288

   289

	if (ver == 1) {

   290

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

   291

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

   292

			port = NetworkRecv_uint16(&_udp_cs, p);

   293

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   294

		}

   295

	}

   296

}

   297

   298

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER) {

   299

	_network_advertise_retries = 0;

   300

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

   301

   302

	if (!_network_advertise)

   303

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

   304

		NetworkUDPRemoveAdvertise();

   305

}

   306

   307

   308

// The layout for the receive-functions by UDP

   309

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

   310

   311

static NetworkUDPPacket* const _network_udp_packet[] = {

   312

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   313

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   314

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   315

	NULL,

   316

	NULL,

   317

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   318

	NULL,

   319

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   320

	NULL

   321

};

   322

   323

   324

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

   325

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   326

   327

   328

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

   329

{

   330

	byte type;

   331

   332

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

   333

	_udp_cs.socket = INVALID_SOCKET;

   334

	_udp_cs.quited = false;

   335

   336

	type = NetworkRecv_uint8(&_udp_cs, p);

   337

   338

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

   339

		_network_udp_packet[type](p, client_addr);

   340

	}	else {

   341

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

   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)

   449

		p = malloc(sizeof(Packet));

   450

   451

	packet_len = sizeof(p->buffer);

   452

	client_len = sizeof(client_addr);

   453

   454

	// Try to receive anything

   455

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

   456

   457

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

   458

	if (nbytes > 0) {

   459

		// Get the size of the buffer

   460

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

   461

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

   462

		// Put the position on the right place

   463

		p->pos = 2;

   464

		p->next = NULL;

   465

   466

		// Handle the packet

   467

		NetworkHandleUDPPacket(p, &client_addr);

   468

   469

		// Free the packet

   470

		free(p);

   471

		p = NULL;

   472

	}

   473

}

   474

   475

// Broadcast to all ips

   476

static void NetworkUDPBroadCast(SOCKET udp)

   477

{

   478

	int i;

   479

	struct sockaddr_in out_addr;

   480

	byte *bcptr;

   481

	uint32 bcaddr;

   482

	Packet *p;

   483

   484

	// Init the packet

   485

	p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   486

   487

	// Go through all the ips on this pc

   488

	i = 0;

   489

	while (_network_ip_list[i] != 0) {

   490

		bcaddr = _network_ip_list[i];

   491

		bcptr = (byte *)&bcaddr;

   492

		// Make the address a broadcast address

   493

		bcptr[3] = 255;

   494

   495

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

   496

   497

		out_addr.sin_family = AF_INET;

   498

		out_addr.sin_port = htons(_network_server_port);

   499

		out_addr.sin_addr.s_addr = bcaddr;

   500

   501

		NetworkSendUDP_Packet(udp, p, &out_addr);

   502