1

/* $Id$ */

     2

     3

#include "../stdafx.h"

     4

#include "network_data.h"

     5

     6

extern const char _openttd_revision[];

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "../openttd.h"

    11

#include "../debug.h"

    12

#include "../string.h"

    13

#include "../strings_func.h"

    14

#include "../map_func.h"

    15

#include "../command_func.h"

    16

#include "../variables.h"

    18

#include "../newgrf_config.h"

    19

#include "table/strings.h"

    20

#include "network_client.h"

    21

#include "network_server.h"

    22

#include "network_udp.h"

    23

#include "network_gamelist.h"

    24

#include "core/udp.h"

    25

#include "core/tcp.h"

    26

#include "core/core.h"

    27

#include "network_gui.h"

    28

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

    29

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

    30

#include "../md5.h"

    31

#include "../fileio.h"

    32

#include "../texteff.hpp"

    33

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

    34

#include "../window_func.h"

    35

    36

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

    37

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

    38

    39

// global variables (declared in network_data.h)

    40

CommandPacket *_local_command_queue;

    41

    42

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

    43

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

    44

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

    45

    46

// Here we keep track of the clients

    47

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

    48

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    49

    50

    51

    52

// The listen socket for the server

    53

static SOCKET _listensocket;

    54

    55

// The amount of clients connected

    56

static byte _network_clients_connected = 0;

    57

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

    58

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    59

    60

/* Some externs / forwards */

    61

extern void StateGameLoop();

    62

    63

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

    64

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    65

{

    66

	NetworkClientInfo *ci;

    67

    68

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

    69

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

    70

	}

    71

    72

	return NULL;

    73

}

    74

    75

/** Return the CI for a given IP

    76

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

    77

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

    78

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    79

{

    80

	NetworkClientInfo *ci;

    81

	uint32 ip_number = inet_addr(ip);

    82

    83

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

    84

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

    85

	}

    86

    87

	return NULL;

    88

}

    89

    90

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

    91

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    92

{

    93

	NetworkTCPSocketHandler *cs;

    94

    95

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

    96

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

    97

	}

    98

    99

	return NULL;

   100

}

   101

   102

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

   103

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

   104

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

   105

{

   106

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   107

   108

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

   109

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

   110

	} else {

   111

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

   112

	}

   113

}

   114

   115

byte NetworkSpectatorCount()

   116

{

   117

	NetworkTCPSocketHandler *cs;

   118

	byte count = 0;

   119

   120

	FOR_ALL_CLIENTS(cs) {

   121

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

   122

	}

   123

   124

	return count;

   125

}

   126

   127

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

   128

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

   129

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

   130

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

   131

{

   132

	char buf[1024];

   133

	va_list va;

   134

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

   135

	char message[1024];

   136

	char temp[1024];

   137

   138

	va_start(va, str);

   139

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

   140

	va_end(va);

   141

   142

	switch (action) {

   143

		case NETWORK_ACTION_SERVER_MESSAGE:

   144

			color = 1;

   145

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

   146

			break;

   147

		case NETWORK_ACTION_JOIN:

   148

			color = 1;

   149

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

   150

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

   151

			break;

   152

		case NETWORK_ACTION_LEAVE:

   153

			color = 1;

   154

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

   155

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

   156

			break;

   157

		case NETWORK_ACTION_GIVE_MONEY:

   158

			if (self_send) {

   159

				SetDParamStr(0, name);

   160

				SetDParam(1, atoi(buf));

   161

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

   162

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

   163

			} else {

   164

				SetDParam(0, atoi(buf));

   165

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

   166

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

   167

			}

   168

			break;

   169

		case NETWORK_ACTION_NAME_CHANGE:

   170

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

   171

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

   172

			break;

   173

		case NETWORK_ACTION_CHAT_COMPANY:

   174

			SetDParamStr(0, name);

   175

			SetDParamStr(1, buf);

   176

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

   177

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

   178

			break;

   179

		case NETWORK_ACTION_CHAT_CLIENT:

   180

			SetDParamStr(0, name);

   181

			SetDParamStr(1, buf);

   182

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

   183

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

   184

			break;

   185

		default:

   186

			SetDParamStr(0, name);

   187

			SetDParamStr(1, buf);

   188

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

   189

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

   190

			break;

   191

	}

   192

   193

#ifdef DEBUG_DUMP_COMMANDS

   194

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

   195

#endif /* DUMP_COMMANDS */

   196

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

   197

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

   198

}

   199

   200

// Calculate the frame-lag of a client

   201

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   202

{

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

   210

	return lag;

   211

}

   212

   213

   214

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

   215

//  error

   216

static void NetworkError(StringID error_string)

   217

{

   218

	_switch_mode = SM_MENU;

   219

	_switch_mode_errorstr = error_string;

   220

}

   221

   222

static void ClientStartError(const char *error)

   223

{

   224

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

   225

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   226

}

   227

   228

static void ServerStartError(const char *error)

   229

{

   230

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

   231

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   232

}

   233

   234

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   235

{

   236

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

   237

	//  disconnection (and why!)

   238

	NetworkErrorCode errorno;

   239

   240

	// We just want to close the connection..

   241

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   242

		cs->has_quit = true;

   243

		NetworkCloseClient(cs);

   244

		_networking = false;

   245

   246

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   247

		return;

   248

	}

   249

   250

	switch (res) {

   251

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   252

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   253

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   254

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   255

	}

   256

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

   257

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

   258

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   259

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   260

   261

		// Dequeue all commands before closing the socket

   262

		DEREF_CLIENT(0)->Send_Packets();

   263

	}

   264

   265

	_switch_mode = SM_MENU;

   266

	NetworkCloseClient(cs);

   267

	_networking = false;

   268

}

   269

   270

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

   271

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

   272

 * @param err NetworkErrorCode

   273

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

   274

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

   275

{

   276

	/* List of possible network errors, used by

   277

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   278

	static const StringID network_error_strings[] = {

   279

		STR_NETWORK_ERR_CLIENT_GENERAL,

   280

		STR_NETWORK_ERR_CLIENT_DESYNC,

   281

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   282

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   283

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   284

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   285

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   286

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   287

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   288

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   289

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   290

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   291

		STR_NETWORK_ERR_CLIENT_KICKED,

   292

		STR_NETWORK_ERR_CLIENT_CHEATER,

   293

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   294

	};

   295

   296

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

   297

   298

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

   299

}

   300

   301

/* Count the number of active clients connected */

   302

static uint NetworkCountPlayers()

   303

{

   304

	NetworkTCPSocketHandler *cs;

   305

	uint count = 0;

   306

   307

	FOR_ALL_CLIENTS(cs) {

   308

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   309

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

   310

	}

   311

   312

	return count;

   313

}

   314

   315

static bool _min_players_paused = false;

   316

   317

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

   318

void CheckMinPlayers()

   319

{

   320

	if (!_network_dedicated) return;

   321

   322

	if (NetworkCountPlayers() < _network_min_players) {

   323

		if (_min_players_paused) return;

   324

   325

		_min_players_paused = true;

   326

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

   327

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

   328

	} else {

   329

		if (!_min_players_paused) return;

   330

   331

		_min_players_paused = false;

   332

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

   333

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

   334

	}

   335

}

   336

   337

// Find all IP-aliases for this host

   338

static void NetworkFindIPs()

   339

{

   340

#if !defined(PSP)

   341

	int i;

   342

   343

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

   344

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

   345

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

   346

   347

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

   348

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

   349

		if (new_pos == 0) {

   350

			return B_ERROR;

   351

		}

   352

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

   353

		return B_OK;

   354

	}

   355

   356

	int output_length;

   357

	char *output_pointer = NULL;

   358

	char **output;

   359

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

   360

	i = 0;

   361

   362

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

   363

	_broadcast_list[0] = 0;

   364

   365

	if (sock < 0) {

   366

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

   367

		return;

   368

	}

   369

   370

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

   371

	if (output_length < 0) {

   372

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

   373

		return;

   374

	}

   375

   376

	output = &output_pointer;

   377

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

   378

		for (;;) {

   379

			uint32 n, fields, read;

   380

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

   381

			struct in_addr inaddr;

   382

			uint32 ip;

   383

			uint32 netmask;

   384

   385

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

   386

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

   387

			read += 1;

   388

			if (fields != 9) {

   389

				break;

   390

			}

   391

   392

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

   393

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

   394

   395

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

   396

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

   397

				_broadcast_list[i] = inaddr.s_addr;

   398

				i++;

   399

			}

   400

			if (read < 0) {

   401

				break;

   402

			}

   403

			*output += read;

   404

		}

   405

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

   406

		/*free(output_pointer);*/

   407

		/*free(output);*/

   408

		closesocket(sock);

   409

	}

   410

#elif defined(HAVE_GETIFADDRS)

   411

	struct ifaddrs *ifap, *ifa;

   412

   413

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

   414

	_broadcast_list[0] = 0;

   415

   416

	if (getifaddrs(&ifap) != 0)

   417

		return;

   418

   419

	i = 0;

   420

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

   421

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

   422

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

   423

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

   424

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

   425

		i++;

   426

	}

   427

	freeifaddrs(ifap);

   428

   429

#else /* not HAVE_GETIFADDRS */

   430

	SOCKET sock;

   431

#ifdef WIN32

   432

	DWORD len = 0;

   433

	INTERFACE_INFO ifo[MAX_INTERFACES];

   434

	uint j;

   435

#else

   436

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

   437

	struct ifconf ifconf;

   438

	const char* buf_end;

   439

	const char* p;

   440

#endif

   441

   442

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

   443

	_broadcast_list[0] = 0;

   444

   445

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   446

	if (sock == INVALID_SOCKET) return;

   447

   448

#ifdef WIN32

   449

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

   450

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

   451

		closesocket(sock);

   452

		return;

   453

	}

   454

   455

	i = 0;

   456

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

   457

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

   458

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

   459

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

   460

		 * 255.255.255.255.

   461

		 */

   462

		_broadcast_list[i++] =

   463

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

   464

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

   465

	}

   466

#else

   467

	ifconf.ifc_len = sizeof(buf);

   468

	ifconf.ifc_buf = buf;

   469

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

   470

		closesocket(sock);

   471

		return;

   472

	}

   473

   474

	i = 0;

   475

	buf_end = buf + ifconf.ifc_len;

   476

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

   477

		const struct ifreq* req = (const struct ifreq*)p;

   478

   479

		if (req->ifr_addr.sa_family == AF_INET) {

   480

			struct ifreq r;

   481

   482

			strncpy(r.ifr_name, req->ifr_name, lengthof(r.ifr_name));

   483

			if (ioctl(sock, SIOCGIFFLAGS, &r) != -1 &&

   484

					r.ifr_flags & IFF_BROADCAST &&