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

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 = 3 */

    66

	NetworkSend_uint32(packet, _network_game_info.game_date);

    67

	NetworkSend_uint32(packet, _network_game_info.start_date);

    68

    69

	/* NETWORK_GAME_INFO_VERSION = 2 */

    70

	NetworkSend_uint8 (packet, _network_game_info.companies_max);

    71

	NetworkSend_uint8 (packet, ActivePlayerCount());

    72

	NetworkSend_uint8 (packet, _network_game_info.spectators_max);

    73

    74

	/* NETWORK_GAME_INFO_VERSION = 1 */

    75

	NetworkSend_string(packet, _network_game_info.server_name);

    76

	NetworkSend_string(packet, _network_game_info.server_revision);

    77

	NetworkSend_uint8 (packet, _network_game_info.server_lang);

    78

	NetworkSend_uint8 (packet, _network_game_info.use_password);

    79

	NetworkSend_uint8 (packet, _network_game_info.clients_max);

    80

	NetworkSend_uint8 (packet, _network_game_info.clients_on);

    81

	NetworkSend_uint8 (packet, NetworkSpectatorCount());

    82

	NetworkSend_string(packet, _network_game_info.map_name);

    83

	NetworkSend_uint16(packet, _network_game_info.map_width);

    84

	NetworkSend_uint16(packet, _network_game_info.map_height);

    85

	NetworkSend_uint8 (packet, _network_game_info.map_set);

    86

	NetworkSend_uint8 (packet, _network_game_info.dedicated);

    87

    88

	// Let the client know that we are here

    89

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

    90

    91

	free(packet);

    92

    93

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

    94

}

    95

    96

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE)

    97

{

    98

	extern const char _openttd_revision[];

    99

	NetworkGameList *item;

   100

	byte game_info_version;

   101

   102

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

   103

	if (_network_udp_server)

   104

		return;

   105

   106

	game_info_version = NetworkRecv_uint8(&_udp_cs, p);

   107

   108

	if (_udp_cs.has_quit) return;

   109

   110

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

   111

   112

	// Find next item

   113

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

   114

   115

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

   116

	 * they are to be received */

   117

	switch (game_info_version) {

   118

		case 3:

   119

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

   120

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

   121

			/* Fallthrough */

   122

		case 2:

   123

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

   124

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

   125

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

   126

			/* Fallthrough */

   127

		case 1:

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

			}

   139

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

   140

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

   141

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

   142

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

   143

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

   144

   145

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

   146

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

   147

   148

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

   149

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

   150

   151

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

   152

			item->info.compatible =

   153

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

   154

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

   155

			break;

   156

	}

   157

   158

	item->online = true;

   159

   160

	UpdateNetworkGameWindow(false);

   161

}

   162

   163

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO)

   164

{

   165

	NetworkClientState *cs;

   166

	NetworkClientInfo *ci;

   167

	Packet *packet;

   168

	Player *player;

   169

	byte current = 0;

   170

	int i;

   171

   172

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

   173

	if (!_network_udp_server) return;

   174

   175

	packet = NetworkSend_Init(PACKET_UDP_SERVER_DETAIL_INFO);

   176

   177

	/* Send the amount of active companies */

   178

	NetworkSend_uint8 (packet, NETWORK_COMPANY_INFO_VERSION);

   179

	NetworkSend_uint8 (packet, ActivePlayerCount());

   180

   181

	/* Fetch the latest version of everything */

   182

	NetworkPopulateCompanyInfo();

   183

   184

	/* Go through all the players */

   185

	FOR_ALL_PLAYERS(player) {

   186

		/* Skip non-active players */

   187

		if (!player->is_active) continue;

   188

   189

		current++;

   190

   191

		/* Send the information */

   192

		NetworkSend_uint8(packet, current);

   193

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

   201

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

   202

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

   203

			NetworkSend_uint8(packet, 1);

   204

		} else {

   205

			NetworkSend_uint8(packet, 0);

   206

		}

   207

   208

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

   209

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

   210

   211

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

   212

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

   213

   214

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

   215

		FOR_ALL_CLIENTS(cs) {

   216

			ci = DEREF_CLIENT_INFO(cs);

   217

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

   218

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

   219

				NetworkSend_uint8(packet, 1);

   220

				NetworkSend_string(packet, ci->client_name);

   221

				NetworkSend_string(packet, ci->unique_id);

   222

				NetworkSend_uint32(packet, ci->join_date);

   223

			}

   224

		}

   225

		/* Also check for the server itself */

   226

		ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   227

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

   228

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

   229

			NetworkSend_uint8(packet, 1);

   230

			NetworkSend_string(packet, ci->client_name);

   231

			NetworkSend_string(packet, ci->unique_id);

   232

			NetworkSend_uint32(packet, ci->join_date);

   233

		}

   234

   235

		/* Indicates end of client list */

   236

		NetworkSend_uint8(packet, 0);

   237

	}

   238

   239

	/* And check if we have any spectators */

   240

	FOR_ALL_CLIENTS(cs) {

   241

		ci = DEREF_CLIENT_INFO(cs);

   242

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

   243

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

   244

			NetworkSend_uint8(packet, 1);

   245

			NetworkSend_string(packet, ci->client_name);

   246

			NetworkSend_string(packet, ci->unique_id);

   247

			NetworkSend_uint32(packet, ci->join_date);

   248

		}

   249

	}

   250

   251

	/* Also check for the server itself */

   252

	ci = NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX);

   253

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

   254

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

   255

		NetworkSend_uint8(packet, 1);

   256

		NetworkSend_string(packet, ci->client_name);

   257

		NetworkSend_string(packet, ci->unique_id);

   258

		NetworkSend_uint32(packet, ci->join_date);

   259

	}

   260

   261

	/* Indicates end of client list */

   262

	NetworkSend_uint8(packet, 0);

   263

   264

	NetworkSendUDP_Packet(_udp_server_socket, packet, client_addr);

   265

   266

	free(packet);

   267

}

   268

   269

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST)

   270

{

   271

	int i;

   272

	struct in_addr ip;

   273

	uint16 port;

   274

	uint8 ver;

   275

   276

	/* packet begins with the protocol version (uint8)

   277

	 * then an uint16 which indicates how many

   278

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

   279

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

   280

	 */

   281

   282

	ver = NetworkRecv_uint8(&_udp_cs, p);

   283

   284

	if (_udp_cs.has_quit) return;

   285

   286

	if (ver == 1) {

   287

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

   288

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

   289

			port = NetworkRecv_uint16(&_udp_cs, p);

   290

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   291

		}

   292

	}

   293

}

   294

   295

DEF_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER)

   296

{

   297

	_network_advertise_retries = 0;

   298

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

   299

   300

	if (!_network_advertise) {

   301

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

   302

		NetworkUDPRemoveAdvertise();

   303

	}

   304

}

   305

   306

   307

// The layout for the receive-functions by UDP

   308

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

   309

   310

static NetworkUDPPacket* const _network_udp_packet[] = {

   311

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER),

   312

	RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE),

   313

	RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO),

   314

	NULL,

   315

	NULL,

   316

	RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER),

   317

	NULL,

   318

	RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST),

   319

	NULL

   320

};

   321

   322

   323

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

   324

assert_compile(lengthof(_network_udp_packet) == PACKET_UDP_END);

   325

   326

   327

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

   328

{

   329

	byte type;

   330

   331

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

   332

	_udp_cs.socket = INVALID_SOCKET;

   333

	_udp_cs.has_quit = false;

   334

   335

	type = NetworkRecv_uint8(&_udp_cs, p);

   336

   337

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

   338

		_network_udp_packet[type](p, client_addr);

   339

	} else {

   340

		if (!_udp_cs.has_quit) {

   341

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

   342

		} else {

   343

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

   344

		}

   345

	}

   346

}

   347

   348

   349

// Send a packet over UDP

   350

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

   351

{

   352

	int res;

   353

   354

	// Put the length in the buffer

   355

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

   356

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

   357

   358

	// Send the buffer

   359

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

   360

   361

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

   362

	if (res == -1) {

   363

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

   364

	}

   365

}

   366

   367

// Start UDP listener

   368

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

   369

{

   370

	struct sockaddr_in sin;

   371

   372

	// Make sure socket is closed

   373

	closesocket(*udp);

   374

   375

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

   376

	if (*udp == INVALID_SOCKET) {

   377

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

   378

		return false;

   379

	}

   380

   381

	// set nonblocking mode for socket

   382

	{

   383

		unsigned long blocking = 1;

   384

#ifndef BEOS_NET_SERVER

   385

		ioctlsocket(*udp, FIONBIO, &blocking);

   386

#else

   387

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

   388

#endif

   389

	}

   390

   391

	sin.sin_family = AF_INET;

   392

	// Listen on all IPs

   393

	sin.sin_addr.s_addr = host;

   394

	sin.sin_port = htons(port);

   395

   396

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

   397

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

   398

		return false;

   399

	}

   400

   401

	if (broadcast) {

   402

		/* Enable broadcast */

   403

		unsigned long val = 1;

   404

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

   405

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

   406

#endif

   407

	}

   408

   409

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

   410

   411

	return true;

   412

}

   413

   414

// Close UDP connection

   415

void NetworkUDPClose(void)

   416

{

   417

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

   418

   419

	if (_network_udp_server) {

   420

		if (_udp_server_socket != INVALID_SOCKET) {

   421

			closesocket(_udp_server_socket);

   422

			_udp_server_socket = INVALID_SOCKET;

   423

		}

   424

   425

		if (_udp_master_socket != INVALID_SOCKET) {

   426

			closesocket(_udp_master_socket);

   427

			_udp_master_socket = INVALID_SOCKET;

   428

		}

   429

   430

		_network_udp_server = false;

   431

		_network_udp_broadcast = 0;

   432

	} else {

   433

		if (_udp_client_socket != INVALID_SOCKET) {

   434

			closesocket(_udp_client_socket);

   435

			_udp_client_socket = INVALID_SOCKET;

   436

		}

   437

		_network_udp_broadcast = 0;

   438

	}

   439

}

   440

   441

// Receive something on UDP level

   442

void NetworkUDPReceive(SOCKET udp)

   443

{

   444

	struct sockaddr_in client_addr;

   445

	socklen_t client_len;

   446

	int nbytes;

   447

	static Packet *p = NULL;

   448

	int packet_len;

   449

   450

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

   451

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

   452

   453

	packet_len = sizeof(p->buffer);

   454

	client_len = sizeof(client_addr);

   455

   456

	// Try to receive anything

   457

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

   458

   459

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

   460

	if (nbytes > 0) {

   461

		// Get the size of the buffer

   462

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

   463

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

   464

		// Put the position on the right place

   465

		p->pos = 2;

   466

		p->next = NULL;

   467

   468

		// Handle the packet

   469

		NetworkHandleUDPPacket(p, &client_addr);

   470

   471

		// Free the packet

   472

		free(p);

   473

		p = NULL;

   474

	}

   475

}

   476

   477

// Broadcast to all ips

   478

static void NetworkUDPBroadCast(SOCKET udp)

   479

{

   480

	Packet* p = NetworkSend_Init(PACKET_UDP_CLIENT_FIND_SERVER);

   481

	uint i;

   482

   483

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

   484

		struct sockaddr_in out_addr;

   485

   486

		out_addr.sin_family = AF_INET;

   487

		out_addr.sin_port = htons(_network_server_port);

   488

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   489

   490

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

   491

   492

		NetworkSendUDP_Packet(udp, p, &out_addr);

   493

	}

   494

   495

	free(p);

   496

}