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

    29

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

    30

// Sending functions

    31

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkClientState *cs

    32

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

    33

    34

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

    35

{

    36

	//

    37

	// Packet: SERVER_CLIENT_INFO

    38

	// Function: Sends info about a client

    39

	// Data:

    40

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

    41

	//    uint8:  As which player the client is playing

    42

	//    String: The name of the client

    43

	//    String: The unique id of the client

    44

	//

    45

    46

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    47

		Packet *p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    48

		NetworkSend_uint16(p, ci->client_index);

    49

		NetworkSend_uint8 (p, ci->client_playas);

    50

		NetworkSend_string(p, ci->client_name);

    51

		NetworkSend_string(p, ci->unique_id);

    52

    53

		NetworkSend_Packet(p, cs);

    54

	}

    55

}

    56

    57

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    58

{

    59

//

    60

	// Packet: SERVER_COMPANY_INFO

    61

	// Function: Sends info about the companies

    62

	// Data:

    63

	//

    64

    65

	int i;

    66

    67

	Player *player;

    68

	Packet *p;

    69

    70

	byte active = ActivePlayerCount();

    71

    72

	if (active == 0) {

    73

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    74

    75

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    76

		NetworkSend_uint8 (p, active);

    77

    78

		NetworkSend_Packet(p, cs);

    79

		return;

    80

	}

    81

    82

	NetworkPopulateCompanyInfo();

    83

    84

	FOR_ALL_PLAYERS(player) {

    85

		if (!player->is_active) continue;

    86

    87

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    88

    89

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    90

		NetworkSend_uint8 (p, active);

    91

		NetworkSend_uint8 (p, player->index);

    92

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

   100

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

   101

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

   102

			NetworkSend_uint8(p, 1);

   103

		} else {

   104

			NetworkSend_uint8(p, 0);

   105

		}

   106

   107

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

   108

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

   109

		}

   110

   111

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

   112

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

   113

		}

   114

   115

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

   116

			NetworkSend_string(p, "<none>");

   117

		} else {

   118

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

   119

		}

   120

   121

		NetworkSend_Packet(p, cs);

   122

	}

   123

   124

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   125

   126

	NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

   127

	NetworkSend_uint8 (p, 0);

   128

   129

	NetworkSend_Packet(p, cs);

   130

}

   131

   132

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

	NetworkSend_uint8(p, error);

   145

	NetworkSend_Packet(p, cs);

   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

		NetworkClientState *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

	NetworkSend_Packets(cs);

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

   184

{

   185

	//

   186

	// Packet: SERVER_NEED_PASSWORD

   187

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

   188

	// Data:

   189

	//    uint8:  Type of password

   190

	//

   191

   192

	Packet *p = NetworkSend_Init(PACKET_SERVER_NEED_PASSWORD);

   193

	NetworkSend_uint8(p, type);

   194

	NetworkSend_Packet(p, cs);

   195

}

   196

   197

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WELCOME)

   198

{

   199

	//

   200

	// Packet: SERVER_WELCOME

   201

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

   202

	// Data:

   203

	//    uint16:  Own ClientID

   204

	//

   205

   206

	Packet *p;

   207

	const NetworkClientState *new_cs;

   208

   209

	// Invalid packet when status is AUTH or higher

   210

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

   211

   212

	cs->status = STATUS_AUTH;

   213

	_network_game_info.clients_on++;

   214

   215

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   216

	NetworkSend_uint16(p, cs->index);

   217

	NetworkSend_Packet(p, cs);

   218

   219

		// Transmit info about all the active clients

   220

	FOR_ALL_CLIENTS(new_cs) {

   221

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

   222

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

   223

	}

   224

	// Also send the info of the server

   225

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

   226

}

   227

   228

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   229

{

   230

	//

   231

	// Packet: PACKET_SERVER_WAIT

   232

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

   233

	//             someone else is already receiving the map

   234

	// Data:

   235

	//    uint8:  Clients awaiting map

   236

	//

   237

	int waiting = 0;

   238

	NetworkClientState *new_cs;

   239

	Packet *p;

   240

   241

	// Count how many players are waiting in the queue

   242

	FOR_ALL_CLIENTS(new_cs) {

   243

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

   244

	}

   245

   246

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   247

	NetworkSend_uint8(p, waiting);

   248

	NetworkSend_Packet(p, cs);

   249

}

   250

   251

// This sends the map to the client

   252

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   253

{

   254

	//

   255

	// Packet: SERVER_MAP

   256

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

   257

	//   a lot of multiple packets)

   258

	// Data:

   259

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

   260

	//  if MAP_PACKET_START:

   261

	//    uint32: The current FrameCounter

   262

	//  if MAP_PACKET_NORMAL:

   263

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

   264

	//  if MAP_PACKET_END:

   265

	//    uint32: seed0 of player

   266

	//    uint32: seed1 of player

   267

	//      last 2 are repeated MAX_PLAYERS time

   268

	//

   269

   270

	static FILE *file_pointer;

   271

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

   272

   273

	if (cs->status < STATUS_AUTH) {

   274

		// Illegal call, return error and ignore the packet

   275

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   276

		return;

   277

	}

   278

   279

	if (cs->status == STATUS_AUTH) {

   280

		char filename[256];

   281

		Packet *p;

   282

   283

		// Make a dump of the current game

   284

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

   285

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

   286

   287

		file_pointer = fopen(filename, "rb");

   288

		fseek(file_pointer, 0, SEEK_END);

   289

   290

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

   291

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   292

		NetworkSend_uint8(p, MAP_PACKET_START);

   293

		NetworkSend_uint32(p, _frame_counter);

   294

		NetworkSend_uint32(p, ftell(file_pointer));

   295

		NetworkSend_Packet(p, cs);

   296

   297

		fseek(file_pointer, 0, SEEK_SET);

   298

   299

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

   300

   301

		cs->status = STATUS_MAP;

   302

		/* Mark the start of download */

   303

		cs->last_frame = _frame_counter;

   304

		cs->last_frame_server = _frame_counter;

   305

	}

   306

   307

	if (cs->status == STATUS_MAP) {

   308

		uint i;

   309

		int res;

   310

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

   311

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   312

			NetworkSend_uint8(p, MAP_PACKET_NORMAL);

   313

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

   314

   315

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

   316

   317

			p->size += res;

   318

			NetworkSend_Packet(p, cs);

   319

			if (feof(file_pointer)) {

   320

				// Done reading!

   321

				Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   322

				NetworkSend_uint8(p, MAP_PACKET_END);

   323

				NetworkSend_Packet(p, cs);

   324

   325

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

   326

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

   327

				cs->status = STATUS_DONE_MAP;

   328

				fclose(file_pointer);

   329

   330

				{

   331

					NetworkClientState *new_cs;

   332

					bool new_map_client = false;

   333

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

   334

					//  and start sending him the map

   335

					FOR_ALL_CLIENTS(new_cs) {

   336

						if (new_cs->status == STATUS_MAP_WAIT) {

   337

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

   338

							if (!new_map_client) {

   339

								// If not, this client will get the map

   340

								new_cs->status = STATUS_AUTH;

   341

								new_map_client = true;

   342

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   343

							} else {

   344

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

   345

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   346

							}

   347

						}

   348

					}

   349

				}

   350

   351

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

   352

				break;

   353

			}

   354

		}

   355

   356

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

   357

		NetworkSend_Packets(cs);

   358

		if (cs->packet_queue == NULL) {

   359

			// All are sent, increase the sent_packets

   360

			sent_packets *= 2;

   361

		} else {

   362

			// Not everything is sent, decrease the sent_packets

   363

			if (sent_packets > 1) sent_packets /= 2;

   364

		}

   365

	}

   366

}

   367

   368

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

   369

{

   370

	//

   371

	// Packet: SERVER_JOIN

   372

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

   373

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   374

	//     PACKET_SERVER_CLIENT_INFO

   375

	// Data:

   376

	//    uint16:  Client-Index

   377

	//

   378

   379

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   380

   381

	NetworkSend_uint16(p, client_index);

   382

   383

	NetworkSend_Packet(p, cs);

   384

}

   385

   386

   387

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   388

{

   389

	//

   390

	// Packet: SERVER_FRAME

   391

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

   392

	// Data:

   393

	//    uint32: Frame Counter

   394

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

   395

	//    [uint32: general-seed-1]

   396

	//    [uint32: general-seed-2]

   397

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

   398

	//

   399

   400

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   401

	NetworkSend_uint32(p, _frame_counter);

   402

	NetworkSend_uint32(p, _frame_counter_max);

   403

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   404

	NetworkSend_uint32(p, _sync_seed_1);

   405

#ifdef NETWORK_SEND_DOUBLE_SEED

   406

	NetworkSend_uint32(p, _sync_seed_2);

   407

#endif

   408

#endif

   409

	NetworkSend_Packet(p, cs);

   410

}

   411

   412

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   413

{

   414

	//

   415

	// Packet: SERVER_SYNC

   416

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

   417

	// Data:

   418

	//    uint32: Frame Counter

   419

	//    uint32: General-seed-1

   420

	//    [uint32: general-seed-2]

   421

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

   422

	//

   423

   424

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   425

	NetworkSend_uint32(p, _frame_counter);

   426

	NetworkSend_uint32(p, _sync_seed_1);

   427

   428

#ifdef NETWORK_SEND_DOUBLE_SEED

   429

	NetworkSend_uint32(p, _sync_seed_2);

   430

#endif

   431

	NetworkSend_Packet(p, cs);

   432

}

   433

   434

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

   435

{

   436

	//

   437

	// Packet: SERVER_COMMAND

   438

	// Function: Sends a DoCommand to the client

   439

	// Data:

   440

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

   441

	//    uint32: CommandID (see command.h)

   442

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

   443

	//    uint32: P2

   444

	//    uint32: Tile

   445

	//    string: text

   446

	//    uint8:  CallBackID (see callback_table.c)

   447

	//    uint32: Frame of execution

   448

	//

   449

   450

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   451

   452

	NetworkSend_uint8(p, cp->player);

   453

	NetworkSend_uint32(p, cp->cmd);

   454

	NetworkSend_uint32(p, cp->p1);

   455

	NetworkSend_uint32(p, cp->p2);

   456

	NetworkSend_uint32(p, cp->tile);

   457

	NetworkSend_string(p, cp->text);

   458

	NetworkSend_uint8(p, cp->callback);

   459

	NetworkSend_uint32(p, cp->frame);

   460

   461

	NetworkSend_Packet(p, cs);

   462

}

   463

   464

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

   465

{

   466

	//

   467

	// Packet: SERVER_CHAT

   468

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

   469

	// Data:

   470

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

   471

	//    uint16:  Client-index

   472

	//    String: Message (max MAX_TEXT_MSG_LEN)

   473

	//

   474

   475

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHAT);

   476

   477

	NetworkSend_uint8(p, action);

   478

	NetworkSend_uint16(p, client_index);

   479

	NetworkSend_uint8(p, self_send);

   480

	NetworkSend_string(p, msg);

   481

   482

	NetworkSend_Packet(p, cs);

   483

}

   484

   485

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

   486

{

   487

	//

   488

	// Packet: SERVER_ERROR_QUIT

   489

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

   490

	//      This packet informs the other clients of that.

   491

	// Data:

   492

	//    uint16:  Client-index

   493

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

   494

	//

   495

   496

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR_QUIT);

   497

   498

	NetworkSend_uint16(p, client_index);

   499

	NetworkSend_uint8(p, errorno);

   500

   501

	NetworkSend_Packet(p, cs);

   502

}

   503

   504

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

   505

{

   506

	//

   507

	// Packet: SERVER_ERROR_QUIT

   508

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

   509

	//      of that.

   510

	// Data:

   511

	//    uint16:  Client-index

   512

	//    String: leave-message

   513

	//

   514

   515

	Packet *p = NetworkSend_Init(PACKET_SERVER_QUIT);

   516