1

/* $Id$ */

     2

     3

/** @file network.cpp Base functions for networking support. */

     4

     5

#include "../stdafx.h"

     6

#include "../player_type.h"

     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_internal.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 "core/host.h"

    27

#include "network_gui.h"

    28

#include "../console_func.h"

    29

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

    30

#include "../md5.h"

    31

#include "../texteff.hpp"

    32

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

    33

#include "../window_func.h"

    34

#include "../string_func.h"

    35

#include "../player_func.h"

    36

#include "../settings_type.h"

    37

#include "../landscape_type.h"

    38

#include "../rev.h"

    39

#ifdef DEBUG_DUMP_COMMANDS

    40

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

    41

#endif /* DEBUG_DUMP_COMMANDS */

    42

#include "table/strings.h"

    43

#include "../player_base.h"

    44

    45

bool _network_server;     ///< network-server is active

    46

bool _network_available;  ///< is network mode available?

    47

bool _network_dedicated;  ///< are we a dedicated server?

    48

bool _is_network_server;  ///< Does this client wants to be a network-server?

    49

NetworkServerGameInfo _network_game_info;

    51

NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

    52

uint16 _network_own_client_index;

    53

uint16 _redirect_console_to_client;

    54

bool _network_need_advertise;

    55

uint32 _network_last_advertise_frame;

    56

uint8 _network_reconnect;

    57

char *_network_host_list[10];

    58

char *_network_ban_list[25];

    59

uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode

    60

uint32 _frame_counter_max; // To where we may go with our clients

    61

uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.

    62

uint32 _broadcast_list[MAX_INTERFACES + 1];

    63

uint32 _network_server_bind_ip;

    64

uint32 _sync_seed_1, _sync_seed_2;

    65

uint32 _sync_frame;

    66

bool _network_first_time;

    67

uint32 _network_last_host_ip;

    68

bool _network_udp_server;

    69

uint16 _network_udp_broadcast;

    70

uint8 _network_advertise_retries;

    71

    72

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

    73

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

    74

assert_compile((int)NETWORK_COMPANY_NAME_LENGTH == MAX_LENGTH_COMPANY_NAME_BYTES);

    75

    76

// global variables (declared in network_data.h)

    77

CommandPacket *_local_command_queue;

    78

    79

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

    80

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

    81

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

    82

    83

// Here we keep track of the clients

    84

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

    85

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    86

    87

    88

    89

// The listen socket for the server

    90

static SOCKET _listensocket;

    91

    92

// The amount of clients connected

    93

static byte _network_clients_connected = 0;

    94

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

    95

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    96

    97

/* Some externs / forwards */

    98

extern void StateGameLoop();

    99

   100

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

   101

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

   102

{

   103

	NetworkClientInfo *ci;

   104

   105

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

   106

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

   107

	}

   108

   109

	return NULL;

   110

}

   111

   112

/** Return the CI for a given IP

   113

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

   114

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

   115

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

   116

{

   117

	NetworkClientInfo *ci;

   118

	uint32 ip_number = inet_addr(ip);

   119

   120

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

   121

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

   122

	}

   123

   124

	return NULL;

   125

}

   126

   127

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

   128

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   129

{

   130

	NetworkTCPSocketHandler *cs;

   131

   132

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

   133

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

   134

	}

   135

   136

	return NULL;

   137

}

   138

   139

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

   140

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

   141

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

   142

{

   143

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   144

   145

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

   146

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

   147

	} else {

   148

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

   149

	}

   150

}

   151

   152

byte NetworkSpectatorCount()

   153

{

   154

	NetworkTCPSocketHandler *cs;

   155

	byte count = 0;

   156

   157

	FOR_ALL_CLIENTS(cs) {

   159

	}

   160

   161

	return count;

   162

}

   163

   164

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

   165

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

   166

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

   167

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

   168

{

   169

	char buf[1024];

   170

	va_list va;

   171

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

   172

	char message[1024];

   173

	char temp[1024];

   174

   175

	va_start(va, str);

   176

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

   177

	va_end(va);

   178

   179

	switch (action) {

   180

		case NETWORK_ACTION_SERVER_MESSAGE:

   181

			color = CC_DEFAULT;

   182

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

   183

			break;

   184

		case NETWORK_ACTION_JOIN:

   185

			color = CC_DEFAULT;

   186

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

   187

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

   188

			break;

   189

		case NETWORK_ACTION_LEAVE:

   190

			color = CC_DEFAULT;

   191

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

   192

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

   193

			break;

   194

		case NETWORK_ACTION_GIVE_MONEY:

   195

			if (self_send) {

   196

				SetDParamStr(0, name);

   197

				SetDParam(1, atoi(buf));

   198

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

   199

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

   200

			} else {

   201

				SetDParam(0, atoi(buf));

   202

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

   203

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

   204

			}

   205

			break;

   206

		case NETWORK_ACTION_NAME_CHANGE:

   207

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

   208

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

   209

			break;

   210

		case NETWORK_ACTION_CHAT_COMPANY:

   211

			SetDParamStr(0, name);

   212

			SetDParamStr(1, buf);

   213

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

   214

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

   215

			break;

   216

		case NETWORK_ACTION_CHAT_CLIENT:

   217

			SetDParamStr(0, name);

   218

			SetDParamStr(1, buf);

   219

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

   220

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

   221

			break;

   222

		default:

   223

			SetDParamStr(0, name);

   224

			SetDParamStr(1, buf);

   225

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

   226

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

   227

			break;

   228

	}

   229

   230

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

   231

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

   232

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

   233

}

   234

   235

// Calculate the frame-lag of a client

   236

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   237

{

   238

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

   239

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

   240

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

   241

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

   242

	if (cs->last_frame_server + DAY_TICKS + _settings_client.network.frame_freq < _frame_counter)

   243

		lag += _frame_counter - (cs->last_frame_server + DAY_TICKS + _settings_client.network.frame_freq);

   244

   245

	return lag;

   246

}

   247

   248

   249

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

   250

//  error

   251

static void NetworkError(StringID error_string)

   252

{

   253

	_switch_mode = SM_MENU;

   254

	extern StringID _switch_mode_errorstr;

   255

	_switch_mode_errorstr = error_string;

   256

}

   257

   258

static void ClientStartError(const char *error)

   259

{

   260

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

   261

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   262

}

   263

   264

static void ServerStartError(const char *error)

   265

{

   266

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

   267

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   268

}

   269

   270

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   271

{

   272

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

   273

	//  disconnection (and why!)

   274

	NetworkErrorCode errorno;

   275

   276

	// We just want to close the connection..

   277

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   278

		cs->has_quit = true;

   279

		NetworkCloseClient(cs);

   280

		_networking = false;

   281

   282

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   283

		return;

   284

	}

   285

   286

	switch (res) {

   287

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   288

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   289

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   290

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   291

	}

   292

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

   293

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

   294

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   295

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   296

   297

		// Dequeue all commands before closing the socket

   298

		DEREF_CLIENT(0)->Send_Packets();

   299

	}

   300

   301

	_switch_mode = SM_MENU;

   302

	NetworkCloseClient(cs);

   303

	_networking = false;

   304

}

   305

   306

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

   307

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

   308

 * @param err NetworkErrorCode

   309

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

   310

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

   311

{

   312

	/* List of possible network errors, used by

   313

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   314

	static const StringID network_error_strings[] = {

   315

		STR_NETWORK_ERR_CLIENT_GENERAL,

   316

		STR_NETWORK_ERR_CLIENT_DESYNC,

   317

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   318

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   319

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   320

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   321

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   322

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   323

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   324

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   325

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   326

		STR_NETWORK_ERR_CLIENT_PLAYER_MISMATCH,

   327

		STR_NETWORK_ERR_CLIENT_KICKED,

   328

		STR_NETWORK_ERR_CLIENT_CHEATER,

   329

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   330

	};

   331

   332

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

   333

   334

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

   335

}

   336

   337

/* Count the number of active clients connected */

   339

{

   340

	NetworkTCPSocketHandler *cs;

   341

	uint count = 0;

   342

   343

	FOR_ALL_CLIENTS(cs) {

   344

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   346

	}

   347

   348

	return count;

   349

}

   350

   352

   355

{

   356

	if (!_network_dedicated) return;

   357

   360

   362

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

   363

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

   364

	} else {

   366

   368

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

   369

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

   370

	}

   371

}

   372

   375

 *

   378

 * occupied by connection_string. */

   380

{

   381

	char *p;

   382

	for (p = connection_string; *p != '\0'; p++) {

   383

		switch (*p) {

   384

			case '#':

   386

				*p = '\0';

   387

				break;

   388

			case ':':

   389

				*port = p + 1;

   390

				*p = '\0';

   391

				break;

   392

		}

   393

	}

   394

}

   395

   396

// Creates a new client from a socket

   397

//   Used both by the server and the client

   398

static NetworkTCPSocketHandler *NetworkAllocClient(SOCKET s)

   399

{

   400

	NetworkTCPSocketHandler *cs;

   401

	byte client_no = 0;

   402

   403

	if (_network_server) {

   404

		// Can we handle a new client?

   405

		if (_network_clients_connected >= MAX_CLIENTS) return NULL;

   406

		if (_network_game_info.clients_on >= _settings_client.network.max_clients) return NULL;

   407

   408

		// Register the login

   409

		client_no = _network_clients_connected++;

   410

	}

   411

   412

	cs = DEREF_CLIENT(client_no);

   413

	cs->Initialize();

   414

	cs->sock = s;

   415

	cs->last_frame = _frame_counter;

   416

	cs->last_frame_server = _frame_counter;

   417

   418

	if (_network_server) {

   419

		NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   420

		memset(ci, 0, sizeof(*ci));

   421

   422

		cs->index = _network_client_index++;

   423

		ci->client_index = cs->index;

   425

		ci->join_date = _date;

   426

   427

		InvalidateWindow(WC_CLIENT_LIST, 0);

   428

	}

   429

   430

	return cs;

   431

}

   432

   433

// Close a connection

   434

void NetworkCloseClient(NetworkTCPSocketHandler *cs)

   435

{

   436

	NetworkClientInfo *ci;

   437

	// Socket is already dead

   438

	if (cs->sock == INVALID_SOCKET) {

   439

		cs->has_quit = true;

   440

		return;

   441

	}

   442

   443

	DEBUG(net, 1, "Closed client connection %d", cs->index);

   444

   445

	if (!cs->has_quit && _network_server && cs->status > STATUS_INACTIVE) {

   446

		// We did not receive a leave message from this client...

   447

		NetworkErrorCode errorno = NETWORK_ERROR_CONNECTION_LOST;

   448

		char str[100];

   449

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   450

		NetworkTCPSocketHandler *new_cs;

   451

   452

		NetworkGetClientName(client_name, sizeof(client_name), cs);

   453

   454

		GetNetworkErrorMsg(str, errorno, lastof(str));

   455

   456

		NetworkTextMessage(NETWORK_ACTION_LEAVE, CC_DEFAULT, false, client_name, "%s", str);

   457

   458

		// Inform other clients of this... strange leaving ;)

   459

		FOR_ALL_CLIENTS(new_cs) {

   460

			if (new_cs->status > STATUS_AUTH && cs != new_cs) {

   461

				SEND_COMMAND(PACKET_SERVER_ERROR_QUIT)(new_cs, cs->index, errorno);

   462

			}

   463

		}

   464

	}

   465

   466

	/* When the client was PRE_ACTIVE, the server was in pause mode, so unpause */

   467

	if (cs->status == STATUS_PRE_ACTIVE && _settings_client.network.pause_on_join) {

   468

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

   469

		NetworkServerSendChat(NETWORK_ACTION_SERVER_MESSAGE, DESTTYPE_BROADCAST, 0, "Game unpaused", NETWORK_SERVER_INDEX);

   470

	}

   471

   472

	cs->Destroy();

   473

   474

	// Close the gap in the client-list

   475

	ci = DEREF_CLIENT_INFO(cs);

   476

   477

	if (_network_server) {

   478

		// We just lost one client :(

   479

		if (cs->status >= STATUS_AUTH) _network_game_info.clients_on--;

   480

		_network_clients_connected--;

   481