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

    20

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

    28

// This file handles all the server-commands

    29

    30

static void NetworkHandleCommandQueue(NetworkTCPSocketHandler* cs);

    31

    32

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

    33

// Sending functions

    34

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkTCPSocketHandler *cs

    35

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

    36

    37

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

    38

{

    39

	//

    40

	// Packet: SERVER_CLIENT_INFO

    41

	// Function: Sends info about a client

    42

	// Data:

    43

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

    44

	//    uint8:  As which player the client is playing

    45

	//    String: The name of the client

    46

	//    String: The unique id of the client

    47

	//

    48

    49

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    50

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    51

		p->Send_uint16(ci->client_index);

    52

		p->Send_uint8 (ci->client_playas);

    53

		p->Send_string(ci->client_name);

    54

		p->Send_string(ci->unique_id);

    55

    56

		cs->Send_Packet(p);

    57

	}

    58

}

    59

    60

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    61

{

    62

//

    63

	// Packet: SERVER_COMPANY_INFO

    64

	// Function: Sends info about the companies

    65

	// Data:

    66

	//

    67

    68

	int i;

    69

    70

	Player *player;

    71

	Packet *p;

    72

    73

	byte active = ActivePlayerCount();

    74

    75

	if (active == 0) {

    76

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    77

    78

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    79

		p->Send_uint8 (active);

    80

    81

		cs->Send_Packet(p);

    82

		return;

    83

	}

    84

    85

	NetworkPopulateCompanyInfo();

    86

    87

	FOR_ALL_PLAYERS(player) {

    88

		if (!player->is_active) continue;

    89

    90

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    91

    92

		p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

    93

		p->Send_uint8 (active);

    94

		p->Send_uint8 (player->index);

    95

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

   103

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

   105

   106

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

   107

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

   108

		}

   109

   110

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

   111

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

   112

		}

   113

   114

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

   115

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

   116

		} else {

   117

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

   118

		}

   119

   120

		cs->Send_Packet(p);

   121

	}

   122

   123

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   124

   125

	p->Send_uint8 (NETWORK_COMPANY_INFO_VERSION);

   126

	p->Send_uint8 (0);

   127

   128

	cs->Send_Packet(p);

   129

}

   130

   131

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

   132

{

   133

	//

   134

	// Packet: SERVER_ERROR

   135

	// Function: The client made an error

   136

	// Data:

   137

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

   138

	//

   139

   140

	char str[100];

   141

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   142

   143

	p->Send_uint8(error);

   144

	cs->Send_Packet(p);

   145

   146

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

   147

   148

	// Only send when the current client was in game

   149

	if (cs->status > STATUS_AUTH) {

   150

		NetworkTCPSocketHandler *new_cs;

   151

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   152

   153

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

   154

   155

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

   156

   157

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

   158

   159

		FOR_ALL_CLIENTS(new_cs) {

   160

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

   161

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

   162

				//  reason a joining failed.

   163

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

   164

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   165

   166

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

   167

			}

   168

		}

   169

	} else {

   170

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

   171

	}

   172

   173

	cs->has_quit = true;

   174

   175

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

   176

	cs->Send_Packets();

   177

   178

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

   179

	NetworkCloseClient(cs);

   180

}

   181

   182

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_CHECK_NEWGRFS)(NetworkTCPSocketHandler *cs)

   183

{

   184

	//

   185

	// Packet: PACKET_SERVER_CHECK_NEWGRFS

   186

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

   187

	// Data:

   188

	//      uint8:  Amount of GRFs

   189

	//    And then for each GRF:

   190

	//      uint32: GRF ID

   191

	// 16 * uint8:  MD5 checksum of the GRF

   192

	//

   193

   194

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHECK_NEWGRFS);

   195

	const GRFConfig *c;

   196

	uint grf_count = 0;

   197

   198

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

   199

   200

	p->Send_uint8 (grf_count);

   201

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

   202

		cs->Send_GRFIdentifier(p, c);

   203

	}

   204

   205

	cs->Send_Packet(p);

   206

}

   207

   208

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

   209

{

   210

	//

   211

	// Packet: SERVER_NEED_PASSWORD

   212

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

   213

	// Data:

   214

	//    uint8:  Type of password

   215

	//

   216

   217

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

   218

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

   219

   220

	cs->status = STATUS_AUTHORIZING;

   221

   222

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   223

	p->Send_uint8(type);

   224

	cs->Send_Packet(p);

   225

}

   226

   227

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   228

{

   229

	//

   230

	// Packet: SERVER_WELCOME

   231

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

   232

	// Data:

   233

	//    uint16:  Own ClientID

   234

	//

   235

   236

	Packet *p;

   237

	NetworkTCPSocketHandler *new_cs;

   238

   239

	// Invalid packet when status is AUTH or higher

   240

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

   241

   242

	cs->status = STATUS_AUTH;

   243

	_network_game_info.clients_on++;

   244

   245

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   246

	p->Send_uint16(cs->index);

   247

	cs->Send_Packet(p);

   248

   249

		// Transmit info about all the active clients

   250

	FOR_ALL_CLIENTS(new_cs) {

   251

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

   252

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

   253

	}

   254

	// Also send the info of the server

   255

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

   256

}

   257

   258

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   259

{

   260

	//

   261

	// Packet: PACKET_SERVER_WAIT

   262

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

   263

	//             someone else is already receiving the map

   264

	// Data:

   265

	//    uint8:  Clients awaiting map

   266

	//

   267

	int waiting = 0;

   268

	NetworkTCPSocketHandler *new_cs;

   269

	Packet *p;

   270

   271

	// Count how many players are waiting in the queue

   272

	FOR_ALL_CLIENTS(new_cs) {

   273

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

   274

	}

   275

   276

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   277

	p->Send_uint8(waiting);

   278

	cs->Send_Packet(p);

   279

}

   280

   281

// This sends the map to the client

   282

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   283

{

   284

	//

   285

	// Packet: SERVER_MAP

   286

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

   287

	//   a lot of multiple packets)

   288

	// Data:

   289

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

   290

	//  if MAP_PACKET_START:

   291

	//    uint32: The current FrameCounter

   292

	//  if MAP_PACKET_NORMAL:

   293

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

   294

	//  if MAP_PACKET_END:

   295

	//    uint32: seed0 of player

   296

	//    uint32: seed1 of player

   297

	//      last 2 are repeated MAX_PLAYERS time

   298

	//

   299

   300

	static FILE *file_pointer;

   301

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

   302

   303

	if (cs->status < STATUS_AUTH) {

   304

		// Illegal call, return error and ignore the packet

   305

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   306

		return;

   307

	}

   308

   309

	if (cs->status == STATUS_AUTH) {

   310

		char filename[256];

   311

		Packet *p;

   312

   313

		// Make a dump of the current game

   314

		snprintf(filename, lengthof(filename), "%s%snetwork_server.tmp",  _paths.autosave_dir, PATHSEP);

   315

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

   316

   317

		file_pointer = fopen(filename, "rb");

   318

		fseek(file_pointer, 0, SEEK_END);

   319

   320

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

   321

   322

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

   323

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   324

		p->Send_uint8 (MAP_PACKET_START);

   325

		p->Send_uint32(_frame_counter);

   326

		p->Send_uint32(ftell(file_pointer));

   327

		cs->Send_Packet(p);

   328

   329

		fseek(file_pointer, 0, SEEK_SET);

   330

   331

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

   332

   333

		cs->status = STATUS_MAP;

   334

		/* Mark the start of download */

   335

		cs->last_frame = _frame_counter;

   336

		cs->last_frame_server = _frame_counter;

   337

	}

   338

   339

	if (cs->status == STATUS_MAP) {

   340

		uint i;

   341

		int res;

   342

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

   343

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   344

			p->Send_uint8(MAP_PACKET_NORMAL);

   345

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

   346

   347

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

   348

   349

			p->size += res;

   350

			cs->Send_Packet(p);

   351

			if (feof(file_pointer)) {

   352

				// Done reading!

   353

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   354

				p->Send_uint8(MAP_PACKET_END);

   355

				cs->Send_Packet(p);

   356

   357

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

   358

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

   359

				cs->status = STATUS_DONE_MAP;

   360

				fclose(file_pointer);

   361

   362

				{

   363

					NetworkTCPSocketHandler *new_cs;

   364

					bool new_map_client = false;

   365

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

   366

					//  and start sending him the map

   367

					FOR_ALL_CLIENTS(new_cs) {

   368

						if (new_cs->status == STATUS_MAP_WAIT) {

   369

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

   370

							if (!new_map_client) {

   371

								// If not, this client will get the map

   372

								new_cs->status = STATUS_AUTH;

   373

								new_map_client = true;

   374

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   375

							} else {

   376

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

   377

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   378

							}

   379

						}

   380

					}

   381

				}

   382

   383

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

   384

				break;

   385

			}

   386

		}

   387

   388

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

   389

		cs->Send_Packets();

   390

		if (cs->IsPacketQueueEmpty()) {

   391

			// All are sent, increase the sent_packets

   392

			sent_packets *= 2;

   393

		} else {

   394

			// Not everything is sent, decrease the sent_packets

   395

			if (sent_packets > 1) sent_packets /= 2;

   396

		}

   397

	}

   398

}

   399

   400

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

   401

{

   402

	//

   403

	// Packet: SERVER_JOIN

   404

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

   405

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   406

	//     PACKET_SERVER_CLIENT_INFO

   407

	// Data:

   408

	//    uint16:  Client-Index

   409

	//

   410

   411

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   412

   413

	p->Send_uint16(client_index);

   414

   415

	cs->Send_Packet(p);

   416

}

   417

   418

   419

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   420

{

   421

	//

   422

	// Packet: SERVER_FRAME

   423

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

   424

	// Data:

   425

	//    uint32: Frame Counter

   426

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

   427

	//    [uint32: general-seed-1]

   428

	//    [uint32: general-seed-2]

   429

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

   430

	//

   431

   432

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   433

	p->Send_uint32(_frame_counter);

   434

	p->Send_uint32(_frame_counter_max);

   435

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   436

	p->Send_uint32(_sync_seed_1);

   437

#ifdef NETWORK_SEND_DOUBLE_SEED

   438

	p->Send_uint32(_sync_seed_2);

   439

#endif

   440

#endif

   441

	cs->Send_Packet(p);

   442

}

   443

   444

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   445

{

   446

	//

   447

	// Packet: SERVER_SYNC

   448

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

   449

	// Data:

   450

	//    uint32: Frame Counter

   451

	//    uint32: General-seed-1

   452

	//    [uint32: general-seed-2]

   453

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

   454

	//

   455

   456

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   457

	p->Send_uint32(_frame_counter);

   458

	p->Send_uint32(_sync_seed_1);

   459

   460

#ifdef NETWORK_SEND_DOUBLE_SEED

   461

	p->Send_uint32(_sync_seed_2);

   462

#endif

   463

	cs->Send_Packet(p);

   464

}

   465

   466

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

   467

{

   468

	//

   469

	// Packet: SERVER_COMMAND

   470

	// Function: Sends a DoCommand to the client

   471

	// Data:

   472

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

   473

	//    uint32: CommandID (see command.h)

   474

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

   475

	//    uint32: P2

   476

	//    uint32: Tile

   477

	//    string: text

   478

	//    uint8:  CallBackID (see callback_table.c)

   479

	//    uint32: Frame of execution

   480

	//

   481

   482

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   483

   484

	p->Send_uint8 (cp->player);

   485

	p->Send_uint32(cp->cmd);

   486

	p->Send_uint32(cp->p1);

   487

	p->Send_uint32(cp->p2);

   488

	p->Send_uint32(cp->tile);

   489

	p->Send_string(cp->text);

   490

	p->Send_uint8 (cp->callback);

   491

	p->Send_uint32(cp->frame);

   492

   493

	cs->Send_Packet(p);

   494

}

   495

   496

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

   497

{

   498

	//

   499

	// Packet: SERVER_CHAT

   500

	// Function: Sends a chat-packet to the client

   501

	// Data:

   502

	//    uint8:  ActionID (see network_data.h, NetworkAction)

   503

	//    uint16:  Client-index

   504

	//    String: Message (max MAX_TEXT_MSG_LEN)

   505

	//

   506