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_func.h"

    26

#include "../string_func.h"

    27

#include "../company_base.h"

    28

#include "../company_func.h"

    29

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

	Company *company;

    75

	Packet *p;

    76

    77

	byte active = ActiveCompanyCount();

    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_COMPANIES(company) {

    92

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    93

    94

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    95

		p->Send_uint8 (active);

    96

		p->Send_uint8 (company->index);

    97

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

   108

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

   109

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

   110

		}

   111

   112

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

   113

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

   114

		}

   115

   116

		if (StrEmpty(_network_company_info[company->index].clients)) {

   117

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

   118

		} else {

   119

			p->Send_string(_network_company_info[company->index].clients);

   120

		}

   121

   122

		cs->Send_Packet(p);

   123

	}

   124

   125

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   126

   127

	p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   128

	p->Send_uint8 (0);

   129

   130

	cs->Send_Packet(p);

   131

}

   132

   133

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

   134

{

   135

	//

   136

	// Packet: SERVER_ERROR

   137

	// Function: The client made an error

   138

	// Data:

   139

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

   140

	//

   141

   142

	char str[100];

   143

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   144

   145

	p->Send_uint8(error);

   146

	cs->Send_Packet(p);

   147

   148

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

   149

   150

	// Only send when the current client was in game

   151

	if (cs->status > STATUS_AUTH) {

   152

		NetworkTCPSocketHandler *new_cs;

   153

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   154

   155

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

   156

   157

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

   158

   159

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

   160

   161

		FOR_ALL_CLIENTS(new_cs) {

   162

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

   163

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

   164

				//  reason a joining failed.

   165

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

   166

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   167

   168

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

   169

			}

   170

		}

   171

	} else {

   172

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

   173

	}

   174

   175

	cs->has_quit = true;

   176

   177

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

   178

	cs->Send_Packets();

   179

   180

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

   181

	NetworkCloseClient(cs);

   182

}

   183

   184

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHECK_NEWGRFS)(NetworkTCPSocketHandler *cs)

   185

{

   186

	//

   187

	// Packet: PACKET_SERVER_CHECK_NEWGRFS

   188

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

   189

	// Data:

   190

	//      uint8:  Amount of GRFs

   191

	//    And then for each GRF:

   192

	//      uint32: GRF ID

   193

	// 16 * uint8:  MD5 checksum of the GRF

   194

	//

   195

   196

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHECK_NEWGRFS);

   197

	const GRFConfig *c;

   198

	uint grf_count = 0;

   199

   200

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

   201

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

   202

	}

   203

   204

	p->Send_uint8 (grf_count);

   205

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

   206

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

   207

	}

   208

   209

	cs->Send_Packet(p);

   210

}

   211

   212

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

   213

{

   214

	//

   215

	// Packet: SERVER_NEED_PASSWORD

   216

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

   217

	// Data:

   218

	//    uint8:  Type of password

   219

	//

   220

   221

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

   222

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

   223

   224

	cs->status = STATUS_AUTHORIZING;

   225

   226

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   227

	p->Send_uint8(type);

   228

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

   229

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

   230

	cs->Send_Packet(p);

   231

}

   232

   233

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   234

{

   235

	//

   236

	// Packet: SERVER_WELCOME

   237

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

   238

	// Data:

   239

	//    uint16:  Own ClientID

   240

	//

   241

   242

	Packet *p;

   243

	NetworkTCPSocketHandler *new_cs;

   244

   245

	// Invalid packet when status is AUTH or higher

   246

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

   247

   248

	cs->status = STATUS_AUTH;

   249

	_network_game_info.clients_on++;

   250

   251

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   252

	p->Send_uint16(cs->index);

   253

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

   254

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

   255

	cs->Send_Packet(p);

   256

   257

		// Transmit info about all the active clients

   258

	FOR_ALL_CLIENTS(new_cs) {

   259

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

   260

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

   261

	}

   262

	// Also send the info of the server

   263

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

   264

}

   265

   266

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   267

{

   268

	//

   269

	// Packet: PACKET_SERVER_WAIT

   270

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

   271

	//             someone else is already receiving the map

   272

	// Data:

   273

	//    uint8:  Clients awaiting map

   274

	//

   275

	int waiting = 0;

   276

	NetworkTCPSocketHandler *new_cs;

   277

	Packet *p;

   278

   279

	// Count how many clients are waiting in the queue

   280

	FOR_ALL_CLIENTS(new_cs) {

   281

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

   282

	}

   283

   284

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   285

	p->Send_uint8(waiting);

   286

	cs->Send_Packet(p);

   287

}

   288

   289

// This sends the map to the client

   290

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   291

{

   292

	//

   293

	// Packet: SERVER_MAP

   294

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

   295

	//   a lot of multiple packets)

   296

	// Data:

   297

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

   298

	//  if MAP_PACKET_START:

   299

	//    uint32: The current FrameCounter

   300

	//  if MAP_PACKET_NORMAL:

   301

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

   302

	//  if MAP_PACKET_END:

   303

	//    nothing

   304

	//

   305

   306

	static FILE *file_pointer;

   307

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

   308

   309

	if (cs->status < STATUS_AUTH) {

   310

		// Illegal call, return error and ignore the packet

   311

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   312

		return;

   313

	}

   314

   315

	if (cs->status == STATUS_AUTH) {

   316

		const char *filename = "network_server.tmp";

   317

		Packet *p;

   318

   319

		// Make a dump of the current game

   320

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

   321

   322

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

   323

		fseek(file_pointer, 0, SEEK_END);

   324

   325

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

   326

   327

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

   328

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   329

		p->Send_uint8 (MAP_PACKET_START);

   330

		p->Send_uint32(_frame_counter);

   331

		p->Send_uint32(ftell(file_pointer));

   332

		cs->Send_Packet(p);

   333

   334

		fseek(file_pointer, 0, SEEK_SET);

   335

   336

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

   337

   338

		cs->status = STATUS_MAP;

   339

		/* Mark the start of download */

   340

		cs->last_frame = _frame_counter;

   341

		cs->last_frame_server = _frame_counter;

   342

	}

   343

   344

	if (cs->status == STATUS_MAP) {

   345

		uint i;

   346

		int res;

   347

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

   348

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   349

			p->Send_uint8(MAP_PACKET_NORMAL);

   350

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

   351

   352

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

   353

   354

			p->size += res;

   355

			cs->Send_Packet(p);

   356

			if (feof(file_pointer)) {

   357

				// Done reading!

   358

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   359

				p->Send_uint8(MAP_PACKET_END);

   360

				cs->Send_Packet(p);

   361

   362

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

   363

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

   364

				cs->status = STATUS_DONE_MAP;

   365

				fclose(file_pointer);

   366

   367

				{

   368

					NetworkTCPSocketHandler *new_cs;

   369

					bool new_map_client = false;

   370

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

   371

					//  and start sending him the map

   372

					FOR_ALL_CLIENTS(new_cs) {

   373

						if (new_cs->status == STATUS_MAP_WAIT) {

   374

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

   375

							if (!new_map_client) {

   376

								// If not, this client will get the map

   377

								new_cs->status = STATUS_AUTH;

   378

								new_map_client = true;

   379

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   380

							} else {

   381

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

   382

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   383

							}

   384

						}

   385

					}

   386

				}

   387

   388

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

   389

				break;

   390

			}

   391

		}

   392

   393

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

   394

		cs->Send_Packets();

   395

		if (cs->IsPacketQueueEmpty()) {

   396

			// All are sent, increase the sent_packets

   397

			sent_packets *= 2;

   398

		} else {

   399

			// Not everything is sent, decrease the sent_packets

   400

			if (sent_packets > 1) sent_packets /= 2;

   401

		}

   402

	}

   403

}

   404

   405

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

   406

{

   407

	//

   408

	// Packet: SERVER_JOIN

   409

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

   410

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   411

	//     PACKET_SERVER_CLIENT_INFO

   412

	// Data:

   413

	//    uint16:  Client-Index

   414

	//

   415

   416

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   417

   418

	p->Send_uint16(client_index);

   419

   420

	cs->Send_Packet(p);

   421

}

   422

   423

   424

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   425

{

   426

	//

   427

	// Packet: SERVER_FRAME

   428

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

   429

	// Data:

   430

	//    uint32: Frame Counter

   431

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

   432

	//    [uint32: general-seed-1]

   433

	//    [uint32: general-seed-2]

   434

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

   435

	//

   436

   437

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   438

	p->Send_uint32(_frame_counter);

   439

	p->Send_uint32(_frame_counter_max);

   440

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   441

	p->Send_uint32(_sync_seed_1);

   442

#ifdef NETWORK_SEND_DOUBLE_SEED

   443

	p->Send_uint32(_sync_seed_2);

   444

#endif

   445

#endif

   446

	cs->Send_Packet(p);

   447

}

   448

   449

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   450

{

   451

	//

   452

	// Packet: SERVER_SYNC

   453

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

   454

	// Data:

   455

	//    uint32: Frame Counter

   456

	//    uint32: General-seed-1

   457

	//    [uint32: general-seed-2]

   458

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

   459

	//

   460

   461

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   462

	p->Send_uint32(_frame_counter);

   463

	p->Send_uint32(_sync_seed_1);

   464

   465

#ifdef NETWORK_SEND_DOUBLE_SEED

   466

	p->Send_uint32(_sync_seed_2);

   467

#endif

   468

	cs->Send_Packet(p);

   469

}

   470

   471

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

   472

{

   473

	//

   474

	// Packet: SERVER_COMMAND

   475

	// Function: Sends a DoCommand to the client

   476

	// Data:

   477

	//    uint8:  CompanyID (0..MAX_COMPANIES-1)

   478

	//    uint32: CommandID (see command.h)

   479

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

   480

	//    uint32: P2

   481

	//    uint32: Tile

   482

	//    string: text

   483

	//    uint8:  CallBackID (see callback_table.c)

   484

	//    uint32: Frame of execution

   485

	//

   486

   487

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   488

   489

	p->Send_uint8 (cp->company);

   490

	p->Send_uint32(cp->cmd);

   491

	p->Send_uint32(cp->p1);

   492

	p->Send_uint32(cp->p2);

   493

	p->Send_uint32(cp->tile);

   494

	p->Send_string(cp->text);

   495

	p->Send_uint8 (cp->callback);

   496

	p->Send_uint32(cp->frame);

   497

	p->Send_bool  (cp->my_cmd);

   498

   499

	cs->Send_Packet(p);

   500

}

   501

   502

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHAT)(NetworkTCPSocketHandler *cs, NetworkAction action, uint16 client_index, bool self_send, const char *msg)

   503

{