1

/* $Id$ */

     2

     3

/** @file network.cpp Base functions for networking support. */

     4

     5

#include "../stdafx.h"

     6

#include "../player_type.h"

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "../openttd.h"

    11

#include "../debug.h"

    12

#include "../strings_func.h"

    13

#include "../map_func.h"

    14

#include "../command_func.h"

    15

#include "../variables.h"

    16

#include "../date_func.h"

    17

#include "../newgrf_config.h"

    18

#include "network_internal.h"

    19

#include "network_client.h"

    20

#include "network_server.h"

    21

#include "network_udp.h"

    22

#include "network_gamelist.h"

    23

#include "core/udp.h"

    24

#include "core/tcp.h"

    25

#include "core/core.h"

    26

#include "network_gui.h"

    27

#include "../console_func.h"

    28

#include <stdarg.h> /* va_list */

    29

#include "../md5.h"

    30

#include "../fileio.h"

    31

#include "../texteff.hpp"

    32

#include "../core/random_func.hpp"

    33

#include "../window_func.h"

    34

#include "../string_func.h"

    35

#include "../player_func.h"

    36

#include "../settings_type.h"

    37

#include "../landscape_type.h"

    38

#include "../rev.h"

    39

#ifdef DEBUG_DUMP_COMMANDS

    40

	#include "../core/alloc_func.hpp"

    41

#endif /* DEBUG_DUMP_COMMANDS */

    42

#include "table/strings.h"

    43

    44

bool _network_reload_cfg;

    45

bool _network_server;     ///< network-server is active

    46

bool _network_available;  ///< is network mode available?

    47

bool _network_dedicated;  ///< are we a dedicated server?

    48

bool _is_network_server;  ///< Does this client wants to be a network-server?

    49

NetworkServerGameInfo _network_game_info;

    50

NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

    51

NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

    52

uint16 _network_own_client_index;

    53

uint16 _redirect_console_to_client;

    54

bool _network_need_advertise;

    55

uint32 _network_last_advertise_frame;

    56

uint8 _network_reconnect;

    57

char *_network_host_list[10];

    58

char *_network_ban_list[25];

    59

uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode

    60

uint32 _frame_counter_max; // To where we may go with our clients

    61

uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.

    62

uint32 _broadcast_list[MAX_INTERFACES + 1];

    63

uint32 _network_server_bind_ip;

    64

uint32 _sync_seed_1, _sync_seed_2;

    65

uint32 _sync_frame;

    66

bool _network_first_time;

    67

uint32 _network_last_host_ip;

    68

bool _network_udp_server;

    69

uint16 _network_udp_broadcast;

    70

uint8 _network_advertise_retries;

    71

    72

/* Check whether NETWORK_NUM_LANDSCAPES is still in sync with NUM_LANDSCAPE */

    73

assert_compile((int)NETWORK_NUM_LANDSCAPES == (int)NUM_LANDSCAPE);

    74

    75

// global variables (declared in network_data.h)

    76

CommandPacket *_local_command_queue;

    77

    78

extern NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    79

extern NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    80

extern NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    81

    82

// Here we keep track of the clients

    83

//  (and the client uses [0] for his own communication)

    84

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    85

    86

    87

    88

// The listen socket for the server

    89

static SOCKET _listensocket;

    90

    91

// The amount of clients connected

    92

static byte _network_clients_connected = 0;

    93

// The index counter for new clients (is never decreased)

    94

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    95

    96

/* Some externs / forwards */

    97

extern void StateGameLoop();

    98

    99

// Function that looks up the CI for a given client-index

   100

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

   101

{

   102

	NetworkClientInfo *ci;

   103

   104

	for (ci = _network_client_info; ci != endof(_network_client_info); ci++) {

   105

		if (ci->client_index == client_index) return ci;

   106

	}

   107

   108

	return NULL;

   109

}

   110

   111

/** Return the CI for a given IP

   112

 * @param ip IP of the client we are looking for. This must be in string-format

   113

 * @return return a pointer to the corresponding NetworkClientInfo struct or NULL on failure */

   114

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

   115

{

   116

	NetworkClientInfo *ci;

   117

	uint32 ip_number = inet_addr(ip);

   118

   119

	for (ci = _network_client_info; ci != endof(_network_client_info); ci++) {

   120

		if (ci->client_ip == ip_number) return ci;

   121

	}

   122

   123

	return NULL;

   124

}

   125

   126

// Function that looks up the CS for a given client-index

   127

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   128

{

   129

	NetworkTCPSocketHandler *cs;

   130

   131

	for (cs = _clients; cs != endof(_clients); cs++) {

   132

		if (cs->index == client_index) return cs;

   133

	}

   134

   135

	return NULL;

   136

}

   137

   138

// NetworkGetClientName is a server-safe function to get the name of the client

   139

//  if the user did not send it yet, Client #<no> is used.

   140

void NetworkGetClientName(char *client_name, size_t size, const NetworkTCPSocketHandler *cs)

   141

{

   142

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   143

   144

	if (ci->client_name[0] == '\0') {

   145

		snprintf(client_name, size, "Client #%4d", cs->index);

   146

	} else {

   147

		ttd_strlcpy(client_name, ci->client_name, size);

   148

	}

   149

}

   150

   151

byte NetworkSpectatorCount()

   152

{

   153

	NetworkTCPSocketHandler *cs;

   154

	byte count = 0;

   155

   156

	FOR_ALL_CLIENTS(cs) {

   157

		if (DEREF_CLIENT_INFO(cs)->client_playas == PLAYER_SPECTATOR) count++;

   158

	}

   159

   160

	return count;

   161

}

   162

   163

// This puts a text-message to the console, or in the future, the chat-box,

   164

//  (to keep it all a bit more general)

   165

// If 'self_send' is true, this is the client who is sending the message

   166

void CDECL NetworkTextMessage(NetworkAction action, ConsoleColour color, bool self_send, const char *name, const char *str, ...)

   167

{

   168

	char buf[1024];

   169

	va_list va;

   170

	const int duration = 10; // Game days the messages stay visible

   171

	char message[1024];

   172

	char temp[1024];

   173

   174

	va_start(va, str);

   175

	vsnprintf(buf, lengthof(buf), str, va);

   176

	va_end(va);

   177

   178

	switch (action) {

   179

		case NETWORK_ACTION_SERVER_MESSAGE:

   180

			color = CC_DEFAULT;

   181

			snprintf(message, sizeof(message), "*** %s", buf);

   182

			break;

   183

		case NETWORK_ACTION_JOIN:

   184

			color = CC_DEFAULT;

   185

			GetString(temp, STR_NETWORK_CLIENT_JOINED, lastof(temp));

   186

			snprintf(message, sizeof(message), "*** %s %s", name, temp);

   187

			break;

   188

		case NETWORK_ACTION_LEAVE:

   189

			color = CC_DEFAULT;

   190

			GetString(temp, STR_NETWORK_ERR_LEFT, lastof(temp));

   191

			snprintf(message, sizeof(message), "*** %s %s (%s)", name, temp, buf);

   192

			break;

   193

		case NETWORK_ACTION_GIVE_MONEY:

   194

			if (self_send) {

   195

				SetDParamStr(0, name);

   196

				SetDParam(1, atoi(buf));

   197

				GetString(temp, STR_NETWORK_GAVE_MONEY_AWAY, lastof(temp));

   198

				snprintf(message, sizeof(message), "*** %s", temp);

   199

			} else {

   200

				SetDParam(0, atoi(buf));

   201

				GetString(temp, STR_NETWORK_GIVE_MONEY, lastof(temp));

   202

				snprintf(message, sizeof(message), "*** %s %s", name, temp);

   203

			}

   204

			break;

   205

		case NETWORK_ACTION_NAME_CHANGE:

   206

			GetString(temp, STR_NETWORK_NAME_CHANGE, lastof(temp));

   207

			snprintf(message, sizeof(message), "*** %s %s %s", name, temp, buf);

   208

			break;

   209

		case NETWORK_ACTION_CHAT_COMPANY:

   210

			SetDParamStr(0, name);

   211

			SetDParamStr(1, buf);

   212

			GetString(temp, self_send ? STR_NETWORK_CHAT_TO_COMPANY : STR_NETWORK_CHAT_COMPANY, lastof(temp));

   213

			ttd_strlcpy(message, temp, sizeof(message));

   214

			break;

   215

		case NETWORK_ACTION_CHAT_CLIENT:

   216

			SetDParamStr(0, name);

   217

			SetDParamStr(1, buf);

   218

			GetString(temp, self_send ? STR_NETWORK_CHAT_TO_CLIENT : STR_NETWORK_CHAT_CLIENT, lastof(temp));

   219

			ttd_strlcpy(message, temp, sizeof(message));

   220

			break;

   221

		default:

   222

			SetDParamStr(0, name);

   223

			SetDParamStr(1, buf);

   224

			GetString(temp, STR_NETWORK_CHAT_ALL, lastof(temp));

   225

			ttd_strlcpy(message, temp, sizeof(message));

   226

			break;

   227

	}

   228

   229

	DebugDumpCommands("ddc:cmsg:%d;%d;%s\n", _date, _date_fract, message);

   230

	IConsolePrintF(color, "%s", message);

   231

	AddChatMessage(color, duration, "%s", message);

   232

}

   233

   234

// Calculate the frame-lag of a client

   235

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   236

{

   237

	int lag = cs->last_frame_server - cs->last_frame;

   238

	// This client has missed his ACK packet after 1 DAY_TICKS..

   239

	//  so we increase his lag for every frame that passes!

   240

	// The packet can be out by a max of _net_frame_freq

   241

	if (cs->last_frame_server + DAY_TICKS + _settings_client.network.frame_freq < _frame_counter)

   242

		lag += _frame_counter - (cs->last_frame_server + DAY_TICKS + _settings_client.network.frame_freq);

   243

   244

	return lag;

   245

}

   246

   247

   248

// There was a non-recoverable error, drop back to the main menu with a nice

   249

//  error

   250

static void NetworkError(StringID error_string)

   251

{

   252

	_switch_mode = SM_MENU;

   253

	extern StringID _switch_mode_errorstr;

   254

	_switch_mode_errorstr = error_string;

   255

}

   256

   257

static void ClientStartError(const char *error)

   258

{

   259

	DEBUG(net, 0, "[client] could not start network: %s",error);

   260

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   261

}

   262

   263

static void ServerStartError(const char *error)

   264

{

   265

	DEBUG(net, 0, "[server] could not start network: %s",error);

   266

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   267

}

   268

   269

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   270

{

   271

	// First, send a CLIENT_ERROR to the server, so he knows we are

   272

	//  disconnection (and why!)

   273

	NetworkErrorCode errorno;

   274

   275

	// We just want to close the connection..

   276

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   277

		cs->has_quit = true;

   278

		NetworkCloseClient(cs);

   279

		_networking = false;

   280

   281

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   282

		return;

   283

	}

   284

   285

	switch (res) {

   286

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   287

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   288

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   289

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   290

	}

   291

	// This means we fucked up and the server closed the connection

   292

	if (res != NETWORK_RECV_STATUS_SERVER_ERROR && res != NETWORK_RECV_STATUS_SERVER_FULL &&

   293

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   294

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   295

   296

		// Dequeue all commands before closing the socket

   297

		DEREF_CLIENT(0)->Send_Packets();

   298

	}

   299

   300

	_switch_mode = SM_MENU;

   301

	NetworkCloseClient(cs);

   302

	_networking = false;

   303

}

   304

   305

/** Retrieve a string representation of an internal error number

   306

 * @param buf buffer where the error message will be stored

   307

 * @param err NetworkErrorCode

   308

 * @return returns a pointer to the error message (buf) */

   309

char* GetNetworkErrorMsg(char* buf, NetworkErrorCode err, const char* last)

   310

{

   311

	/* List of possible network errors, used by

   312

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   313

	static const StringID network_error_strings[] = {

   314

		STR_NETWORK_ERR_CLIENT_GENERAL,

   315

		STR_NETWORK_ERR_CLIENT_DESYNC,

   316

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   317

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   318

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   319

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   320

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   321

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   322

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   323

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   324

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   325

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   326

		STR_NETWORK_ERR_CLIENT_KICKED,

   327

		STR_NETWORK_ERR_CLIENT_CHEATER,

   328

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   329

	};

   330

   331

	if (err >= (ptrdiff_t)lengthof(network_error_strings)) err = NETWORK_ERROR_GENERAL;

   332

   333

	return GetString(buf, network_error_strings[err], last);

   334

}

   335

   336

/* Count the number of active clients connected */

   337

static uint NetworkCountPlayers()

   338

{

   339

	NetworkTCPSocketHandler *cs;

   340

	uint count = 0;

   341

   342

	FOR_ALL_CLIENTS(cs) {

   343

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   344

		if (IsValidPlayer(ci->client_playas)) count++;

   345

	}

   346

   347

	return count;

   348

}

   349

   350

static bool _min_players_paused = false;

   351

   352

/* Check if the minimum number of players has been reached and pause or unpause the game as appropriate */

   353

void CheckMinPlayers()

   354

{

   355

	if (!_network_dedicated) return;

   356

   357

	if (NetworkCountPlayers() < _settings_client.network.min_players) {

   358

		if (_min_players_paused) return;

   359

   360

		_min_players_paused = true;

   361

		DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   362

		NetworkServerSendChat(NETWORK_ACTION_SERVER_MESSAGE, DESTTYPE_BROADCAST, 0, "Game paused (not enough players)", NETWORK_SERVER_INDEX);

   363

	} else {

   364

		if (!_min_players_paused) return;

   365

   366

		_min_players_paused = false;

   367

		DoCommandP(0, 0, 0, NULL, CMD_PAUSE);

   368

		NetworkServerSendChat(NETWORK_ACTION_SERVER_MESSAGE, DESTTYPE_BROADCAST, 0, "Game unpaused (enough players)", NETWORK_SERVER_INDEX);

   369

	}

   370

}

   371

   372

// Find all IP-aliases for this host

   373

static void NetworkFindIPs()

   374

{

   375

#if !defined(PSP)

   376

	int i;

   377

   378

#if defined(BEOS_NET_SERVER) /* doesn't have neither getifaddrs or net/if.h */

   379

	/* Based on Andrew Bachmann's netstat+.c. Big thanks to him! */

   380

	int _netstat(int fd, char **output, int verbose);

   381

   382

	int seek_past_header(char **pos, const char *header) {

   383

		char *new_pos = strstr(*pos, header);

   384

		if (new_pos == 0) {

   385

			return B_ERROR;

   386

		}

   387

		*pos += strlen(header) + new_pos - *pos + 1;

   388

		return B_OK;

   389

	}

   390

   391

	int output_length;

   392

	char *output_pointer = NULL;

   393

	char **output;

   394

	int sock = socket(AF_INET, SOCK_DGRAM, 0);

   395

	i = 0;

   396

   397

	// If something fails, make sure the list is empty

   398

	_broadcast_list[0] = 0;

   399

   400

	if (sock < 0) {

   401

		DEBUG(net, 0, "[core] error creating socket");

   402

		return;

   403

	}

   404

   405

	output_length = _netstat(sock, &output_pointer, 1);

   406

	if (output_length < 0) {

   407

		DEBUG(net, 0, "[core] error running _netstat");

   408

		return;

   409

	}

   410

   411

	output = &output_pointer;

   412

	if (seek_past_header(output, "IP Interfaces:") == B_OK) {

   413

		for (;;) {

   414

			uint32 n, fields, read;

   415

			uint8 i1, i2, i3, i4, j1, j2, j3, j4;

   416

			struct in_addr inaddr;

   417

			uint32 ip;

   418

			uint32 netmask;

   419

   420

			fields = sscanf(*output, "%u: %hhu.%hhu.%hhu.%hhu, netmask %hhu.%hhu.%hhu.%hhu%n",

   421

												&n, &i1, &i2, &i3, &i4, &j1, &j2, &j3, &j4, &read);

   422

			read += 1;

   423

			if (fields != 9) {

   424

				break;

   425

			}

   426

   427

			ip      = (uint32)i1 << 24 | (uint32)i2 << 16 | (uint32)i3 << 8 | (uint32)i4;

   428

			netmask = (uint32)j1 << 24 | (uint32)j2 << 16 | (uint32)j3 << 8 | (uint32)j4;

   429

   430

			if (ip != INADDR_LOOPBACK && ip != INADDR_ANY) {

   431

				inaddr.s_addr = htonl(ip | ~netmask);

   432

				_broadcast_list[i] = inaddr.s_addr;

   433

				i++;

   434

				if (i == MAX_INTERFACES) break;

   435

			}

   436

			if (read < 0) {

   437

				break;

   438

			}

   439

			*output += read;

   440

		}

   441

		/* XXX - Using either one of these crashes openttd heavily? - wber */

   442

		/*free(output_pointer);*/

   443

		/*free(output);*/

   444

		closesocket(sock);

   445

	}

   446

#elif defined(HAVE_GETIFADDRS)

   447

	struct ifaddrs *ifap, *ifa;

   448

   449

	// If something fails, make sure the list is empty

   450

	_broadcast_list[0] = 0;

   451

   452

	if (getifaddrs(&ifap) != 0)

   453

		return;

   454

   455

	i = 0;

   456

	for (ifa = ifap; ifa != NULL; ifa = ifa->ifa_next) {

   457

		if (!(ifa->ifa_flags & IFF_BROADCAST)) continue;

   458

		if (ifa->ifa_broadaddr == NULL) continue;

   459

		if (ifa->ifa_broadaddr->sa_family != AF_INET) continue;

   460

		_broadcast_list[i] = ((struct sockaddr_in*)ifa->ifa_broadaddr)->sin_addr.s_addr;

   461

		i++;

   462

		if (i == MAX_INTERFACES) break;

   463

	}

   464

	freeifaddrs(ifap);

   465

   466

#else /* not HAVE_GETIFADDRS */

   467

	SOCKET sock;

   468

#ifdef WIN32

   469

	DWORD len = 0;

   470

	INTERFACE_INFO ifo[MAX_INTERFACES];

   471

	uint j;

   472

#else

   473

	char buf[4 * 1024]; // Arbitrary buffer size

   474

	struct ifconf ifconf;

   475

	const char* buf_end;

   476

	const char* p;

   477

#endif

   478

   479

	// If something fails, make sure the list is empty

   480

	_broadcast_list[0] = 0;

   481

   482

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   483

	if (sock == INVALID_SOCKET) return;

   484