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 "../strings_func.h"

    13

#include "../map_func.h"

    14

#include "../command_func.h"

    15

#include "../variables.h"

    16

#include "../date_func.h"

    17

#include "../newgrf_config.h"

    18

#include "network_client.h"

    19

#include "network_server.h"

    20

#include "network_udp.h"

    21

#include "network_gamelist.h"

    22

#include "core/udp.h"

    23

#include "core/tcp.h"

    24

#include "core/core.h"

    25

#include "network_gui.h"

    26

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

    27

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

    28

#include "../md5.h"

    29

#include "../fileio.h"

    30

#include "../texteff.hpp"

    31

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

    32

#include "../window_func.h"

    33

#include "../string_func.h"

    34

#include "../player_func.h"

    35

#ifdef DEBUG_DUMP_COMMANDS

    36

	#include "../core/alloc_func.hpp"

    37

#endif /* DEBUG_DUMP_COMMANDS */

    38

    39

#include "table/strings.h"

    40

    43

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

    44

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

    45

    46

// global variables (declared in network_data.h)

    47

CommandPacket *_local_command_queue;

    48

    49

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

    50

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

    51

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

    52

    53

// Here we keep track of the clients

    54

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

    55

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    56

    57

    58

    59

// The listen socket for the server

    60

static SOCKET _listensocket;

    61

    62

// The amount of clients connected

    63

static byte _network_clients_connected = 0;

    64

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

    65

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    66

    67

/* Some externs / forwards */

    68

extern void StateGameLoop();

    69

    70

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

    71

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    72

{

    73

	NetworkClientInfo *ci;

    74

    75

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

    76

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

    77

	}

    78

    79

	return NULL;

    80

}

    81

    82

/** Return the CI for a given IP

    83

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

    84

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

    85

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    86

{

    87

	NetworkClientInfo *ci;

    88

	uint32 ip_number = inet_addr(ip);

    89

    90

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

    91

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

    92

	}

    93

    94

	return NULL;

    95

}

    96

    97

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

    98

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    99

{

   100

	NetworkTCPSocketHandler *cs;

   101

   102

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

   103

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

   104

	}

   105

   106

	return NULL;

   107

}

   108

   109

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

   110

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

   111

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

   112

{

   113

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   114

   115

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

   116

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

   117

	} else {

   118

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

   119

	}

   120

}

   121

   122

byte NetworkSpectatorCount()

   123

{

   124

	NetworkTCPSocketHandler *cs;

   125

	byte count = 0;

   126

   127

	FOR_ALL_CLIENTS(cs) {

   128

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

   129

	}

   130

   131

	return count;

   132

}

   133

   134

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

   135

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

   136

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

   137

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

   138

{

   139

	char buf[1024];

   140

	va_list va;

   141

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

   142

	char message[1024];

   143

	char temp[1024];

   144

   145

	va_start(va, str);

   146

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

   147

	va_end(va);

   148

   149

	switch (action) {

   150

		case NETWORK_ACTION_SERVER_MESSAGE:

   151

			color = 1;

   152

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

   153

			break;

   154

		case NETWORK_ACTION_JOIN:

   155

			color = 1;

   156

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

   157

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

   158

			break;

   159

		case NETWORK_ACTION_LEAVE:

   160

			color = 1;

   161

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

   162

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

   163

			break;

   164

		case NETWORK_ACTION_GIVE_MONEY:

   165

			if (self_send) {

   166

				SetDParamStr(0, name);

   167

				SetDParam(1, atoi(buf));

   168

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

   169

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

   170

			} else {

   171

				SetDParam(0, atoi(buf));

   172

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

   173

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

   174

			}

   175

			break;

   176

		case NETWORK_ACTION_NAME_CHANGE:

   177

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

   178

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

   179

			break;

   180

		case NETWORK_ACTION_CHAT_COMPANY:

   181

			SetDParamStr(0, name);

   182

			SetDParamStr(1, buf);

   183

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

   184

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

   185

			break;

   186

		case NETWORK_ACTION_CHAT_CLIENT:

   187

			SetDParamStr(0, name);

   188

			SetDParamStr(1, buf);

   189

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

   190

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

   191

			break;

   192

		default:

   193

			SetDParamStr(0, name);

   194

			SetDParamStr(1, buf);

   195

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

   196

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

   197

			break;

   198

	}

   199

   200

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

   201

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

   202

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

   203

}

   204

   205

// Calculate the frame-lag of a client

   206

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   207

{

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

   215

	return lag;

   216

}

   217

   218

   219

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

   220

//  error

   221

static void NetworkError(StringID error_string)

   222

{

   223

	_switch_mode = SM_MENU;

   224

	_switch_mode_errorstr = error_string;

   225

}

   226

   227

static void ClientStartError(const char *error)

   228

{

   229

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

   230

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   231

}

   232

   233

static void ServerStartError(const char *error)

   234

{

   235

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

   236

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   237

}

   238

   239

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   240

{

   241

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

   242

	//  disconnection (and why!)

   243

	NetworkErrorCode errorno;

   244

   245

	// We just want to close the connection..

   246

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   247

		cs->has_quit = true;

   248

		NetworkCloseClient(cs);

   249

		_networking = false;

   250

   251

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   252

		return;

   253

	}

   254

   255

	switch (res) {

   256

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   257

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   258

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   259

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   260

	}

   261

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

   262

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

   263

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   264

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   265

   266

		// Dequeue all commands before closing the socket

   267

		DEREF_CLIENT(0)->Send_Packets();

   268

	}

   269

   270

	_switch_mode = SM_MENU;

   271

	NetworkCloseClient(cs);

   272

	_networking = false;

   273

}

   274

   275

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

   276

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

   277

 * @param err NetworkErrorCode

   278

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

   279

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

   280

{

   281

	/* List of possible network errors, used by

   282

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   283

	static const StringID network_error_strings[] = {

   284

		STR_NETWORK_ERR_CLIENT_GENERAL,

   285

		STR_NETWORK_ERR_CLIENT_DESYNC,

   286

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   287

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   288

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   289

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   290

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   291

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   292

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   293

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   294

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   295

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   296

		STR_NETWORK_ERR_CLIENT_KICKED,

   297

		STR_NETWORK_ERR_CLIENT_CHEATER,

   298

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   299

	};

   300

   301

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

   302

   303

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

   304

}

   305

   306

/* Count the number of active clients connected */

   307

static uint NetworkCountPlayers()

   308

{

   309

	NetworkTCPSocketHandler *cs;

   310

	uint count = 0;

   311

   312

	FOR_ALL_CLIENTS(cs) {

   313

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   314

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

   315

	}

   316

   317

	return count;

   318

}

   319

   320

static bool _min_players_paused = false;

   321

   322

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

   323

void CheckMinPlayers()

   324

{

   325

	if (!_network_dedicated) return;

   326

   327

	if (NetworkCountPlayers() < _network_min_players) {

   328

		if (_min_players_paused) return;

   329

   330

		_min_players_paused = true;

   331

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

   332

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

   333

	} else {

   334

		if (!_min_players_paused) return;

   335

   336

		_min_players_paused = false;

   337

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

   338

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

   339

	}

   340

}

   341

   342

// Find all IP-aliases for this host

   343

static void NetworkFindIPs()

   344

{

   345

#if !defined(PSP)

   346

	int i;

   347

   348

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

   349

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

   350

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

   351

   352

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

   353

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

   354

		if (new_pos == 0) {

   355

			return B_ERROR;

   356

		}

   357

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

   358

		return B_OK;

   359

	}

   360

   361

	int output_length;

   362

	char *output_pointer = NULL;

   363

	char **output;

   364

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

   365

	i = 0;

   366

   367

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

   368

	_broadcast_list[0] = 0;

   369

   370

	if (sock < 0) {

   371

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

   372

		return;

   373

	}

   374

   375

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

   376

	if (output_length < 0) {

   377

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

   378

		return;

   379

	}

   380

   381

	output = &output_pointer;

   382

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

   383

		for (;;) {

   384

			uint32 n, fields, read;

   385

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

   386

			struct in_addr inaddr;

   387

			uint32 ip;

   388

			uint32 netmask;

   389

   390

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

   391

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

   392

			read += 1;

   393

			if (fields != 9) {

   394

				break;

   395

			}

   396

   397

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

   398

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

   399

   400

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

   401

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

   402

				_broadcast_list[i] = inaddr.s_addr;

   403

				i++;

   404

			}

   405

			if (read < 0) {

   406

				break;

   407

			}

   408

			*output += read;

   409

		}

   410

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

   411

		/*free(output_pointer);*/

   412

		/*free(output);*/

   413

		closesocket(sock);

   414

	}

   415

#elif defined(HAVE_GETIFADDRS)

   416

	struct ifaddrs *ifap, *ifa;

   417

   418

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

   419

	_broadcast_list[0] = 0;

   420

   421

	if (getifaddrs(&ifap) != 0)

   422

		return;

   423

   424

	i = 0;

   425

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

   426

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

   427

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

   428

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

   429

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

   430

		i++;

   431

	}

   432

	freeifaddrs(ifap);

   433

   434

#else /* not HAVE_GETIFADDRS */

   435

	SOCKET sock;

   436

#ifdef WIN32

   437

	DWORD len = 0;

   438

	INTERFACE_INFO ifo[MAX_INTERFACES];

   439

	uint j;

   440

#else

   441

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

   442

	struct ifconf ifconf;

   443

	const char* buf_end;

   444

	const char* p;

   445

#endif

   446

   447

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

   448

	_broadcast_list[0] = 0;

   449

   450

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   451

	if (sock == INVALID_SOCKET) return;

   452

   453

#ifdef WIN32

   454

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

   455

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

   456

		closesocket(sock);

   457

		return;

   458

	}

   459

   460

	i = 0;

   461

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

   462

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

   463

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

   464

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

   465

		 * 255.255.255.255.

   466

		 */

   467

		_broadcast_list[i++] =

   468

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

   469

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

   470

	}

   471

#else

   472

	ifconf.ifc_len = sizeof(buf);

   473

	ifconf.ifc_buf = buf;

   474

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

   475

		closesocket(sock);

   476

		return;

   477

	}

   478

   479

	i = 0;

   480

	buf_end = buf + ifconf.ifc_len;

   481

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

   482

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

   483

   484

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