1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "stdafx.h"

     7

#include "debug.h"

     8

#include "string.h"

     9

#include "strings.h"

    10

#include "network_data.h"

    11

#include "train.h"

    12

#include "date.h"

    13

#include "table/strings.h"

    14

#include "functions.h"

    15

#include "network_server.h"

    16

#include "network_udp.h"

    17

#include "console.h"

    18

#include "command.h"

    19

#include "saveload.h"

    20

#include "vehicle.h"

    21

#include "station.h"

    22

#include "variables.h"

    23

#include "genworld.h"

    24

    25

// This file handles all the server-commands

    26

    27

static void NetworkHandleCommandQueue(NetworkClientState* cs);

    28

void NetworkPopulateCompanyInfo(void);

    29

    30

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

    31

// Sending functions

    32

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkClientState *cs

    33

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

    34

    35

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

    36

{

    37

	//

    38

	// Packet: SERVER_CLIENT_INFO

    39

	// Function: Sends info about a client

    40

	// Data:

    41

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

    42

	//    uint8:  As which player the client is playing

    43

	//    String: The name of the client

    44

	//    String: The unique id of the client

    45

	//

    46

    47

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    48

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    49

		NetworkSend_uint16(p, ci->client_index);

    50

		NetworkSend_uint8 (p, ci->client_playas);

    51

		NetworkSend_string(p, ci->client_name);

    52

		NetworkSend_string(p, ci->unique_id);

    53

    54

		NetworkSend_Packet(p, cs);

    55

	}

    56

}

    57

    58

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    59

{

    60

//

    61

	// Packet: SERVER_COMPANY_INFO

    62

	// Function: Sends info about the companies

    63

	// Data:

    64

	//

    65

    66

	int i;

    67

    68

	Player *player;

    69

	Packet *p;

    70

    71

	byte active = ActivePlayerCount();

    72

    73

	if (active == 0) {

    74

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    75

    76

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    77

		NetworkSend_uint8 (p, active);

    78

    79

		NetworkSend_Packet(p, cs);

    80

		return;

    81

	}

    82

    83

	NetworkPopulateCompanyInfo();

    84

    85

	FOR_ALL_PLAYERS(player) {

    86

		if (!player->is_active) continue;

    87

    88

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    89

    90

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    91

		NetworkSend_uint8 (p, active);

    92

		NetworkSend_uint8 (p, player->index);

    93

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

   101

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

   102

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

   103

			NetworkSend_uint8(p, 1);

   104

		} else {

   105

			NetworkSend_uint8(p, 0);

   106

		}

   107

   108

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

   109

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

   110

		}

   111

   112

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

   113

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

   114

		}

   115

   116

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

   117

			NetworkSend_string(p, "<none>");

   118

		} else {

   119

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

   120

		}

   121

   122

		NetworkSend_Packet(p, cs);

   123

	}

   124

   125

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   126

   127

	NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

   128

	NetworkSend_uint8 (p, 0);

   129

   130

	NetworkSend_Packet(p, cs);

   131

}

   132

   133

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

	NetworkSend_uint8(p, error);

   146

	NetworkSend_Packet(p, cs);

   147

   149

   150

	// Only send when the current client was in game

   151

	if (cs->status > STATUS_AUTH) {

   152

		NetworkClientState *new_cs;

   153

		char client_name[NETWORK_CLIENT_NAME_LENGTH];

   154

   155

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

   156

   157

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

   158

   159

		NetworkTextMessage(NETWORK_ACTION_LEAVE, 1, 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, 2) ("[NET] 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

	NetworkSend_Packets(cs);

   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_NEED_PASSWORD)(NetworkClientState *cs, NetworkPasswordType type)

   185

{

   186

	//

   187

	// Packet: SERVER_NEED_PASSWORD

   188

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

   189

	// Data:

   190

	//    uint8:  Type of password

   191

	//

   192

   193

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   194

	NetworkSend_uint8(p, type);

   195

	NetworkSend_Packet(p, cs);

   196

}

   197

   198

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   199

{

   200

	//

   201

	// Packet: SERVER_WELCOME

   202

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

   203

	// Data:

   204

	//    uint16:  Own ClientID

   205

	//

   206

   207

	Packet *p;

   208

	const NetworkClientState *new_cs;

   209

   210

	// Invalid packet when status is AUTH or higher

   211

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

   212

   213

	cs->status = STATUS_AUTH;

   214

	_network_game_info.clients_on++;

   215

   216

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   217

	NetworkSend_uint16(p, cs->index);

   218

	NetworkSend_Packet(p, cs);

   219

   220

		// Transmit info about all the active clients

   221

	FOR_ALL_CLIENTS(new_cs) {

   222

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

   223

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

   224

	}

   225

	// Also send the info of the server

   226

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

   227

}

   228

   229

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   230

{

   231

	//

   232

	// Packet: PACKET_SERVER_WAIT

   233

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

   234

	//             someone else is already receiving the map

   235

	// Data:

   236

	//    uint8:  Clients awaiting map

   237

	//

   238

	int waiting = 0;

   239

	NetworkClientState *new_cs;

   240

	Packet *p;

   241

   242

	// Count how many players are waiting in the queue

   243

	FOR_ALL_CLIENTS(new_cs) {

   244

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

   245

	}

   246

   247

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   248

	NetworkSend_uint8(p, waiting);

   249

	NetworkSend_Packet(p, cs);

   250

}

   251

   252

// This sends the map to the client

   253

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   254

{

   255

	//

   256

	// Packet: SERVER_MAP

   257

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

   258

	//   a lot of multiple packets)

   259

	// Data:

   260

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

   261

	//  if MAP_PACKET_START:

   262

	//    uint32: The current FrameCounter

   263

	//  if MAP_PACKET_NORMAL:

   264

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

   265

	//  if MAP_PACKET_END:

   266

	//    uint32: seed0 of player

   267

	//    uint32: seed1 of player

   268

	//      last 2 are repeated MAX_PLAYERS time

   269

	//

   270

   271

	static FILE *file_pointer;

   272

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

   273

   274

	if (cs->status < STATUS_AUTH) {

   275

		// Illegal call, return error and ignore the packet

   276

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   277

		return;

   278

	}

   279

   280

	if (cs->status == STATUS_AUTH) {

   281

		char filename[256];

   282

		Packet *p;

   283

   284

		// Make a dump of the current game

   285

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

   286

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

   287

   288

		file_pointer = fopen(filename, "rb");

   289

		fseek(file_pointer, 0, SEEK_END);

   290

   291

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

   292

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   293

		NetworkSend_uint8(p, MAP_PACKET_START);

   294

		NetworkSend_uint32(p, _frame_counter);

   295

		NetworkSend_uint32(p, ftell(file_pointer));

   296

		NetworkSend_Packet(p, cs);

   297

   298

		fseek(file_pointer, 0, SEEK_SET);

   299

   300

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

   301

   302

		cs->status = STATUS_MAP;

   303

		/* Mark the start of download */

   304

		cs->last_frame = _frame_counter;

   305

		cs->last_frame_server = _frame_counter;

   306

	}

   307

   308

	if (cs->status == STATUS_MAP) {

   309

		uint i;

   310

		int res;

   311

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

   312

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   313

			NetworkSend_uint8(p, MAP_PACKET_NORMAL);

   314

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

   315

   316

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

   317

   318

			p->size += res;

   319

			NetworkSend_Packet(p, cs);

   320

			if (feof(file_pointer)) {

   321

				// Done reading!

   322

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   323

				NetworkSend_uint8(p, MAP_PACKET_END);

   324

				NetworkSend_Packet(p, cs);

   325

   326

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

   327

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

   328

				cs->status = STATUS_DONE_MAP;

   329

				fclose(file_pointer);

   330

   331

				{

   332

					NetworkClientState *new_cs;

   333

					bool new_map_client = false;

   334

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

   335

					//  and start sending him the map

   336

					FOR_ALL_CLIENTS(new_cs) {

   337

						if (new_cs->status == STATUS_MAP_WAIT) {

   338

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

   339

							if (!new_map_client) {

   340

								// If not, this client will get the map

   341

								new_cs->status = STATUS_AUTH;

   342

								new_map_client = true;

   343

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   344

							} else {

   345

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

   346

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   347

							}

   348

						}

   349

					}

   350

				}

   351

   352

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

   353

				break;

   354

			}

   355

		}

   356

   357

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

   358

		NetworkSend_Packets(cs);

   359

		if (cs->packet_queue == NULL) {

   360

			// All are sent, increase the sent_packets

   361

			sent_packets *= 2;

   362

		} else {

   363

			// Not everything is sent, decrease the sent_packets

   364

			if (sent_packets > 1) sent_packets /= 2;

   365

		}

   366

	}

   367

}

   368

   369

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

   370

{

   371

	//

   372

	// Packet: SERVER_JOIN

   373

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

   374

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   375

	//     PACKET_SERVER_CLIENT_INFO

   376

	// Data:

   377

	//    uint16:  Client-Index

   378

	//

   379

   380

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   381

   382

	NetworkSend_uint16(p, client_index);

   383

   384

	NetworkSend_Packet(p, cs);

   385

}

   386

   387

   388

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   389

{

   390

	//

   391

	// Packet: SERVER_FRAME

   392

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

   393

	// Data:

   394

	//    uint32: Frame Counter

   395

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

   396

	//    [uint32: general-seed-1]

   397

	//    [uint32: general-seed-2]

   398

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

   399

	//

   400

   401

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   402

	NetworkSend_uint32(p, _frame_counter);

   403

	NetworkSend_uint32(p, _frame_counter_max);

   404

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   405

	NetworkSend_uint32(p, _sync_seed_1);

   406

#ifdef NETWORK_SEND_DOUBLE_SEED

   407

	NetworkSend_uint32(p, _sync_seed_2);

   408

#endif

   409

#endif

   410

	NetworkSend_Packet(p, cs);

   411

}

   412

   413

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   414

{

   415

	//

   416

	// Packet: SERVER_SYNC

   417

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

   418

	// Data:

   419

	//    uint32: Frame Counter

   420

	//    uint32: General-seed-1

   421

	//    [uint32: general-seed-2]

   422

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

   423

	//

   424

   425

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   426

	NetworkSend_uint32(p, _frame_counter);

   427

	NetworkSend_uint32(p, _sync_seed_1);

   428

   429

#ifdef NETWORK_SEND_DOUBLE_SEED

   430

	NetworkSend_uint32(p, _sync_seed_2);

   431

#endif

   432

	NetworkSend_Packet(p, cs);

   433

}

   434

   435

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

   436

{

   437

	//

   438

	// Packet: SERVER_COMMAND

   439

	// Function: Sends a DoCommand to the client

   440

	// Data:

   441

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

   442

	//    uint32: CommandID (see command.h)

   443

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

   444

	//    uint32: P2

   445

	//    uint32: Tile

   446

	//    string: text

   447

	//    uint8:  CallBackID (see callback_table.c)

   448

	//    uint32: Frame of execution

   449

	//

   450

   451

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   452

   453

	NetworkSend_uint8(p, cp->player);

   454

	NetworkSend_uint32(p, cp->cmd);

   455

	NetworkSend_uint32(p, cp->p1);

   456

	NetworkSend_uint32(p, cp->p2);

   457

	NetworkSend_uint32(p, cp->tile);

   458

	NetworkSend_string(p, cp->text);

   459

	NetworkSend_uint8(p, cp->callback);

   460

	NetworkSend_uint32(p, cp->frame);

   461

   462

	NetworkSend_Packet(p, cs);

   463

}

   464

   465

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

   466

{

   467

	//

   468

	// Packet: SERVER_CHAT

   469

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

   470

	// Data:

   471

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

   472

	//    uint16:  Client-index

   473

	//    String: Message (max MAX_TEXT_MSG_LEN)

   474

	//

   475

   476

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHAT);

   477

   478

	NetworkSend_uint8(p, action);

   479

	NetworkSend_uint16(p, client_index);

   480

	NetworkSend_uint8(p, self_send);

   481

	NetworkSend_string(p, msg);

   482

   483

	NetworkSend_Packet(p, cs);

   484

}

   485

   486

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

   487

{

   488

	//

   489

	// Packet: SERVER_ERROR_QUIT

   490

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

   491

	//      This packet informs the other clients of that.

   492

	// Data:

   493

	//    uint16:  Client-index

   494

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

   495

	//

   496

   497

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR_QUIT);

   498

   499

	NetworkSend_uint16(p, client_index);

   500

	NetworkSend_uint8(p, errorno);

   501

   502

	NetworkSend_Packet(p, cs);

   503

}

   504

   505

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

   506

{

   507

	//

   508

	// Packet: SERVER_ERROR_QUIT

   509

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

   510

	//      of that.

   511

	// Data:

   512

	//    uint16:  Client-index

   513

	//    String: leave-message

   514

	//

   515