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_internal.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

	//

    53

    54

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    55

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    56

		p->Send_uint16(ci->client_index);

    57

		p->Send_uint8 (ci->client_playas);

    58

		p->Send_string(ci->client_name);

    59

    60

		cs->Send_Packet(p);

    61

	}

    62

}

    63

    64

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    65

{

    66

//

    67

	// Packet: SERVER_COMPANY_INFO

    68

	// Function: Sends info about the companies

    69

	// Data:

    70

	//

    71

    72

	int i;

    73

    74

	Player *player;

    75

	Packet *p;

    76

    77

	byte active = ActivePlayerCount();

    78

    79

	if (active == 0) {

    80

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    81

    82

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    83

		p->Send_uint8 (active);

    84

    85

		cs->Send_Packet(p);

    86

		return;

    87

	}

    88

    89

	NetworkPopulateCompanyInfo();

    90

    91

	FOR_ALL_PLAYERS(player) {

    92

		if (!player->is_active) continue;

    93

    94

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    95

    96

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    97

		p->Send_uint8 (active);

    98

		p->Send_uint8 (player->index);

    99

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

   107

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

   108

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

   109

   110

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

   111

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

   112

		}

   113

   114

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

   115

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

   116

		}

   117

   118

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

   119

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

   120

		} else {

   121

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

   122

		}

   123

   124

		cs->Send_Packet(p);

   125

	}

   126

   127

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   128

   129

	p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   130

	p->Send_uint8 (0);

   131

   132

	cs->Send_Packet(p);

   133

}

   134

   135

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

   136

{

   137

	//

   138

	// Packet: SERVER_ERROR

   139

	// Function: The client made an error

   140

	// Data:

   141

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

   142

	//

   143

   144

	char str[100];

   145

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   146

   147

	p->Send_uint8(error);

   148

	cs->Send_Packet(p);

   149

   150

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

   151

   152

	// Only send when the current client was in game

   153

	if (cs->status > STATUS_AUTH) {

   154

		NetworkTCPSocketHandler *new_cs;

   155

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   156

   157

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

   158

   159

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

   160

   161

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

   162

   163

		FOR_ALL_CLIENTS(new_cs) {

   164

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

   165

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

   166

				//  reason a joining failed.

   167

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

   168

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   169

   170

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

   171

			}

   172

		}

   173

	} else {

   174

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

   175

	}

   176

   177

	cs->has_quit = true;

   178

   179

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

   180

	cs->Send_Packets();

   181

   182

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

   183

	NetworkCloseClient(cs);

   184

}

   185

   186

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHECK_NEWGRFS)(NetworkTCPSocketHandler *cs)

   187

{

   188

	//

   189

	// Packet: PACKET_SERVER_CHECK_NEWGRFS

   190

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

   191

	// Data:

   192

	//      uint8:  Amount of GRFs

   193

	//    And then for each GRF:

   194

	//      uint32: GRF ID

   195

	// 16 * uint8:  MD5 checksum of the GRF

   196

	//

   197

   198

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHECK_NEWGRFS);

   199

	const GRFConfig *c;

   200

	uint grf_count = 0;

   201

   202

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

   203

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

   204

	}

   205

   206

	p->Send_uint8 (grf_count);

   207

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

   208

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

   209

	}

   210

   211

	cs->Send_Packet(p);

   212

}

   213

   214

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

   215

{

   216

	//

   217

	// Packet: SERVER_NEED_PASSWORD

   218

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

   219

	// Data:

   220

	//    uint8:  Type of password

   221

	//

   222

   223

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

   224

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

   225

   226

	cs->status = STATUS_AUTHORIZING;

   227

   228

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   229

	p->Send_uint8(type);

   230

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

   231

	p->Send_string(_settings_client.network.network_id);

   232

	cs->Send_Packet(p);

   233

}

   234

   235

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   236

{

   237

	//

   238

	// Packet: SERVER_WELCOME

   239

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

   240

	// Data:

   241

	//    uint16:  Own ClientID

   242

	//

   243

   244

	Packet *p;

   245

	NetworkTCPSocketHandler *new_cs;

   246

   247

	// Invalid packet when status is AUTH or higher

   248

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

   249

   250

	cs->status = STATUS_AUTH;

   251

	_network_game_info.clients_on++;

   252

   253

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   254

	p->Send_uint16(cs->index);

   255

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

   256

	p->Send_string(_settings_client.network.network_id);

   257

	cs->Send_Packet(p);

   258

   259

		// Transmit info about all the active clients

   260

	FOR_ALL_CLIENTS(new_cs) {

   261

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

   262

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

   263

	}

   264

	// Also send the info of the server

   265

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

   266

}

   267

   268

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   269

{

   270

	//

   271

	// Packet: PACKET_SERVER_WAIT

   272

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

   273

	//             someone else is already receiving the map

   274

	// Data:

   275

	//    uint8:  Clients awaiting map

   276

	//

   277

	int waiting = 0;

   278

	NetworkTCPSocketHandler *new_cs;

   279

	Packet *p;

   280

   281

	// Count how many players are waiting in the queue

   282

	FOR_ALL_CLIENTS(new_cs) {

   283

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

   284

	}

   285

   286

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   287

	p->Send_uint8(waiting);

   288

	cs->Send_Packet(p);

   289

}

   290

   291

// This sends the map to the client

   292

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   293

{

   294

	//

   295

	// Packet: SERVER_MAP

   296

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

   297

	//   a lot of multiple packets)

   298

	// Data:

   299

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

   300

	//  if MAP_PACKET_START:

   301

	//    uint32: The current FrameCounter

   302

	//  if MAP_PACKET_NORMAL:

   303

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

   304

	//  if MAP_PACKET_END:

   305

	//    uint32: seed0 of player

   306

	//    uint32: seed1 of player

   307

	//      last 2 are repeated MAX_PLAYERS time

   308

	//

   309

   310

	static FILE *file_pointer;

   311

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

   312

   313

	if (cs->status < STATUS_AUTH) {

   314

		// Illegal call, return error and ignore the packet

   315

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   316

		return;

   317

	}

   318

   319

	if (cs->status == STATUS_AUTH) {

   320

		const char *filename = "network_server.tmp";

   321

		Packet *p;

   322

   323

		// Make a dump of the current game

   324

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

   325

   326

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

   327

		fseek(file_pointer, 0, SEEK_END);

   328

   329

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

   330

   331

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

   332

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   333

		p->Send_uint8 (MAP_PACKET_START);

   334

		p->Send_uint32(_frame_counter);

   335

		p->Send_uint32(ftell(file_pointer));

   336

		cs->Send_Packet(p);

   337

   338

		fseek(file_pointer, 0, SEEK_SET);

   339

   340

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

   341

   342

		cs->status = STATUS_MAP;

   343

		/* Mark the start of download */

   344

		cs->last_frame = _frame_counter;

   345

		cs->last_frame_server = _frame_counter;

   346

	}

   347

   348

	if (cs->status == STATUS_MAP) {

   349

		uint i;

   350

		int res;

   351

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

   352

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   353

			p->Send_uint8(MAP_PACKET_NORMAL);

   354

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

   355

   356

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

   357

   358

			p->size += res;

   359

			cs->Send_Packet(p);

   360

			if (feof(file_pointer)) {

   361

				// Done reading!

   362

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   363

				p->Send_uint8(MAP_PACKET_END);

   364

				cs->Send_Packet(p);

   365

   366

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

   367

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

   368

				cs->status = STATUS_DONE_MAP;

   369

				fclose(file_pointer);

   370

   371

				{

   372

					NetworkTCPSocketHandler *new_cs;

   373

					bool new_map_client = false;

   374

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

   375

					//  and start sending him the map

   376

					FOR_ALL_CLIENTS(new_cs) {

   377

						if (new_cs->status == STATUS_MAP_WAIT) {

   378

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

   379

							if (!new_map_client) {

   380

								// If not, this client will get the map

   381

								new_cs->status = STATUS_AUTH;

   382

								new_map_client = true;

   383

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   384

							} else {

   385

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

   386

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   387

							}

   388

						}

   389

					}

   390

				}

   391

   392

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

   393

				break;

   394

			}

   395

		}

   396

   397

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

   398

		cs->Send_Packets();

   399

		if (cs->IsPacketQueueEmpty()) {

   400

			// All are sent, increase the sent_packets

   401

			sent_packets *= 2;

   402

		} else {

   403

			// Not everything is sent, decrease the sent_packets

   404

			if (sent_packets > 1) sent_packets /= 2;

   405

		}

   406

	}

   407

}

   408

   409

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

   410

{

   411

	//

   412

	// Packet: SERVER_JOIN

   413

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

   414

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   415

	//     PACKET_SERVER_CLIENT_INFO

   416

	// Data:

   417

	//    uint16:  Client-Index

   418

	//

   419

   420

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   421

   422

	p->Send_uint16(client_index);

   423

   424

	cs->Send_Packet(p);

   425

}

   426

   427

   428

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   429

{

   430

	//

   431

	// Packet: SERVER_FRAME

   432

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

   433

	// Data:

   434

	//    uint32: Frame Counter

   435

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

   436

	//    [uint32: general-seed-1]

   437

	//    [uint32: general-seed-2]

   438

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

   439

	//

   440

   441

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   442

	p->Send_uint32(_frame_counter);

   443

	p->Send_uint32(_frame_counter_max);

   444

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   445

	p->Send_uint32(_sync_seed_1);

   446

#ifdef NETWORK_SEND_DOUBLE_SEED

   447

	p->Send_uint32(_sync_seed_2);

   448

#endif

   449

#endif

   450

	cs->Send_Packet(p);

   451

}

   452

   453

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   454

{

   455

	//

   456

	// Packet: SERVER_SYNC

   457

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

   458

	// Data:

   459

	//    uint32: Frame Counter

   460

	//    uint32: General-seed-1

   461

	//    [uint32: general-seed-2]

   462

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

   463

	//

   464

   465

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   466

	p->Send_uint32(_frame_counter);

   467

	p->Send_uint32(_sync_seed_1);

   468

   469

#ifdef NETWORK_SEND_DOUBLE_SEED

   470

	p->Send_uint32(_sync_seed_2);

   471

#endif

   472

	cs->Send_Packet(p);

   473

}

   474

   475

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

   476

{

   477

	//

   478

	// Packet: SERVER_COMMAND

   479

	// Function: Sends a DoCommand to the client

   480

	// Data:

   481

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

   482

	//    uint32: CommandID (see command.h)

   483

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

   484

	//    uint32: P2

   485

	//    uint32: Tile

   486

	//    string: text

   487

	//    uint8:  CallBackID (see callback_table.c)

   488

	//    uint32: Frame of execution

   489

	//

   490

   491

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   492

   493

	p->Send_uint8 (cp->player);

   494

	p->Send_uint32(cp->cmd);

   495

	p->Send_uint32(cp->p1);

   496

	p->Send_uint32(cp->p2);

   497

	p->Send_uint32(cp->tile);

   498

	p->Send_string(cp->text);

   499

	p->Send_uint8 (cp->callback);

   500

	p->Send_uint32(cp->frame);

   501

	p->Send_bool  (cp->my_cmd);

   502

   503

	cs->Send_Packet(p);

   504

}