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

     9

#ifdef ENABLE_NETWORK

    10

    11

#include "table/strings.h"

    12

#include "functions.h"

    13

#include "network_client.h"

    14

#include "network_gamelist.h"

    15

#include "saveload.h"

    16

#include "command.h"

    17

#include "gfx.h"

    18

#include "window.h"

    19

#include "settings.h"

    20

#include "console.h"

    21

#include "variables.h"

    22

#include "ai/ai.h"

    23

    24

    25

// This file handles all the client-commands

    26

    27

    28

extern const char _openttd_revision[];

    29

    30

// So we don't make too much typos ;)

    31

#define MY_CLIENT DEREF_CLIENT(0)

    32

    33

static uint32 last_ack_frame;

    34

    35

static void NetworkRecvPatchSettings(NetworkClientState* cs, Packet* p);

    36

    37

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

    38

// Sending functions

    39

//   DEF_CLIENT_SEND_COMMAND has no parameters

    40

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

    41

    42

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    43

{

    44

	//

    45

	// Packet: CLIENT_COMPANY_INFO

    46

	// Function: Request company-info (in detail)

    47

	// Data:

    48

	//    <none>

    49

	//

    50

	Packet *p;

    51

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    52

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    53

    54

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    55

	NetworkSend_Packet(p, MY_CLIENT);

    56

}

    57

    58

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    59

{

    60

	//

    61

	// Packet: CLIENT_JOIN

    62

	// Function: Try to join the server

    63

	// Data:

    64

	//    String: OpenTTD Revision (norev000 if no revision)

    65

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    66

	//    uint8:  Play as Player id (1..MAX_PLAYERS)

    67

	//    uint8:  Language ID

    68

	//    String: Unique id to find the player back in server-listing

    69

	//

    70

    71

	Packet *p;

    72

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    73

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    74

    75

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    76

	NetworkSend_string(p, _openttd_revision);

    77

	NetworkSend_string(p, _network_player_name); // Player name

    78

	NetworkSend_uint8(p, _network_playas); // PlayAs

    79

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    80

	NetworkSend_string(p, _network_unique_id);

    81

	NetworkSend_Packet(p, MY_CLIENT);

    82

}

    83

    84

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_PASSWORD)(NetworkPasswordType type, const char *password)

    85

{

    86

	//

    87

	// Packet: CLIENT_PASSWORD

    88

	// Function: Send a password to the server to authorize

    89

	// Data:

    90

	//    uint8:  NetworkPasswordType

    91

	//    String: Password

    92

	//

    93

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    94

	NetworkSend_uint8(p, type);

    95

	NetworkSend_string(p, password);

    96

	NetworkSend_Packet(p, MY_CLIENT);

    97

}

    98

    99

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   100

{

   101

	//

   102

	// Packet: CLIENT_GETMAP

   103

	// Function: Request the map from the server

   104

	// Data:

   105

	//    <none>

   106

	//

   107

   108

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   109

	NetworkSend_Packet(p, MY_CLIENT);

   110

}

   111

   112

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   113

{

   114

	//

   115

	// Packet: CLIENT_MAP_OK

   116

	// Function: Tell the server that we are done receiving/loading the map

   117

	// Data:

   118

	//    <none>

   119

	//

   120

   121

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   122

	NetworkSend_Packet(p, MY_CLIENT);

   123

}

   124

   125

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   126

{

   127

	//

   128

	// Packet: CLIENT_ACK

   129

	// Function: Tell the server we are done with this frame

   130

	// Data:

   131

	//    uint32: current FrameCounter of the client

   132

	//

   133

   134

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   135

   136

	NetworkSend_uint32(p, _frame_counter);

   137

	NetworkSend_Packet(p, MY_CLIENT);

   138

}

   139

   140

// Send a command packet to the server

   141

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   142

{

   143

	//

   144

	// Packet: CLIENT_COMMAND

   145

	// Function: Send a DoCommand to the Server

   146

	// Data:

   147

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

   148

	//    uint32: CommandID (see command.h)

   149

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

   150

	//    uint32: P2

   151

	//    uint32: Tile

   152

	//    string: text

   153

	//    uint8:  CallBackID (see callback_table.c)

   154

	//

   155

   156

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   157

   158

	NetworkSend_uint8(p, cp->player);

   159

	NetworkSend_uint32(p, cp->cmd);

   160

	NetworkSend_uint32(p, cp->p1);

   161

	NetworkSend_uint32(p, cp->p2);

   162

	NetworkSend_uint32(p, (uint32)cp->tile);

   163

	NetworkSend_string(p, cp->text);

   164

	NetworkSend_uint8(p, cp->callback);

   165

   166

	NetworkSend_Packet(p, MY_CLIENT);

   167

}

   168

   169

// Send a chat-packet over the network

   170

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_CHAT)(NetworkAction action, DestType desttype, int dest, const char *msg)

   171

{

   172

	//

   173

	// Packet: CLIENT_CHAT

   174

	// Function: Send a chat-packet to the serve

   175

	// Data:

   176

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

   177

	//    uint8:  Destination Type (see network_data.h, DestType);

   178

	//    uint8:  Destination Player (1..MAX_PLAYERS)

   179

	//    String: Message (max MAX_TEXT_MSG_LEN)

   180

	//

   181

   182

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   183

   184

	NetworkSend_uint8(p, action);

   185

	NetworkSend_uint8(p, desttype);

   186

	NetworkSend_uint8(p, dest);

   187

	NetworkSend_string(p, msg);

   188

	NetworkSend_Packet(p, MY_CLIENT);

   189

}

   190

   191

// Send an error-packet over the network

   192

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   193

{

   194

	//

   195

	// Packet: CLIENT_ERROR

   196

	// Function: The client made an error and is quiting the game

   197

	// Data:

   198

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

   199

	//

   200

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   201

   202

	NetworkSend_uint8(p, errorno);

   203

	NetworkSend_Packet(p, MY_CLIENT);

   204

}

   205

   206

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   207

{

   208

	//

   209

	// Packet: PACKET_CLIENT_SET_PASSWORD

   210

	// Function: Set the password for the clients current company

   211

	// Data:

   212

	//    String: Password

   213

	//

   214

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   215

   216

	NetworkSend_string(p, password);

   217

	NetworkSend_Packet(p, MY_CLIENT);

   218

}

   219

   220

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   221

{

   222

	//

   223

	// Packet: PACKET_CLIENT_SET_NAME

   224

	// Function: Gives the player a new name

   225

	// Data:

   226

	//    String: Name

   227

	//

   228

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   229

   230

	NetworkSend_string(p, name);

   231

	NetworkSend_Packet(p, MY_CLIENT);

   232

}

   233

   234

// Send an quit-packet over the network

   235

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   236

{

   237

	//

   238

	// Packet: CLIENT_QUIT

   239

	// Function: The client is quiting the game

   240

	// Data:

   241

	//    String: leave-message

   242

	//

   243

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   244

   245

	NetworkSend_string(p, leavemsg);

   246

	NetworkSend_Packet(p, MY_CLIENT);

   247

}

   248

   249

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_RCON)(const char *pass, const char *command)

   250

{

   251

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   252

	NetworkSend_string(p, pass);

   253

	NetworkSend_string(p, command);

   254

	NetworkSend_Packet(p, MY_CLIENT);

   255

}

   256

   257

   258

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

   259

// Receiving functions

   260

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   261

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

   262

   263

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm);

   264

   265

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   266

{

   267

	// We try to join a server which is full

   268

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   269

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   270

   271

	return NETWORK_RECV_STATUS_SERVER_FULL;

   272

}

   273

   274

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   275

{

   276

	// We try to join a server where we are banned

   277

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   278

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   279

   280

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   281

}

   282

   283

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   284

{

   285

	byte company_info_version;

   286

	int i;

   287

   288

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   289

   290

	if (!MY_CLIENT->quited && company_info_version == NETWORK_COMPANY_INFO_VERSION) {

   291

		byte total;

   292

		byte current;

   293

   294

		total = NetworkRecv_uint8(MY_CLIENT, p);

   295

   296

		// There is no data at all..

   297

		if (total == 0)

   298

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   299

   300

		current = NetworkRecv_uint8(MY_CLIENT, p);

   301

		if (current >= MAX_PLAYERS)

   302

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   303

   304

		NetworkRecv_string(MY_CLIENT, p, _network_player_info[current].company_name, sizeof(_network_player_info[current].company_name));

   305

		_network_player_info[current].inaugurated_year = NetworkRecv_uint8(MY_CLIENT, p);

   306

		_network_player_info[current].company_value = NetworkRecv_uint64(MY_CLIENT, p);

   307

		_network_player_info[current].money = NetworkRecv_uint64(MY_CLIENT, p);

   308

		_network_player_info[current].income = NetworkRecv_uint64(MY_CLIENT, p);

   309

		_network_player_info[current].performance = NetworkRecv_uint16(MY_CLIENT, p);

   310

		_network_player_info[current].use_password = NetworkRecv_uint8(MY_CLIENT, p);

   311

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

   312

			_network_player_info[current].num_vehicle[i] = NetworkRecv_uint16(MY_CLIENT, p);

   313

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

   314

			_network_player_info[current].num_station[i] = NetworkRecv_uint16(MY_CLIENT, p);

   315

   316

		NetworkRecv_string(MY_CLIENT, p, _network_player_info[current].players, sizeof(_network_player_info[current].players));

   317

   318

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   319

   320

		return NETWORK_RECV_STATUS_OKAY;

   321

	}

   322

   323

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   324

}

   325

   326

// This packet contains info about the client (playas and name)

   327

//  as client we save this in NetworkClientInfo, linked via 'index'

   328

//  which is always an unique number on a server.

   329

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   330

{

   331

	NetworkClientInfo *ci;

   332

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   333

	byte playas = NetworkRecv_uint8(MY_CLIENT, p);

   334

	char name[NETWORK_NAME_LENGTH];

   335

	char unique_id[NETWORK_NAME_LENGTH];

   336

   337

	NetworkRecv_string(MY_CLIENT, p, name, sizeof(name));

   338

	NetworkRecv_string(MY_CLIENT, p, unique_id, sizeof(unique_id));

   339

   340

	if (MY_CLIENT->quited)

   341

		return NETWORK_RECV_STATUS_CONN_LOST;

   342

   343

	/* Do we receive a change of data? Most likely we changed playas */

   344

	if (index == _network_own_client_index) {

   345

		_network_playas = playas;

   346

   347

		/* Are we a ai-network-client? Are we not joining as a SPECTATOR (playas == 0, means SPECTATOR) */

   348

		if (_ai.network_client && playas != 0) {

   349

			if (_ai.network_playas == OWNER_SPECTATOR)

   350

				AI_StartNewAI(playas - 1);

   351

   352

			_ai.network_playas = playas - 1;

   353

		}

   354

	}

   355

   356

	ci = NetworkFindClientInfoFromIndex(index);

   357

	if (ci != NULL) {

   358

		if (playas == ci->client_playas && strcmp(name, ci->client_name) != 0) {

   359

			// Client name changed, display the change

   360

			NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, 1, false, ci->client_name, "%s", name);

   361

		} else if (playas != ci->client_playas) {

   362

			// The player changed from client-player..

   363

			// Do not display that for now

   364

		}

   365

   366

		ci->client_playas = playas;

   367

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   368

   369

		InvalidateWindow(WC_CLIENT_LIST, 0);

   370

   371

		return NETWORK_RECV_STATUS_OKAY;

   372

	}

   373

   374

	// We don't have this index yet, find an empty index, and put the data there

   375

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   376

	if (ci != NULL) {

   377

		ci->client_index = index;

   378

		ci->client_playas = playas;

   379

   380

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   381

		ttd_strlcpy(ci->unique_id, unique_id, sizeof(ci->unique_id));

   382

   383

		InvalidateWindow(WC_CLIENT_LIST, 0);

   384

   385

		return NETWORK_RECV_STATUS_OKAY;

   386

	}

   387

   388

	// Here the program should never ever come.....

   389

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   390

}

   391

   392

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   393

{

   394

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   395

   396

	switch (error) {

   397

		/* We made an error in the protocol, and our connection is closed.... */

   398

		case NETWORK_ERROR_NOT_AUTHORIZED:

   399

		case NETWORK_ERROR_NOT_EXPECTED:

   400

		case NETWORK_ERROR_PLAYER_MISMATCH:

   401

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   402

			break;

   403

		case NETWORK_ERROR_FULL:

   404

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   405

			break;

   406

		case NETWORK_ERROR_WRONG_REVISION:

   407

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   408

			break;

   409

		case NETWORK_ERROR_WRONG_PASSWORD:

   410

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   411

			break;

   412

		case NETWORK_ERROR_KICKED:

   413

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   414

			break;

   415

		case NETWORK_ERROR_CHEATER:

   416

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   417

			break;

   418

		default:

   419

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   420

	}

   421

   422

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   423

   424

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   425

}

   426

   427

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   428

{

   429

	NetworkPasswordType type;

   430

	type = NetworkRecv_uint8(MY_CLIENT, p);

   431

   432

	if (type == NETWORK_GAME_PASSWORD) {

   433

		ShowNetworkNeedGamePassword();

   434

		return NETWORK_RECV_STATUS_OKAY;

   435

	} else if (type == NETWORK_COMPANY_PASSWORD) {

   436

		ShowNetworkNeedCompanyPassword();

   437

		return NETWORK_RECV_STATUS_OKAY;

   438

	}

   439

   440

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   441

}

   442

   443

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   444

{

   445

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   446

   447

	// Start receiving the map

   448

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   449

	return NETWORK_RECV_STATUS_OKAY;

   450

}

   451

   452

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   453

{

   454

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   455

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   456

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   457

   458

	// We are put on hold for receiving the map.. we need GUI for this ;)

   459

	DEBUG(net, 1)("[NET] The server is currently busy sending the map to someone else.. please hold..." );

   460

	DEBUG(net, 1)("[NET]  There are %d clients in front of you", _network_join_waiting);

   461

   462

	return NETWORK_RECV_STATUS_OKAY;

   463

}

   464

   465

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   466

{

   467

	static char filename[256];

   468

	static FILE *file_pointer;

   469

   470

	byte maptype;

   471

   472

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   473

   474

	if (MY_CLIENT->quited)

   475

		return NETWORK_RECV_STATUS_CONN_LOST;

   476

   477

	// First packet, init some stuff

   478

	if (maptype == MAP_PACKET_START) {

   479

		// The name for the temp-map

   480

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

   481

   482

		file_pointer = fopen(filename, "wb");

   483

		if (file_pointer == NULL) {

   484

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   485

			return NETWORK_RECV_STATUS_SAVEGAME;

   486

		}

   487

   488

		_frame_counter = _frame_counter_server = _frame_counter_max = NetworkRecv_uint32(MY_CLIENT, p);

   489

   490

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   491

		_network_join_kbytes = 0;

   492

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   493

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   494

   495

		// The first packet does not contain any more data

   496

		return NETWORK_RECV_STATUS_OKAY;

   497

	}

   498

   499

	if (maptype == MAP_PACKET_NORMAL) {

   500

		// We are still receiving data, put it to the file

   501

		fwrite(p->buffer + p->pos, 1, p->size - p->pos, file_pointer);

   502

   503

		_network_join_kbytes = ftell(file_pointer) / 1024;

   504

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   505

	}

   506

   507

	if (maptype == MAP_PACKET_PATCH) {

   508

		NetworkRecvPatchSettings(MY_CLIENT, p);

   509

	}

   510

   511

	// Check if this was the last packet

   512

	if (maptype == MAP_PACKET_END) {

   513

		fclose(file_pointer);

   514

   515

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   516