1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "debug.h"

     5

#include "string.h"

     6

#include "strings.h"

     7

#include "network_data.h"

     8

#include "train.h"

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "table/strings.h"

    13

#include "functions.h"

    14

#include "network_server.h"

    15

#include "network_udp.h"

    16

#include "console.h"

    17

#include "command.h"

    18

#include "gfx.h"

    19

#include "saveload.h"

    20

#include "vehicle.h"

    21

#include "station.h"

    22

#include "settings.h"

    23

#include "variables.h"

    24

    25

// This file handles all the server-commands

    26

    27

static void NetworkHandleCommandQueue(NetworkClientState* cs);

    28

static void NetworkSendPatchSettings(NetworkClientState* cs);

    29

    30

void NetworkPopulateCompanyInfo(void);

    31

    32

// Is the network enabled?

    33

    34

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

    35

// Sending functions

    36

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkClientState *cs

    37

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

    38

    39

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

    40

{

    41

	//

    42

	// Packet: SERVER_CLIENT_INFO

    43

	// Function: Sends info about a client

    44

	// Data:

    45

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

    46

	//    uint8:  As which player the client is playing

    47

	//    String: The name of the client

    48

	//    String: The unique id of the client

    49

	//

    50

    51

	Packet *p;

    52

    53

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    54

		p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    55

		NetworkSend_uint16(p, ci->client_index);

    56

		NetworkSend_uint8 (p, ci->client_playas);

    57

		NetworkSend_string(p, ci->client_name);

    58

		NetworkSend_string(p, ci->unique_id);

    59

    60

		NetworkSend_Packet(p, cs);

    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

    78

    79

	if (active == 0) {

    80

		Packet *p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    81

    82

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    83

		NetworkSend_uint8 (p, active);

    84

    85

		NetworkSend_Packet(p, cs);

    86

		return;

    87

	}

    88

    89

	NetworkPopulateCompanyInfo();

    90

    91

	FOR_ALL_PLAYERS(player) {

    92

		if (!player->is_active)

    93

			continue;

    94

    95

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    96

    97

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    98

		NetworkSend_uint8 (p, active);

    99

		NetworkSend_uint8 (p, player->index);

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

   108

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

   109

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

   110

			NetworkSend_uint8 (p, 1);

   111

		} else {

   112

			NetworkSend_uint8 (p, 0);

   113

		}

   114

   115

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

   116

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

   117

   118

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

   119

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

   120

   121

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

   122

			NetworkSend_string(p, "<none>");

   123

		else

   124

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

   125

   126

		NetworkSend_Packet(p, cs);

   127

	}

   128

   129

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   130

   131

	NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

   132

	NetworkSend_uint8 (p, 0);

   133

   134

	NetworkSend_Packet(p, cs);

   135

}

   136

   137

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_ERROR)(NetworkClientState *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

	NetworkClientState *new_cs;

   147

	char str[100];

   148

	char client_name[NETWORK_CLIENT_NAME_LENGTH];

   149

   150

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   151

	NetworkSend_uint8(p, error);

   152

	NetworkSend_Packet(p, cs);

   153

   154

	GetString(str, STR_NETWORK_ERR_CLIENT_GENERAL + error);

   155

   156

	// Only send when the current client was in game

   157

	if (cs->status > STATUS_AUTH) {

   158

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

   159

   160

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

   161

   162

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

   163

   164

		FOR_ALL_CLIENTS(new_cs) {

   165

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

   166

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

   167

				//  reason a joining failed.

   168

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

   169

					error = NETWORK_ERROR_ILLEGAL_PACKET;

   170

   171

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

   172

			}

   173

		}

   174

	} else {

   175

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

   176

	}

   177

   178

	cs->quited = true;

   179

   180

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

   181

	NetworkSend_Packets(cs);

   182

   183

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

   184

	NetworkCloseClient(cs);

   185

}

   186

   187

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

   188

{

   189

	//

   190

	// Packet: SERVER_NEED_PASSWORD

   191

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

   192

	// Data:

   193

	//    uint8:  Type of password

   194

	//

   195

   196

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   197

	NetworkSend_uint8(p, type);

   198

	NetworkSend_Packet(p, cs);

   199

}

   200

   201

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   202

{

   203

	//

   204

	// Packet: SERVER_WELCOME

   205

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

   206

	// Data:

   207

	//    uint16:  Own ClientID

   208

	//

   209

   210

	Packet *p;

   211

	const NetworkClientState *new_cs;

   212

   213

	// Invalid packet when status is AUTH or higher

   214

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

   215

   216

	cs->status = STATUS_AUTH;

   217

	_network_game_info.clients_on++;

   218

   219

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   220

	NetworkSend_uint16(p, cs->index);

   221

	NetworkSend_Packet(p, cs);

   222

   223

		// Transmit info about all the active clients

   224

	FOR_ALL_CLIENTS(new_cs) {

   225

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

   226

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

   227

	}

   228

	// Also send the info of the server

   229

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

   230

}

   231

   232

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   233

{

   234

	//

   235

	// Packet: PACKET_SERVER_WAIT

   236

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

   237

	//             someone else is already receiving the map

   238

	// Data:

   239

	//    uint8:  Clients awaiting map

   240

	//

   241

	int waiting = 0;

   242

	NetworkClientState *new_cs;

   243

	Packet *p;

   244

   245

	// Count how many players are waiting in the queue

   246

	FOR_ALL_CLIENTS(new_cs) {

   247

		if (new_cs->status == STATUS_MAP_WAIT)

   248

			waiting++;

   249

	}

   250

   251

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   252

	NetworkSend_uint8(p, waiting);

   253

	NetworkSend_Packet(p, cs);

   254

}

   255

   256

// This sends the map to the client

   257

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   258

{

   259

	//

   260

	// Packet: SERVER_MAP

   261

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

   262

	//   a lot of multiple packets)

   263

	// Data:

   264

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

   265

	//  if MAP_PACKET_START:

   266

	//    uint32: The current FrameCounter

   267

	//  if MAP_PACKET_NORMAL:

   268

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

   269

	//  if MAP_PACKET_END:

   270

	//    uint32: seed0 of player

   271

	//    uint32: seed1 of player

   272

	//      last 2 are repeated MAX_PLAYERS time

   273

	//

   274

   275

	char filename[256];

   276

	static FILE *file_pointer;

   277

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

   278

   279

	if (cs->status < STATUS_AUTH) {

   280

		// Illegal call, return error and ignore the packet

   281

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   282

		return;

   283

	}

   284

	if (cs->status == STATUS_AUTH) {

   285

		Packet *p;

   286

   287

		// Make a dump of the current game

   288

		sprintf(filename, "%s%snetwork_server.tmp",  _path.autosave_dir, PATHSEP);

   289

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

   290

   291

		file_pointer = fopen(filename, "rb");

   292

		fseek(file_pointer, 0, SEEK_END);

   293

   294

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

   295

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   296

		NetworkSend_uint8(p, MAP_PACKET_START);

   297

		NetworkSend_uint32(p, _frame_counter);

   298

		NetworkSend_uint32(p, ftell(file_pointer));

   299

		NetworkSend_Packet(p, cs);

   300

   301

		fseek(file_pointer, 0, SEEK_SET);

   302

   303

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

   304

   305

		cs->status = STATUS_MAP;

   306

		/* Mark the start of download */

   307

		cs->last_frame = _frame_counter;

   308

		cs->last_frame_server = _frame_counter;

   309

	}

   310

   311

	if (cs->status == STATUS_MAP) {

   312

		uint i;

   313

		int res;

   314

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

   315

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   316

			NetworkSend_uint8(p, MAP_PACKET_NORMAL);

   317

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

   318

			if (ferror(file_pointer)) {

   319

				error("Error reading temporary network savegame!");

   320

			}

   321

			p->size += res;

   322

			NetworkSend_Packet(p, cs);

   323

			if (feof(file_pointer)) {

   324

				// Done reading!

   325

				Packet *p;

   326

   327

				// XXX - Delete this when patch-settings are saved in-game

   328

				NetworkSendPatchSettings(cs);

   329

   330

				p = NetworkSend_Init(PACKET_SERVER_MAP);

   331

				NetworkSend_uint8(p, MAP_PACKET_END);

   332

				NetworkSend_Packet(p, cs);

   333

   334

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

   335

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

   336

				cs->status = STATUS_DONE_MAP;

   337

				fclose(file_pointer);

   338

   339

				{

   340

					NetworkClientState *new_cs;

   341

					bool new_map_client = false;

   342

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

   343

					//  and start sending him the map

   344

					FOR_ALL_CLIENTS(new_cs) {

   345

						if (new_cs->status == STATUS_MAP_WAIT) {

   346

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

   347

							if (!new_map_client) {

   348

								// If not, this client will get the map

   349

								new_cs->status = STATUS_AUTH;

   350

								new_map_client = true;

   351

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   352

							} else {

   353

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

   354

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   355

							}

   356

						}

   357

					}

   358

				}

   359

   360

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

   361

				break;

   362

			}

   363

		}

   364

   365

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

   366

		NetworkSend_Packets(cs);

   367

		if (cs->packet_queue == NULL) {

   368

			// All are sent, increase the sent_packets

   369

			sent_packets *= 2;

   370

		} else {

   371

			// Not everything is sent, decrease the sent_packets

   372

			if (sent_packets > 1) sent_packets /= 2;

   373

		}

   374

	}

   375

}

   376

   377

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

   378

{

   379

	//

   380

	// Packet: SERVER_JOIN

   381

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

   382

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   383

	//     PACKET_SERVER_CLIENT_INFO

   384

	// Data:

   385

	//    uint16:  Client-Index

   386

	//

   387

   388

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   389

   390

	NetworkSend_uint16(p, client_index);

   391

   392

	NetworkSend_Packet(p, cs);

   393

}

   394

   395

   396

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   397

{

   398

	//

   399

	// Packet: SERVER_FRAME

   400

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

   401

	// Data:

   402

	//    uint32: Frame Counter

   403

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

   404

	//    [uint32: general-seed-1]

   405

	//    [uint32: general-seed-2]

   406

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

   407

	//

   408

   409

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   410

	NetworkSend_uint32(p, _frame_counter);

   411

	NetworkSend_uint32(p, _frame_counter_max);

   412

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   413

	NetworkSend_uint32(p, _sync_seed_1);

   414

#ifdef NETWORK_SEND_DOUBLE_SEED

   415

	NetworkSend_uint32(p, _sync_seed_2);

   416

#endif

   417

#endif

   418

	NetworkSend_Packet(p, cs);

   419

}

   420

   421

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   422

{

   423

	//

   424

	// Packet: SERVER_SYNC

   425

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

   426

	// Data:

   427

	//    uint32: Frame Counter

   428

	//    uint32: General-seed-1

   429

	//    [uint32: general-seed-2]

   430

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

   431

	//

   432

   433

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   434

	NetworkSend_uint32(p, _frame_counter);

   435

	NetworkSend_uint32(p, _sync_seed_1);

   436

   437

#ifdef NETWORK_SEND_DOUBLE_SEED

   438

	NetworkSend_uint32(p, _sync_seed_2);

   439

#endif

   440

	NetworkSend_Packet(p, cs);

   441

}

   442

   443

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

   444

{

   445

	//

   446

	// Packet: SERVER_COMMAND

   447

	// Function: Sends a DoCommand to the client

   448

	// Data:

   449

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

   450

	//    uint32: CommandID (see command.h)

   451

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

   452

	//    uint32: P2

   453

	//    uint32: Tile

   454

	//    string: text

   455

	//    uint8:  CallBackID (see callback_table.c)

   456

	//    uint32: Frame of execution

   457

	//

   458

   459

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   460

   461

	NetworkSend_uint8(p, cp->player);

   462

	NetworkSend_uint32(p, cp->cmd);

   463

	NetworkSend_uint32(p, cp->p1);

   464

	NetworkSend_uint32(p, cp->p2);

   465

	NetworkSend_uint32(p, cp->tile);

   466

	NetworkSend_string(p, cp->text);

   467

	NetworkSend_uint8(p, cp->callback);

   468

	NetworkSend_uint32(p, cp->frame);

   469

   470

	NetworkSend_Packet(p, cs);

   471

}

   472

   473

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

   474

{

   475

	//

   476

	// Packet: SERVER_CHAT

   477

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

   478

	// Data:

   479

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

   480

	//    uint16:  Client-index

   481

	//    String: Message (max MAX_TEXT_MSG_LEN)

   482

	//

   483

   484

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHAT);

   485

   486

	NetworkSend_uint8(p, action);

   487

	NetworkSend_uint16(p, client_index);

   488

	NetworkSend_uint8(p, self_send);

   489

	NetworkSend_string(p, msg);

   490

   491

	NetworkSend_Packet(p, cs);

   492

}

   493

   494

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_ERROR_QUIT)(NetworkClientState *cs, uint16 client_index, NetworkErrorCode errorno)

   495

{

   496

	//

   497

	// Packet: SERVER_ERROR_QUIT

   498

	// Function: One of the clients made an error and is quiting the game

   499

	//      This packet informs the other clients of that.

   500

	// Data:

   501

	//    uint16:  Client-index

   502

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

   503

	//

   504

   505

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR_QUIT);

   506

   507

	NetworkSend_uint16(p, client_index);

   508

	NetworkSend_uint8(p, errorno);

   509

   510

	NetworkSend_Packet(p, cs);

   511

}

   512

   513

DEF_SERVER_SEND_COMMAND_PARAM(PACKET_SERVER_QUIT)(NetworkClientState *cs, uint16 client_index, const char *leavemsg)

   514

{

   515

	//

   516

	// Packet: SERVER_ERROR_QUIT

   517

	// Function: A client left the game, and this packets informs the other clients

   518

	//      of that.

   519

	// Data:

   520

	//    uint16:  Client-index