1

/* $Id$ */

     2

     3

/** @file network_server.cpp Server part of the network protocol. */

     4

     5

#ifdef ENABLE_NETWORK

     6

     7

#include "../stdafx.h"

     8

#include "../openttd.h" // XXX StringID

     9

#include "../debug.h"

    10

#include "../strings_func.h"

    11

#include "network_data.h"

    12

#include "core/tcp.h"

    13

#include "../vehicle_base.h"

    14

#include "../vehicle_func.h"

    15

#include "../date_func.h"

    16

#include "network_server.h"

    17

#include "network_udp.h"

    18

#include "../console_func.h"

    19

#include "../command_func.h"

    20

#include "../saveload.h"

    21

#include "../station_base.h"

    22

#include "../variables.h"

    23

#include "../genworld.h"

    24

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

    25

#include "../fileio.h"

    26

#include "../string_func.h"

    27

#include "../player_base.h"

    28

#include "../player_func.h"

    29

#include "../player_gui.h"

    30

#include "../settings_type.h"

    31

    32

#include "table/strings.h"

    33

    34

// This file handles all the server-commands

    35

    36

static void NetworkHandleCommandQueue(NetworkTCPSocketHandler* cs);

    37

    38

// **********

    39

// Sending functions

    40

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkTCPSocketHandler *cs

    41

// **********

    42

    43

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CLIENT_INFO)(NetworkTCPSocketHandler *cs, NetworkClientInfo *ci)

    44

{

    45

	//

    46

	// Packet: SERVER_CLIENT_INFO

    47

	// Function: Sends info about a client

    48

	// Data:

    49

	//    uint16:  The index of the client (always unique on a server. 1 = server)

    50

	//    uint8:  As which player the client is playing

    51

	//    String: The name of the client

    52

	//    String: The unique id of the client

    53

	//

    54

    55

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    56

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    57

		p->Send_uint16(ci->client_index);

    58

		p->Send_uint8 (ci->client_playas);

    59

		p->Send_string(ci->client_name);

    60

		p->Send_string(ci->unique_id);

    61

    62

		cs->Send_Packet(p);

    63

	}

    64

}

    65

    66

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    67

{

    68

//

    69

	// Packet: SERVER_COMPANY_INFO

    70

	// Function: Sends info about the companies

    71

	// Data:

    72

	//

    73

    74

	int i;

    75

    76

	Player *player;

    77

	Packet *p;

    78

    79

	byte active = ActivePlayerCount();

    80

    81

	if (active == 0) {

    82

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    83

    84

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    85

		p->Send_uint8 (active);

    86

    87

		cs->Send_Packet(p);

    88

		return;

    89

	}

    90

    91

	NetworkPopulateCompanyInfo();

    92

    93

	FOR_ALL_PLAYERS(player) {

    94

		if (!player->is_active) continue;

    95

    96

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    97

    98

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    99

		p->Send_uint8 (active);

   100

		p->Send_uint8 (player->index);

   101

   102

		p->Send_string(_network_player_info[player->index].company_name);

   103

		p->Send_uint32(_network_player_info[player->index].inaugurated_year);

   104

		p->Send_uint64(_network_player_info[player->index].company_value);

   105

		p->Send_uint64(_network_player_info[player->index].money);

   106

		p->Send_uint64(_network_player_info[player->index].income);

   107

		p->Send_uint16(_network_player_info[player->index].performance);

   108

   109

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

   110

		p->Send_bool(!StrEmpty(_network_player_info[player->index].password));

   111

   112

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

   113

			p->Send_uint16(_network_player_info[player->index].num_vehicle[i]);

   114

		}

   115

   116

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

   117

			p->Send_uint16(_network_player_info[player->index].num_station[i]);

   118

		}

   119

   120

		if (_network_player_info[player->index].players[0] == '\0') {

   121

			p->Send_string("<none>");

   122

		} else {

   123

			p->Send_string(_network_player_info[player->index].players);

   124

		}

   125

   126

		cs->Send_Packet(p);

   127

	}

   128

   129

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   130

   131

	p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   132

	p->Send_uint8 (0);

   133

   134

	cs->Send_Packet(p);

   135

}

   136

   137

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_ERROR)(NetworkTCPSocketHandler *cs, NetworkErrorCode error)

   138

{

   139

	//

   140

	// Packet: SERVER_ERROR

   141

	// Function: The client made an error

   142

	// Data:

   143

	//    uint8:  ErrorID (see network_data.h, NetworkErrorCode)

   144

	//

   145

   146

	char str[100];

   147

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   148

   149

	p->Send_uint8(error);

   150

	cs->Send_Packet(p);

   151

   152

	GetNetworkErrorMsg(str, error, lastof(str));

   153

   154

	// Only send when the current client was in game

   155

	if (cs->status > STATUS_AUTH) {

   156

		NetworkTCPSocketHandler *new_cs;

   157

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   158

   159

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

   160

   161

		DEBUG(net, 1, "'%s' made an error and has been disconnected. Reason: '%s'", client_name, str);

   162

   163

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

   164

   165

		FOR_ALL_CLIENTS(new_cs) {

   166

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

   167

				// Some errors we filter to a more general error. Clients don't have to know the real

   168

				//  reason a joining failed.

   169

				if (error == NETWORK_ERROR_NOT_AUTHORIZED || error == NETWORK_ERROR_NOT_EXPECTED || error == NETWORK_ERROR_WRONG_REVISION)

   170

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   171

   172

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

   173

			}

   174

		}

   175

	} else {

   176

		DEBUG(net, 1, "Client %d made an error and has been disconnected. Reason: '%s'", cs->index, str);

   177

	}

   178

   179

	cs->has_quit = true;

   180

   181

	// Make sure the data get's there before we close the connection

   182

	cs->Send_Packets();

   183

   184

	// The client made a mistake, so drop his connection now!

   185

	NetworkCloseClient(cs);

   186

}

   187

   188

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHECK_NEWGRFS)(NetworkTCPSocketHandler *cs)

   189

{

   190

	//

   191

	// Packet: PACKET_SERVER_CHECK_NEWGRFS

   192

	// Function: Sends info about the used GRFs to the client

   193

	// Data:

   194

	//      uint8:  Amount of GRFs

   195

	//    And then for each GRF:

   196

	//      uint32: GRF ID

   197

	// 16 * uint8:  MD5 checksum of the GRF

   198

	//

   199

   200

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHECK_NEWGRFS);

   201

	const GRFConfig *c;

   202

	uint grf_count = 0;

   203

   204

	for (c = _grfconfig; c != NULL; c = c->next) {

   205

		if (!HasBit(c->flags, GCF_STATIC)) grf_count++;

   206

	}

   207

   208

	p->Send_uint8 (grf_count);

   209

	for (c = _grfconfig; c != NULL; c = c->next) {

   210

		if (!HasBit(c->flags, GCF_STATIC)) cs->Send_GRFIdentifier(p, c);

   211

	}

   212

   213

	cs->Send_Packet(p);

   214

}

   215

   216

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_NEED_PASSWORD)(NetworkTCPSocketHandler *cs, NetworkPasswordType type)

   217

{

   218

	//

   219

	// Packet: SERVER_NEED_PASSWORD

   220

	// Function: Indication to the client that the server needs a password

   221

	// Data:

   222

	//    uint8:  Type of password

   223

	//

   224

   225

	/* Invalid packet when status is AUTH or higher */

   226

	if (cs->status >= STATUS_AUTH) return;

   227

   228

	cs->status = STATUS_AUTHORIZING;

   229

   230

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   231

	p->Send_uint8(type);

   232

	p->Send_uint32(_settings.game_creation.generation_seed);

   233

	p->Send_string(_network_unique_id);

   234

	cs->Send_Packet(p);

   235

}

   236

   237

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   238

{

   239

	//

   240

	// Packet: SERVER_WELCOME

   241

	// Function: The client is joined and ready to receive his map

   242

	// Data:

   243

	//    uint16:  Own ClientID

   244

	//

   245

   246

	Packet *p;

   247

	NetworkTCPSocketHandler *new_cs;

   248

   249

	// Invalid packet when status is AUTH or higher

   250

	if (cs->status >= STATUS_AUTH) return;

   251

   252

	cs->status = STATUS_AUTH;

   253

	_network_game_info.clients_on++;

   254

   255

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   256

	p->Send_uint16(cs->index);

   257

	p->Send_uint32(_settings.game_creation.generation_seed);

   258

	p->Send_string(_network_unique_id);

   259

	cs->Send_Packet(p);

   260

   261

		// Transmit info about all the active clients

   262

	FOR_ALL_CLIENTS(new_cs) {

   263

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

   264

			SEND_COMMAND(PACKET_SERVER_CLIENT_INFO)(cs, DEREF_CLIENT_INFO(new_cs));

   265

	}

   266

	// Also send the info of the server

   267

	SEND_COMMAND(PACKET_SERVER_CLIENT_INFO)(cs, NetworkFindClientInfoFromIndex(NETWORK_SERVER_INDEX));

   268

}

   269

   270

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   271

{

   272

	//

   273

	// Packet: PACKET_SERVER_WAIT

   274

	// Function: The client can not receive the map at the moment because

   275

	//             someone else is already receiving the map

   276

	// Data:

   277

	//    uint8:  Clients awaiting map

   278

	//

   279

	int waiting = 0;

   280

	NetworkTCPSocketHandler *new_cs;

   281

	Packet *p;

   282

   283

	// Count how many players are waiting in the queue

   284

	FOR_ALL_CLIENTS(new_cs) {

   285

		if (new_cs->status == STATUS_MAP_WAIT) waiting++;

   286

	}

   287

   288

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   289

	p->Send_uint8(waiting);

   290

	cs->Send_Packet(p);

   291

}

   292

   293

// This sends the map to the client

   294

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   295

{

   296

	//

   297

	// Packet: SERVER_MAP

   298

	// Function: Sends the map to the client, or a part of it (it is splitted in

   299

	//   a lot of multiple packets)

   300

	// Data:

   301

	//    uint8:  packet-type (MAP_PACKET_START, MAP_PACKET_NORMAL and MAP_PACKET_END)

   302

	//  if MAP_PACKET_START:

   303

	//    uint32: The current FrameCounter

   304

	//  if MAP_PACKET_NORMAL:

   305

	//    piece of the map (till max-size of packet)

   306

	//  if MAP_PACKET_END:

   307

	//    uint32: seed0 of player

   308

	//    uint32: seed1 of player

   309

	//      last 2 are repeated MAX_PLAYERS time

   310

	//

   311

   312

	static FILE *file_pointer;

   313

	static uint sent_packets; // How many packets we did send succecfully last time

   314

   315

	if (cs->status < STATUS_AUTH) {

   316

		// Illegal call, return error and ignore the packet

   317

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   318

		return;

   319

	}

   320

   321

	if (cs->status == STATUS_AUTH) {

   322

		const char *filename = "network_server.tmp";

   323

		Packet *p;

   324

   325

		// Make a dump of the current game

   326

		if (SaveOrLoad(filename, SL_SAVE, AUTOSAVE_DIR) != SL_OK) error("network savedump failed");

   327

   328

		file_pointer = FioFOpenFile(filename, "rb", AUTOSAVE_DIR);

   329

		fseek(file_pointer, 0, SEEK_END);

   330

   331

		if (ftell(file_pointer) == 0) error("network savedump failed - zero sized savegame?");

   332

   333

		// Now send the _frame_counter and how many packets are coming

   334

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   335

		p->Send_uint8 (MAP_PACKET_START);

   336

		p->Send_uint32(_frame_counter);

   337

		p->Send_uint32(ftell(file_pointer));

   338

		cs->Send_Packet(p);

   339

   340

		fseek(file_pointer, 0, SEEK_SET);

   341

   342

		sent_packets = 4; // We start with trying 4 packets

   343

   344

		cs->status = STATUS_MAP;

   345

		/* Mark the start of download */

   346

		cs->last_frame = _frame_counter;

   347

		cs->last_frame_server = _frame_counter;

   348

	}

   349

   350

	if (cs->status == STATUS_MAP) {

   351

		uint i;

   352

		int res;

   353

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

   354

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   355

			p->Send_uint8(MAP_PACKET_NORMAL);

   356

			res = (int)fread(p->buffer + p->size, 1, SEND_MTU - p->size, file_pointer);

   357

   358

			if (ferror(file_pointer)) error("Error reading temporary network savegame!");

   359

   360

			p->size += res;

   361

			cs->Send_Packet(p);

   362

			if (feof(file_pointer)) {

   363

				// Done reading!

   364

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   365

				p->Send_uint8(MAP_PACKET_END);

   366

				cs->Send_Packet(p);

   367

   368

				// Set the status to DONE_MAP, no we will wait for the client

   369

				//  to send it is ready (maybe that happens like never ;))

   370

				cs->status = STATUS_DONE_MAP;

   371

				fclose(file_pointer);

   372

   373

				{

   374

					NetworkTCPSocketHandler *new_cs;

   375

					bool new_map_client = false;

   376

					// Check if there is a client waiting for receiving the map

   377

					//  and start sending him the map

   378

					FOR_ALL_CLIENTS(new_cs) {

   379

						if (new_cs->status == STATUS_MAP_WAIT) {

   380

							// Check if we already have a new client to send the map to

   381

							if (!new_map_client) {

   382

								// If not, this client will get the map

   383

								new_cs->status = STATUS_AUTH;

   384

								new_map_client = true;

   385

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   386

							} else {

   387

								// Else, send the other clients how many clients are in front of them

   388

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   389

							}

   390

						}

   391

					}

   392

				}

   393

   394

				// There is no more data, so break the for

   395

				break;

   396

			}

   397

		}

   398

   399

		// Send all packets (forced) and check if we have send it all

   400

		cs->Send_Packets();

   401

		if (cs->IsPacketQueueEmpty()) {

   402

			// All are sent, increase the sent_packets

   403

			sent_packets *= 2;

   404

		} else {

   405

			// Not everything is sent, decrease the sent_packets

   406

			if (sent_packets > 1) sent_packets /= 2;

   407

		}

   408

	}

   409

}

   410

   411

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_JOIN)(NetworkTCPSocketHandler *cs, uint16 client_index)

   412

{

   413

	//

   414

	// Packet: SERVER_JOIN

   415

	// Function: A client is joined (all active clients receive this after a

   416

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   417

	//     PACKET_SERVER_CLIENT_INFO

   418

	// Data:

   419

	//    uint16:  Client-Index

   420

	//

   421

   422

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   423

   424

	p->Send_uint16(client_index);

   425

   426

	cs->Send_Packet(p);

   427

}

   428

   429

   430

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   431

{

   432

	//

   433

	// Packet: SERVER_FRAME

   434

	// Function: Sends the current frame-counter to the client

   435

	// Data:

   436

	//    uint32: Frame Counter

   437

	//    uint32: Frame Counter Max (how far may the client walk before the server?)

   438

	//    [uint32: general-seed-1]

   439

	//    [uint32: general-seed-2]

   440

	//      (last two depends on compile-settings, and are not default settings)

   441

	//

   442

   443

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   444

	p->Send_uint32(_frame_counter);

   445

	p->Send_uint32(_frame_counter_max);

   446

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   447

	p->Send_uint32(_sync_seed_1);

   448

#ifdef NETWORK_SEND_DOUBLE_SEED

   449

	p->Send_uint32(_sync_seed_2);

   450

#endif

   451

#endif

   452

	cs->Send_Packet(p);

   453

}

   454

   455

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   456

{

   457

	//

   458

	// Packet: SERVER_SYNC

   459

	// Function: Sends a sync-check to the client

   460

	// Data:

   461

	//    uint32: Frame Counter

   462

	//    uint32: General-seed-1

   463

	//    [uint32: general-seed-2]

   464

	//      (last one depends on compile-settings, and are not default settings)

   465

	//

   466

   467

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   468

	p->Send_uint32(_frame_counter);

   469

	p->Send_uint32(_sync_seed_1);

   470

   471

#ifdef NETWORK_SEND_DOUBLE_SEED

   472

	p->Send_uint32(_sync_seed_2);

   473

#endif

   474

	cs->Send_Packet(p);

   475

}

   476

   477

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_COMMAND)(NetworkTCPSocketHandler *cs, CommandPacket *cp)

   478

{

   479

	//

   480

	// Packet: SERVER_COMMAND

   481

	// Function: Sends a DoCommand to the client

   482

	// Data:

   483

	//    uint8:  PlayerID (0..MAX_PLAYERS-1)

   484

	//    uint32: CommandID (see command.h)

   485

	//    uint32: P1 (free variables used in DoCommand)

   486

	//    uint32: P2

   487

	//    uint32: Tile

   488

	//    string: text

   489

	//    uint8:  CallBackID (see callback_table.c)

   490

	//    uint32: Frame of execution

   491

	//

   492

   493

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   494

   495

	p->Send_uint8 (cp->player);

   496

	p->Send_uint32(cp->cmd);

   497

	p->Send_uint32(cp->p1);

   498

	p->Send_uint32(cp->p2);

   499

	p->Send_uint32(cp->tile);

   500

	p->Send_string(cp->text);

   501

	p->Send_uint8 (cp->callback);

   502

	p->Send_uint32(cp->frame);

   503

	p->Send_bool  (cp->my_cmd);

   504