1

/* $Id$ */

     2

     3

#include "../stdafx.h"

     4

#include "network_data.h"

     5

     6

#if defined(WITH_REV)

     7

	extern const char _openttd_revision[];

     8

#elif defined(WITH_REV_HACK)

     9

	#define WITH_REV

    10

	extern const char _openttd_revision[] = WITH_REV_HACK;

    11

#else

    12

	extern const char _openttd_revision[] = NOREV_STRING;

    13

#endif

    14

    15

    16

#ifdef ENABLE_NETWORK

    17

    18

#include "../openttd.h"

    19

#include "../debug.h"

    20

#include "../functions.h"

    21

#include "../string.h"

    22

#include "../strings.h"

    23

#include "../map.h"

    24

#include "../command.h"

    25

#include "../variables.h"

    26

#include "../date.h"

    27

#include "../newgrf_config.h"

    28

#include "table/strings.h"

    29

#include "network_client.h"

    30

#include "network_server.h"

    31

#include "network_udp.h"

    32

#include "network_gamelist.h"

    33

#include "core/udp.h"

    34

#include "core/tcp.h"

    35

#include "core/core.h"

    36

#include "network_gui.h"

    37

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

    38

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

    39

#include "../md5.h"

    40

#include "../fileio.h"

    41

    42

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

    43

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

    44

    45

// global variables (declared in network_data.h)

    46

CommandPacket *_local_command_queue;

    47

    48

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

    49

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

    50

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

    51

    52

// Here we keep track of the clients

    53

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

    54

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    55

    56

    57

    58

// The listen socket for the server

    59

static SOCKET _listensocket;

    60

    61

// The amount of clients connected

    62

static byte _network_clients_connected = 0;

    63

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

    64

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    65

    66

/* Some externs / forwards */

    67

extern void StateGameLoop();

    68

    69

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

    70

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    71

{

    72

	NetworkClientInfo *ci;

    73

    74

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

    75

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

    76

	}

    77

    78

	return NULL;

    79

}

    80

    81

/** Return the CI for a given IP

    82

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

    83

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

    84

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    85

{

    86

	NetworkClientInfo *ci;

    87

	uint32 ip_number = inet_addr(ip);

    88

    89

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

    90

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

    91

	}

    92

    93

	return NULL;

    94

}

    95

    96

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

    97

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    98

{

    99

	NetworkTCPSocketHandler *cs;

   100

   101

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

   102

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

   103

	}

   104

   105

	return NULL;

   106

}

   107

   108

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

   109

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

   110

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

   111

{

   112

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   113

   114

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

   115

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

   116

	} else {

   117

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

   118

	}

   119

}

   120

   121

byte NetworkSpectatorCount()

   122

{

   123

	NetworkTCPSocketHandler *cs;

   124

	byte count = 0;

   125

   126

	FOR_ALL_CLIENTS(cs) {

   127

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

   128

	}

   129

   130

	return count;

   131

}

   132

   133

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

   134

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

   135

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

   136

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

   137

{

   138

	char buf[1024];

   139

	va_list va;

   140

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

   141

	char message[1024];

   142

	char temp[1024];

   143

   144

	va_start(va, str);

   145

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

   146

	va_end(va);

   147

   148

	switch (action) {

   149

		case NETWORK_ACTION_SERVER_MESSAGE:

   150

			color = 1;

   151

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

   152

			break;

   153

		case NETWORK_ACTION_JOIN:

   154

			color = 1;

   155

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

   156

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

   157

			break;

   158

		case NETWORK_ACTION_LEAVE:

   159

			color = 1;

   160

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

   161

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

   162

			break;

   163

		case NETWORK_ACTION_GIVE_MONEY:

   164

			if (self_send) {

   165

				SetDParamStr(0, name);

   166

				SetDParam(1, atoi(buf));

   167

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

   168

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

   169

			} else {

   170

				SetDParam(0, atoi(buf));

   171

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

   172

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

   173

			}

   174

			break;

   175

		case NETWORK_ACTION_NAME_CHANGE:

   176

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

   177

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

   178

			break;

   179

		case NETWORK_ACTION_CHAT_COMPANY:

   180

			SetDParamStr(0, name);

   181

			SetDParamStr(1, buf);

   182

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

   183

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

   184

			break;

   185

		case NETWORK_ACTION_CHAT_CLIENT:

   186

			SetDParamStr(0, name);

   187

			SetDParamStr(1, buf);

   188

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

   189

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

   190

			break;

   191

		default:

   192

			SetDParamStr(0, name);

   193

			SetDParamStr(1, buf);

   194

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

   195

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

   196

			break;

   197

	}

   198

   199

#ifdef DEBUG_DUMP_COMMANDS

   200

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

   201

#endif /* DUMP_COMMANDS */

   202

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

   203

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

   204

}

   205

   206

// Calculate the frame-lag of a client

   207

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   208

{

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

   216

	return lag;

   217

}

   218

   219

   220

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

   221

//  error

   222

static void NetworkError(StringID error_string)

   223

{

   224

	_switch_mode = SM_MENU;

   225

	_switch_mode_errorstr = error_string;

   226

}

   227

   228

static void ClientStartError(const char *error)

   229

{

   230

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

   231

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   232

}

   233

   234

static void ServerStartError(const char *error)

   235

{

   236

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

   237

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   238

}

   239

   240

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   241

{

   242

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

   243

	//  disconnection (and why!)

   244

	NetworkErrorCode errorno;

   245

   246

	// We just want to close the connection..

   247

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   248

		cs->has_quit = true;

   249

		NetworkCloseClient(cs);

   250

		_networking = false;

   251

   252

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   253

		return;

   254

	}

   255

   256

	switch (res) {

   257

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   258

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   259

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   260

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   261

	}

   262

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

   263

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

   264

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   265

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   266

   267

		// Dequeue all commands before closing the socket

   268

		DEREF_CLIENT(0)->Send_Packets();

   269

	}

   270

   271

	_switch_mode = SM_MENU;

   272

	NetworkCloseClient(cs);

   273

	_networking = false;

   274

}

   275

   276

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

   277

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

   278

 * @param err NetworkErrorCode

   279

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

   280

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

   281

{

   282

	/* List of possible network errors, used by

   283

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   284

	static const StringID network_error_strings[] = {

   285

		STR_NETWORK_ERR_CLIENT_GENERAL,

   286

		STR_NETWORK_ERR_CLIENT_DESYNC,

   287

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   288

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   289

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   290

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   291

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   292

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   293

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   294

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   295

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   296

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   297

		STR_NETWORK_ERR_CLIENT_KICKED,

   298

		STR_NETWORK_ERR_CLIENT_CHEATER,

   299

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   300

	};

   301

   302

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

   303

   304

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

   305

}

   306

   307

/* Count the number of active clients connected */

   308

static uint NetworkCountPlayers()

   309

{

   310

	NetworkTCPSocketHandler *cs;

   311

	uint count = 0;

   312

   313

	FOR_ALL_CLIENTS(cs) {

   314

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   315

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

   316

	}

   317

   318

	return count;

   319

}

   320

   321

static bool _min_players_paused = false;

   322

   323

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

   324

void CheckMinPlayers()

   325

{

   326

	if (!_network_dedicated) return;

   327

   328

	if (NetworkCountPlayers() < _network_min_players) {

   329

		if (_min_players_paused) return;

   330

   331

		_min_players_paused = true;

   332

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

   333

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

   334

	} else {

   335

		if (!_min_players_paused) return;

   336

   337

		_min_players_paused = false;

   338

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

   339

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

   340

	}

   341

}

   342

   343

// Find all IP-aliases for this host

   344

static void NetworkFindIPs()

   345

{

   346

#if !defined(PSP)

   347

	int i;

   348

   349

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

   350

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

   351

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

   352

   353

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

   354

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

   355

		if (new_pos == 0) {

   356

			return B_ERROR;

   357

		}

   358

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

   359

		return B_OK;

   360

	}

   361

   362

	int output_length;

   363

	char *output_pointer = NULL;

   364

	char **output;

   365

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

   366

	i = 0;

   367

   368

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

   369

	_broadcast_list[0] = 0;

   370

   371

	if (sock < 0) {

   372

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

   373

		return;

   374

	}

   375

   376

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

   377

	if (output_length < 0) {

   378

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

   379

		return;

   380

	}

   381

   382

	output = &output_pointer;

   383

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

   384

		for (;;) {

   385

			uint32 n, fields, read;

   386

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

   387

			struct in_addr inaddr;

   388

			uint32 ip;

   389

			uint32 netmask;

   390

   391

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

   392

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

   393

			read += 1;

   394

			if (fields != 9) {

   395

				break;

   396

			}

   397

   398

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

   399

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

   400

   401

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

   402

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

   403

				_broadcast_list[i] = inaddr.s_addr;

   404

				i++;

   405

			}

   406

			if (read < 0) {

   407

				break;

   408

			}

   409

			*output += read;

   410

		}

   411

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

   412

		/*free(output_pointer);*/

   413

		/*free(output);*/

   414

		closesocket(sock);

   415

	}

   416

#elif defined(HAVE_GETIFADDRS)

   417

	struct ifaddrs *ifap, *ifa;

   418

   419

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

   420

	_broadcast_list[0] = 0;

   421

   422

	if (getifaddrs(&ifap) != 0)

   423

		return;

   424

   425

	i = 0;

   426

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

   427

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

   428

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

   429

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

   430

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

   431

		i++;

   432

	}

   433

	freeifaddrs(ifap);

   434

   435

#else /* not HAVE_GETIFADDRS */

   436

	SOCKET sock;

   437

#ifdef WIN32

   438

	DWORD len = 0;

   439

	INTERFACE_INFO ifo[MAX_INTERFACES];

   440

	uint j;

   441

#else

   442

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

   443

	struct ifconf ifconf;

   444

	const char* buf_end;

   445

	const char* p;

   446

#endif

   447

   448

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

   449

	_broadcast_list[0] = 0;

   450

   451

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   452

	if (sock == INVALID_SOCKET) return;

   453

   454

#ifdef WIN32

   455

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

   456

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

   457

		closesocket(sock);

   458

		return;

   459

	}

   460

   461

	i = 0;

   462

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

   463

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

   464

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

   465

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

   466

		 * 255.255.255.255.

   467

		 */

   468

		_broadcast_list[i++] =

   469

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

   470

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

   471

	}

   472

#else

   473

	ifconf.ifc_len = sizeof(buf);

   474

	ifconf.ifc_buf = buf;

   475

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

   476

		closesocket(sock);

   477

		return;

   478

	}

   479

   480

	i = 0;

   481

	buf_end = buf + ifconf.ifc_len;

   482

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

   483

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

   484

   485