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_server;     ///< network-server is active

    45

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

    46

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

    47

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

    48

NetworkServerGameInfo _network_game_info;

    49

NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

    50

NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

    51

uint16 _network_own_client_index;

    52

uint16 _redirect_console_to_client;

    53

bool _network_need_advertise;

    54

uint32 _network_last_advertise_frame;

    55

uint8 _network_reconnect;

    56

char *_network_host_list[10];

    57

char *_network_ban_list[25];

    58

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

    59

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

    60

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

    61

uint32 _broadcast_list[MAX_INTERFACES + 1];

    62

uint32 _network_server_bind_ip;

    63

uint32 _sync_seed_1, _sync_seed_2;

    64

uint32 _sync_frame;

    65

bool _network_first_time;

    66

uint32 _network_last_host_ip;

    67

bool _network_udp_server;

    68

uint16 _network_udp_broadcast;

    69

uint8 _network_advertise_retries;

    70

    71

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

    72

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

    73

    74

// global variables (declared in network_data.h)

    75

CommandPacket *_local_command_queue;

    76

    77

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

    78

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

    79

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

    80

    81

// Here we keep track of the clients

    82

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

    83

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    84

    85

    86

    87

// The listen socket for the server

    88

static SOCKET _listensocket;

    89

    90

// The amount of clients connected

    91

static byte _network_clients_connected = 0;

    92

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

    93

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    94

    95

/* Some externs / forwards */

    96

extern void StateGameLoop();

    97

    98

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

    99

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

   100

{

   101

	NetworkClientInfo *ci;

   102

   103

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

   104

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

   105

	}

   106

   107

	return NULL;

   108

}

   109

   110

/** Return the CI for a given IP

   111

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

   112

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

   113

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

   114

{

   115

	NetworkClientInfo *ci;

   116

	uint32 ip_number = inet_addr(ip);

   117

   118

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

   119

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

   120

	}

   121

   122

	return NULL;

   123

}

   124

   125

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

   126

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   127

{

   128

	NetworkTCPSocketHandler *cs;

   129

   130

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

   131

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

   132

	}

   133

   134

	return NULL;

   135

}

   136

   137

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

   138

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

   139

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

   140

{

   141

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   142

   143

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

   144

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

   145

	} else {

   146

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

   147

	}

   148

}

   149

   150

byte NetworkSpectatorCount()

   151

{

   152

	NetworkTCPSocketHandler *cs;

   153

	byte count = 0;

   154

   155

	FOR_ALL_CLIENTS(cs) {

   156

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

   157

	}

   158

   159

	return count;

   160

}

   161

   162

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

   163

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

   164

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

   165

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

   166

{

   167

	char buf[1024];

   168

	va_list va;

   169

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

   170

	char message[1024];

   171

	char temp[1024];

   172

   173

	va_start(va, str);

   174

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

   175

	va_end(va);

   176

   177

	switch (action) {

   178

		case NETWORK_ACTION_SERVER_MESSAGE:

   179

			color = CC_DEFAULT;

   180

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

   181

			break;

   182

		case NETWORK_ACTION_JOIN:

   183

			color = CC_DEFAULT;

   184

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

   185

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

   186

			break;

   187

		case NETWORK_ACTION_LEAVE:

   188

			color = CC_DEFAULT;

   189

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

   190

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

   191

			break;

   192

		case NETWORK_ACTION_GIVE_MONEY:

   193

			if (self_send) {

   194

				SetDParamStr(0, name);

   195

				SetDParam(1, atoi(buf));

   196

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

   197

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

   198

			} else {

   199

				SetDParam(0, atoi(buf));

   200

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

   201

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

   202

			}

   203

			break;

   204

		case NETWORK_ACTION_NAME_CHANGE:

   205

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

   206

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

   207

			break;

   208

		case NETWORK_ACTION_CHAT_COMPANY:

   209

			SetDParamStr(0, name);

   210

			SetDParamStr(1, buf);

   211

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

   212

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

   213

			break;

   214

		case NETWORK_ACTION_CHAT_CLIENT:

   215

			SetDParamStr(0, name);

   216

			SetDParamStr(1, buf);

   217

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

   218

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

   219

			break;

   220

		default:

   221

			SetDParamStr(0, name);

   222

			SetDParamStr(1, buf);

   223

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

   224

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

   225

			break;

   226

	}

   227

   228

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

   229

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

   230

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

   231

}

   232

   233

// Calculate the frame-lag of a client

   234

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   235

{

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

   243

	return lag;

   244

}

   245

   246

   247

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

   248

//  error

   249

static void NetworkError(StringID error_string)

   250

{

   251

	_switch_mode = SM_MENU;

   252

	extern StringID _switch_mode_errorstr;

   253

	_switch_mode_errorstr = error_string;

   254

}

   255

   256

static void ClientStartError(const char *error)

   257

{

   258

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

   259

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   260

}

   261

   262

static void ServerStartError(const char *error)

   263

{

   264

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

   265

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   266

}

   267

   268

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   269

{

   270

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

   271

	//  disconnection (and why!)

   272

	NetworkErrorCode errorno;

   273

   274

	// We just want to close the connection..

   275

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   276

		cs->has_quit = true;

   277

		NetworkCloseClient(cs);

   278

		_networking = false;

   279

   280

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   281

		return;

   282

	}

   283

   284

	switch (res) {

   285

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   286

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   287

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   288

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   289

	}

   290

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

   291

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

   292

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   293

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   294

   295

		// Dequeue all commands before closing the socket

   296

		DEREF_CLIENT(0)->Send_Packets();

   297

	}

   298

   299

	_switch_mode = SM_MENU;

   300

	NetworkCloseClient(cs);

   301

	_networking = false;

   302

}

   303

   304

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

   305

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

   306

 * @param err NetworkErrorCode

   307

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

   308

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

   309

{

   310

	/* List of possible network errors, used by

   311

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   312

	static const StringID network_error_strings[] = {

   313

		STR_NETWORK_ERR_CLIENT_GENERAL,

   314

		STR_NETWORK_ERR_CLIENT_DESYNC,

   315

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   316

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   317

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   318

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   319

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   320

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   321

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   322

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   323

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   324

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   325

		STR_NETWORK_ERR_CLIENT_KICKED,

   326

		STR_NETWORK_ERR_CLIENT_CHEATER,

   327

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   328

	};

   329

   330

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

   331

   332

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

   333

}

   334

   335

/* Count the number of active clients connected */

   336

static uint NetworkCountPlayers()

   337

{

   338

	NetworkTCPSocketHandler *cs;

   339

	uint count = 0;

   340

   341

	FOR_ALL_CLIENTS(cs) {

   342

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   343

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

   344

	}

   345

   346

	return count;

   347

}

   348

   349

static bool _min_players_paused = false;

   350

   351

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

   352

void CheckMinPlayers()

   353

{

   354

	if (!_network_dedicated) return;

   355

   356

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

   357

		if (_min_players_paused) return;

   358

   359

		_min_players_paused = true;

   360

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

   361

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

   362

	} else {

   363

		if (!_min_players_paused) return;

   364

   365

		_min_players_paused = false;

   366

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

   367

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

   368

	}

   369

}

   370

   371

// Find all IP-aliases for this host

   372

static void NetworkFindIPs()

   373

{

   374

#if !defined(PSP)

   375

	int i;

   376

   377

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

   378

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

   379

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

   380

   381

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

   382

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

   383

		if (new_pos == 0) {

   384

			return B_ERROR;

   385

		}

   386

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

   387

		return B_OK;

   388

	}

   389

   390

	int output_length;

   391

	char *output_pointer = NULL;

   392

	char **output;

   393

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

   394

	i = 0;

   395

   396

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

   397

	_broadcast_list[0] = 0;

   398

   399

	if (sock < 0) {

   400

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

   401

		return;

   402

	}

   403

   404

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

   405

	if (output_length < 0) {

   406

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

   407

		return;

   408

	}

   409

   410

	output = &output_pointer;

   411

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

   412

		for (;;) {

   413

			uint32 n, fields, read;

   414

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

   415

			struct in_addr inaddr;

   416

			uint32 ip;

   417

			uint32 netmask;

   418

   419

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

   420

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

   421

			read += 1;

   422

			if (fields != 9) {

   423

				break;

   424

			}

   425

   426

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

   427

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

   428

   429

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

   430

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

   431

				_broadcast_list[i] = inaddr.s_addr;

   432

				i++;

   433

				if (i == MAX_INTERFACES) break;

   434

			}

   435

			if (read < 0) {

   436

				break;

   437

			}

   438

			*output += read;

   439

		}

   440

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

   441

		/*free(output_pointer);*/

   442

		/*free(output);*/

   443

		closesocket(sock);

   444

	}

   445

#elif defined(HAVE_GETIFADDRS)

   446

	struct ifaddrs *ifap, *ifa;

   447

   448

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

   449

	_broadcast_list[0] = 0;

   450

   451

	if (getifaddrs(&ifap) != 0)

   452

		return;

   453

   454

	i = 0;

   455

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

   456

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

   457

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

   458

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

   459

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

   460

		i++;

   461

		if (i == MAX_INTERFACES) break;

   462

	}

   463

	freeifaddrs(ifap);

   464

   465

#else /* not HAVE_GETIFADDRS */

   466

	SOCKET sock;

   467

#ifdef WIN32

   468

	DWORD len = 0;

   469

	INTERFACE_INFO ifo[MAX_INTERFACES];

   470

	uint j;

   471

#else

   472

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

   473

	struct ifconf ifconf;

   474

	const char* buf_end;

   475

	const char* p;

   476

#endif

   477

   478

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

   479

	_broadcast_list[0] = 0;

   480

   481

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   482

	if (sock == INVALID_SOCKET) return;

   483

   484

#ifdef WIN32