1

/* $Id$ */

     2

     3

/**

     4

 * @file network_udp.cpp This file handles the UDP related communication.

     5

 *

     6

 * This is the GameServer <-> MasterServer and GameServer <-> GameClient

     7

 * communication before the game is being joined.

     8

 */

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "../stdafx.h"

    13

#include "../debug.h"

    14

#include "../date_func.h"

    15

#include "../map_func.h"

    16

#include "network_gamelist.h"

    17

#include "network_udp.h"

    18

#include "network_internal.h"

    19

#include "core/host.h"

    20

#include "../variables.h"

    21

#include "../newgrf_config.h"

    22

#include "../core/endian_func.hpp"

    23

#include "../string_func.h"

    24

#include "../company_base.h"

    25

#include "../company_func.h"

    26

#include "../settings_type.h"

    27

#include "../rev.h"

    28

    29

#include "core/udp.h"

    30

    31

enum {

    32

	ADVERTISE_NORMAL_INTERVAL = 30000, // interval between advertising in ticks (15 minutes)

    33

	ADVERTISE_RETRY_INTERVAL  =   300, // readvertise when no response after this many ticks (9 seconds)

    34

	ADVERTISE_RETRY_TIMES     =     3  // give up readvertising after this much failed retries

    35

};

    36

    37

NetworkUDPSocketHandler *_udp_client_socket; ///< udp client socket

    38

NetworkUDPSocketHandler *_udp_server_socket; ///< udp server socket

    39

NetworkUDPSocketHandler *_udp_master_socket; ///< udp master socket

    40

    41

///*** Communication with the masterserver ***/

    42

    43

class MasterNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    44

protected:

    45

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

    46

public:

    47

	virtual ~MasterNetworkUDPSocketHandler() {}

    48

};

    49

    50

DEF_UDP_RECEIVE_COMMAND(Master, PACKET_UDP_MASTER_ACK_REGISTER)

    51

{

    52

	_network_advertise_retries = 0;

    53

	DEBUG(net, 2, "[udp] advertising on master server successful");

    54

    55

	/* We are advertised, but we don't want to! */

    56

	if (!_settings_client.network.server_advertise) NetworkUDPRemoveAdvertise();

    57

}

    58

    59

///*** Communication with clients (we are server) ***/

    60

    61

class ServerNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

    62

protected:

    63

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

    64

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

    65

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

    66

public:

    67

	virtual ~ServerNetworkUDPSocketHandler() {}

    68

};

    69

    70

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_FIND_SERVER)

    71

{

    72

	// Just a fail-safe.. should never happen

    73

	if (!_network_udp_server) {

    74

		return;

    75

	}

    76

    77

	NetworkGameInfo ngi;

    78

    79

	/* Update some game_info */

    80

	ngi.clients_on     = _network_game_info.clients_on;

    81

	ngi.start_date     = _network_game_info.start_date;

    82

    83

	ngi.server_lang    = _settings_client.network.server_lang;

    84

	ngi.use_password   = !StrEmpty(_settings_client.network.server_password);

    85

	ngi.clients_max    = _settings_client.network.max_clients;

    86

	ngi.companies_on   = ActiveCompanyCount();

    87

	ngi.companies_max  = _settings_client.network.max_companies;

    88

	ngi.spectators_on  = NetworkSpectatorCount();

    89

	ngi.spectators_max = _settings_client.network.max_spectators;

    90

	ngi.game_date      = _date;

    91

	ngi.map_width      = MapSizeX();

    92

	ngi.map_height     = MapSizeY();

    93

	ngi.map_set        = _settings_game.game_creation.landscape;

    94

	ngi.dedicated      = _network_dedicated;

    95

	ngi.grfconfig      = _grfconfig;

    96

    97

	strecpy(ngi.map_name, _network_game_info.map_name, lastof(ngi.map_name));

    98

	strecpy(ngi.server_name, _settings_client.network.server_name, lastof(ngi.server_name));

    99

	strecpy(ngi.server_revision, _openttd_revision, lastof(ngi.server_revision));

   100

   101

	Packet packet(PACKET_UDP_SERVER_RESPONSE);

   102

	this->Send_NetworkGameInfo(&packet, &ngi);

   103

   104

	// Let the client know that we are here

   105

	this->SendPacket(&packet, client_addr);

   106

   107

	DEBUG(net, 2, "[udp] queried from '%s'", inet_ntoa(client_addr->sin_addr));

   108

}

   109

   110

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_DETAIL_INFO)

   111

{

   112

	// Just a fail-safe.. should never happen

   113

	if (!_network_udp_server) return;

   114

   115

	Packet packet(PACKET_UDP_SERVER_DETAIL_INFO);

   116

   117

	/* Send the amount of active companies */

   118

	packet.Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   119

	packet.Send_uint8 (ActiveCompanyCount());

   120

   121

	/* Fetch the latest version of everything */

   122

	NetworkPopulateCompanyInfo();

   123

   124

	Company *company;

   125

	byte current = 0;

   126

	/* Go through all the companies */

   127

	FOR_ALL_COMPANIES(company) {

   128

		current++;

   129

   130

		/* Send the information */

   131

		packet.Send_uint8 (current);

   132

   133

		packet.Send_string(_network_company_info[company->index].company_name);

   134

		packet.Send_uint32(_network_company_info[company->index].inaugurated_year);

   135

		packet.Send_uint64(_network_company_info[company->index].company_value);

   136

		packet.Send_uint64(_network_company_info[company->index].money);

   137

		packet.Send_uint64(_network_company_info[company->index].income);

   138

		packet.Send_uint16(_network_company_info[company->index].performance);

   139

   140

		/* Send 1 if there is a passord for the company else send 0 */

   141

		packet.Send_bool  (!StrEmpty(_network_company_info[company->index].password));

   142

   143

		for (int i = 0; i < NETWORK_VEHICLE_TYPES; i++) {

   144

			packet.Send_uint16(_network_company_info[company->index].num_vehicle[i]);

   145

		}

   146

   147

		for (int i = 0; i < NETWORK_STATION_TYPES; i++) {

   148

			packet.Send_uint16(_network_company_info[company->index].num_station[i]);

   149

		}

   150

	}

   151

   152

	this->SendPacket(&packet, client_addr);

   153

}

   154

   155

/**

   156

 * A client has requested the names of some NewGRFs.

   157

 *

   158

 * Replying this can be tricky as we have a limit of SEND_MTU bytes

   159

 * in the reply packet and we can send up to 100 bytes per NewGRF

   160

 * (GRF ID, MD5sum and NETWORK_GRF_NAME_LENGTH bytes for the name).

   161

 * As SEND_MTU is _much_ less than 100 * NETWORK_MAX_GRF_COUNT, it

   162

 * could be that a packet overflows. To stop this we only reply

   163

 * with the first N NewGRFs so that if the first N + 1 NewGRFs

   164

 * would be sent, the packet overflows.

   165

 * in_reply and in_reply_count are used to keep a list of GRFs to

   166

 * send in the reply.

   167

 */

   168

DEF_UDP_RECEIVE_COMMAND(Server, PACKET_UDP_CLIENT_GET_NEWGRFS)

   169

{

   170

	uint8 num_grfs;

   171

	uint i;

   172

   173

	const GRFConfig *in_reply[NETWORK_MAX_GRF_COUNT];

   174

	uint8 in_reply_count = 0;

   175

	size_t packet_len = 0;

   176

   177

	DEBUG(net, 6, "[udp] newgrf data request from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   178

   179

	num_grfs = p->Recv_uint8 ();

   180

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   181

   182

	for (i = 0; i < num_grfs; i++) {

   183

		GRFConfig c;

   184

		const GRFConfig *f;

   185

   186

		this->Recv_GRFIdentifier(p, &c);

   187

   188

		/* Find the matching GRF file */

   189

		f = FindGRFConfig(c.grfid, c.md5sum);

   190

		if (f == NULL) continue; // The GRF is unknown to this server

   191

   192

		/* If the reply might exceed the size of the packet, only reply

   193

		 * the current list and do not send the other data.

   194

		 * The name could be an empty string, if so take the filename. */

   195

		packet_len += sizeof(c.grfid) + sizeof(c.md5sum) +

   196

				min(strlen((f->name != NULL && !StrEmpty(f->name)) ? f->name : f->filename) + 1, (size_t)NETWORK_GRF_NAME_LENGTH);

   197

		if (packet_len > SEND_MTU - 4) { // 4 is 3 byte header + grf count in reply

   198

			break;

   199

		}

   200

		in_reply[in_reply_count] = f;

   201

		in_reply_count++;

   202

	}

   203

   204

	if (in_reply_count == 0) return;

   205

   206

	Packet packet(PACKET_UDP_SERVER_NEWGRFS);

   207

	packet.Send_uint8(in_reply_count);

   208

	for (i = 0; i < in_reply_count; i++) {

   209

		char name[NETWORK_GRF_NAME_LENGTH];

   210

   211

		/* The name could be an empty string, if so take the filename */

   212

		strecpy(name, (in_reply[i]->name != NULL && !StrEmpty(in_reply[i]->name)) ?

   213

				in_reply[i]->name : in_reply[i]->filename, lastof(name));

   214

		this->Send_GRFIdentifier(&packet, in_reply[i]);

   215

		packet.Send_string(name);

   216

	}

   217

   218

	this->SendPacket(&packet, client_addr);

   219

}

   220

   221

///*** Communication with servers (we are client) ***/

   222

   223

class ClientNetworkUDPSocketHandler : public NetworkUDPSocketHandler {

   224

protected:

   225

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   226

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   227

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   228

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   229

public:

   230

	virtual ~ClientNetworkUDPSocketHandler() {}

   231

};

   232

   233

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_RESPONSE)

   234

{

   235

	NetworkGameList *item;

   236

   237

	// Just a fail-safe.. should never happen

   238

	if (_network_udp_server) return;

   239

   240

	DEBUG(net, 4, "[udp] server response from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   241

   242

	// Find next item

   243

	item = NetworkGameListAddItem(inet_addr(inet_ntoa(client_addr->sin_addr)), ntohs(client_addr->sin_port));

   244

   245

	this->Recv_NetworkGameInfo(p, &item->info);

   246

   247

	item->info.compatible = true;

   248

	{

   249

		/* Checks whether there needs to be a request for names of GRFs and makes

   250

		 * the request if necessary. GRFs that need to be requested are the GRFs

   251

		 * that do not exist on the clients system and we do not have the name

   252

		 * resolved of, i.e. the name is still UNKNOWN_GRF_NAME_PLACEHOLDER.

   253

		 * The in_request array and in_request_count are used so there is no need

   254

		 * to do a second loop over the GRF list, which can be relatively expensive

   255

		 * due to the string comparisons. */

   256

		const GRFConfig *in_request[NETWORK_MAX_GRF_COUNT];

   257

		const GRFConfig *c;

   258

		uint in_request_count = 0;

   259

		struct sockaddr_in out_addr;

   260

   261

		for (c = item->info.grfconfig; c != NULL; c = c->next) {

   262

			if (c->status == GCS_NOT_FOUND) item->info.compatible = false;

   263

			if (c->status != GCS_NOT_FOUND || strcmp(c->name, UNKNOWN_GRF_NAME_PLACEHOLDER) != 0) continue;

   264

			in_request[in_request_count] = c;

   265

			in_request_count++;

   266

		}

   267

   268

		if (in_request_count > 0) {

   269

			/* There are 'unknown' GRFs, now send a request for them */

   270

			uint i;

   271

			Packet packet(PACKET_UDP_CLIENT_GET_NEWGRFS);

   272

   273

			packet.Send_uint8(in_request_count);

   274

			for (i = 0; i < in_request_count; i++) {

   275

				this->Send_GRFIdentifier(&packet, in_request[i]);

   276

			}

   277

   278

			out_addr.sin_family      = AF_INET;

   279

			out_addr.sin_port        = htons(item->port);

   280

			out_addr.sin_addr.s_addr = item->ip;

   281

			this->SendPacket(&packet, &out_addr);

   282

		}

   283

	}

   284

   285

	if (item->info.hostname[0] == '\0')

   286

		snprintf(item->info.hostname, sizeof(item->info.hostname), "%s", inet_ntoa(client_addr->sin_addr));

   287

   288

	/* Check if we are allowed on this server based on the revision-match */

   289

	item->info.version_compatible = IsNetworkCompatibleVersion(item->info.server_revision);

   290

	item->info.compatible &= item->info.version_compatible; // Already contains match for GRFs

   291

   292

	item->online = true;

   293

   294

	UpdateNetworkGameWindow(false);

   295

}

   296

   297

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_MASTER_RESPONSE_LIST)

   298

{

   299

	int i;

   300

	struct in_addr ip;

   301

	uint16 port;

   302

	uint8 ver;

   303

   304

	/* packet begins with the protocol version (uint8)

   305

	 * then an uint16 which indicates how many

   306

	 * ip:port pairs are in this packet, after that

   307

	 * an uint32 (ip) and an uint16 (port) for each pair

   308

	 */

   309

   310

	ver = p->Recv_uint8();

   311

   312

	if (ver == 1) {

   313

		for (i = p->Recv_uint16(); i != 0 ; i--) {

   314

			ip.s_addr = TO_LE32(p->Recv_uint32());

   315

			port = p->Recv_uint16();

   316

   317

			/* Somehow we reached the end of the packet */

   318

			if (this->HasClientQuit()) return;

   319

			NetworkUDPQueryServer(inet_ntoa(ip), port);

   320

		}

   321

	}

   322

}

   323

   324

/** The return of the client's request of the names of some NewGRFs */

   325

DEF_UDP_RECEIVE_COMMAND(Client, PACKET_UDP_SERVER_NEWGRFS)

   326

{

   327

	uint8 num_grfs;

   328

	uint i;

   329

   330

	DEBUG(net, 6, "[udp] newgrf data reply from %s:%d", inet_ntoa(client_addr->sin_addr), ntohs(client_addr->sin_port));

   331

   332

	num_grfs = p->Recv_uint8 ();

   333

	if (num_grfs > NETWORK_MAX_GRF_COUNT) return;

   334

   335

	for (i = 0; i < num_grfs; i++) {

   336

		char *unknown_name;

   337

		char name[NETWORK_GRF_NAME_LENGTH];

   338

		GRFConfig c;

   339

   340

		this->Recv_GRFIdentifier(p, &c);

   341

		p->Recv_string(name, sizeof(name));

   342

   343

		/* An empty name is not possible under normal circumstances

   344

		 * and causes problems when showing the NewGRF list. */

   345

		if (StrEmpty(name)) continue;

   346

   347

		/* Finds the fake GRFConfig for the just read GRF ID and MD5sum tuple.

   348

		 * If it exists and not resolved yet, then name of the fake GRF is

   349

		 * overwritten with the name from the reply. */

   350

		unknown_name = FindUnknownGRFName(c.grfid, c.md5sum, false);

   351

		if (unknown_name != NULL && strcmp(unknown_name, UNKNOWN_GRF_NAME_PLACEHOLDER) == 0) {

   352

			ttd_strlcpy(unknown_name, name, NETWORK_GRF_NAME_LENGTH);

   353

		}

   354

	}

   355

}

   356

   357

void ClientNetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)

   358

{

   359

	/* Find the matching GRF file */

   360

	const GRFConfig *f = FindGRFConfig(config->grfid, config->md5sum);

   361

	if (f == NULL) {

   362

		/* Don't know the GRF, so mark game incompatible and the (possibly)

   363

		 * already resolved name for this GRF (another server has sent the

   364

		 * name of the GRF already */

   365

		config->name   = FindUnknownGRFName(config->grfid, config->md5sum, true);

   366

		config->status = GCS_NOT_FOUND;

   367

	} else {

   368

		config->filename  = f->filename;

   369

		config->name      = f->name;

   370

		config->info      = f->info;

   371

	}

   372

	SetBit(config->flags, GCF_COPY);

   373

}

   374

   375

// Close UDP connection

   376

void NetworkUDPCloseAll()

   377

{

   378

	DEBUG(net, 1, "[udp] closed listeners");

   379

   380

	_udp_server_socket->Close();

   381

	_udp_master_socket->Close();

   382

	_udp_client_socket->Close();

   383

   384

	_network_udp_server = false;

   385

	_network_udp_broadcast = 0;

   386

}

   387

   388

// Broadcast to all ips

   389

static void NetworkUDPBroadCast(NetworkUDPSocketHandler *socket)

   390

{

   391

	uint i;

   392

   393

	for (i = 0; _broadcast_list[i] != 0; i++) {

   394

		Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   395

		struct sockaddr_in out_addr;

   396

   397

		out_addr.sin_family = AF_INET;

   398

		out_addr.sin_port = htons(_settings_client.network.server_port);

   399

		out_addr.sin_addr.s_addr = _broadcast_list[i];

   400

   401

		DEBUG(net, 4, "[udp] broadcasting to %s", inet_ntoa(out_addr.sin_addr));

   402

   403

		socket->SendPacket(&p, &out_addr);

   404

	}

   405

}

   406

   407

   408

// Request the the server-list from the master server

   409

void NetworkUDPQueryMasterServer()

   410

{

   411

	struct sockaddr_in out_addr;

   412

   413

	if (!_udp_client_socket->IsConnected()) {

   414

		if (!_udp_client_socket->Listen(0, 0, true)) return;

   415

	}

   416

   417

	Packet p(PACKET_UDP_CLIENT_GET_LIST);

   418

   419

	out_addr.sin_family = AF_INET;

   420

	out_addr.sin_port = htons(NETWORK_MASTER_SERVER_PORT);

   421

	out_addr.sin_addr.s_addr = NetworkResolveHost(NETWORK_MASTER_SERVER_HOST);

   422

   423

	// packet only contains protocol version

   424

	p.Send_uint8(NETWORK_MASTER_SERVER_VERSION);

   425

   426

	_udp_client_socket->SendPacket(&p, &out_addr);

   427

   428

	DEBUG(net, 2, "[udp] master server queried at %s:%d", inet_ntoa(out_addr.sin_addr), ntohs(out_addr.sin_port));

   429

}

   430

   431

// Find all servers

   432

void NetworkUDPSearchGame()

   433

{

   434

	// We are still searching..

   435

	if (_network_udp_broadcast > 0) return;

   436

   437

	// No UDP-socket yet..

   438

	if (!_udp_client_socket->IsConnected()) {

   439

		if (!_udp_client_socket->Listen(0, 0, true)) return;

   440

	}

   441

   442

	DEBUG(net, 0, "[udp] searching server");

   443

   444

	NetworkUDPBroadCast(_udp_client_socket);

   445

	_network_udp_broadcast = 300; // Stay searching for 300 ticks

   446

}

   447

   448

void NetworkUDPQueryServer(const char* host, unsigned short port, bool manually)

   449

{

   450

	struct sockaddr_in out_addr;

   451

	NetworkGameList *item;

   452

   453

	// No UDP-socket yet..

   454

	if (!_udp_client_socket->IsConnected()) {

   455

		if (!_udp_client_socket->Listen(0, 0, true)) return;

   456

	}

   457

   458

	out_addr.sin_family = AF_INET;

   459

	out_addr.sin_port = htons(port);

   460

	out_addr.sin_addr.s_addr = NetworkResolveHost(host);

   461

   462

	// Clear item in gamelist

   463

	item = NetworkGameListAddItem(inet_addr(inet_ntoa(out_addr.sin_addr)), ntohs(out_addr.sin_port));

   464

	if (item == NULL) return;

   465

   466

	if (StrEmpty(item->info.server_name)) {

   467

		memset(&item->info, 0, sizeof(item->info));

   468

		strecpy(item->info.server_name, host, lastof(item->info.server_name));

   469

		strecpy(item->info.hostname, host, lastof(item->info.hostname));

   470

		item->online = false;

   471

	}

   472

	item->manually = manually;

   473

   474

	// Init the packet

   475

	Packet p(PACKET_UDP_CLIENT_FIND_SERVER);

   476

	_udp_client_socket->SendPacket(&p, &out_addr);

   477

   478

	UpdateNetworkGameWindow(false);

   479

}

   480

   481

/* Remove our advertise from the master-server */

   482

void NetworkUDPRemoveAdvertise()

   483

{

   484

	struct sockaddr_in out_addr;

   485

   486

	/* Check if we are advertising */

   487

	if (!_networking || !_network_server || !_network_udp_server) return;

   488