1

/* $Id$ */

     2

     3

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

     4

     5

#include "../stdafx.h"

     6

#include "network_data.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_client.h"

    19

#include "network_server.h"

    20

#include "network_udp.h"

    21

#include "network_gamelist.h"

    22

#include "core/udp.h"

    23

#include "core/tcp.h"

    24

#include "core/core.h"

    25

#include "network_gui.h"

    26

#include "../console_func.h"

    27

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

    28

#include "../md5.h"

    29

#include "../fileio.h"

    30

#include "../texteff.hpp"

    31

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

    32

#include "../window_func.h"

    33

#include "../string_func.h"

    34

#include "../player_func.h"

    35

#include "../settings_type.h"

    36

#include "../landscape_type.h"

    37

#include "../rev.h"

    38

#ifdef DEBUG_DUMP_COMMANDS

    39

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

    40

#endif /* DEBUG_DUMP_COMMANDS */

    41

    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 _network_advertise;  ///< is the server advertising to the master server?

    49

    50

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

    51

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

    52

    53

// global variables (declared in network_data.h)

    54

CommandPacket *_local_command_queue;

    55

    56

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

    57

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

    58

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

    59

    60

// Here we keep track of the clients

    61

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

    62

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    63

    64

    65

    66

// The listen socket for the server

    67

static SOCKET _listensocket;

    68

    69

// The amount of clients connected

    70

static byte _network_clients_connected = 0;

    71

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

    72

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    73

    74

/* Some externs / forwards */

    75

extern void StateGameLoop();

    76

    77

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

    78

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    79

{

    80

	NetworkClientInfo *ci;

    81

    82

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

    83

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

    84

	}

    85

    86

	return NULL;

    87

}

    88

    89

/** Return the CI for a given IP

    90

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

    91

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

    92

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    93

{

    94

	NetworkClientInfo *ci;

    95

	uint32 ip_number = inet_addr(ip);

    96

    97

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

    98

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

    99

	}

   100

   101

	return NULL;

   102

}

   103

   104

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

   105

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   106

{

   107

	NetworkTCPSocketHandler *cs;

   108

   109

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

   110

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

   111

	}

   112

   113

	return NULL;

   114

}

   115

   116

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

   117

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

   118

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

   119

{

   120

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   121

   122

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

   123

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

   124

	} else {

   125

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

   126

	}

   127

}

   128

   129

byte NetworkSpectatorCount()

   130

{

   131

	NetworkTCPSocketHandler *cs;

   132

	byte count = 0;

   133

   134

	FOR_ALL_CLIENTS(cs) {

   135

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

   136

	}

   137

   138

	return count;

   139

}

   140

   141

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

   142

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

   143

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

   144

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

   145

{

   146

	char buf[1024];

   147

	va_list va;

   148

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

   149

	char message[1024];

   150

	char temp[1024];

   151

   152

	va_start(va, str);

   153

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

   154

	va_end(va);

   155

   156

	switch (action) {

   157

		case NETWORK_ACTION_SERVER_MESSAGE:

   158

			color = CC_DEFAULT;

   159

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

   160

			break;

   161

		case NETWORK_ACTION_JOIN:

   162

			color = CC_DEFAULT;

   163

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

   164

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

   165

			break;

   166

		case NETWORK_ACTION_LEAVE:

   167

			color = CC_DEFAULT;

   168

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

   169

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

   170

			break;

   171

		case NETWORK_ACTION_GIVE_MONEY:

   172

			if (self_send) {

   173

				SetDParamStr(0, name);

   174

				SetDParam(1, atoi(buf));

   175

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

   176

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

   177

			} else {

   178

				SetDParam(0, atoi(buf));

   179

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

   180

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

   181

			}

   182

			break;

   183

		case NETWORK_ACTION_NAME_CHANGE:

   184

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

   185

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

   186

			break;

   187

		case NETWORK_ACTION_CHAT_COMPANY:

   188

			SetDParamStr(0, name);

   189

			SetDParamStr(1, buf);

   190

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

   191

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

   192

			break;

   193

		case NETWORK_ACTION_CHAT_CLIENT:

   194

			SetDParamStr(0, name);

   195

			SetDParamStr(1, buf);

   196

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

   197

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

   198

			break;

   199

		default:

   200

			SetDParamStr(0, name);

   201

			SetDParamStr(1, buf);

   202

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

   203

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

   204

			break;

   205

	}

   206

   207

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

   208

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

   209

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

   210

}

   211

   212

// Calculate the frame-lag of a client

   213

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   214

{

   215

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

   216

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

   217

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

   218

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

   219

	if (cs->last_frame_server + DAY_TICKS + _network_frame_freq < _frame_counter)

   220

		lag += _frame_counter - (cs->last_frame_server + DAY_TICKS + _network_frame_freq);

   221

   222

	return lag;

   223

}

   224

   225

   226

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

   227

//  error

   228

static void NetworkError(StringID error_string)

   229

{

   230

	_switch_mode = SM_MENU;

   231

	extern StringID _switch_mode_errorstr;

   232

	_switch_mode_errorstr = error_string;

   233

}

   234

   235

static void ClientStartError(const char *error)

   236

{

   237

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

   238

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   239

}

   240

   241

static void ServerStartError(const char *error)

   242

{

   243

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

   244

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   245

}

   246

   247

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   248

{

   249

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

   250

	//  disconnection (and why!)

   251

	NetworkErrorCode errorno;

   252

   253

	// We just want to close the connection..

   254

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   255

		cs->has_quit = true;

   256

		NetworkCloseClient(cs);

   257

		_networking = false;

   258

   259

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   260

		return;

   261

	}

   262

   263

	switch (res) {

   264

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   265

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   266

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   267

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   268

	}

   269

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

   270

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

   271

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   272

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   273

   274

		// Dequeue all commands before closing the socket

   275

		DEREF_CLIENT(0)->Send_Packets();

   276

	}

   277

   278

	_switch_mode = SM_MENU;

   279

	NetworkCloseClient(cs);

   280

	_networking = false;

   281

}

   282

   283

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

   284

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

   285

 * @param err NetworkErrorCode

   286

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

   287

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

   288

{

   289

	/* List of possible network errors, used by

   290

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   291

	static const StringID network_error_strings[] = {

   292

		STR_NETWORK_ERR_CLIENT_GENERAL,

   293

		STR_NETWORK_ERR_CLIENT_DESYNC,

   294

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   295

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   296

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   297

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   298

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   299

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   300

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   301

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   302

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   303

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   304

		STR_NETWORK_ERR_CLIENT_KICKED,

   305

		STR_NETWORK_ERR_CLIENT_CHEATER,

   306

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   307

	};

   308

   309

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

   310

   311

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

   312

}

   313

   314

/* Count the number of active clients connected */

   315

static uint NetworkCountPlayers()

   316

{

   317

	NetworkTCPSocketHandler *cs;

   318

	uint count = 0;

   319

   320

	FOR_ALL_CLIENTS(cs) {

   321

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   322

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

   323

	}

   324

   325

	return count;

   326

}

   327

   328

static bool _min_players_paused = false;

   329

   330

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

   331

void CheckMinPlayers()

   332

{

   333

	if (!_network_dedicated) return;

   334

   335

	if (NetworkCountPlayers() < _network_min_players) {

   336

		if (_min_players_paused) return;

   337

   338

		_min_players_paused = true;

   339

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

   340

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

   341

	} else {

   342

		if (!_min_players_paused) return;

   343

   344

		_min_players_paused = false;

   345

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

   346

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

   347

	}

   348

}

   349

   350

// Find all IP-aliases for this host

   351

static void NetworkFindIPs()

   352

{

   353

#if !defined(PSP)

   354

	int i;

   355

   356

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

   357

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

   358

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

   359

   360

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

   361

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

   362

		if (new_pos == 0) {

   363

			return B_ERROR;

   364

		}

   365

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

   366

		return B_OK;

   367

	}

   368

   369

	int output_length;

   370

	char *output_pointer = NULL;

   371

	char **output;

   372

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

   373

	i = 0;

   374

   375

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

   376

	_broadcast_list[0] = 0;

   377

   378

	if (sock < 0) {

   379

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

   380

		return;

   381

	}

   382

   383

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

   384

	if (output_length < 0) {

   385

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

   386

		return;

   387

	}

   388

   389

	output = &output_pointer;

   390

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

   391

		for (;;) {

   392

			uint32 n, fields, read;

   393

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

   394

			struct in_addr inaddr;

   395

			uint32 ip;

   396

			uint32 netmask;

   397

   398

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

   399

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

   400

			read += 1;

   401

			if (fields != 9) {

   402

				break;

   403

			}

   404

   405

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

   406

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

   407

   408

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

   409

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

   410

				_broadcast_list[i] = inaddr.s_addr;

   411

				i++;

   412

				if (i == MAX_INTERFACES) break;

   413

			}

   414

			if (read < 0) {

   415

				break;

   416

			}

   417

			*output += read;

   418

		}

   419

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

   420

		/*free(output_pointer);*/

   421

		/*free(output);*/

   422

		closesocket(sock);

   423

	}

   424

#elif defined(HAVE_GETIFADDRS)

   425

	struct ifaddrs *ifap, *ifa;

   426

   427

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

   428

	_broadcast_list[0] = 0;

   429

   430

	if (getifaddrs(&ifap) != 0)

   431

		return;

   432

   433

	i = 0;

   434

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

   435

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

   436

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

   437

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

   438

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

   439

		i++;

   440

		if (i == MAX_INTERFACES) break;

   441

	}

   442

	freeifaddrs(ifap);

   443

   444

#else /* not HAVE_GETIFADDRS */

   445

	SOCKET sock;

   446

#ifdef WIN32

   447

	DWORD len = 0;

   448

	INTERFACE_INFO ifo[MAX_INTERFACES];

   449

	uint j;

   450

#else

   451

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

   452

	struct ifconf ifconf;

   453

	const char* buf_end;

   454

	const char* p;

   455

#endif

   456

   457

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

   458

	_broadcast_list[0] = 0;

   459

   460

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   461

	if (sock == INVALID_SOCKET) return;

   462

   463

#ifdef WIN32

   464

	memset(&ifo[0], 0, sizeof(ifo));

   465

	if ((WSAIoctl(sock, SIO_GET_INTERFACE_LIST, NULL, 0, &ifo[0], sizeof(ifo), &len, NULL, NULL)) != 0) {

   466

		closesocket(sock);

   467

		return;

   468

	}

   469

   470

	i = 0;

   471

	for (j = 0; j < len / sizeof(*ifo); j++) {

   472

		if (ifo[j].iiFlags & IFF_LOOPBACK) continue;

   473

		if (!(ifo[j].iiFlags & IFF_BROADCAST)) continue;

   474

		/* iiBroadcast is unusable, because it always seems to be set to

   475

		 * 255.255.255.255.

   476

		 */

   477

		_broadcast_list[i++] =

   478

			 ifo[j].iiAddress.AddressIn.sin_addr.s_addr |

   479

			~ifo[j].iiNetmask.AddressIn.sin_addr.s_addr;

   480

		if (i == MAX_INTERFACES) break;

   481

	}

   482

#else

   483

	ifconf.ifc_len = sizeof(buf);