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

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

    42

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

    43

    44

// global variables (declared in network_data.h)

    45

CommandPacket *_local_command_queue;

    46

    47

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

    48

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

    49

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

    50

    51

// Here we keep track of the clients

    52

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

    53

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    54

    55

    56

    57

// The listen socket for the server

    58

static SOCKET _listensocket;

    59

    60

// The amount of clients connected

    61

static byte _network_clients_connected = 0;

    62

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

    63

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    64

    65

/* Some externs / forwards */

    66

extern void StateGameLoop(void);

    67

    68

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

    69

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    70

{

    71

	NetworkClientInfo *ci;

    72

    73

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

    74

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

    75

	}

    76

    77

	return NULL;

    78

}

    79

    80

/** Return the CI for a given IP

    81

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

    82

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

    83

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    84

{

    85

	NetworkClientInfo *ci;

    86

	uint32 ip_number = inet_addr(ip);

    87

    88

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

    89

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

    90

	}

    91

    92

	return NULL;

    93

}

    94

    95

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

    96

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    97

{

    98

	NetworkTCPSocketHandler *cs;

    99

   100

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

   101

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

   102

	}

   103

   104

	return NULL;

   105

}

   106

   107

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

   108

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

   109

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

   110

{

   111

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   112

   113

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

   114

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

   115

	} else {

   116

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

   117

	}

   118

}

   119

   120

byte NetworkSpectatorCount(void)

   121

{

   122

	NetworkTCPSocketHandler *cs;

   123

	byte count = 0;

   124

   125

	FOR_ALL_CLIENTS(cs) {

   126

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

   127

	}

   128

   129

	return count;

   130

}

   131

   132

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

   133

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

   134

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

   135

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

   136

{

   137

	char buf[1024];

   138

	va_list va;

   139

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

   140

	char message[1024];

   141

	char temp[1024];

   142

   143

	va_start(va, str);

   144

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

   145

	va_end(va);

   146

   147

	switch (action) {

   148

		case NETWORK_ACTION_SERVER_MESSAGE:

   149

			color = 1;

   150

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

   151

			break;

   152

		case NETWORK_ACTION_JOIN:

   153

			color = 1;

   154

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

   155

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

   156

			break;

   157

		case NETWORK_ACTION_LEAVE:

   158

			color = 1;

   159

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

   160

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

   161

			break;

   162

		case NETWORK_ACTION_GIVE_MONEY:

   163

			if (self_send) {

   164

				SetDParamStr(0, name);

   165

				SetDParam(1, atoi(buf));

   166

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

   167

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

   168

			} else {

   169

				SetDParam(0, atoi(buf));

   170

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

   171

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

   172

			}

   173

			break;

   174

		case NETWORK_ACTION_NAME_CHANGE:

   175

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

   176

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

   177

			break;

   178

		case NETWORK_ACTION_CHAT_COMPANY:

   179

			SetDParamStr(0, name);

   180

			SetDParamStr(1, buf);

   181

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

   182

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

   183

			break;

   184

		case NETWORK_ACTION_CHAT_CLIENT:

   185

			SetDParamStr(0, name);

   186

			SetDParamStr(1, buf);

   187

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

   188

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

   189

			break;

   190

		default:

   191

			SetDParamStr(0, name);

   192

			SetDParamStr(1, buf);

   193

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

   194

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

   195

			break;

   196

	}

   197

   198

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

   199

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

   200

}

   201

   202

// Calculate the frame-lag of a client

   203

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   204

{

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

   212

	return lag;

   213

}

   214

   215

   216

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

   217

//  error

   218

static void NetworkError(StringID error_string)

   219

{

   220

	_switch_mode = SM_MENU;

   221

	_switch_mode_errorstr = error_string;

   222

}

   223

   224

static void ClientStartError(const char *error)

   225

{

   226

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

   227

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   228

}

   229

   230

static void ServerStartError(const char *error)

   231

{

   232

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

   233

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   234

}

   235

   236

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   237

{

   238

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

   239

	//  disconnection (and why!)

   240

	NetworkErrorCode errorno;

   241

   242

	// We just want to close the connection..

   243

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   244

		cs->has_quit = true;

   245

		NetworkCloseClient(cs);

   246

		_networking = false;

   247

   248

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   249

		return;

   250

	}

   251

   252

	switch (res) {

   253

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   254

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   255

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   256

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   257

	}

   258

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

   259

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

   260

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   261

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   262

   263

		// Dequeue all commands before closing the socket

   264

		DEREF_CLIENT(0)->Send_Packets();

   265

	}

   266

   267

	_switch_mode = SM_MENU;

   268

	NetworkCloseClient(cs);

   269

	_networking = false;

   270

}

   271

   272

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

   273

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

   274

 * @param err NetworkErrorCode

   275

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

   276

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

   277

{

   278

	/* List of possible network errors, used by

   279

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   280

	static const StringID network_error_strings[] = {

   281

		STR_NETWORK_ERR_CLIENT_GENERAL,

   282

		STR_NETWORK_ERR_CLIENT_DESYNC,

   283

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   284

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   285

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   286

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   287

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   288

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   289

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   290

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   291

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   292

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   293

		STR_NETWORK_ERR_CLIENT_KICKED,

   294

		STR_NETWORK_ERR_CLIENT_CHEATER,

   295

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   296

	};

   297

   298

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

   299

   300

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

   301

}

   302

   303

/* Count the number of active clients connected */

   304

static uint NetworkCountPlayers(void)

   305

{

   306

	NetworkTCPSocketHandler *cs;

   307

	uint count = 0;

   308

   309

	FOR_ALL_CLIENTS(cs) {

   310

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   311

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

   312

	}

   313

   314

	return count;

   315

}

   316

   317

static bool _min_players_paused = false;

   318

   319

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

   320

void CheckMinPlayers(void)

   321

{

   322

	if (!_network_dedicated) return;

   323

   324

	if (NetworkCountPlayers() < _network_min_players) {

   325

		if (_min_players_paused) return;

   326

   327

		_min_players_paused = true;

   328

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

   329

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

   330

	} else {

   331

		if (!_min_players_paused) return;

   332

   333

		_min_players_paused = false;

   334

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

   335

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

   336

	}

   337

}

   338

   339

// Find all IP-aliases for this host

   340

static void NetworkFindIPs(void)

   341

{

   342

	int i;

   343

   344

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

   345

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

   346

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

   347

   348

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

   349

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

   350

		if (new_pos == 0) {

   351

			return B_ERROR;

   352

		}

   353

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

   354

		return B_OK;

   355

	}

   356

   357

	int output_length;

   358

	char *output_pointer = NULL;

   359

	char **output;

   360

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

   361

	i = 0;

   362

   363

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

   364

	_broadcast_list[0] = 0;

   365

   366

	if (sock < 0) {

   367

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

   368

		return;

   369

	}

   370

   371

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

   372

	if (output_length < 0) {

   373

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

   374

		return;

   375

	}

   376

   377

	output = &output_pointer;

   378

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

   379

		for (;;) {

   380

			uint32 n, fields, read;

   381

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

   382

			struct in_addr inaddr;

   383

			uint32 ip;

   384

			uint32 netmask;

   385

   386

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

   387

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

   388

			read += 1;

   389

			if (fields != 9) {

   390

				break;

   391

			}

   392

   393

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

   394

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

   395

   396

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

   397

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

   398

				_broadcast_list[i] = inaddr.s_addr;

   399

				i++;

   400

			}

   401

			if (read < 0) {

   402

				break;

   403

			}

   404

			*output += read;

   405

		}

   406

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

   407

		/*free(output_pointer);*/

   408

		/*free(output);*/

   409

		closesocket(sock);

   410

	}

   411

#elif defined(HAVE_GETIFADDRS)

   412

	struct ifaddrs *ifap, *ifa;

   413

   414

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

   415

	_broadcast_list[0] = 0;

   416

   417

	if (getifaddrs(&ifap) != 0)

   418

		return;

   419

   420

	i = 0;

   421

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

   422

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

   423

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

   424

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

   425

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

   426

		i++;

   427

	}

   428

	freeifaddrs(ifap);

   429

   430

#else /* not HAVE_GETIFADDRS */

   431

	SOCKET sock;

   432

#ifdef WIN32

   433

	DWORD len = 0;

   434

	INTERFACE_INFO ifo[MAX_INTERFACES];

   435

	uint j;

   436

#else

   437

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

   438

	struct ifconf ifconf;

   439

	const char* buf_end;

   440

	const char* p;

   441

#endif

   442

   443

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

   444

	_broadcast_list[0] = 0;

   445

   446

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   447

	if (sock == INVALID_SOCKET) return;

   448

   449

#ifdef WIN32

   450

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

   451

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

   452

		closesocket(sock);

   453

		return;

   454

	}

   455

   456

	i = 0;

   457

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

   458

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

   459

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

   460

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

   461

		 * 255.255.255.255.

   462

		 */

   463

		_broadcast_list[i++] =

   464

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

   465

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

   466

	}

   467

#else

   468

	ifconf.ifc_len = sizeof(buf);

   469

	ifconf.ifc_buf = buf;

   470

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

   471

		closesocket(sock);

   472

		return;

   473

	}

   474

   475

	i = 0;

   476

	buf_end = buf + ifconf.ifc_len;

   477

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

   478

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

   479

   480

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

   481

			struct ifreq r;

   482

   483

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

   484

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

   485