1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../openttd.h"

     8

#include "network_data.h"

     9

#include "core/tcp.h"

    10

#include "table/strings.h"

    11

#include "network_client.h"

    12

#include "network_gamelist.h"

    13

#include "network_gui.h"

    14

#include "../saveload.h"

    16

#include "../console.h"

    17

#include "../variables.h"

    19

#include "../fileio.h"

    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

    85

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

    86

// Sending functions

    87

//   DEF_CLIENT_SEND_COMMAND has no parameters

    88

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

    89

    90

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    91

{

    92

	//

    93

	// Packet: CLIENT_COMPANY_INFO

    94

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

    95

	// Data:

    96

	//    <none>

    97

	//

    98

	Packet *p;

    99

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

   100

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   101

   102

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

   103

	MY_CLIENT->Send_Packet(p);

   104

}

   105

   106

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

   107

{

   108

	//

   109

	// Packet: CLIENT_JOIN

   110

	// Function: Try to join the server

   111

	// Data:

   112

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

   113

	//    String: Player Name (max NETWORK_NAME_LENGTH)

   114

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

   115

	//    uint8:  Language ID

   116

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

   117

	//

   118

   119

	extern const char _openttd_revision[];

   120

	Packet *p;

   121

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

   122

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   123

   124

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

   125

	p->Send_string(_openttd_revision);

   126

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

   127

	p->Send_uint8 (_network_playas);      // PlayAs

   128

	p->Send_uint8 (NETLANG_ANY);          // Language

   129

	p->Send_string(_network_unique_id);

   130

	MY_CLIENT->Send_Packet(p);

   131

}

   132

   133

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

   134

{

   135

	//

   136

	// Packet: CLIENT_NEWGRFS_CHECKED

   137

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

   138

	// Data:

   139

	//

   140

   141

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

   142

	MY_CLIENT->Send_Packet(p);

   143

}

   144

   145

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

   146

{

   147

	//

   148

	// Packet: CLIENT_PASSWORD

   149

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

   150

	// Data:

   151

	//    uint8:  NetworkPasswordType

   152

	//    String: Password

   153

	//

   154

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   155

	p->Send_uint8 (type);

   157

	MY_CLIENT->Send_Packet(p);

   158

}

   159

   160

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   161

{

   162

	//

   163

	// Packet: CLIENT_GETMAP

   164

	// Function: Request the map from the server

   165

	// Data:

   166

	//    <none>

   167

	//

   168

   169

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   170

	MY_CLIENT->Send_Packet(p);

   171

}

   172

   173

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   174

{

   175

	//

   176

	// Packet: CLIENT_MAP_OK

   177

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

   178

	// Data:

   179

	//    <none>

   180

	//

   181

   182

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   183

	MY_CLIENT->Send_Packet(p);

   184

}

   185

   186

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   187

{

   188

	//

   189

	// Packet: CLIENT_ACK

   190

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

   191

	// Data:

   192

	//    uint32: current FrameCounter of the client

   193

	//

   194

   195

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   196

   197

	p->Send_uint32(_frame_counter);

   198

	MY_CLIENT->Send_Packet(p);

   199

}

   200

   201

// Send a command packet to the server

   202

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   203

{

   204

	//

   205

	// Packet: CLIENT_COMMAND

   206

	// Function: Send a DoCommand to the Server

   207

	// Data:

   208

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

   209

	//    uint32: CommandID (see command.h)

   210

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

   211

	//    uint32: P2

   212

	//    uint32: Tile

   213

	//    string: text

   214

	//    uint8:  CallBackID (see callback_table.c)

   215

	//

   216

   217

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   218

   219

	p->Send_uint8 (cp->player);

   220

	p->Send_uint32(cp->cmd);

   221

	p->Send_uint32(cp->p1);

   222

	p->Send_uint32(cp->p2);

   223

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

   224

	p->Send_string(cp->text);

   225

	p->Send_uint8 (cp->callback);

   226

   227

	MY_CLIENT->Send_Packet(p);

   228

}

   229

   230

// Send a chat-packet over the network

   231

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

   232

{

   233

	//

   234

	// Packet: CLIENT_CHAT

   235

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

   236

	// Data:

   237

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

   238

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

   239

	//    uint16: Destination Player

   240

	//    String: Message (max MAX_TEXT_MSG_LEN)

   241

	//

   242

   243

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   244

   245

	p->Send_uint8 (action);

   246

	p->Send_uint8 (type);

   247

	p->Send_uint16(dest);

   248

	p->Send_string(msg);

   249

	MY_CLIENT->Send_Packet(p);

   250

}

   251

   252

// Send an error-packet over the network

   253

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   254

{

   255

	//

   256

	// Packet: CLIENT_ERROR

   257

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

   258

	// Data:

   259

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

   260

	//

   261

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   262

   263

	p->Send_uint8(errorno);

   264

	MY_CLIENT->Send_Packet(p);

   265

}

   266

   267

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   268

{

   269

	//

   270

	// Packet: PACKET_CLIENT_SET_PASSWORD

   271

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

   272

	// Data:

   273

	//    String: Password

   274

	//

   275

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   276

   278

	MY_CLIENT->Send_Packet(p);

   279

}

   280

   281

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   282

{

   283

	//

   284

	// Packet: PACKET_CLIENT_SET_NAME

   285

	// Function: Gives the player a new name

   286

	// Data:

   287

	//    String: Name

   288

	//

   289

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   290

   291

	p->Send_string(name);

   292

	MY_CLIENT->Send_Packet(p);

   293

}

   294

   295

// Send an quit-packet over the network

   296

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   297

{

   298

	//

   299

	// Packet: CLIENT_QUIT

   300

	// Function: The client is quiting the game

   301

	// Data:

   302

	//    String: leave-message

   303

	//

   304

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   305

   306

	p->Send_string(leavemsg);

   307

	MY_CLIENT->Send_Packet(p);

   308

}

   309

   310

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

   311

{

   312

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   313

	p->Send_string(pass);

   314

	p->Send_string(command);

   315

	MY_CLIENT->Send_Packet(p);

   316

}

   317

   318

   319

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

   320

// Receiving functions

   321

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   322

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

   323

   324

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

   325

   326

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   327

{

   328

	// We try to join a server which is full

   329

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   330

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   331

   332

	return NETWORK_RECV_STATUS_SERVER_FULL;

   333

}

   334

   335

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   336

{

   337

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

   338

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   339

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   340

   341

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   342

}

   343

   344

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   345

{

   346

	byte company_info_version;

   347

	int i;

   348

   349

	company_info_version = p->Recv_uint8();

   350

   351

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

   352

		byte total;

   353

		PlayerID current;

   354

   355

		total = p->Recv_uint8();

   356

   357

		// There is no data at all..

   358

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   359

   360

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

   361

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   362

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

   375

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

   376

   377

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   378

   379

		return NETWORK_RECV_STATUS_OKAY;

   380

	}

   381

   382

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   383

}

   384

   385

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

   386

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

   387

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

   388

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   389

{

   390

	NetworkClientInfo *ci;

   391

	uint16 index = p->Recv_uint16();

   392

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

   393

	char name[NETWORK_NAME_LENGTH];

   394

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];

   395

   396

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

   397

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

   398

   399

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   400

   401

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

   402

	if (index == _network_own_client_index) _network_playas = playas;

   403

   404

	ci = NetworkFindClientInfoFromIndex(index);

   405

	if (ci != NULL) {

   406

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

   407

			// Client name changed, display the change

   408

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

   409

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

   410

			// The player changed from client-player..

   411

			// Do not display that for now

   412

		}

   413

   414

		ci->client_playas = playas;

   415

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

   416

   417

		InvalidateWindow(WC_CLIENT_LIST, 0);

   418

   419

		return NETWORK_RECV_STATUS_OKAY;

   420

	}

   421

   422

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

   423

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   424

	if (ci != NULL) {

   425

		ci->client_index = index;

   426

		ci->client_playas = playas;

   427

   428

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

   429

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

   430

   431

		InvalidateWindow(WC_CLIENT_LIST, 0);

   432

   433

		return NETWORK_RECV_STATUS_OKAY;

   434

	}

   435

   436

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

   437

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   438

}

   439

   440

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   441

{

   442

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

   443

   444

	switch (error) {

   445

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

   446

		case NETWORK_ERROR_NOT_AUTHORIZED:

   447

		case NETWORK_ERROR_NOT_EXPECTED:

   448

		case NETWORK_ERROR_PLAYER_MISMATCH:

   449

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   450

			break;

   451

		case NETWORK_ERROR_FULL:

   452

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   453

			break;

   454

		case NETWORK_ERROR_WRONG_REVISION:

   455

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   456

			break;

   457

		case NETWORK_ERROR_WRONG_PASSWORD:

   458

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   459

			break;

   460

		case NETWORK_ERROR_KICKED:

   461

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   462

			break;

   463

		case NETWORK_ERROR_CHEATER:

   464

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   465

			break;

   466

		default:

   467

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   468

	}

   469

   470

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   471

   472

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   473

}

   474

   475

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   476

{

   477

	uint grf_count = p->Recv_uint8();

   478

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   479

   480

	/* Check all GRFs */

   481

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

   482

		GRFConfig c;

   483

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   484

   485

		/* Check whether we know this GRF */

   486

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

   487

		if (f == NULL) {

   488

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

   489

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

   490

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

   491

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

   492

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   493

		}

   494

	}

   495

   496

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   497

		/* Start receiving the map */

   498

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();

   499

	} else {

   500

		/* NewGRF mismatch, bail out */

   501

		_switch_mode_errorstr = STR_NETWORK_ERR_NEWGRF_MISMATCH;

   502

	}

   503

	return ret;

   504

}

   505