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

    13

#include "../string.h"

    14

#include "../strings_func.h"

    15

#include "../map.h"

    16

#include "../command_func.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"

    34

    35

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

    36

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

    37

    38

// global variables (declared in network_data.h)

    39

CommandPacket *_local_command_queue;

    40

    41

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

    42

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

    43

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

    44

    45

// Here we keep track of the clients

    46

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

    47

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    48

    49

    50

    51

// The listen socket for the server

    52

static SOCKET _listensocket;

    53

    54

// The amount of clients connected

    55

static byte _network_clients_connected = 0;

    56

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

    57

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    58

    59

/* Some externs / forwards */

    60

extern void StateGameLoop();

    61

    62

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

    63

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

    64

{

    65

	NetworkClientInfo *ci;

    66

    67

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

    68

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

    69

	}

    70

    71

	return NULL;

    72

}

    73

    74

/** Return the CI for a given IP

    75

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

    76

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

    77

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

    78

{

    79

	NetworkClientInfo *ci;

    80

	uint32 ip_number = inet_addr(ip);

    81

    82

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

    83

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

    84

	}

    85

    86

	return NULL;

    87

}

    88

    89

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

    90

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

    91

{

    92

	NetworkTCPSocketHandler *cs;

    93

    94

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

    95

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

    96

	}

    97

    98

	return NULL;

    99

}

   100

   101

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

   102

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

   103

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

   104

{

   105

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   106

   107

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

   108

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

   109

	} else {

   110

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

   111

	}

   112

}

   113

   114

byte NetworkSpectatorCount()

   115

{

   116

	NetworkTCPSocketHandler *cs;

   117

	byte count = 0;

   118

   119

	FOR_ALL_CLIENTS(cs) {

   120

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

   121

	}

   122

   123

	return count;

   124

}

   125

   126

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

   127

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

   128

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

   129

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

   130

{

   131

	char buf[1024];

   132

	va_list va;

   133

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

   134

	char message[1024];

   135

	char temp[1024];

   136

   137

	va_start(va, str);

   138

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

   139

	va_end(va);

   140

   141

	switch (action) {

   142

		case NETWORK_ACTION_SERVER_MESSAGE:

   143

			color = 1;

   144

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

   145

			break;

   146

		case NETWORK_ACTION_JOIN:

   147

			color = 1;

   148

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

   149

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

   150

			break;

   151

		case NETWORK_ACTION_LEAVE:

   152

			color = 1;

   153

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

   154

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

   155

			break;

   156

		case NETWORK_ACTION_GIVE_MONEY:

   157

			if (self_send) {

   158

				SetDParamStr(0, name);

   159

				SetDParam(1, atoi(buf));

   160

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

   161

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

   162

			} else {

   163

				SetDParam(0, atoi(buf));

   164

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

   165

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

   166

			}

   167

			break;

   168

		case NETWORK_ACTION_NAME_CHANGE:

   169

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

   170

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

   171

			break;

   172

		case NETWORK_ACTION_CHAT_COMPANY:

   173

			SetDParamStr(0, name);

   174

			SetDParamStr(1, buf);

   175

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

   176

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

   177

			break;

   178

		case NETWORK_ACTION_CHAT_CLIENT:

   179

			SetDParamStr(0, name);

   180

			SetDParamStr(1, buf);

   181

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

   182

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

   183

			break;

   184

		default:

   185

			SetDParamStr(0, name);

   186

			SetDParamStr(1, buf);

   187

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

   188

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

   189

			break;

   190

	}

   191

   192

#ifdef DEBUG_DUMP_COMMANDS

   193

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

   194

#endif /* DUMP_COMMANDS */

   195

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

   196

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

   197

}

   198

   199

// Calculate the frame-lag of a client

   200

uint NetworkCalculateLag(const NetworkTCPSocketHandler *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, NetworkTCPSocketHandler* 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

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   253

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   254

	}

   255

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

   256

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

   257

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   258

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   259

   260

		// Dequeue all commands before closing the socket

   261

		DEREF_CLIENT(0)->Send_Packets();

   262

	}

   263

   264

	_switch_mode = SM_MENU;

   265

	NetworkCloseClient(cs);

   266

	_networking = false;

   267

}

   268

   269

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

   270

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

   271

 * @param err NetworkErrorCode

   272

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

   273

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

   274

{

   275

	/* List of possible network errors, used by

   276

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   277

	static const StringID network_error_strings[] = {

   278

		STR_NETWORK_ERR_CLIENT_GENERAL,

   279

		STR_NETWORK_ERR_CLIENT_DESYNC,

   280

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   281

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   282

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   283

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   284

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   285

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   286

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   287

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   288

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   289

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   290

		STR_NETWORK_ERR_CLIENT_KICKED,

   291

		STR_NETWORK_ERR_CLIENT_CHEATER,

   292

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   293

	};

   294

   295

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

   296

   297

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

   298

}

   299

   300

/* Count the number of active clients connected */

   301

static uint NetworkCountPlayers()

   302

{

   303

	NetworkTCPSocketHandler *cs;

   304

	uint count = 0;

   305

   306

	FOR_ALL_CLIENTS(cs) {

   307

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   308

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

   309

	}

   310

   311

	return count;

   312

}

   313

   314

static bool _min_players_paused = false;

   315

   316

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

   317

void CheckMinPlayers()

   318

{

   319

	if (!_network_dedicated) return;

   320

   321

	if (NetworkCountPlayers() < _network_min_players) {

   322

		if (_min_players_paused) return;

   323

   324

		_min_players_paused = true;

   325

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

   326

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

   327

	} else {

   328

		if (!_min_players_paused) return;

   329

   330

		_min_players_paused = false;

   331

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

   332

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

   333

	}

   334

}

   335

   336

// Find all IP-aliases for this host

   337

static void NetworkFindIPs()

   338

{

   339

#if !defined(PSP)

   340

	int i;

   341

   342

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

   343

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

   344

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

   345

   346

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

   347

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

   348

		if (new_pos == 0) {

   349

			return B_ERROR;

   350

		}

   351

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

   352

		return B_OK;

   353

	}

   354

   355

	int output_length;

   356

	char *output_pointer = NULL;

   357

	char **output;

   358

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

   359

	i = 0;

   360

   361

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

   362

	_broadcast_list[0] = 0;

   363

   364

	if (sock < 0) {

   365

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

   366

		return;

   367

	}

   368

   369

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

   370

	if (output_length < 0) {

   371

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

   372

		return;

   373

	}

   374

   375

	output = &output_pointer;

   376

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

   377

		for (;;) {

   378

			uint32 n, fields, read;

   379

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

   380

			struct in_addr inaddr;

   381

			uint32 ip;

   382

			uint32 netmask;

   383

   384

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

   385

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

   386

			read += 1;

   387

			if (fields != 9) {

   388

				break;

   389

			}

   390

   391

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

   392

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

   393

   394

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

   395

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

   396

				_broadcast_list[i] = inaddr.s_addr;

   397

				i++;

   398

			}

   399

			if (read < 0) {

   400

				break;

   401

			}

   402

			*output += read;

   403

		}

   404

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

   405

		/*free(output_pointer);*/

   406

		/*free(output);*/

   407

		closesocket(sock);

   408

	}

   409

#elif defined(HAVE_GETIFADDRS)

   410

	struct ifaddrs *ifap, *ifa;

   411

   412

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

   413

	_broadcast_list[0] = 0;

   414

   415

	if (getifaddrs(&ifap) != 0)

   416

		return;

   417

   418

	i = 0;

   419

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

   420

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

   421

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

   422

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

   423

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

   424

		i++;

   425

	}

   426

	freeifaddrs(ifap);

   427

   428

#else /* not HAVE_GETIFADDRS */

   429

	SOCKET sock;

   430

#ifdef WIN32

   431

	DWORD len = 0;

   432

	INTERFACE_INFO ifo[MAX_INTERFACES];

   433

	uint j;

   434

#else

   435

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

   436

	struct ifconf ifconf;

   437

	const char* buf_end;

   438

	const char* p;

   439

#endif

   440

   441

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

   442

	_broadcast_list[0] = 0;

   443

   444

	sock = socket(AF_INET, SOCK_DGRAM, 0);

   445

	if (sock == INVALID_SOCKET) return;

   446

   447

#ifdef WIN32

   448

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

   449

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

   450

		closesocket(sock);

   451

		return;

   452

	}

   453

   454

	i = 0;

   455

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

   456

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

   457

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

   458

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

   459

		 * 255.255.255.255.

   460

		 */

   461

		_broadcast_list[i++] =

   462

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

   463

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

   464

	}

   465

#else

   466

	ifconf.ifc_len = sizeof(buf);

   467

	ifconf.ifc_buf = buf;

   468

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

   469

		closesocket(sock);

   470

		return;

   471

	}

   472

   473

	i = 0;

   474

	buf_end = buf + ifconf.ifc_len;

   475

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

   476

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

   477

   478

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

   479

			struct ifreq r;

   480

   481

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

   482

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

   483

					r.ifr_flags & IFF_BROADCAST &&

   484

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