1

/* $Id$ */

     2

     3

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

     4

     5

#include "../stdafx.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"

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

    72

    73

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

    74

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

    75

    76

// global variables (declared in network_data.h)

    77

CommandPacket *_local_command_queue;

    78

    79

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

    80

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

    81

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

    82

    83

// Here we keep track of the clients

    84

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

    85

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    86

    87

    88

    89

// The listen socket for the server

    90

static SOCKET _listensocket;

    91

    92

// The amount of clients connected

    93

static byte _network_clients_connected = 0;

    94

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

    95

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    96

    97

/* Some externs / forwards */

    98

extern void StateGameLoop();

    99

   100

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

   101

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

   102

{

   103

	NetworkClientInfo *ci;

   104

   105

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

   106

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

   107

	}

   108

   109

	return NULL;

   110

}

   111

   112

/** Return the CI for a given IP

   113

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

   114

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

   115

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

   116

{

   117

	NetworkClientInfo *ci;

   118

	uint32 ip_number = inet_addr(ip);

   119

   120

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

   121

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

   122

	}

   123

   124

	return NULL;

   125

}

   126

   127

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

   128

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   129

{

   130

	NetworkTCPSocketHandler *cs;

   131

   132

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

   133

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

   134

	}

   135

   136

	return NULL;

   137

}

   138

   139

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

   140

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

   141

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

   142

{

   143

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   144

   145

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

   146

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

   147

	} else {

   148

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

   149

	}

   150

}

   151

   152

byte NetworkSpectatorCount()

   153

{

   154

	NetworkTCPSocketHandler *cs;

   155

	byte count = 0;

   156

   157

	FOR_ALL_CLIENTS(cs) {

   158

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

   159

	}

   160

   161

	return count;

   162

}

   163

   164

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

   165

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

   166

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

   167

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

   168

{

   169

	char buf[1024];

   170

	va_list va;

   171

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

   172

	char message[1024];

   173

	char temp[1024];

   174

   175

	va_start(va, str);

   176

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

   177

	va_end(va);

   178

   179

	switch (action) {

   180

		case NETWORK_ACTION_SERVER_MESSAGE:

   181

			color = CC_DEFAULT;

   182

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

   183

			break;

   184

		case NETWORK_ACTION_JOIN:

   185

			color = CC_DEFAULT;

   186

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

   187

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

   188

			break;

   189

		case NETWORK_ACTION_LEAVE:

   190

			color = CC_DEFAULT;

   191

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

   192

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

   193

			break;

   194

		case NETWORK_ACTION_GIVE_MONEY:

   195

			if (self_send) {

   196

				SetDParamStr(0, name);

   197

				SetDParam(1, atoi(buf));

   198

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

   199

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

   200

			} else {

   201

				SetDParam(0, atoi(buf));

   202

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

   203

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

   204

			}

   205

			break;

   206

		case NETWORK_ACTION_NAME_CHANGE:

   207

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

   208

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

   209

			break;

   210

		case NETWORK_ACTION_CHAT_COMPANY:

   211

			SetDParamStr(0, name);

   212

			SetDParamStr(1, buf);

   213

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

   214

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

   215

			break;

   216

		case NETWORK_ACTION_CHAT_CLIENT:

   217

			SetDParamStr(0, name);

   218

			SetDParamStr(1, buf);

   219

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

   220

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

   221

			break;

   222

		default:

   223

			SetDParamStr(0, name);

   224

			SetDParamStr(1, buf);

   225

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

   226

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

   227

			break;

   228

	}

   229

   230

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

   231

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

   232

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

   233

}

   234

   235

// Calculate the frame-lag of a client

   236

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   237

{

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

   245

	return lag;

   246

}

   247

   248

   249

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

   250

//  error

   251

static void NetworkError(StringID error_string)

   252

{

   253

	_switch_mode = SM_MENU;

   254

	extern StringID _switch_mode_errorstr;

   255

	_switch_mode_errorstr = error_string;

   256

}

   257

   258

static void ClientStartError(const char *error)

   259

{

   260

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

   261

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   262

}

   263

   264

static void ServerStartError(const char *error)

   265

{

   266

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

   267

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   268

}

   269

   270

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   271

{

   272

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

   273

	//  disconnection (and why!)

   274

	NetworkErrorCode errorno;

   275

   276

	// We just want to close the connection..

   277

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   278

		cs->has_quit = true;

   279

		NetworkCloseClient(cs);

   280

		_networking = false;

   281

   282

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   283

		return;

   284

	}

   285

   286

	switch (res) {

   287

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   288

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   289

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   290

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   291

	}

   292

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

   293

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

   294

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   295

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   296

   297

		// Dequeue all commands before closing the socket

   298

		DEREF_CLIENT(0)->Send_Packets();

   299

	}

   300

   301

	_switch_mode = SM_MENU;

   302

	NetworkCloseClient(cs);

   303

	_networking = false;

   304

}

   305

   306

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

   307

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

   308

 * @param err NetworkErrorCode

   309

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

   310

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

   311

{

   312

	/* List of possible network errors, used by

   313

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   314

	static const StringID network_error_strings[] = {

   315

		STR_NETWORK_ERR_CLIENT_GENERAL,

   316

		STR_NETWORK_ERR_CLIENT_DESYNC,

   317

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   318

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   319

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   320

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   321

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   322

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   323

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   324

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   325

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   326

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   327

		STR_NETWORK_ERR_CLIENT_KICKED,

   328

		STR_NETWORK_ERR_CLIENT_CHEATER,

   329

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   330

	};

   331

   332

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

   333

   334

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

   335

}

   336

   337

/* Count the number of active clients connected */

   338

static uint NetworkCountPlayers()

   339

{

   340

	NetworkTCPSocketHandler *cs;

   341

	uint count = 0;

   342

   343

	FOR_ALL_CLIENTS(cs) {

   344

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   345

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

   346

	}

   347

   348

	return count;

   349

}

   350

   351

static bool _min_players_paused = false;

   352

   353

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

   354

void CheckMinPlayers()

   355

{

   356

	if (!_network_dedicated) return;

   357

   358

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

   359

		if (_min_players_paused) return;

   360

   361

		_min_players_paused = true;

   362

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

   364

	} else {

   365

		if (!_min_players_paused) return;

   366

   367

		_min_players_paused = false;

   368

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

   370

	}

   371

}

   372

   373

// Find all IP-aliases for this host

   374

static void NetworkFindIPs()

   375

{

   376

#if !defined(PSP)

   377

	int i;

   378

   379

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

   380

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

   381

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

   382

   383

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

   384

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

   385

		if (new_pos == 0) {

   386

			return B_ERROR;

   387

		}

   388

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

   389

		return B_OK;

   390

	}

   391

   392

	int output_length;

   393

	char *output_pointer = NULL;

   394

	char **output;

   395

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

   396

	i = 0;

   397

   398

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

   399

	_broadcast_list[0] = 0;

   400

   401

	if (sock < 0) {

   402

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

   403

		return;

   404

	}

   405

   406

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

   407

	if (output_length < 0) {

   408

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

   409

		return;

   410

	}

   411

   412

	output = &output_pointer;

   413

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

   414

		for (;;) {

   415

			uint32 n, fields, read;

   416

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

   417

			struct in_addr inaddr;

   418

			uint32 ip;

   419

			uint32 netmask;

   420

   421

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

   422

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

   423

			read += 1;

   424

			if (fields != 9) {

   425

				break;

   426

			}

   427

   428

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

   429

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

   430

   431

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

   432

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

   433

				_broadcast_list[i] = inaddr.s_addr;

   434

				i++;

   435

				if (i == MAX_INTERFACES) break;

   436

			}

   437

			if (read < 0) {

   438

				break;

   439

			}

   440

			*output += read;

   441

		}

   442

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

   443

		/*free(output_pointer);*/

   444

		/*free(output);*/

   445

		closesocket(sock);

   446

	}

   447

#elif defined(HAVE_GETIFADDRS)

   448

	struct ifaddrs *ifap, *ifa;

   449

   450

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

   451

	_broadcast_list[0] = 0;

   452

   453

	if (getifaddrs(&ifap) != 0)

   454

		return;

   455

   456

	i = 0;

   457

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

   458

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

   459

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

   460

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

   461

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

   462

		i++;

   463

		if (i == MAX_INTERFACES) break;

   464

	}

   465

	freeifaddrs(ifap);

   466

   467

#else /* not HAVE_GETIFADDRS */

   468

	SOCKET sock;

   469

#ifdef WIN32

   470

	DWORD len = 0;

   471

	INTERFACE_INFO ifo[MAX_INTERFACES];

   472

	uint j;

   473

#else

   474

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

   475

	struct ifconf ifconf;

   476

	const char* buf_end;

   477

	const char* p;

   478

#endif

   479

   480

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

   481

	_broadcast_list[0] = 0;

   482

   483

	sock = socket(AF_INET, SOCK_DGRAM, 0);