1

/* $Id$ */

     2

     3

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

     4

     5

#include "../stdafx.h"

     6

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

	#include "../fileio_func.h"

    42

#endif /* DEBUG_DUMP_COMMANDS */

    43

#include "table/strings.h"

    44

#include "../company_base.h"

    45

    46

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

    47

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

    48

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

    49

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

    50

NetworkServerGameInfo _network_game_info;

    51

NetworkCompanyInfo _network_company_info[MAX_COMPANIES];

    52

NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

    53

uint16 _network_own_client_index;

    54

uint16 _redirect_console_to_client;

    55

bool _network_need_advertise;

    56

uint32 _network_last_advertise_frame;

    57

uint8 _network_reconnect;

    58

char *_network_host_list[10];

    59

char *_network_ban_list[25];

    60

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

    61

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

    62

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

    63

uint32 _broadcast_list[MAX_INTERFACES + 1];

    64

uint32 _network_server_bind_ip;

    65

uint32 _sync_seed_1, _sync_seed_2;

    66

uint32 _sync_frame;

    67

bool _network_first_time;

    68

uint32 _network_last_host_ip;

    69

bool _network_udp_server;

    70

uint16 _network_udp_broadcast;

    71

uint8 _network_advertise_retries;

    72

    73

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

    74

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

    75

assert_compile((int)NETWORK_COMPANY_NAME_LENGTH == MAX_LENGTH_COMPANY_NAME_BYTES);

    76

    77

// global variables (declared in network_data.h)

    78

CommandPacket *_local_command_queue;

    79

    80

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

    81

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

    82

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

    83

    84

// Here we keep track of the clients

    85

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

    86

NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    87

    88

    89

    90

// The listen socket for the server

    91

static SOCKET _listensocket;

    92

    93

// The amount of clients connected

    94

static byte _network_clients_connected = 0;

    95

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

    96

static uint16 _network_client_index = NETWORK_SERVER_INDEX + 1;

    97

    98

/* Some externs / forwards */

    99

extern void StateGameLoop();

   100

   101

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

   102

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index)

   103

{

   104

	NetworkClientInfo *ci;

   105

   106

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

   107

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

   108

	}

   109

   110

	return NULL;

   111

}

   112

   113

/** Return the CI for a given IP

   114

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

   115

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

   116

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip)

   117

{

   118

	NetworkClientInfo *ci;

   119

	uint32 ip_number = inet_addr(ip);

   120

   121

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

   122

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

   123

	}

   124

   125

	return NULL;

   126

}

   127

   128

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

   129

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index)

   130

{

   131

	NetworkTCPSocketHandler *cs;

   132

   133

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

   134

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

   135

	}

   136

   137

	return NULL;

   138

}

   139

   140

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

   141

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

   142

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

   143

{

   144

	const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   145

   146

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

   147

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

   148

	} else {

   149

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

   150

	}

   151

}

   152

   153

byte NetworkSpectatorCount()

   154

{

   155

	NetworkTCPSocketHandler *cs;

   156

	byte count = 0;

   157

   158

	FOR_ALL_CLIENTS(cs) {

   159

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

   160

	}

   161

   162

	return count;

   163

}

   164

   165

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

   166

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

   167

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

   168

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

   169

{

   170

	char buf[1024];

   171

	va_list va;

   172

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

   173

	char message[1024];

   174

	char temp[1024];

   175

   176

	va_start(va, str);

   177

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

   178

	va_end(va);

   179

   180

	switch (action) {

   181

		case NETWORK_ACTION_SERVER_MESSAGE:

   182

			color = CC_DEFAULT;

   183

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

   184

			break;

   185

		case NETWORK_ACTION_JOIN:

   186

			color = CC_DEFAULT;

   187

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

   188

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

   189

			break;

   190

		case NETWORK_ACTION_LEAVE:

   191

			color = CC_DEFAULT;

   192

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

   193

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

   194

			break;

   195

		case NETWORK_ACTION_GIVE_MONEY:

   196

			if (self_send) {

   197

				SetDParamStr(0, name);

   198

				SetDParam(1, atoi(buf));

   199

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

   200

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

   201

			} else {

   202

				SetDParam(0, atoi(buf));

   203

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

   204

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

   205

			}

   206

			break;

   207

		case NETWORK_ACTION_NAME_CHANGE:

   208

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

   209

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

   210

			break;

   211

		case NETWORK_ACTION_CHAT_COMPANY:

   212

			SetDParamStr(0, name);

   213

			SetDParamStr(1, buf);

   214

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

   215

			strecpy(message, temp, lastof(message));

   216

			break;

   217

		case NETWORK_ACTION_CHAT_CLIENT:

   218

			SetDParamStr(0, name);

   219

			SetDParamStr(1, buf);

   220

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

   221

			strecpy(message, temp, lastof(message));

   222

			break;

   223

		default:

   224

			SetDParamStr(0, name);

   225

			SetDParamStr(1, buf);

   226

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

   227

			strecpy(message, temp, lastof(message));

   228

			break;

   229

	}

   230

   231

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

   232

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

   233

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

   234

}

   235

   236

// Calculate the frame-lag of a client

   237

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs)

   238

{

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

   246

	return lag;

   247

}

   248

   249

   250

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

   251

//  error

   252

static void NetworkError(StringID error_string)

   253

{

   254

	_switch_mode = SM_MENU;

   255

	extern StringID _switch_mode_errorstr;

   256

	_switch_mode_errorstr = error_string;

   257

}

   258

   259

static void ClientStartError(const char *error)

   260

{

   261

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

   262

	NetworkError(STR_NETWORK_ERR_CLIENT_START);

   263

}

   264

   265

static void ServerStartError(const char *error)

   266

{

   267

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

   268

	NetworkError(STR_NETWORK_ERR_SERVER_START);

   269

}

   270

   271

static void NetworkClientError(NetworkRecvStatus res, NetworkTCPSocketHandler* cs)

   272

{

   273

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

   274

	//  disconnection (and why!)

   275

	NetworkErrorCode errorno;

   276

   277

	// We just want to close the connection..

   278

	if (res == NETWORK_RECV_STATUS_CLOSE_QUERY) {

   279

		cs->has_quit = true;

   280

		NetworkCloseClient(cs);

   281

		_networking = false;

   282

   283

		DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   284

		return;

   285

	}

   286

   287

	switch (res) {

   288

		case NETWORK_RECV_STATUS_DESYNC:          errorno = NETWORK_ERROR_DESYNC; break;

   289

		case NETWORK_RECV_STATUS_SAVEGAME:        errorno = NETWORK_ERROR_SAVEGAME_FAILED; break;

   290

		case NETWORK_RECV_STATUS_NEWGRF_MISMATCH: errorno = NETWORK_ERROR_NEWGRF_MISMATCH; break;

   291

		default:                                  errorno = NETWORK_ERROR_GENERAL; break;

   292

	}

   293

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

   294

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

   295

			res != NETWORK_RECV_STATUS_SERVER_BANNED) {

   296

		SEND_COMMAND(PACKET_CLIENT_ERROR)(errorno);

   297

   298

		// Dequeue all commands before closing the socket

   299

		DEREF_CLIENT(0)->Send_Packets();

   300

	}

   301

   302

	_switch_mode = SM_MENU;

   303

	NetworkCloseClient(cs);

   304

	_networking = false;

   305

}

   306

   307

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

   308

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

   309

 * @param err NetworkErrorCode

   310

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

   311

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

   312

{

   313

	/* List of possible network errors, used by

   314

	 * PACKET_SERVER_ERROR and PACKET_CLIENT_ERROR */

   315

	static const StringID network_error_strings[] = {

   316

		STR_NETWORK_ERR_CLIENT_GENERAL,

   317

		STR_NETWORK_ERR_CLIENT_DESYNC,

   318

		STR_NETWORK_ERR_CLIENT_SAVEGAME,

   319

		STR_NETWORK_ERR_CLIENT_CONNECTION_LOST,

   320

		STR_NETWORK_ERR_CLIENT_PROTOCOL_ERROR,

   321

		STR_NETWORK_ERR_CLIENT_NEWGRF_MISMATCH,

   322

		STR_NETWORK_ERR_CLIENT_NOT_AUTHORIZED,

   323

		STR_NETWORK_ERR_CLIENT_NOT_EXPECTED,

   324

		STR_NETWORK_ERR_CLIENT_WRONG_REVISION,

   325

		STR_NETWORK_ERR_CLIENT_NAME_IN_USE,

   326

		STR_NETWORK_ERR_CLIENT_WRONG_PASSWORD,

   327

		STR_NETWORK_ERR_CLIENT_COMPANY_MISMATCH,

   328

		STR_NETWORK_ERR_CLIENT_KICKED,

   329

		STR_NETWORK_ERR_CLIENT_CHEATER,

   330

		STR_NETWORK_ERR_CLIENT_SERVER_FULL

   331

	};

   332

   333

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

   334

   335

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

   336

}

   337

   338

/* Count the number of active clients connected */

   339

static uint NetworkCountActiveClients()

   340

{

   341

	NetworkTCPSocketHandler *cs;

   342

	uint count = 0;

   343

   344

	FOR_ALL_CLIENTS(cs) {

   345

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   346

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

   347

	}

   348

   349

	return count;

   350

}

   351

   352

static bool _min_active_clients_paused = false;

   353

   354

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

   355

void CheckMinActiveClients()

   356

{

   357

	if (!_network_dedicated) return;

   358

   359

	if (NetworkCountActiveClients() < _settings_client.network.min_active_clients) {

   360

		if (_min_active_clients_paused) return;

   361

   362

		_min_active_clients_paused = true;

   363

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

   364

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

   365

	} else {

   366

		if (!_min_active_clients_paused) return;

   367

   368

		_min_active_clients_paused = false;

   369

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

   370

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

   371

	}

   372

}

   373

   374

/** Converts a string to ip/port/company

   375

 *  Format: IP#company:port

   376

 *

   377

 * connection_string will be re-terminated to seperate out the hostname, and company and port will

   378

 * be set to the company and port strings given by the user, inside the memory area originally

   379

 * occupied by connection_string. */

   380

void ParseConnectionString(const char **company, const char **port, char *connection_string)

   381

{

   382

	char *p;

   383

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

   384

		switch (*p) {

   385

			case '#':

   386

				*company = p + 1;

   387

				*p = '\0';

   388

				break;

   389

			case ':':

   390

				*port = p + 1;

   391

				*p = '\0';

   392

				break;

   393

		}

   394

	}

   395

}

   396

   397

// Creates a new client from a socket

   398

//   Used both by the server and the client

   399

static NetworkTCPSocketHandler *NetworkAllocClient(SOCKET s)

   400

{

   401

	NetworkTCPSocketHandler *cs;

   402

	byte client_no = 0;

   403

   404

	if (_network_server) {

   405

		// Can we handle a new client?

   406

		if (_network_clients_connected >= MAX_CLIENTS) return NULL;

   407

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

   408

   409

		// Register the login

   410

		client_no = _network_clients_connected++;

   411

	}

   412

   413

	cs = DEREF_CLIENT(client_no);

   414

	cs->Initialize();

   415

	cs->sock = s;

   416

	cs->last_frame = _frame_counter;

   417

	cs->last_frame_server = _frame_counter;

   418

   419

	if (_network_server) {

   420

		NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   421

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

   422

   423

		cs->index = _network_client_index++;

   424

		ci->client_index = cs->index;

   425

		ci->client_playas = COMPANY_INACTIVE_CLIENT;

   426

		ci->join_date = _date;

   427

   428

		InvalidateWindow(WC_CLIENT_LIST, 0);

   429

	}

   430

   431

	return cs;

   432

}

   433

   434

// Close a connection

   435

void NetworkCloseClient(NetworkTCPSocketHandler *cs)

   436

{

   437

	NetworkClientInfo *ci;

   438

	// Socket is already dead

   439

	if (cs->sock == INVALID_SOCKET) {

   440

		cs->has_quit = true;

   441

		return;

   442

	}

   443

   444

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

   445

   446

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

   447

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

   448

		NetworkErrorCode errorno = NETWORK_ERROR_CONNECTION_LOST;

   449

		char str[100];

   450

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   451

		NetworkTCPSocketHandler *new_cs;

   452

   453

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

   454

   455

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

   456

   457

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

   458

   459

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

   460

		FOR_ALL_CLIENTS(new_cs) {

   461

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

   462

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

   463

			}

   464

		}

   465

	}

   466

   467

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

   468

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

   469

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

   470

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

   471

	}

   472

   473

	cs->Destroy();

   474

   475

	// Close the gap in the client-list

   476

	ci = DEREF_CLIENT_INFO(cs);

   477

   478

	if (_network_server) {

   479

		// We just lost one client :(

   480

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

   481

		_network_clients_connected--;