1

/* $Id$ */

     2

     3

#include "../stdafx.h"

     4

#include "network_data.h"

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "../openttd.h"

     9

#include "../debug.h"

    10

#include "../strings_func.h"

    11

#include "../map_func.h"

    12

#include "../command_func.h"

    13

#include "../variables.h"

    14

#include "../date_func.h"

    15

#include "../newgrf_config.h"

    16

#include "network_client.h"

    17

#include "network_server.h"

    18

#include "network_udp.h"

    19

#include "network_gamelist.h"

    20

#include "core/udp.h"

    21

#include "core/tcp.h"

    22

#include "core/core.h"

    23

#include "network_gui.h"

    24

#include "../console.h" /* IConsoleCmdExec */

    25

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

    26

#include "../md5.h"

    27

#include "../fileio.h"

    28

#include "../texteff.hpp"

    29

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

    30

#include "../window_func.h"

    31

#include "../string_func.h"

    32

#include "../player_func.h"

    33

#include "../settings_type.h"

    34

#ifdef DEBUG_DUMP_COMMANDS

    35

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

    36

#endif /* DEBUG_DUMP_COMMANDS */

    37

    38

#include "table/strings.h"

    39

    40

bool _network_reload_cfg;

    41

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

    42

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

    43

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

    44

bool _network_advertise;  ///< is the server advertising to the master server?

    45

    46

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

    47

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

    48

    49

// global variables (declared in network_data.h)

    50

CommandPacket *_local_command_queue;

    51

    52

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

    53

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

    54

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

    55

    56

// Here we keep track of the clients

    57

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

    58

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    59

    60

    61

    62

// The listen socket for the server

    63

static SOCKET _listensocket;

    64

    65

// The amount of clients connected

    66

static byte _network_clients_connected = 0;

    67

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

    68

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    69

    70

/* Some externs / forwards */

    71

extern void StateGameLoop();

    72

    73

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

    74

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    75

{

    76

	NetworkClientInfo *ci;

    77

    78

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

    79

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

    80

	}

    81

    82

	return NULL;

    83

}

    84

    85

/** Return the CI for a given IP

    86

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

    87

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

    88

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    89

{

    90

	NetworkClientInfo *ci;

    91

	uint32 ip_number = inet_addr(ip);

    92

    93

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

    94

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

    95

	}

    96

    97

	return NULL;

    98

}

    99

   100

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

   101

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   102

{

   103

	NetworkTCPSocketHandler *cs;

   104

   105

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

   106

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

   107

	}

   108

   109

	return NULL;

   110

}

   111

   112

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

   113

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

   114

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

   115

{

   116

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   117

   118

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

   119

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

   120

	} else {

   121

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

   122

	}

   123

}

   124

   125

byte NetworkSpectatorCount()

   126

{

   127

	NetworkTCPSocketHandler *cs;

   128

	byte count = 0;

   129

   130

	FOR_ALL_CLIENTS(cs) {

   131

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

   132

	}

   133

   134

	return count;

   135

}

   136

   137

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

   138

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

   139

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

   140

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

   141

{

   142

	char buf[1024];

   143

	va_list va;

   144

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

   145

	char message[1024];

   146

	char temp[1024];

   147

   148

	va_start(va, str);

   149

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

   150

	va_end(va);

   151

   152

	switch (action) {

   153

		case NETWORK_ACTION_SERVER_MESSAGE:

   154

			color = 1;

   155

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

   156

			break;

   157

		case NETWORK_ACTION_JOIN:

   158

			color = 1;

   159

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

   160

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

   161

			break;

   162

		case NETWORK_ACTION_LEAVE:

   163

			color = 1;

   164

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

   165

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

   166

			break;

   167

		case NETWORK_ACTION_GIVE_MONEY:

   168

			if (self_send) {

   169

				SetDParamStr(0, name);

   170

				SetDParam(1, atoi(buf));

   171

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

   172

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

   173

			} else {

   174

				SetDParam(0, atoi(buf));

   175

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

   176

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

   177

			}

   178

			break;

   179

		case NETWORK_ACTION_NAME_CHANGE:

   180

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

   181

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

   182

			break;

   183

		case NETWORK_ACTION_CHAT_COMPANY:

   184

			SetDParamStr(0, name);

   185

			SetDParamStr(1, buf);

   186

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

   187

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

   188

			break;

   189

		case NETWORK_ACTION_CHAT_CLIENT:

   190

			SetDParamStr(0, name);

   191

			SetDParamStr(1, buf);

   192

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

   193

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

   194

			break;

   195

		default:

   196

			SetDParamStr(0, name);

   197

			SetDParamStr(1, buf);

   198

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

   199

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

   200

			break;

   201

	}

   202

   203

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

   204

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

   205

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

   206

}

   207

   208

// Calculate the frame-lag of a client

   209

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   210

{

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

   218

	return lag;

   219

}

   220

   221

   222

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

   223

//  error

   224

static void NetworkError(StringID error_string)

   225

{

   226

	_switch_mode = SM_MENU;

   227

	_switch_mode_errorstr = error_string;

   228

}

   229

   230

static void ClientStartError(const char *error)

   231

{

   232

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

   233

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   234

}

   235

   236

static void ServerStartError(const char *error)

   237

{

   238

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

   239

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   240

}

   241

   242

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   243

{

   244

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

   245

	//  disconnection (and why!)

   246

	NetworkErrorCode errorno;

   247

   248

	// We just want to close the connection..

   249

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   250

		cs->has_quit = true;

   251

		NetworkCloseClient(cs);

   252

		_networking = false;

   253

   254

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   255

		return;

   256

	}

   257

   258

	switch (res) {

   259

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   260

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   261

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   262

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   263

	}

   264

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

   265

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

   266

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   267

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   268

   269

		// Dequeue all commands before closing the socket

   270

		DEREF_CLIENT(0)->Send_Packets();

   271

	}

   272

   273

	_switch_mode = SM_MENU;

   274

	NetworkCloseClient(cs);

   275

	_networking = false;

   276

}

   277

   278

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

   279

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

   280

 * @param err NetworkErrorCode

   281

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

   282

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

   283

{

   284

	/* List of possible network errors, used by

   285

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   286

	static const StringID network_error_strings[] = {

   287

		STR_NETWORK_ERR_CLIENT_GENERAL,

   288

		STR_NETWORK_ERR_CLIENT_DESYNC,

   289

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   290

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   291

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   292

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   293

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   294

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   295

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   296

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   297

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   298

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   299

		STR_NETWORK_ERR_CLIENT_KICKED,

   300

		STR_NETWORK_ERR_CLIENT_CHEATER,

   301

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   302

	};

   303

   304

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

   305

   306

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

   307

}

   308

   309

/* Count the number of active clients connected */

   310

static uint NetworkCountPlayers()

   311

{

   312

	NetworkTCPSocketHandler *cs;

   313

	uint count = 0;

   314

   315

	FOR_ALL_CLIENTS(cs) {

   316

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   317

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

   318

	}

   319

   320

	return count;

   321

}

   322

   323

static bool _min_players_paused = false;

   324

   325

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

   326

void CheckMinPlayers()

   327

{

   328

	if (!_network_dedicated) return;

   329

   330

	if (NetworkCountPlayers() < _network_min_players) {

   331

		if (_min_players_paused) return;

   332

   333

		_min_players_paused = true;

   334

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

   335

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

   336

	} else {

   337

		if (!_min_players_paused) return;

   338

   339

		_min_players_paused = false;

   340

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

   341

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

   342

	}

   343

}

   344

   345

// Find all IP-aliases for this host

   346

static void NetworkFindIPs()

   347

{

   348

#if !defined(PSP)

   349

	int i;

   350

   351

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

   352

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

   353

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

   354

   355

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

   356

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

   357

		if (new_pos == 0) {

   358

			return B_ERROR;

   359

		}

   360

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

   361

		return B_OK;

   362

	}

   363

   364

	int output_length;

   365

	char *output_pointer = NULL;

   366

	char **output;

   367

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

   368

	i = 0;

   369

   370

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

   371

	_broadcast_list[0] = 0;

   372

   373

	if (sock < 0) {

   374

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

   375

		return;

   376

	}

   377

   378

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

   379

	if (output_length < 0) {

   380

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

   381

		return;

   382

	}

   383

   384

	output = &output_pointer;

   385

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

   386

		for (;;) {

   387

			uint32 n, fields, read;

   388

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

   389

			struct in_addr inaddr;

   390

			uint32 ip;

   391

			uint32 netmask;

   392

   393

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

   394

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

   395

			read += 1;

   396

			if (fields != 9) {

   397

				break;

   398

			}

   399

   400

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

   401

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

   402

   403

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

   404

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

   405

				_broadcast_list[i] = inaddr.s_addr;

   406

				i++;

   407

			}

   408

			if (read < 0) {

   409

				break;

   410

			}

   411

			*output += read;

   412

		}

   413

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

   414

		/*free(output_pointer);*/

   415

		/*free(output);*/

   416

		closesocket(sock);

   417

	}

   418

#elif defined(HAVE_GETIFADDRS)

   419

	struct ifaddrs *ifap, *ifa;

   420

   421

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

   422

	_broadcast_list[0] = 0;

   423

   424

	if (getifaddrs(&ifap) != 0)

   425

		return;

   426

   427

	i = 0;

   428

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

   429

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

   430

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

   431

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

   432

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

   433

		i++;

   434

	}

   435

	freeifaddrs(ifap);

   436

   437

#else /* not HAVE_GETIFADDRS */

   438

	SOCKET sock;

   439

#ifdef WIN32

   440

	DWORD len = 0;

   441

	INTERFACE_INFO ifo[MAX_INTERFACES];

   442

	uint j;

   443

#else

   444

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

   445

	struct ifconf ifconf;

   446

	const char* buf_end;

   447

	const char* p;

   448

#endif

   449

   450

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

   451

	_broadcast_list[0] = 0;

   452

   453

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   454

	if (sock == INVALID_SOCKET) return;

   455

   456

#ifdef WIN32

   457

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

   458

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

   459

		closesocket(sock);

   460

		return;

   461

	}

   462

   463

	i = 0;

   464

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

   465

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

   466

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

   467

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

   468

		 * 255.255.255.255.

   469

		 */

   470

		_broadcast_list[i++] =

   471

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

   472

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

   473

	}

   474

#else

   475

	ifconf.ifc_len = sizeof(buf);

   476

	ifconf.ifc_buf = buf;

   477

	if (ioctl(sock, SIOCGIFCONF, &ifconf) == -1) {

   478

		closesocket(sock);

   479

		return;

   480

	}

   481

   482

	i = 0;

   483

	buf_end = buf + ifconf.ifc_len;

   484

	for (p = buf; p < buf_end;) {