1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../string.h"

     8

#include "../strings.h"

     9

#include "network_data.h"

    10

#include "core/tcp.h"

    11

#include "../date.h"

    12

#include "table/strings.h"

    13

#include "../functions.h"

    14

#include "network_client.h"

    15

#include "network_gamelist.h"

    16

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

#include "../helpers.hpp"

    24

    25

// This file handles all the client-commands

    26

    27

    28

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

    29

#define MY_CLIENT DEREF_CLIENT(0)

    30

    31

static uint32 last_ack_frame;

    32

    33

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

    34

// Sending functions

    35

//   DEF_CLIENT_SEND_COMMAND has no parameters

    36

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

    37

    38

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    39

{

    40

	//

    41

	// Packet: CLIENT_COMPANY_INFO

    42

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

    43

	// Data:

    44

	//    <none>

    45

	//

    46

	Packet *p;

    47

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

    48

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    49

    50

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

    51

	MY_CLIENT->Send_Packet(p);

    52

}

    53

    54

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

    55

{

    56

	//

    57

	// Packet: CLIENT_JOIN

    58

	// Function: Try to join the server

    59

	// Data:

    60

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

    61

	//    String: Player Name (max NETWORK_NAME_LENGTH)

    62

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

    63

	//    uint8:  Language ID

    64

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

    65

	//

    66

    67

	extern const char _openttd_revision[];

    68

	Packet *p;

    69

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

    70

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

    71

    72

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

    73

	p->Send_string(_openttd_revision);

    74

	p->Send_string(_network_player_name); // Player name

    75

	p->Send_uint8 (_network_playas);      // PlayAs

    76

	p->Send_uint8 (NETLANG_ANY);          // Language

    77

	p->Send_string(_network_unique_id);

    78

	MY_CLIENT->Send_Packet(p);

    79

}

    80

    81

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

    82

{

    83

	//

    84

	// Packet: CLIENT_NEWGRFS_CHECKED

    85

	// Function: Tell the server that we have the required GRFs

    86

	// Data:

    87

	//

    88

    89

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

    90

	MY_CLIENT->Send_Packet(p);

    91

}

    92

    93

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

    94

{

    95

	//

    96

	// Packet: CLIENT_PASSWORD

    97

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

    98

	// Data:

    99

	//    uint8:  NetworkPasswordType

   100

	//    String: Password

   101

	//

   102

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   103

	p->Send_uint8 (type);

   104

	p->Send_string(password);

   105

	MY_CLIENT->Send_Packet(p);

   106

}

   107

   108

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   109

{

   110

	//

   111

	// Packet: CLIENT_GETMAP

   112

	// Function: Request the map from the server

   113

	// Data:

   114

	//    <none>

   115

	//

   116

   117

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   118

	MY_CLIENT->Send_Packet(p);

   119

}

   120

   121

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   122

{

   123

	//

   124

	// Packet: CLIENT_MAP_OK

   125

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

   126

	// Data:

   127

	//    <none>

   128

	//

   129

   130

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   131

	MY_CLIENT->Send_Packet(p);

   132

}

   133

   134

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   135

{

   136

	//

   137

	// Packet: CLIENT_ACK

   138

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

   139

	// Data:

   140

	//    uint32: current FrameCounter of the client

   141

	//

   142

   143

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   144

   145

	p->Send_uint32(_frame_counter);

   146

	MY_CLIENT->Send_Packet(p);

   147

}

   148

   149

// Send a command packet to the server

   150

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   151

{

   152

	//

   153

	// Packet: CLIENT_COMMAND

   154

	// Function: Send a DoCommand to the Server

   155

	// Data:

   156

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

   157

	//    uint32: CommandID (see command.h)

   158

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

   159

	//    uint32: P2

   160

	//    uint32: Tile

   161

	//    string: text

   162

	//    uint8:  CallBackID (see callback_table.c)

   163

	//

   164

   165

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   166

   167

	p->Send_uint8 (cp->player);

   168

	p->Send_uint32(cp->cmd);

   169

	p->Send_uint32(cp->p1);

   170

	p->Send_uint32(cp->p2);

   171

	p->Send_uint32((uint32)cp->tile);

   172

	p->Send_string(cp->text);

   173

	p->Send_uint8 (cp->callback);

   174

   175

	MY_CLIENT->Send_Packet(p);

   176

}

   177

   178

// Send a chat-packet over the network

   179

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

   180

{

   181

	//

   182

	// Packet: CLIENT_CHAT

   183

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

   184

	// Data:

   185

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

   186

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

   187

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

   188

	//    String: Message (max MAX_TEXT_MSG_LEN)

   189

	//

   190

   191

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   192

   193

	p->Send_uint8 (action);

   194

	p->Send_uint8 (type);

   195

	p->Send_uint8 (dest);

   196

	p->Send_string(msg);

   197

	MY_CLIENT->Send_Packet(p);

   198

}

   199

   200

// Send an error-packet over the network

   201

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   202

{

   203

	//

   204

	// Packet: CLIENT_ERROR

   205

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

   206

	// Data:

   207

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

   208

	//

   209

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   210

   211

	p->Send_uint8(errorno);

   212

	MY_CLIENT->Send_Packet(p);

   213

}

   214

   215

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   216

{

   217

	//

   218

	// Packet: PACKET_CLIENT_SET_PASSWORD

   219

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

   220

	// Data:

   221

	//    String: Password

   222

	//

   223

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   224

   225

	p->Send_string(password);

   226

	MY_CLIENT->Send_Packet(p);

   227

}

   228

   229

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   230

{

   231

	//

   232

	// Packet: PACKET_CLIENT_SET_NAME

   233

	// Function: Gives the player a new name

   234

	// Data:

   235

	//    String: Name

   236

	//

   237

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   238

   239

	p->Send_string(name);

   240

	MY_CLIENT->Send_Packet(p);

   241

}

   242

   243

// Send an quit-packet over the network

   244

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   245

{

   246

	//

   247

	// Packet: CLIENT_QUIT

   248

	// Function: The client is quiting the game

   249

	// Data:

   250

	//    String: leave-message

   251

	//

   252

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   253

   254

	p->Send_string(leavemsg);

   255

	MY_CLIENT->Send_Packet(p);

   256

}

   257

   258

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

   259

{

   260

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   261

	p->Send_string(pass);

   262

	p->Send_string(command);

   263

	MY_CLIENT->Send_Packet(p);

   264

}

   265

   266

   267

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

   268

// Receiving functions

   269

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   270

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

   271

   272

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

   273

   274

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   275

{

   276

	// We try to join a server which is full

   277

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   278

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   279

   280

	return NETWORK_RECV_STATUS_SERVER_FULL;

   281

}

   282

   283

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   284

{

   285

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

   286

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   287

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   288

   289

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   290

}

   291

   292

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   293

{

   294

	byte company_info_version;

   295

	int i;

   296

   297

	company_info_version = p->Recv_uint8();

   298

   299

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

   300

		byte total;

   301

		PlayerID current;

   302

   303

		total = p->Recv_uint8();

   304

   305

		// There is no data at all..

   306

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   307

   308

		current = (Owner)p->Recv_uint8();

   309

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   310

   311

		p->Recv_string(_network_player_info[current].company_name, sizeof(_network_player_info[current].company_name));

   312

		_network_player_info[current].inaugurated_year = p->Recv_uint32();

   313

		_network_player_info[current].company_value    = p->Recv_uint64();

   314

		_network_player_info[current].money            = p->Recv_uint64();

   315

		_network_player_info[current].income           = p->Recv_uint64();

   316

		_network_player_info[current].performance      = p->Recv_uint16();

   317

		_network_player_info[current].use_password     = p->Recv_bool();

   318

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

   319

			_network_player_info[current].num_vehicle[i] = p->Recv_uint16();

   320

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

   321

			_network_player_info[current].num_station[i] = p->Recv_uint16();

   322

   323

		p->Recv_string(_network_player_info[current].players, sizeof(_network_player_info[current].players));

   324

   325

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   326

   327

		return NETWORK_RECV_STATUS_OKAY;

   328

	}

   329

   330

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   331

}

   332

   333

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

   334

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

   335

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

   336

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   337

{

   338

	NetworkClientInfo *ci;

   339

	uint16 index = p->Recv_uint16();

   340

	PlayerID playas = (Owner)p->Recv_uint8();

   341

	char name[NETWORK_NAME_LENGTH];

   342

	char unique_id[NETWORK_NAME_LENGTH];

   343

   344

	p->Recv_string(name, sizeof(name));

   345

	p->Recv_string(unique_id, sizeof(unique_id));

   346

   347

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   348

   349

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

   350

	if (index == _network_own_client_index) _network_playas = playas;

   351

   352

	ci = NetworkFindClientInfoFromIndex(index);

   353

	if (ci != NULL) {

   354

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

   355

			// Client name changed, display the change

   356

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

   357

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

   358

			// The player changed from client-player..

   359

			// Do not display that for now

   360

		}

   361

   362

		ci->client_playas = playas;

   363

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

   364

   365

		InvalidateWindow(WC_CLIENT_LIST, 0);

   366

   367

		return NETWORK_RECV_STATUS_OKAY;

   368

	}

   369

   370

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

   371

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   372

	if (ci != NULL) {

   373

		ci->client_index = index;

   374

		ci->client_playas = playas;

   375

   376

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

   377

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

   378

   379

		InvalidateWindow(WC_CLIENT_LIST, 0);

   380

   381

		return NETWORK_RECV_STATUS_OKAY;

   382

	}

   383

   384

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

   385

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   386

}

   387

   388

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   389

{

   390

	NetworkErrorCode error = (NetworkErrorCode)p->Recv_uint8();

   391

   392

	switch (error) {

   393

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

   394

		case NETWORK_ERROR_NOT_AUTHORIZED:

   395

		case NETWORK_ERROR_NOT_EXPECTED:

   396

		case NETWORK_ERROR_PLAYER_MISMATCH:

   397

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   398

			break;

   399

		case NETWORK_ERROR_FULL:

   400

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   401

			break;

   402

		case NETWORK_ERROR_WRONG_REVISION:

   403

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   404

			break;

   405

		case NETWORK_ERROR_WRONG_PASSWORD:

   406

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   407

			break;

   408

		case NETWORK_ERROR_KICKED:

   409

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   410

			break;

   411

		case NETWORK_ERROR_CHEATER:

   412

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   413

			break;

   414

		default:

   415

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   416

	}

   417

   418

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   419

   420

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   421

}

   422

   423

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   424

{

   425

	uint grf_count = p->Recv_uint8();

   426

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   427

   428

	/* Check all GRFs */

   429

	for (; grf_count > 0; grf_count--) {

   430

		GRFConfig c;

   431

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   432

   433

		/* Check whether we know this GRF */

   434

		const GRFConfig *f = FindGRFConfig(c.grfid, c.md5sum);

   435

		if (f == NULL) {

   436

			/* We do not know this GRF, bail out of initialization */

   437

			char buf[sizeof(c.md5sum) * 2 + 1];

   438

			md5sumToString(buf, lastof(buf), c.md5sum);

   439

			DEBUG(grf, 0, "NewGRF %08X not found; checksum %s", BSWAP32(c.grfid), buf);

   440

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   441

		}

   442

	}

   443

   444

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   445

		/* Start receiving the map */

   446

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();

   447

	} else {

   448

		/* NewGRF mismatch, bail out */

   449

		_switch_mode_errorstr = STR_NETWORK_ERR_NEWGRF_MISMATCH;

   450

	}

   451

	return ret;

   452

}

   453

   454

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_NEED_PASSWORD)

   455

{

   456

	NetworkPasswordType type = (NetworkPasswordType)p->Recv_uint8();

   457

   458

	switch (type) {

   459

		case NETWORK_GAME_PASSWORD:

   460

		case NETWORK_COMPANY_PASSWORD:

   461

			ShowNetworkNeedPassword(type);

   462

			return NETWORK_RECV_STATUS_OKAY;

   463

   464

		default: return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   465

	}

   466

}

   467

   468

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WELCOME)

   469

{

   470

	_network_own_client_index = p->Recv_uint16();

   471

   472

	// Start receiving the map

   473

	SEND_COMMAND(PACKET_CLIENT_GETMAP)();

   474

	return NETWORK_RECV_STATUS_OKAY;

   475

}

   476

   477

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_WAIT)

   478

{

   479

	_network_join_status = NETWORK_JOIN_STATUS_WAITING;

   480

	_network_join_waiting = p->Recv_uint8();

   481

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   482

   483

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

   484

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

   485

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

   486

   487

	return NETWORK_RECV_STATUS_OKAY;

   488

}

   489

   490

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP)

   491

{

   492

	static char filename[256];

   493

	static FILE *file_pointer;

   494

   495

	byte maptype;

   496

   497

	maptype = p->Recv_uint8();

   498

   499

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   500

   501

	// First packet, init some stuff

   502

	if (maptype == MAP_PACKET_START) {

   503

		// The name for the temp-map

   504

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

   505

   506

		file_pointer = fopen(filename, "wb");

   507

		if (file_pointer == NULL) {