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 "date.h"

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "table/strings.h"

    13

#include "functions.h"

    14

#include "network_client.h"

    15

#include "network_gamelist.h"

    17

#include "saveload.h"

    18

#include "command.h"

    19

#include "window.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

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

    36

// Sending functions

    37

//   DEF_CLIENT_SEND_COMMAND has no parameters

    38

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

    39

    40

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    41

{

    42

	//

    43

	// Packet: CLIENT_COMPANY_INFO

    44

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

    45

	// Data:

    46

	//    <none>

    47

	//

    48

	Packet *p;

    49

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    50

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    51

    52

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    53

	NetworkSend_Packet(p, MY_CLIENT);

    54

}

    55

    56

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    57

{

    58

	//

    59

	// Packet: CLIENT_JOIN

    60

	// Function: Try to join the server

    61

	// Data:

    62

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

    63

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    64

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

    65

	//    uint8:  Language ID

    66

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

    67

	//

    68

    69

	Packet *p;

    70

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    71

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    72

    73

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    74

	NetworkSend_string(p, _openttd_revision);

    75

	NetworkSend_string(p, _network_player_name); // Player name

    76

	NetworkSend_uint8(p, _network_playas); // PlayAs

    77

	NetworkSend_uint8(p, NETLANG_ANY); // Language

    78

	NetworkSend_string(p, _network_unique_id);

    79

	NetworkSend_Packet(p, MY_CLIENT);

    80

}

    81

    82

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

    83

{

    84

	//

    85

	// Packet: CLIENT_PASSWORD

    86

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

    87

	// Data:

    88

	//    uint8:  NetworkPasswordType

    89

	//    String: Password

    90

	//

    91

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

    92

	NetworkSend_uint8(p, type);

    93

	NetworkSend_string(p, password);

    94

	NetworkSend_Packet(p, MY_CLIENT);

    95

}

    96

    97

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

    98

{

    99

	//

   100

	// Packet: CLIENT_GETMAP

   101

	// Function: Request the map from the server

   102

	// Data:

   103

	//    <none>

   104

	//

   105

   106

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   107

	NetworkSend_Packet(p, MY_CLIENT);

   108

}

   109

   110

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   111

{

   112

	//

   113

	// Packet: CLIENT_MAP_OK

   114

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

   115

	// Data:

   116

	//    <none>

   117

	//

   118

   119

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   120

	NetworkSend_Packet(p, MY_CLIENT);

   121

}

   122

   123

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   124

{

   125

	//

   126

	// Packet: CLIENT_ACK

   127

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

   128

	// Data:

   129

	//    uint32: current FrameCounter of the client

   130

	//

   131

   132

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   133

   134

	NetworkSend_uint32(p, _frame_counter);

   135

	NetworkSend_Packet(p, MY_CLIENT);

   136

}

   137

   138

// Send a command packet to the server

   139

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   140

{

   141

	//

   142

	// Packet: CLIENT_COMMAND

   143

	// Function: Send a DoCommand to the Server

   144

	// Data:

   145

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

   146

	//    uint32: CommandID (see command.h)

   147

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

   148

	//    uint32: P2

   149

	//    uint32: Tile

   150

	//    string: text

   151

	//    uint8:  CallBackID (see callback_table.c)

   152

	//

   153

   154

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   155

   156

	NetworkSend_uint8(p, cp->player);

   157

	NetworkSend_uint32(p, cp->cmd);

   158

	NetworkSend_uint32(p, cp->p1);

   159

	NetworkSend_uint32(p, cp->p2);

   160

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

   161

	NetworkSend_string(p, cp->text);

   162

	NetworkSend_uint8(p, cp->callback);

   163

   164

	NetworkSend_Packet(p, MY_CLIENT);

   165

}

   166

   167

// Send a chat-packet over the network

   168

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

   169

{

   170

	//

   171

	// Packet: CLIENT_CHAT

   172

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

   173

	// Data:

   174

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

   175

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

   176

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

   177

	//    String: Message (max MAX_TEXT_MSG_LEN)

   178

	//

   179

   180

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   181

   182

	NetworkSend_uint8(p, action);

   183

	NetworkSend_uint8(p, desttype);

   184

	NetworkSend_uint8(p, dest);

   185

	NetworkSend_string(p, msg);

   186

	NetworkSend_Packet(p, MY_CLIENT);

   187

}

   188

   189

// Send an error-packet over the network

   190

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   191

{

   192

	//

   193

	// Packet: CLIENT_ERROR

   194

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

   195

	// Data:

   196

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

   197

	//

   198

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   199

   200

	NetworkSend_uint8(p, errorno);

   201

	NetworkSend_Packet(p, MY_CLIENT);

   202

}

   203

   204

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   205

{

   206

	//

   207

	// Packet: PACKET_CLIENT_SET_PASSWORD

   208

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

   209

	// Data:

   210

	//    String: Password

   211

	//

   212

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   213

   214

	NetworkSend_string(p, password);

   215

	NetworkSend_Packet(p, MY_CLIENT);

   216

}

   217

   218

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   219

{

   220

	//

   221

	// Packet: PACKET_CLIENT_SET_NAME

   222

	// Function: Gives the player a new name

   223

	// Data:

   224

	//    String: Name

   225

	//

   226

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   227

   228

	NetworkSend_string(p, name);

   229

	NetworkSend_Packet(p, MY_CLIENT);

   230

}

   231

   232

// Send an quit-packet over the network

   233

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   234

{

   235

	//

   236

	// Packet: CLIENT_QUIT

   237

	// Function: The client is quiting the game

   238

	// Data:

   239

	//    String: leave-message

   240

	//

   241

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   242

   243

	NetworkSend_string(p, leavemsg);

   244

	NetworkSend_Packet(p, MY_CLIENT);

   245

}

   246

   247

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

   248

{

   249

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   250

	NetworkSend_string(p, pass);

   251

	NetworkSend_string(p, command);

   252

	NetworkSend_Packet(p, MY_CLIENT);

   253

}

   254

   255

   256

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

   257

// Receiving functions

   258

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   259

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

   260

   261

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

   262

   263

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   264

{

   265

	// We try to join a server which is full

   266

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   267

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   268

   269

	return NETWORK_RECV_STATUS_SERVER_FULL;

   270

}

   271

   272

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   273

{

   274

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

   275

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   276

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   277

   278

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   279

}

   280

   281

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   282

{

   283

	byte company_info_version;

   284

	int i;

   285

   286

	company_info_version = NetworkRecv_uint8(MY_CLIENT, p);

   287

   288

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

   289

		byte total;

   290

		byte current;

   291

   292

		total = NetworkRecv_uint8(MY_CLIENT, p);

   293

   294

		// There is no data at all..

   295

		if (total == 0)

   296

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   297

   298

		current = NetworkRecv_uint8(MY_CLIENT, p);

   299

		if (current >= MAX_PLAYERS)

   300

			return NETWORK_RECV_STATUS_CLOSE_QUERY;

   301

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

   314

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

   315

   316

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   317

   318

		return NETWORK_RECV_STATUS_OKAY;

   319

	}

   320

   321

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   322

}

   323

   324

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

   325

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

   326

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

   327

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   328

{

   329

	NetworkClientInfo *ci;

   330

	uint16 index = NetworkRecv_uint16(MY_CLIENT, p);

   331

	PlayerID playas = NetworkRecv_uint8(MY_CLIENT, p);

   332

	char name[NETWORK_NAME_LENGTH];

   333

	char unique_id[NETWORK_NAME_LENGTH];

   334

   335

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

   336

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

   337

   338

	if (MY_CLIENT->quited)

   339

		return NETWORK_RECV_STATUS_CONN_LOST;

   340

   341

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

   342

	if (index == _network_own_client_index) {

   343

		_network_playas = playas;

   344

   345

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

   346

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

   347

			if (_ai.network_playas == OWNER_SPECTATOR)

   348

				AI_StartNewAI(playas - 1);

   349

   350

			_ai.network_playas = playas - 1;

   351

		}

   352

	}

   353

   354

	ci = NetworkFindClientInfoFromIndex(index);

   355

	if (ci != NULL) {

   356

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

   357

			// Client name changed, display the change

   358

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

   359

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

   360

			// The player changed from client-player..

   361

			// Do not display that for now

   362

		}

   363

   364

		ci->client_playas = playas;

   365

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

   366

   367

		InvalidateWindow(WC_CLIENT_LIST, 0);

   368

   369

		return NETWORK_RECV_STATUS_OKAY;

   370

	}

   371

   372

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

   373

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   374

	if (ci != NULL) {

   375

		ci->client_index = index;

   376

		ci->client_playas = playas;

   377

   378

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

   379

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

   380

   381

		InvalidateWindow(WC_CLIENT_LIST, 0);

   382

   383

		return NETWORK_RECV_STATUS_OKAY;

   384

	}

   385

   386

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

   387

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   388

}

   389

   390

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   391

{

   392

	NetworkErrorCode error = NetworkRecv_uint8(MY_CLIENT, p);

   393

   394

	switch (error) {

   395

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

   396

		case NETWORK_ERROR_NOT_AUTHORIZED:

   397

		case NETWORK_ERROR_NOT_EXPECTED:

   398

		case NETWORK_ERROR_PLAYER_MISMATCH:

   399

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   400

			break;

   401

		case NETWORK_ERROR_FULL:

   402

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   403

			break;

   404

		case NETWORK_ERROR_WRONG_REVISION:

   405

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   406

			break;

   407

		case NETWORK_ERROR_WRONG_PASSWORD:

   408

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   409

			break;

   410

		case NETWORK_ERROR_KICKED:

   411

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   412

			break;

   413

		case NETWORK_ERROR_CHEATER:

   414

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   415

			break;

   416

		default:

   417

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   418

	}

   419

   420

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   421

   422

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   423

}

   424

   425

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   426

{

   428

   436

	}

   437

}

   438

   439

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   440

{

   441

	_network_own_client_index = NetworkRecv_uint16(MY_CLIENT, p);

   442

   443

	// Start receiving the map

   444

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   445

	return NETWORK_RECV_STATUS_OKAY;

   446

}

   447

   448

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   449

{

   450

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   451

	_network_join_waiting = NetworkRecv_uint8(MY_CLIENT, p);

   452

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   453

   454

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

   455

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

   456

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

   457

   458

	return NETWORK_RECV_STATUS_OKAY;

   459

}

   460

   461

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   462

{

   463

	static char filename[256];

   464

	static FILE *file_pointer;

   465

   466

	byte maptype;

   467

   468

	maptype = NetworkRecv_uint8(MY_CLIENT, p);

   469

   470

	if (MY_CLIENT->quited)

   471

		return NETWORK_RECV_STATUS_CONN_LOST;

   472

   473

	// First packet, init some stuff

   474

	if (maptype == MAP_PACKET_START) {

   475

		// The name for the temp-map

   476

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

   477

   478

		file_pointer = fopen(filename, "wb");

   479

		if (file_pointer == NULL) {

   480

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   481

			return NETWORK_RECV_STATUS_SAVEGAME;

   482

		}

   483

   484

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

   485

   486

		_network_join_status = NETWORK_JOIN_STATUS_DOWNLOADING;

   487

		_network_join_kbytes = 0;

   488

		_network_join_kbytes_total = NetworkRecv_uint32(MY_CLIENT, p) / 1024;

   489

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   490

   491

		// The first packet does not contain any more data

   492

		return NETWORK_RECV_STATUS_OKAY;

   493

	}

   494

   495

	if (maptype == MAP_PACKET_NORMAL) {

   496

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

   497

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

   498

   499

		_network_join_kbytes = ftell(file_pointer) / 1024;

   500

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   501

	}

   502

   503

	// Check if this was the last packet

   504

	if (maptype == MAP_PACKET_END) {

   505

		fclose(file_pointer);

   506

   507

		_network_join_status = NETWORK_JOIN_STATUS_PROCESSING;

   508

		InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   509

   510

		// The map is done downloading, load it

   511

		// Load the map

   512

		if (!SafeSaveOrLoad(filename, SL_LOAD, GM_NORMAL)) {

   513

			DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   514

			_switch_mode_errorstr = STR_NETWORK_ERR_SAVEGAMEERROR;

   515

			return NETWORK_RECV_STATUS_SAVEGAME;