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

    19

#include "network_client.h"

    20

#include "network_server.h"

    21

#include "network_udp.h"

    22

#include "network_gamelist.h"

    23

#include "core/udp.h"

    24

#include "core/tcp.h"

    25

#include "core/core.h"

    26

#include "network_gui.h"

    27

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

    28

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

    29

#include "../md5.h"

    30

#include "../fileio.h"

    31

#include "../texteff.hpp"

    32

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

    33

#include "../window_func.h"

    34

#include "../string_func.h"

    35

#ifdef DEBUG_DUMP_COMMANDS

    36

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

    38

    39

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

    40

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

    41

    42

// global variables (declared in network_data.h)

    43

CommandPacket *_local_command_queue;

    44

    45

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

    46

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

    47

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

    48

    49

// Here we keep track of the clients

    50

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

    51

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    52

    53

    54

    55

// The listen socket for the server

    56

static SOCKET _listensocket;

    57

    58

// The amount of clients connected

    59

static byte _network_clients_connected = 0;

    60

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

    61

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    62

    63

/* Some externs / forwards */

    64

extern void StateGameLoop();

    65

    66

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

    67

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    68

{

    69

	NetworkClientInfo *ci;

    70

    71

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

    72

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

    73

	}

    74

    75

	return NULL;

    76

}

    77

    78

/** Return the CI for a given IP

    79

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

    80

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

    81

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    82

{

    83

	NetworkClientInfo *ci;

    84

	uint32 ip_number = inet_addr(ip);

    85

    86

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

    87

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

    88

	}

    89

    90

	return NULL;

    91

}

    92

    93

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

    94

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    95

{

    96

	NetworkTCPSocketHandler *cs;

    97

    98

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

    99

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

   100

	}

   101

   102

	return NULL;

   103

}

   104

   105

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

   106

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

   107

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

   108

{

   109

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   110

   111

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

   112

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

   113

	} else {

   114

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

   115

	}

   116

}

   117

   118

byte NetworkSpectatorCount()

   119

{

   120

	NetworkTCPSocketHandler *cs;

   121

	byte count = 0;

   122

   123

	FOR_ALL_CLIENTS(cs) {

   124

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

   125

	}

   126

   127

	return count;

   128

}

   129

   130

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

   131

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

   132

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

   133

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

   134

{

   135

	char buf[1024];

   136

	va_list va;

   137

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

   138

	char message[1024];

   139

	char temp[1024];

   140

   141

	va_start(va, str);

   142

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

   143

	va_end(va);

   144

   145

	switch (action) {

   146

		case NETWORK_ACTION_SERVER_MESSAGE:

   147

			color = 1;

   148

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

   149

			break;

   150

		case NETWORK_ACTION_JOIN:

   151

			color = 1;

   152

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

   153

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

   154

			break;

   155

		case NETWORK_ACTION_LEAVE:

   156

			color = 1;

   157

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

   158

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

   159

			break;

   160

		case NETWORK_ACTION_GIVE_MONEY:

   161

			if (self_send) {

   162

				SetDParamStr(0, name);

   163

				SetDParam(1, atoi(buf));

   164

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

   165

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

   166

			} else {

   167

				SetDParam(0, atoi(buf));

   168

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

   169

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

   170

			}

   171

			break;

   172

		case NETWORK_ACTION_NAME_CHANGE:

   173

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

   174

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

   175

			break;

   176

		case NETWORK_ACTION_CHAT_COMPANY:

   177

			SetDParamStr(0, name);

   178

			SetDParamStr(1, buf);

   179

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

   180

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

   181

			break;

   182

		case NETWORK_ACTION_CHAT_CLIENT:

   183

			SetDParamStr(0, name);

   184

			SetDParamStr(1, buf);

   185

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

   186

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

   187

			break;

   188

		default:

   189

			SetDParamStr(0, name);

   190

			SetDParamStr(1, buf);

   191

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

   192

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

   193

			break;

   194

	}

   195

   197

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

   198

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

   199

}

   200

   201

// Calculate the frame-lag of a client

   202

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   203

{

   204

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

   205

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

   206

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

   207

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

   208

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

   209

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

   210

   211

	return lag;

   212

}

   213

   214

   215

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

   216

//  error

   217

static void NetworkError(StringID error_string)

   218

{

   219

	_switch_mode = SM_MENU;

   220

	_switch_mode_errorstr = error_string;

   221

}

   222

   223

static void ClientStartError(const char *error)

   224

{

   225

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

   226

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   227

}

   228

   229

static void ServerStartError(const char *error)

   230

{

   231

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

   232

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   233

}

   234

   235

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   236

{

   237

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

   238

	//  disconnection (and why!)

   239

	NetworkErrorCode errorno;

   240

   241

	// We just want to close the connection..

   242

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   243

		cs->has_quit = true;

   244

		NetworkCloseClient(cs);

   245

		_networking = false;

   246

   247

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   248

		return;

   249

	}

   250

   251

	switch (res) {

   252

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   253

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   254

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   255

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   256

	}

   257

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

   258

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

   259

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   260

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   261

   262

		// Dequeue all commands before closing the socket

   263

		DEREF_CLIENT(0)->Send_Packets();

   264

	}

   265

   266

	_switch_mode = SM_MENU;

   267

	NetworkCloseClient(cs);

   268

	_networking = false;

   269

}

   270

   271

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

   272

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

   273

 * @param err NetworkErrorCode

   274

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

   275

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

   276

{

   277

	/* List of possible network errors, used by

   278

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   279

	static const StringID network_error_strings[] = {

   280

		STR_NETWORK_ERR_CLIENT_GENERAL,

   281

		STR_NETWORK_ERR_CLIENT_DESYNC,

   282

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   283

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   284

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   285

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   286

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   287

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   288

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   289

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   290

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   291

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   292

		STR_NETWORK_ERR_CLIENT_KICKED,

   293

		STR_NETWORK_ERR_CLIENT_CHEATER,

   294

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   295

	};

   296

   297

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

   298

   299

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

   300

}

   301

   302

/* Count the number of active clients connected */

   303

static uint NetworkCountPlayers()

   304

{

   305

	NetworkTCPSocketHandler *cs;

   306

	uint count = 0;

   307

   308

	FOR_ALL_CLIENTS(cs) {

   309

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   310

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

   311

	}

   312

   313

	return count;

   314

}

   315

   316

static bool _min_players_paused = false;

   317

   318

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

   319

void CheckMinPlayers()

   320

{

   321

	if (!_network_dedicated) return;

   322

   323

	if (NetworkCountPlayers() < _network_min_players) {

   324

		if (_min_players_paused) return;

   325

   326

		_min_players_paused = true;

   327

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

   328

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

   329

	} else {

   330

		if (!_min_players_paused) return;

   331

   332

		_min_players_paused = false;

   333

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

   334

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

   335

	}

   336

}

   337

   338

// Find all IP-aliases for this host

   339

static void NetworkFindIPs()

   340

{

   341

#if !defined(PSP)

   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 &&