1

#include "stdafx.h"

     2

#include "network_data.h"

     3

     4

#ifdef ENABLE_NETWORK

     5

     6

#include "table/strings.h"

     7

#include "network_server.h"

     8

#include "network_udp.h"

     9

#include "console.h"

    10

#include "command.h"

    11

#include "gfx.h"

    12

#include "vehicle.h"

    13

#include "station.h"

    14

#include "settings.h"

    15

    16

// This file handles all the server-commands

    17

    18

void NetworkHandleCommandQueue(NetworkClientState *cs);

    19

void NetworkPopulateCompanyInfo(void);

    20

void NetworkSendPatchSettings(NetworkClientState *cs);

    21

    22

extern const char _openttd_revision[];

    23

    24

// Is the network enabled?

    25

    26

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

    27

// Sending functions

    28

//   DEF_SERVER_SEND_COMMAND has parameter: NetworkClientState *cs

    29

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

    30

    31

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

    32

{

    33

	//

    34

	// Packet: SERVER_CLIENT_INFO

    35

	// Function: Sends info about a client

    36

	// Data:

    37

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

    38

	//    uint8:  As which player the client is playing

    39

	//    String: The name of the client

    40

	//    String: The unique id of the client

    41

	//

    42

    43

	Packet *p;

    44

    45

	if (ci->client_index != NETWORK_EMPTY_INDEX) {

    46

		p = NetworkSend_Init(PACKET_SERVER_CLIENT_INFO);

    47

		NetworkSend_uint16(p, ci->client_index);

    48

		NetworkSend_uint8 (p, ci->client_playas);

    49

		NetworkSend_string(p, ci->client_name);

    50

		NetworkSend_string(p, ci->unique_id);

    51

    52

		NetworkSend_Packet(p, cs);

    53

	}

    54

}

    55

    56

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_COMPANY_INFO)

    57

{

    58

//

    59

	// Packet: SERVER_COMPANY_INFO

    60

	// Function: Sends info about the companies

    61

	// Data:

    62

	//

    63

    64

	int i;

    65

    66

	Player *player;

    67

	Packet *p;

    68

    69

	byte active = 0;

    70

    71

	FOR_ALL_PLAYERS(player) {

    72

		if (player->is_active)

    73

			active++;

    74

	}

    75

    76

	if (active == 0) {

    77

		Packet *p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    78

    79

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    80

		NetworkSend_uint8 (p, active);

    81

    82

		NetworkSend_Packet(p, cs);

    83

		return;

    84

	}

    85

    86

	NetworkPopulateCompanyInfo();

    87

    88

	FOR_ALL_PLAYERS(player) {

    89

		if (!player->is_active)

    90

			continue;

    91

    92

		p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

    93

    94

		NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

    95

		NetworkSend_uint8 (p, active);

    96

		NetworkSend_uint8 (p, player->index);

    97

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

			NetworkSend_uint8 (p, 1);

   108

		} else {

   109

			NetworkSend_uint8 (p, 0);

   110

		}

   111

   112

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

   113

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

   114

   115

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

   116

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

   117

   118

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

   119

			NetworkSend_string(p, "<none>");

   120

		else

   121

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

   122

   123

		NetworkSend_Packet(p, cs);

   124

	}

   125

   126

	p = NetworkSend_Init(PACKET_SERVER_COMPANY_INFO);

   127

   128

	NetworkSend_uint8 (p, NETWORK_COMPANY_INFO_VERSION);

   129

	NetworkSend_uint8 (p, 0);

   130

   131

	NetworkSend_Packet(p, cs);

   132

}

   133

   134

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

   135

{

   136

	//

   137

	// Packet: SERVER_ERROR

   138

	// Function: The client made an error

   139

	// Data:

   140

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

   141

	//

   142

   143

	NetworkClientState *new_cs;

   144

	char str[100];

   145

	char client_name[NETWORK_CLIENT_NAME_LENGTH];

   146

   147

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR);

   148

	NetworkSend_uint8(p, error);

   149

	NetworkSend_Packet(p, cs);

   150

   151

	// Only send when the current client was in game

   152

	if (cs->status > STATUS_AUTH) {

   153

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

   154

   155

		GetString(str, STR_NETWORK_ERR_CLIENT_GENERAL + error);

   156

   157

		DEBUG(net, 2)("[NET] %s made an error (%s) and his connection is closed", client_name, str);

   158

   159

		NetworkTextMessage(NETWORK_ACTION_LEAVE, 1, false, client_name, 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] Clientno %d has made an error and his connection is closed", cs->index);

   173

	}

   174

   175

	cs->quited = 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

	NetworkClientState *new_cs;

   209

   210

	// Invalid packet when status is AUTH or higher

   211

	if (cs->status >= STATUS_AUTH)

   212

		return;

   213

   214

	cs->status = STATUS_AUTH;

   215

	_network_game_info.clients_on++;

   216

   217

	p = NetworkSend_Init(PACKET_SERVER_WELCOME);

   218

	NetworkSend_uint16(p, cs->index);

   219

	NetworkSend_Packet(p, cs);

   220

   221

		// Transmit info about all the active clients

   222

	FOR_ALL_CLIENTS(new_cs) {

   223

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

   224

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

   225

	}

   226

	// Also send the info of the server

   227

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

   228

}

   229

   230

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_WAIT)

   231

{

   232

	//

   233

	// Packet: PACKET_SERVER_WAIT

   234

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

   235

	//             someone else is already receiving the map

   236

	// Data:

   237

	//    uint8:  Clients awaiting map

   238

	//

   239

	int waiting = 0;

   240

	NetworkClientState *new_cs;

   241

	Packet *p;

   242

   243

	// Count how many players are waiting in the queue

   244

	FOR_ALL_CLIENTS(new_cs) {

   245

		if (new_cs->status == STATUS_MAP_WAIT)

   246

			waiting++;

   247

	}

   248

   249

	p = NetworkSend_Init(PACKET_SERVER_WAIT);

   250

	NetworkSend_uint8(p, waiting);

   251

	NetworkSend_Packet(p, cs);

   252

}

   253

   254

// This sends the map to the client

   255

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_MAP)

   256

{

   257

	//

   258

	// Packet: SERVER_MAP

   259

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

   260

	//   a lot of multiple packets)

   261

	// Data:

   262

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

   263

	//  if MAP_PACKET_START:

   264

	//    uint32: The current FrameCounter

   265

	//  if MAP_PACKET_NORMAL:

   266

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

   267

	//  if MAP_PACKET_END:

   268

	//    uint32: seed0 of player

   269

	//    uint32: seed1 of player

   270

	//      last 2 are repeated MAX_PLAYERS time

   271

	//

   272

   273

	char filename[256];

   274

	static FILE *file_pointer;

   275

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

   276

   277

	if (cs->status < STATUS_AUTH) {

   278

		// Illegal call, return error and ignore the packet

   279

		SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_AUTHORIZED);

   280

		return;

   281

	}

   282

	if (cs->status == STATUS_AUTH) {

   283

		Packet *p;

   284

   285

		// Make a dump of the current game

   286

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

   287

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

   288

   289

		file_pointer = fopen(filename, "rb");

   290

		fseek(file_pointer, 0, SEEK_END);

   291

   292

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

   293

		p = NetworkSend_Init(PACKET_SERVER_MAP);

   294

		NetworkSend_uint8(p, MAP_PACKET_START);

   295

		NetworkSend_uint32(p, _frame_counter);

   296

		NetworkSend_uint32(p, ftell(file_pointer));

   297

		NetworkSend_Packet(p, cs);

   298

   299

		fseek(file_pointer, 0, SEEK_SET);

   300

   301

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

   302

   303

		cs->status = STATUS_MAP;

   304

	}

   305

   306

	if (cs->status == STATUS_MAP) {

   307

		uint i;

   308

		int res;

   309

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

   310

			Packet *p = NetworkSend_Init(PACKET_SERVER_MAP);

   311

			NetworkSend_uint8(p, MAP_PACKET_NORMAL);

   312

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

   313

			if (ferror(file_pointer)) {

   314

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

   315

			}

   316

			p->size += res;

   317

			NetworkSend_Packet(p, cs);

   318

			if (feof(file_pointer)) {

   319

				// Done reading!

   320

				int i;

   321

				Packet *p;

   322

   323

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

   324

				NetworkSendPatchSettings(cs);

   325

   326

				p = NetworkSend_Init(PACKET_SERVER_MAP);

   327

				NetworkSend_uint8(p, MAP_PACKET_END);

   328

				// Send the player_seeds in this packet

   329

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

   330

					NetworkSend_uint32(p, _player_seeds[i][0]);

   331

					NetworkSend_uint32(p, _player_seeds[i][1]);

   332

				}

   333

				NetworkSend_Packet(p, cs);

   334

   335

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

   336

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

   337

				cs->status = STATUS_DONE_MAP;

   338

				fclose(file_pointer);

   339

   340

				{

   341

					NetworkClientState *new_cs;

   342

					bool new_map_client = false;

   343

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

   344

					//  and start sending him the map

   345

					FOR_ALL_CLIENTS(new_cs) {

   346

						if (new_cs->status == STATUS_MAP_WAIT) {

   347

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

   348

							if (!new_map_client) {

   349

								// If not, this client will get the map

   350

								new_cs->status = STATUS_AUTH;

   351

								new_map_client = true;

   352

								SEND_COMMAND(PACKET_SERVER_MAP)(new_cs);

   353

							} else {

   354

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

   355

								SEND_COMMAND(PACKET_SERVER_WAIT)(new_cs);

   356

							}

   357

						}

   358

					}

   359

				}

   360

   361

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

   362

				break;

   363

			}

   364

		}

   365

   366

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

   367

		NetworkSend_Packets(cs);

   368

		if (cs->packet_queue == NULL) {

   369

			// All are sent, increase the sent_packets

   370

			sent_packets *= 2;

   371

		} else {

   372

			// Not everything is sent, decrease the sent_packets

   373

			if (sent_packets > 1) sent_packets /= 2;

   374

		}

   375

	}

   376

}

   377

   378

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

   379

{

   380

	//

   381

	// Packet: SERVER_JOIN

   382

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

   383

	//     PACKET_CLIENT_MAP_OK) Mostly what directly follows is a

   384

	//     PACKET_SERVER_CLIENT_INFO

   385

	// Data:

   386

	//    uint16:  Client-Index

   387

	//

   388

   389

	Packet *p = NetworkSend_Init(PACKET_SERVER_JOIN);

   390

   391

	NetworkSend_uint16(p, client_index);

   392

   393

	NetworkSend_Packet(p, cs);

   394

}

   395

   396

   397

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_FRAME)

   398

{

   399

	//

   400

	// Packet: SERVER_FRAME

   401

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

   402

	// Data:

   403

	//    uint32: Frame Counter

   404

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

   405

	//    [uint32: general-seed-1]

   406

	//    [uint32: general-seed-2]

   407

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

   408

	//

   409

   410

	Packet *p = NetworkSend_Init(PACKET_SERVER_FRAME);

   411

	NetworkSend_uint32(p, _frame_counter);

   412

	NetworkSend_uint32(p, _frame_counter_max);

   413

#ifdef ENABLE_NETWORK_SYNC_EVERY_FRAME

   414

	NetworkSend_uint32(p, _sync_seed_1);

   415

#ifdef NETWORK_SEND_DOUBLE_SEED

   416

	NetworkSend_uint32(p, _sync_seed_2);

   417

#endif

   418

#endif

   419

	NetworkSend_Packet(p, cs);

   420

}

   421

   422

DEF_SERVER_SEND_COMMAND(PACKET_SERVER_SYNC)

   423

{

   424

	//

   425

	// Packet: SERVER_SYNC

   426

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

   427

	// Data:

   428

	//    uint32: Frame Counter

   429

	//    uint32: General-seed-1

   430

	//    [uint32: general-seed-2]

   431

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

   432

	//

   433

   434

	Packet *p = NetworkSend_Init(PACKET_SERVER_SYNC);

   435

	NetworkSend_uint32(p, _frame_counter);

   436

	NetworkSend_uint32(p, _sync_seed_1);

   437

   438

#ifdef NETWORK_SEND_DOUBLE_SEED

   439

	NetworkSend_uint32(p, _sync_seed_2);

   440

#endif

   441

	NetworkSend_Packet(p, cs);

   442

}

   443

   444

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

   445

{

   446

	//

   447

	// Packet: SERVER_COMMAND

   448

	// Function: Sends a DoCommand to the client

   449

	// Data:

   450

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

   451

	//    uint32: CommandID (see command.h)

   452

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

   453

	//    uint32: P2

   454

	//    uint32: Tile

   455

	//    uint32: decode_params

   456

	//      10 times the last one (lengthof(cp->dp))

   457

	//    uint8:  CallBackID (see callback_table.c)

   458

	//    uint32: Frame of execution

   459

	//

   460

   461

	uint i;

   462

	char *dparam_char;

   463

	Packet *p = NetworkSend_Init(PACKET_SERVER_COMMAND);

   464

   465

	NetworkSend_uint8(p, cp->player);

   466

	NetworkSend_uint32(p, cp->cmd);

   467

	NetworkSend_uint32(p, cp->p1);

   468

	NetworkSend_uint32(p, cp->p2);

   469

	NetworkSend_uint32(p, cp->tile);

   470

	/* We are going to send them byte by byte, because dparam is misused

   471

	    for chars (if it is used), and else we have a BigEndian / LittleEndian

   472

	    problem.. we should fix the misuse of dparam... -- TrueLight */

   473

	dparam_char = (char *)&cp->dp[0];

   474

	for (i = 0; i < lengthof(cp->dp) * 4; i++) {

   475

		NetworkSend_uint8(p, *dparam_char);

   476

		dparam_char++;

   477

	}

   478

	NetworkSend_uint8(p, cp->callback);

   479

	NetworkSend_uint32(p, cp->frame);

   480

   481

	NetworkSend_Packet(p, cs);

   482

}

   483

   484

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

   485

{

   486

	//

   487

	// Packet: SERVER_CHAT

   488

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

   489

	// Data:

   490

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

   491

	//    uint16:  Client-index

   492

	//    String: Message (max MAX_TEXT_MSG_LEN)

   493

	//

   494

   495

	Packet *p = NetworkSend_Init(PACKET_SERVER_CHAT);

   496

   497

	NetworkSend_uint8(p, action);

   498

	NetworkSend_uint16(p, client_index);

   499

	NetworkSend_uint8(p, self_send);

   500

	NetworkSend_string(p, msg);

   501

   502

	NetworkSend_Packet(p, cs);

   503

}

   504

   505

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

   506

{

   507

	//

   508

	// Packet: SERVER_ERROR_QUIT

   509

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

   510

	//      This packet informs the other clients of that.

   511

	// Data:

   512

	//    uint16:  Client-index

   513

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

   514

	//

   515

   516

	Packet *p = NetworkSend_Init(PACKET_SERVER_ERROR_QUIT);

   517

   518

	NetworkSend_uint16(p, client_index);

   519

	NetworkSend_uint8(p, errorno);

   520

   521

	NetworkSend_Packet(p, cs);

   522

}