1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

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

     7

#include "../debug.h"

     8

#include "../string.h"

     9

#include "../strings_func.h"

    10

#include "network_data.h"

    11

#include "core/tcp.h"

    12

#include "../train.h"

    13

#include "../aircraft.h"

    14

#include "../date.h"

    15

#include "table/strings.h"

    16

#include "../functions.h"

    17

#include "network_server.h"

    18

#include "network_udp.h"

    19

#include "../console.h"

    21

#include "../saveload.h"

    22

#include "../vehicle.h"

    23

#include "../station.h"

    24

#include "../variables.h"

    25

#include "../genworld.h"

    26

#include "../helpers.hpp"

    27

#include "../fileio.h"

    28

    29

// This file handles all the server-commands

    30

    31

static void NetworkHandleCommandQueue(NetworkTCPSocketHandler* cs);

    32

    33

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

    34

// Sending functions

    35

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkTCPSocketHandler *cs

    36

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

    37

    38

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

    39

{

    40

	//

    41

	// Packet: SERVER_CLIENT_INFO

    42

	// Function: Sends info about a client

    43

	// Data:

    44

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

    45

	//    uint8:  As which player the client is playing

    46

	//    String: The name of the client

    47

	//    String: The unique id of the client

    48

	//

    49

    50

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    51

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    52

		p->Send_uint16(ci->client_index);

    53

		p->Send_uint8 (ci->client_playas);

    54

		p->Send_string(ci->client_name);

    55

		p->Send_string(ci->unique_id);

    56

    57

		cs->Send_Packet(p);

    58

	}

    59

}

    60

    61

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    62

{

    63

//

    64

	// Packet: SERVER_COMPANY_INFO

    65

	// Function: Sends info about the companies

    66

	// Data:

    67

	//

    68

    69

	int i;

    70

    71

	Player *player;

    72

	Packet *p;

    73

    74

	byte active = ActivePlayerCount();

    75

    76

	if (active == 0) {

    77

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    78

    79

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    80

		p->Send_uint8 (active);

    81

    82

		cs->Send_Packet(p);

    83

		return;

    84

	}

    85

    86

	NetworkPopulateCompanyInfo();

    87

    88

	FOR_ALL_PLAYERS(player) {

    89

		if (!player->is_active) continue;

    90

    91

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    92

    93

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    94

		p->Send_uint8 (active);

    95

		p->Send_uint8 (player->index);

    96

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

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

   106

   107

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

   108

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

   109

		}

   110

   111

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

   112

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

   113

		}

   114

   115

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

   116

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

   117

		} else {

   118

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

   119

		}

   120

   121

		cs->Send_Packet(p);

   122

	}

   123

   124

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   125

   126

	p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   127

	p->Send_uint8 (0);

   128

   129

	cs->Send_Packet(p);

   130

}

   131

   132

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

   133

{

   134

	//

   135

	// Packet: SERVER_ERROR

   136

	// Function: The client made an error

   137

	// Data:

   138

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

   139

	//

   140

   141

	char str[100];

   142

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   143

   144

	p->Send_uint8(error);

   145

	cs->Send_Packet(p);

   146

   147

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

   148

   149

	// Only send when the current client was in game

   150

	if (cs->status > STATUS_AUTH) {

   151

		NetworkTCPSocketHandler *new_cs;

   152

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   153

   154

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

   155

   156

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

   157

   158

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

   159

   160

		FOR_ALL_CLIENTS(new_cs) {

   161

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

   162

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

   163

				//  reason a joining failed.

   164

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

   165

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   166

   167

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

   168

			}

   169

		}

   170

	} else {

   171

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

   172

	}

   173

   174

	cs->has_quit = true;

   175

   176

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

   177

	cs->Send_Packets();

   178

   179

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

   180

	NetworkCloseClient(cs);

   181

}

   182

   183

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHECK_NEWGRFS)(NetworkTCPSocketHandler *cs)

   184

{

   185

	//

   186

	// Packet: PACKET_SERVER_CHECK_NEWGRFS

   187

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

   188

	// Data:

   189

	//      uint8:  Amount of GRFs

   190

	//    And then for each GRF:

   191

	//      uint32: GRF ID

   192

	// 16 * uint8:  MD5 checksum of the GRF

   193

	//

   194

   195

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHECK_NEWGRFS);

   196

	const GRFConfig *c;

   197

	uint grf_count = 0;

   198

   199

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

   200

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

   201

	}

   202

   203

	p->Send_uint8 (grf_count);

   204

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

   205

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

   206

	}

   207

   208

	cs->Send_Packet(p);

   209

}

   210

   211

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

   212

{

   213

	//

   214

	// Packet: SERVER_NEED_PASSWORD

   215

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

   216

	// Data:

   217

	//    uint8:  Type of password

   218

	//

   219

   220

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

   221

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

   222

   223

	cs->status = STATUS_AUTHORIZING;

   224

   225

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   226

	p->Send_uint8(type);

   227

	p->Send_uint32(_patches.generation_seed);

   228

	p->Send_string(_network_unique_id);

   229

	cs->Send_Packet(p);

   230

}

   231

   232

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   233

{

   234

	//

   235

	// Packet: SERVER_WELCOME

   236

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

   237

	// Data:

   238

	//    uint16:  Own ClientID

   239

	//

   240

   241

	Packet *p;

   242

	NetworkTCPSocketHandler *new_cs;

   243

   244

	// Invalid packet when status is AUTH or higher

   245

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

   246

   247

	cs->status = STATUS_AUTH;

   248

	_network_game_info.clients_on++;

   249

   250

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   251

	p->Send_uint16(cs->index);

   252

	p->Send_uint32(_patches.generation_seed);

   253

	p->Send_string(_network_unique_id);

   254

	cs->Send_Packet(p);

   255

   256

		// Transmit info about all the active clients

   257

	FOR_ALL_CLIENTS(new_cs) {

   258

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

   259

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

   260

	}

   261

	// Also send the info of the server

   262

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

   263

}

   264

   265

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   266

{

   267

	//

   268

	// Packet: PACKET_SERVER_WAIT

   269

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

   270

	//             someone else is already receiving the map

   271

	// Data:

   272

	//    uint8:  Clients awaiting map

   273

	//

   274

	int waiting = 0;

   275

	NetworkTCPSocketHandler *new_cs;

   276

	Packet *p;

   277

   278

	// Count how many players are waiting in the queue

   279

	FOR_ALL_CLIENTS(new_cs) {

   280

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

   281

	}

   282

   283

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   284

	p->Send_uint8(waiting);

   285

	cs->Send_Packet(p);

   286

}

   287

   288

// This sends the map to the client

   289

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   290

{

   291

	//

   292

	// Packet: SERVER_MAP

   293

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

   294

	//   a lot of multiple packets)

   295

	// Data:

   296

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

   297

	//  if MAP_PACKET_START:

   298

	//    uint32: The current FrameCounter

   299

	//  if MAP_PACKET_NORMAL:

   300

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

   301

	//  if MAP_PACKET_END:

   302

	//    uint32: seed0 of player

   303

	//    uint32: seed1 of player

   304

	//      last 2 are repeated MAX_PLAYERS time

   305

	//

   306

   307

	static FILE *file_pointer;

   308

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

   309

   310

	if (cs->status < STATUS_AUTH) {

   311

		// Illegal call, return error and ignore the packet

   312

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   313

		return;

   314

	}

   315

   316

	if (cs->status == STATUS_AUTH) {

   317

		const char *filename = "network_server.tmp";

   318

		Packet *p;

   319

   320

		// Make a dump of the current game

   321

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

   322

   323

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

   324

		fseek(file_pointer, 0, SEEK_END);

   325

   326

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

   327

   328

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

   329

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   330

		p->Send_uint8 (MAP_PACKET_START);

   331

		p->Send_uint32(_frame_counter);

   332

		p->Send_uint32(ftell(file_pointer));

   333

		cs->Send_Packet(p);

   334

   335

		fseek(file_pointer, 0, SEEK_SET);

   336

   337

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

   338

   339

		cs->status = STATUS_MAP;

   340

		/* Mark the start of download */

   341

		cs->last_frame = _frame_counter;

   342

		cs->last_frame_server = _frame_counter;

   343

	}

   344

   345

	if (cs->status == STATUS_MAP) {

   346

		uint i;

   347

		int res;

   348

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

   349

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   350

			p->Send_uint8(MAP_PACKET_NORMAL);

   351

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

   352

   353

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

   354

   355

			p->size += res;

   356

			cs->Send_Packet(p);

   357

			if (feof(file_pointer)) {

   358

				// Done reading!

   359

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   360

				p->Send_uint8(MAP_PACKET_END);

   361

				cs->Send_Packet(p);

   362

   363

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

   364

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

   365

				cs->status = STATUS_DONE_MAP;

   366

				fclose(file_pointer);

   367

   368

				{

   369

					NetworkTCPSocketHandler *new_cs;

   370

					bool new_map_client = false;

   371

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

   372

					//  and start sending him the map

   373

					FOR_ALL_CLIENTS(new_cs) {

   374

						if (new_cs->status == STATUS_MAP_WAIT) {

   375

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

   376

							if (!new_map_client) {

   377

								// If not, this client will get the map

   378

								new_cs->status = STATUS_AUTH;

   379

								new_map_client = true;

   380

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   381

							} else {

   382

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

   383

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   384

							}

   385

						}

   386

					}

   387

				}

   388

   389

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

   390

				break;

   391

			}

   392

		}

   393

   394

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

   395

		cs->Send_Packets();

   396

		if (cs->IsPacketQueueEmpty()) {

   397

			// All are sent, increase the sent_packets

   398

			sent_packets *= 2;

   399

		} else {

   400

			// Not everything is sent, decrease the sent_packets

   401

			if (sent_packets > 1) sent_packets /= 2;

   402

		}

   403

	}

   404

}

   405

   406

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

   407

{

   408

	//

   409

	// Packet: SERVER_JOIN

   410

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

   411

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   412

	//     PACKET_SERVER_CLIENT_INFO

   413

	// Data:

   414

	//    uint16:  Client-Index

   415

	//

   416

   417

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   418

   419

	p->Send_uint16(client_index);

   420

   421

	cs->Send_Packet(p);

   422

}

   423

   424

   425

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   426

{

   427

	//

   428

	// Packet: SERVER_FRAME

   429

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

   430

	// Data:

   431

	//    uint32: Frame Counter

   432

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

   433

	//    [uint32: general-seed-1]

   434

	//    [uint32: general-seed-2]

   435

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

   436

	//

   437

   438

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   439

	p->Send_uint32(_frame_counter);

   440

	p->Send_uint32(_frame_counter_max);

   441

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   442

	p->Send_uint32(_sync_seed_1);

   443

#ifdef NETWORK_SEND_DOUBLE_SEED

   444

	p->Send_uint32(_sync_seed_2);

   445

#endif

   446

#endif

   447

	cs->Send_Packet(p);

   448

}

   449

   450

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   451

{

   452

	//

   453

	// Packet: SERVER_SYNC

   454

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

   455

	// Data:

   456

	//    uint32: Frame Counter

   457

	//    uint32: General-seed-1

   458

	//    [uint32: general-seed-2]

   459

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

   460

	//

   461

   462

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   463

	p->Send_uint32(_frame_counter);

   464

	p->Send_uint32(_sync_seed_1);

   465

   466

#ifdef NETWORK_SEND_DOUBLE_SEED

   467

	p->Send_uint32(_sync_seed_2);

   468

#endif

   469

	cs->Send_Packet(p);

   470

}

   471

   472

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

   473

{

   474

	//

   475

	// Packet: SERVER_COMMAND

   476

	// Function: Sends a DoCommand to the client

   477

	// Data:

   478

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

   479

	//    uint32: CommandID (see command.h)

   480

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

   481

	//    uint32: P2

   482

	//    uint32: Tile

   483

	//    string: text

   484

	//    uint8:  CallBackID (see callback_table.c)

   485

	//    uint32: Frame of execution

   486

	//

   487

   488

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   489

   490

	p->Send_uint8 (cp->player);

   491

	p->Send_uint32(cp->cmd);

   492

	p->Send_uint32(cp->p1);

   493

	p->Send_uint32(cp->p2);

   494

	p->Send_uint32(cp->tile);

   495

	p->Send_string(cp->text);

   496

	p->Send_uint8 (cp->callback);

   497

	p->Send_uint32(cp->frame);

   498

	p->Send_bool  (cp->my_cmd);

   499

   500

	cs->Send_Packet(p);

   501

}

   502

   503

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

   504

{