1

/* $Id$ */

     2

     3

#include "../stdafx.h"

     4

#include "network_data.h"

     5

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "../openttd.h"

    11

#include "../debug.h"

    12

#include "../functions.h"

    13

#include "../string.h"

    14

#include "../strings.h"

    15

#include "../map.h"

    16

#include "../command.h"

    17

#include "../variables.h"

    18

#include "../date.h"

    19

#include "../newgrf_config.h"

    20

#include "table/strings.h"

    21

#include "network_client.h"

    22

#include "network_server.h"

    23

#include "network_udp.h"

    24

#include "network_gamelist.h"

    25

#include "core/udp.h"

    26

#include "core/tcp.h"

    27

#include "core/core.h"

    28

#include "network_gui.h"

    29

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

    30

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

    31

#include "../md5.h"

    32

#include "../fileio.h"

    33

    34

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

    35

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

    36

    37

// global variables (declared in network_data.h)

    38

CommandPacket *_local_command_queue;

    39

    40

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

    41

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

    42

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

    43

    44

// Here we keep track of the clients

    45

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

    46

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    47

    48

    49

    50

// The listen socket for the server

    51

static SOCKET _listensocket;

    52

    53

// The amount of clients connected

    54

static byte _network_clients_connected = 0;

    55

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

    56

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    57

    58

/* Some externs / forwards */

    59

extern void StateGameLoop();

    60

    61

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

    62

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    63

{

    64

	NetworkClientInfo *ci;

    65

    66

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

    67

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

    68

	}

    69

    70

	return NULL;

    71

}

    72

    73

/** Return the CI for a given IP

    74

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

    75

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

    76

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    77

{

    78

	NetworkClientInfo *ci;

    79

	uint32 ip_number = inet_addr(ip);

    80

    81

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

    82

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

    83

	}

    84

    85

	return NULL;

    86

}

    87

    88

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

    89

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    90

{

    91

	NetworkTCPSocketHandler *cs;

    92

    93

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

    94

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

    95

	}

    96

    97

	return NULL;

    98

}

    99

   100

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

   101

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

   102

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

   103

{

   104

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   105

   106

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

   107

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

   108

	} else {

   109

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

   110

	}

   111

}

   112

   113

byte NetworkSpectatorCount()

   114

{

   115

	NetworkTCPSocketHandler *cs;

   116

	byte count = 0;

   117

   118

	FOR_ALL_CLIENTS(cs) {

   119

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

   120

	}

   121

   122

	return count;

   123

}

   124

   125

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

   126

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

   127

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

   128

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

   129

{

   130

	char buf[1024];

   131

	va_list va;

   132

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

   133

	char message[1024];

   134

	char temp[1024];

   135

   136

	va_start(va, str);

   137

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

   138

	va_end(va);

   139

   140

	switch (action) {

   141

		case NETWORK_ACTION_SERVER_MESSAGE:

   142

			color = 1;

   143

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

   144

			break;

   145

		case NETWORK_ACTION_JOIN:

   146

			color = 1;

   147

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

   148

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

   149

			break;

   150

		case NETWORK_ACTION_LEAVE:

   151

			color = 1;

   152

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

   153

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

   154

			break;

   155

		case NETWORK_ACTION_GIVE_MONEY:

   156

			if (self_send) {

   157

				SetDParamStr(0, name);

   158

				SetDParam(1, atoi(buf));

   159

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

   160

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

   161

			} else {

   162

				SetDParam(0, atoi(buf));

   163

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

   164

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

   165

			}

   166

			break;

   167

		case NETWORK_ACTION_NAME_CHANGE:

   168

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

   169

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

   170

			break;

   171

		case NETWORK_ACTION_CHAT_COMPANY:

   172

			SetDParamStr(0, name);

   173

			SetDParamStr(1, buf);

   174

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

   175

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

   176

			break;

   177

		case NETWORK_ACTION_CHAT_CLIENT:

   178

			SetDParamStr(0, name);

   179

			SetDParamStr(1, buf);

   180

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

   181

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

   182

			break;

   183

		default:

   184

			SetDParamStr(0, name);

   185

			SetDParamStr(1, buf);

   186

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

   187

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

   188

			break;

   189

	}

   190

   191

#ifdef DEBUG_DUMP_COMMANDS

   192

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

   193

#endif /* DUMP_COMMANDS */

   194

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

   195

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

   196

}

   197

   198

// Calculate the frame-lag of a client

   199

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   200

{

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

   208

	return lag;

   209

}

   210

   211

   212

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

   213

//  error

   214

static void NetworkError(StringID error_string)

   215

{

   216

	_switch_mode = SM_MENU;

   217

	_switch_mode_errorstr = error_string;

   218

}

   219

   220

static void ClientStartError(const char *error)

   221

{

   222

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

   223

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   224

}

   225

   226

static void ServerStartError(const char *error)

   227

{

   228

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

   229

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   230

}

   231

   232

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   233

{

   234

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

   235

	//  disconnection (and why!)

   236

	NetworkErrorCode errorno;

   237

   238

	// We just want to close the connection..

   239

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   240

		cs->has_quit = true;

   241

		NetworkCloseClient(cs);

   242

		_networking = false;

   243

   244

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   245

		return;

   246

	}

   247

   248

	switch (res) {

   249

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   250

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   251

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; 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

		DEREF_CLIENT(0)->Send_Packets();

   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_NEWGRF_MISMATCH,

   283

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   284

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   285

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   286

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   287

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   288

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   289

		STR_NETWORK_ERR_CLIENT_KICKED,

   290

		STR_NETWORK_ERR_CLIENT_CHEATER,

   291

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   292

	};

   293

   294

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

   295

   296

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

   297

}

   298

   299

/* Count the number of active clients connected */

   300

static uint NetworkCountPlayers()

   301

{

   302

	NetworkTCPSocketHandler *cs;

   303

	uint count = 0;

   304

   305

	FOR_ALL_CLIENTS(cs) {

   306

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   307

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

   308

	}

   309

   310

	return count;

   311

}

   312

   313

static bool _min_players_paused = false;

   314

   315

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

   316

void CheckMinPlayers()

   317

{

   318

	if (!_network_dedicated) return;

   319

   320

	if (NetworkCountPlayers() < _network_min_players) {

   321

		if (_min_players_paused) return;

   322

   323

		_min_players_paused = true;

   324

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

   325

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

   326

	} else {

   327

		if (!_min_players_paused) return;

   328

   329

		_min_players_paused = false;

   330

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

   331

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

   332

	}

   333

}

   334

   335

// Find all IP-aliases for this host

   336

static void NetworkFindIPs()

   337

{

   338

#if !defined(PSP)

   339

	int i;

   340

   341

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

   342

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

   343

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

   344

   345

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

   346

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

   347

		if (new_pos == 0) {

   348

			return B_ERROR;

   349

		}

   350

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

   351

		return B_OK;

   352

	}

   353

   354

	int output_length;

   355

	char *output_pointer = NULL;

   356

	char **output;

   357

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

   358

	i = 0;

   359

   360

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

   361

	_broadcast_list[0] = 0;

   362

   363

	if (sock < 0) {

   364

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

   365

		return;

   366

	}

   367

   368

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

   369

	if (output_length < 0) {

   370

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

   371

		return;

   372

	}

   373

   374

	output = &output_pointer;

   375

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

   376

		for (;;) {

   377

			uint32 n, fields, read;

   378

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

   379

			struct in_addr inaddr;

   380

			uint32 ip;

   381

			uint32 netmask;

   382

   383

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

   384

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

   385

			read += 1;

   386

			if (fields != 9) {

   387

				break;

   388

			}

   389

   390

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

   391

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

   392

   393

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

   394

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

   395

				_broadcast_list[i] = inaddr.s_addr;

   396

				i++;

   397

			}

   398

			if (read < 0) {

   399

				break;

   400

			}

   401

			*output += read;

   402

		}

   403

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

   404

		/*free(output_pointer);*/

   405

		/*free(output);*/

   406

		closesocket(sock);

   407

	}

   408

#elif defined(HAVE_GETIFADDRS)

   409

	struct ifaddrs *ifap, *ifa;

   410

   411

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

   412

	_broadcast_list[0] = 0;

   413

   414

	if (getifaddrs(&ifap) != 0)

   415

		return;

   416

   417

	i = 0;

   418

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

   419

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

   420

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

   421

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

   422

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

   423

		i++;

   424

	}

   425

	freeifaddrs(ifap);

   426

   427

#else /* not HAVE_GETIFADDRS */

   428

	SOCKET sock;

   429

#ifdef WIN32

   430

	DWORD len = 0;

   431

	INTERFACE_INFO ifo[MAX_INTERFACES];

   432

	uint j;

   433

#else

   434

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

   435

	struct ifconf ifconf;

   436

	const char* buf_end;

   437

	const char* p;

   438

#endif

   439

   440

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

   441

	_broadcast_list[0] = 0;

   442

   443

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   444

	if (sock == INVALID_SOCKET) return;

   445

   446

#ifdef WIN32

   447

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

   448

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

   449

		closesocket(sock);

   450

		return;

   451

	}

   452

   453

	i = 0;

   454

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

   455

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

   456

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

   457

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

   458

		 * 255.255.255.255.

   459

		 */

   460

		_broadcast_list[i++] =

   461

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

   462

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

   463

	}

   464

#else

   465

	ifconf.ifc_len = sizeof(buf);

   466

	ifconf.ifc_buf = buf;

   467

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

   468

		closesocket(sock);

   469

		return;

   470

	}

   471

   472

	i = 0;

   473

	buf_end = buf + ifconf.ifc_len;

   474

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

   475

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

   476

   477

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

   478

			struct ifreq r;

   479

   480

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

   481

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

   482

					r.ifr_flags & IFF_BROADCAST &&

   483

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

   484

				_broadcast_list[i++] =