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

    41

// global variables (declared in network_data.h)

    42

CommandPacket *_local_command_queue;

    43

    44

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

    45

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

    46

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

    47

    48

// Here we keep track of the clients

    49

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

    50

NetworkClientState _clients[MAX_CLIENTS];

    51

    52

    53

    54

// The listen socket for the server

    55

static SOCKET _listensocket;

    56

    57

// The amount of clients connected

    58

static byte _network_clients_connected = 0;

    59

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

    60

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    61

    62

/* Some externs / forwards */

    63

extern void StateGameLoop(void);

    64

    65

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

    66

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    67

{

    68

	NetworkClientInfo *ci;

    69

    70

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

    71

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

    72

	}

    73

    74

	return NULL;

    75

}

    76

    77

/** Return the CI for a given IP

    78

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

    79

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

    80

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    81

{

    82

	NetworkClientInfo *ci;

    83

	uint32 ip_number = inet_addr(ip);

    84

    85

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

    86

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

    87

	}

    88

    89

	return NULL;

    90

}

    91

    92

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

    93

NetworkClientState *NetworkFindClientStateFromIndex(uint16 client_index)

    94

{

    95

	NetworkClientState *cs;

    96

    97

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

    98

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

    99

	}

   100

   101

	return NULL;

   102

}

   103

   104

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

   105

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

   106

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

   107

{

   108

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   109

   110

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

   111

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

   112

	} else {

   113

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

   114

	}

   115

}

   116

   117

byte NetworkSpectatorCount(void)

   118

{

   119

	const NetworkClientState *cs;

   120

	byte count = 0;

   121

   122

	FOR_ALL_CLIENTS(cs) {

   123

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

   124

	}

   125

   126

	return count;

   127

}

   128

   129

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

   130

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

   131

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

   132

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

   133

{

   134

	char buf[1024];

   135

	va_list va;

   136

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

   137

	char message[1024];

   138

	char temp[1024];

   139

   140

	va_start(va, str);

   141

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

   142

	va_end(va);

   143

   144

	switch (action) {

   145

		case NETWORK_ACTION_SERVER_MESSAGE:

   146

			color = 1;

   147

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

   148

			break;

   149

		case NETWORK_ACTION_JOIN:

   150

			color = 1;

   151

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

   152

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

   153

			break;

   154

		case NETWORK_ACTION_LEAVE:

   155

			color = 1;

   156

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

   157

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

   158

			break;

   159

		case NETWORK_ACTION_GIVE_MONEY:

   160

			if (self_send) {

   161

				SetDParamStr(0, name);

   162

				SetDParam(1, atoi(buf));

   163

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

   164

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

   165

			} else {

   166

				SetDParam(0, atoi(buf));

   167

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

   168

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

   169

			}

   170

			break;

   171

		case NETWORK_ACTION_NAME_CHANGE:

   172

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

   173

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

   174

			break;

   175

		case NETWORK_ACTION_CHAT_COMPANY:

   176

			SetDParamStr(0, name);

   177

			SetDParamStr(1, buf);

   178

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

   179

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

   180

			break;

   181

		case NETWORK_ACTION_CHAT_CLIENT:

   182

			SetDParamStr(0, name);

   183

			SetDParamStr(1, buf);

   184

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

   185

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

   186

			break;

   187

		default:

   188

			SetDParamStr(0, name);

   189

			SetDParamStr(1, buf);

   190

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

   191

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

   192

			break;

   193

	}

   194

   195

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

   196

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

   197

}

   198

   199

// Calculate the frame-lag of a client

   200

uint NetworkCalculateLag(const NetworkClientState *cs)

   201

{

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

   209

	return lag;

   210

}

   211

   212

   213

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

   214

//  error

   215

static void NetworkError(StringID error_string)

   216

{

   217

	_switch_mode = SM_MENU;

   218

	_switch_mode_errorstr = error_string;

   219

}

   220

   221

static void ClientStartError(const char *error)

   222

{

   223

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

   224

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   225

}

   226

   227

static void ServerStartError(const char *error)

   228

{

   229

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

   230

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   231

}

   232

   233

static void NetworkClientError(NetworkRecvStatus res, NetworkClientState* cs)

   234

{

   235

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

   236

	//  disconnection (and why!)

   237

	NetworkErrorCode errorno;

   238

   239

	// We just want to close the connection..

   240

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   241

		cs->has_quit = true;

   242

		NetworkCloseClient(cs);

   243

		_networking = false;

   244

   245

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   246

		return;

   247

	}

   248

   249

	switch (res) {

   250

		case NETWORK_RECV_STATUS_DESYNC:   errorno = NETWORK_ERROR_DESYNC; break;

   251

		case NETWORK_RECV_STATUS_SAVEGAME: errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   252

		default:                           errorno = NETWORK_ERROR_GENERAL; break;

   253

	}

   254

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

   255

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

   256

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   257

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   258

   259

		// Dequeue all commands before closing the socket

   260

		NetworkSend_Packets(DEREF_CLIENT(0));

   261

	}

   262

   263

	_switch_mode = SM_MENU;

   264

	NetworkCloseClient(cs);

   265

	_networking = false;

   266

}

   267

   268

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

   269

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

   270

 * @param err NetworkErrorCode

   271

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

   272

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

   273

{

   274

	/* List of possible network errors, used by

   275

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   276

	static const StringID network_error_strings[] = {

   277

		STR_NETWORK_ERR_CLIENT_GENERAL,

   278

		STR_NETWORK_ERR_CLIENT_DESYNC,

   279

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   280

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   281

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   282

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   283

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   284

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   285

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   286

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   287

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   288

		STR_NETWORK_ERR_CLIENT_KICKED,

   289

		STR_NETWORK_ERR_CLIENT_CHEATER,

   290

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   291

	};

   292

   293

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

   294

   295

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

   296

}

   297

   298

/* Count the number of active clients connected */

   299

static uint NetworkCountPlayers(void)

   300

{

   301

	const NetworkClientState *cs;

   302

	uint count = 0;

   303

   304

	FOR_ALL_CLIENTS(cs) {

   305

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   306

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

   307

	}

   308

   309

	return count;

   310

}

   311

   312

static bool _min_players_paused = false;

   313

   314

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

   315

void CheckMinPlayers(void)

   316

{

   317

	if (!_network_dedicated) return;

   318

   319

	if (NetworkCountPlayers() < _network_min_players) {

   320

		if (_min_players_paused) return;

   321

   322

		_min_players_paused = true;

   323

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

   324

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

   325

	} else {

   326

		if (!_min_players_paused) return;

   327

   328

		_min_players_paused = false;

   329

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

   330

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

   331

	}

   332

}

   333

   334

// Find all IP-aliases for this host

   335

static void NetworkFindIPs(void)

   336

{

   337

	int i;

   338

   339

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

   340

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

   341

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

   342

   343

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

   344

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

   345

		if (new_pos == 0) {

   346

			return B_ERROR;

   347

		}

   348

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

   349

		return B_OK;

   350

	}

   351

   352

	int output_length;

   353

	char *output_pointer = NULL;

   354

	char **output;

   355

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

   356

	i = 0;

   357

   358

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

   359

	_broadcast_list[0] = 0;

   360

   361

	if (sock < 0) {

   362

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

   363

		return;

   364

	}

   365

   366

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

   367

	if (output_length < 0) {

   368

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

   369

		return;

   370

	}

   371

   372

	output = &output_pointer;

   373

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

   374

		for (;;) {

   375

			uint32 n, fields, read;

   376

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

   377

			struct in_addr inaddr;

   378

			uint32 ip;

   379

			uint32 netmask;

   380

   381

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

   382

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

   383

			read += 1;

   384

			if (fields != 9) {

   385

				break;

   386

			}

   387

   388

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

   389

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

   390

   391

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

   392

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

   393

				_broadcast_list[i] = inaddr.s_addr;

   394

				i++;

   395

			}

   396

			if (read < 0) {

   397

				break;

   398

			}

   399

			*output += read;

   400

		}

   401

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

   402

		/*free(output_pointer);*/

   403

		/*free(output);*/

   404

		closesocket(sock);

   405

	}

   406

#elif defined(HAVE_GETIFADDRS)

   407

	struct ifaddrs *ifap, *ifa;

   408

   409

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

   410

	_broadcast_list[0] = 0;

   411

   412

	if (getifaddrs(&ifap) != 0)

   413

		return;

   414

   415

	i = 0;

   416

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

   417

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

   418

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

   419

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

   420

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

   421

		i++;

   422

	}

   423

	freeifaddrs(ifap);

   424

   425

#else /* not HAVE_GETIFADDRS */

   426

	SOCKET sock;

   427

#ifdef WIN32

   428

	DWORD len = 0;

   429

	INTERFACE_INFO ifo[MAX_INTERFACES];

   430

	uint j;

   431

#else

   432

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

   433

	struct ifconf ifconf;

   434

	const char* buf_end;

   435

	const char* p;

   436

#endif

   437

   438

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

   439

	_broadcast_list[0] = 0;

   440

   441

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   442

	if (sock == INVALID_SOCKET) return;

   443

   444

#ifdef WIN32

   445

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

   446

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

   447

		closesocket(sock);

   448

		return;

   449

	}

   450

   451

	i = 0;

   452

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

   453

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

   454

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

   455

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

   456

		 * 255.255.255.255.

   457

		 */

   458

		_broadcast_list[i++] =

   459

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

   460

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

   461

	}

   462

#else

   463

	ifconf.ifc_len = sizeof(buf);

   464

	ifconf.ifc_buf = buf;

   465

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

   466

		closesocket(sock);

   467

		return;

   468

	}

   469

   470

	i = 0;

   471

	buf_end = buf + ifconf.ifc_len;

   472

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

   473

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

   474

   475

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

   476

			struct ifreq r;

   477

   478

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

   479

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

   480

					r.ifr_flags & IFF_BROADCAST &&

   481

					ioctl(sock, SIOCGIFBRDADDR, &r) != -1) {

   482

				_broadcast_list[i++] =

   483

					((struct sockaddr_in*)&r.ifr_broadaddr)->sin_addr.s_addr;

   484

			}

   485

		}

   486