1

/* $Id$ */

     2

     3

/** @file network_gui.cpp Implementation of the Network related GUIs. */

     4

     5

#ifdef ENABLE_NETWORK

     6

#include "../stdafx.h"

     7

#include "../openttd.h"

     8

#include "../strings_func.h"

     9

#include "network.h"

    10

#include "../date_func.h"

    11

#include "../fios.h"

    12

#include "network_internal.h"

    13

#include "network_client.h"

    14

#include "network_gui.h"

    15

#include "network_gamelist.h"

    16

#include "../gui.h"

    17

#include "../window_gui.h"

    18

#include "../textbuf_gui.h"

    19

#include "../variables.h"

    20

#include "network_server.h"

    21

#include "network_udp.h"

    22

#include "../town.h"

    23

#include "../newgrf.h"

    25

#include "../functions.h"

    26

#include "../window_func.h"

    27

#include "../core/alloc_func.hpp"

    28

#include "../string_func.h"

    29

#include "../gfx_func.h"

    30

#include "../player_func.h"

    31

#include "../settings_type.h"

    32

#include "../widgets/dropdown_func.h"

    33

#include "../querystring_gui.h"

    34

#include "../sortlist_type.h"

    35

    36

#include "table/strings.h"

    37

#include "../table/sprites.h"

    38

    39

#define BGC 5

    40

#define BTC 15

    41

    42

static bool _chat_tab_completion_active;

    43

    44

static void ShowNetworkStartServerWindow();

    45

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    46

extern void SwitchMode(int new_mode);

    47

    48

static const StringID _connection_types_dropdown[] = {

    49

	STR_NETWORK_LAN_INTERNET,

    50

	STR_NETWORK_INTERNET_ADVERTISE,

    51

	INVALID_STRING_ID

    52

};

    53

    54

static const StringID _lan_internet_types_dropdown[] = {

    55

	STR_NETWORK_LAN,

    56

	STR_NETWORK_INTERNET,

    57

	INVALID_STRING_ID

    58

};

    59

    60

static StringID _language_dropdown[NETLANG_COUNT + 1] = {STR_NULL};

    61

    62

void SortNetworkLanguages()

    63

{

    64

	/* Init the strings */

    65

	if (_language_dropdown[0] == STR_NULL) {

    66

		for (int i = 0; i < NETLANG_COUNT; i++) _language_dropdown[i] = STR_NETWORK_LANG_ANY + i;

    67

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    68

	}

    69

    70

	/* Sort the strings (we don't move 'any' and the 'invalid' one) */

    71

	qsort(&_language_dropdown[1], NETLANG_COUNT - 1, sizeof(StringID), &StringIDSorter);

    72

}

    73

    74

enum {

    75

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    76

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    77

	NET_PRC__SIZE_OF_ROW                = 14,

    78

};

    79

    80

/** Update the network new window because a new server is

    81

 * found on the network.

    82

 * @param unselect unselect the currently selected item */

    83

void UpdateNetworkGameWindow(bool unselect)

    84

{

    85

	InvalidateWindowData(WC_NETWORK_WINDOW, 0, unselect);

    86

}

    87

    88

/** Enum for NetworkGameWindow, referring to _network_game_window_widgets */

    89

enum NetworkGameWindowWidgets {

    90

	NGWW_CLOSE,         ///< Close 'X' button

    91

	NGWW_CAPTION,       ///< Caption of the window

    92

	NGWW_RESIZE,        ///< Resize button

    93

    94

	NGWW_CONNECTION,    ///< Label in from of connection droplist

    95

	NGWW_CONN_BTN,      ///< 'Connection' droplist button

    96

	NGWW_PLAYER,        ///< Panel with editbox to set player name

    97

    98

	NGWW_NAME,          ///< 'Name' button

    99

	NGWW_CLIENTS,       ///< 'Clients' button

   100

	NGWW_INFO,          ///< Third button in the game list panel

   101

   102

	NGWW_MATRIX,        ///< Panel with list of games

   103

	NGWW_SCROLLBAR,     ///< Scrollbar of matrix

   104

   105

	NGWW_LASTJOINED_LABEL, ///< Label "Last joined server:"

   106

	NGWW_LASTJOINED,    ///< Info about the last joined server

   107

   108

	NGWW_DETAILS,       ///< Panel with game details

   109

	NGWW_JOIN,          ///< 'Join game' button

   110

	NGWW_REFRESH,       ///< 'Refresh server' button

   111

    NGWW_NEWGRF_DL,     ///< 'NewGRF Download' button

   112

	NGWW_NEWGRF,        ///< 'NewGRF Settings' button

   113

   114

	NGWW_FIND,          ///< 'Find server' button

   115

	NGWW_ADD,           ///< 'Add server' button

   116

	NGWW_START,         ///< 'Start server' button

   117

	NGWW_CANCEL,        ///< 'Cancel' button

   118

};

   119

   120

typedef GUIList<NetworkGameList*> GUIGameServerList;

   121

   122

class NetworkGameWindow : public QueryStringBaseWindow {

   123

protected:

   124

	/* Runtime saved values */

   125

	static Listing last_sorting;

   126

   127

	/* Constants for sorting servers */

   128

	static GUIGameServerList::SortFunction *const sorter_funcs[];

   129

   130

	byte field;                  ///< selected text-field

   131

	NetworkGameList *server;     ///< selected server

   132

	GUIGameServerList servers;   ///< list with game servers.

   133

   134

	/**

   135

	 * (Re)build the network game list as its amount has changed because

   136

	 * an item has been added or deleted for example

   137

	 */

   138

	void BuildNetworkGameList()

   139

	{

   140

		if (!this->servers.NeedRebuild()) return;

   141

   142

		/* Create temporary array of games to use for listing */

   143

		this->servers.Clear();

   144

   145

		for (NetworkGameList *ngl = _network_game_list; ngl != NULL; ngl = ngl->next) {

   146

			*this->servers.Append() = ngl;

   147

		}

   148

   149

		this->servers.Compact();

   150

		this->servers.RebuildDone();

   151

	}

   152

   153

	/** Sort servers by name. */

   154

	static int CDECL NGameNameSorter(NetworkGameList* const *a, NetworkGameList* const *b)

   155

	{

   156

		return strcasecmp((*a)->info.server_name, (*b)->info.server_name);

   157

	}

   158

   159

	/** Sort servers by the amount of clients online on a

   160

	 * server. If the two servers have the same amount, the one with the

   161

	 * higher maximum is preferred. */

   162

	static int CDECL NGameClientSorter(NetworkGameList* const *a, NetworkGameList* const *b)

   163

	{

   164

		/* Reverse as per default we are interested in most-clients first */

   165

		int r = (*a)->info.clients_on - (*b)->info.clients_on;

   166

   167

		if (r == 0) r = (*a)->info.clients_max - (*b)->info.clients_max;

   168

		if (r == 0) r = NGameNameSorter(a, b);

   169

   170

		return r;

   171

	}

   172

   173

	/** Sort servers by joinability. If both servers are the

   174

	 * same, prefer the non-passworded server first. */

   175

	static int CDECL NGameAllowedSorter(NetworkGameList* const *a, NetworkGameList* const *b)

   176

	{

   177

		/* The servers we do not know anything about (the ones that did not reply) should be at the bottom) */

   178

		int r = StrEmpty((*a)->info.server_revision) - StrEmpty((*b)->info.server_revision);

   179

   180

		/* Reverse default as we are interested in version-compatible clients first */

   181

		if (r == 0) r = (*b)->info.version_compatible - (*a)->info.version_compatible;

   182

		/* The version-compatible ones are then sorted with NewGRF compatible first, incompatible last */

   183

		if (r == 0) r = (*b)->info.compatible - (*a)->info.compatible;

   184

		/* Passworded servers should be below unpassworded servers */

   185

		if (r == 0) r = (*a)->info.use_password - (*b)->info.use_password;

   186

		/* Finally sort on the name of the server */

   187

		if (r == 0) r = NGameNameSorter(a, b);

   188

   189

		return r;

   190

	}

   191

   192

	/** Sort the server list */

   193

	void SortNetworkGameList()

   194

	{

   195

		if (!this->servers.Sort()) return;

   196

   197

		/* After sorting ngl->sort_list contains the sorted items. Put these back

   198

		 * into the original list. Basically nothing has changed, we are only

   199

		 * shuffling the ->next pointers */

   200

		_network_game_list = this->servers[0];

   201

		NetworkGameList *item = _network_game_list;

   202

		for (uint i = 1; i != this->servers.Length(); i++) {

   203

			item->next = this->servers[i];

   204

			item = item->next;

   205

		}

   206

		item->next = NULL;

   207

	}

   208

   209

	/**

   210

	 * Draw a single server line.

   211

	 * @param cur_item  the server to draw.

   212

	 * @param y         from where to draw?

   213

	 * @param highlight does the line need to be highlighted?

   214

	 */

   215

	void DrawServerLine(const NetworkGameList *cur_item, uint y, bool highlight)

   216

	{

   217

		/* show highlighted item with a different colour */

   218

		if (highlight) GfxFillRect(this->widget[NGWW_NAME].left + 1, y - 2, this->widget[NGWW_INFO].right - 1, y + 9, 10);

   219

   220

		SetDParamStr(0, cur_item->info.server_name);

   221

		DrawStringTruncated(this->widget[NGWW_NAME].left + 5, y, STR_JUST_RAW_STRING, TC_BLACK, this->widget[NGWW_NAME].right - this->widget[NGWW_NAME].left - 5);

   222

   223

		SetDParam(0, cur_item->info.clients_on);

   224

		SetDParam(1, cur_item->info.clients_max);

   225

		SetDParam(2, cur_item->info.companies_on);

   226

		SetDParam(3, cur_item->info.companies_max);

   227

		DrawStringCentered(this->widget[NGWW_CLIENTS].left + 39, y, STR_NETWORK_GENERAL_ONLINE, TC_GOLD);

   228

   229

		/* only draw icons if the server is online */

   230

		if (cur_item->online) {

   231

			/* draw a lock if the server is password protected */

   232

			if (cur_item->info.use_password) DrawSprite(SPR_LOCK, PAL_NONE, this->widget[NGWW_INFO].left + 5, y - 1);

   233

   234

			/* draw red or green icon, depending on compatibility with server */

   235

			DrawSprite(SPR_BLOT, (cur_item->info.compatible ? PALETTE_TO_GREEN : (cur_item->info.version_compatible ? PALETTE_TO_YELLOW : PALETTE_TO_RED)), this->widget[NGWW_INFO].left + 15, y);

   236

   237

			/* draw flag according to server language */

   238

			DrawSprite(SPR_FLAGS_BASE + cur_item->info.server_lang, PAL_NONE, this->widget[NGWW_INFO].left + 25, y);

   239

		}

   240

	}

   241

   242

public:

   243

	NetworkGameWindow(const WindowDesc *desc) : QueryStringBaseWindow(desc)

   244

	{

   245

		ttd_strlcpy(this->edit_str_buf, _settings_client.network.player_name, lengthof(this->edit_str_buf));

   246

		this->afilter = CS_ALPHANUMERAL;

   247

		InitializeTextBuffer(&this->text, this->edit_str_buf, lengthof(this->edit_str_buf), 120);

   248

   249

		UpdateNetworkGameWindow(true);

   250

   251

		this->vscroll.cap = 11;

   252

		this->resize.step_height = NET_PRC__SIZE_OF_ROW;

   253

   254

		this->field = NGWW_PLAYER;

   255

		this->server = NULL;

   256

   257

		this->servers.SetListing(this->last_sorting);

   258

		this->servers.SetSortFuncs(this->sorter_funcs);

   259

		this->servers.ForceRebuild();

   260

		this->SortNetworkGameList();

   261

   262

		this->FindWindowPlacementAndResize(desc);

   263

	}

   264

   265

	~NetworkGameWindow()

   266

	{

   267

		this->last_sorting = this->servers.GetListing();

   268

	}

   269

   270

	virtual void OnPaint()

   271

	{

   272

		const NetworkGameList *sel = this->server;

   273

		const SortButtonState arrow = this->servers.IsDescSortOrder() ? SBS_DOWN : SBS_UP;

   274

   275

		if (this->servers.NeedRebuild()) {

   276

			this->BuildNetworkGameList();

   277

			SetVScrollCount(this, this->servers.Length());

   278

		}

   279

		this->SortNetworkGameList();

   280

   281

		/* 'Refresh' button invisible if no server selected */

   282

		this->SetWidgetDisabledState(NGWW_REFRESH, sel == NULL);

   283

		/* 'Join' button disabling conditions */

   284

		this->SetWidgetDisabledState(NGWW_JOIN, sel == NULL || // no Selected Server

   285

				!sel->online || // Server offline

   286

				sel->info.clients_on >= sel->info.clients_max || // Server full

   287

				!sel->info.compatible); // Revision mismatch

   288

   289

		/* 'NewGRF Settings' button invisible if no NewGRF is used */

   290

		this->SetWidgetHiddenState(NGWW_NEWGRF, sel == NULL ||

   291

				!sel->online ||

   292

				sel->info.grfconfig == NULL);

   293

   294

        /* 'NewGRF Download' button invisible if no incompatible NewGRFs are used */

   295

		this->SetWidgetHiddenState(NGWW_NEWGRF_DL, sel == NULL ||

   296

				!sel->online ||

   297

				sel->info.compatible || !sel->info.version_compatible);

   298

   299

		SetDParam(0, 0x00);

   300

		SetDParam(1, _lan_internet_types_dropdown[_settings_client.network.lan_internet]);

   301

		this->DrawWidgets();

   302

   303

		/* Edit box to set player name */

   304

		this->DrawEditBox(NGWW_PLAYER);

   305

   306

		DrawString(this->widget[NGWW_PLAYER].left - 100, 23, STR_NETWORK_PLAYER_NAME, TC_GOLD);

   307

   308

		/* Sort based on widgets: name, clients, compatibility */

   309

		switch (this->servers.SortType()) {

   310

			case NGWW_NAME    - NGWW_NAME: this->DrawSortButtonState(NGWW_NAME,    arrow); break;

   311

			case NGWW_CLIENTS - NGWW_NAME: this->DrawSortButtonState(NGWW_CLIENTS, arrow); break;

   312

			case NGWW_INFO    - NGWW_NAME: this->DrawSortButtonState(NGWW_INFO,    arrow); break;

   313

		}

   314

   315

		uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   316

   317

		const int max = min(this->vscroll.pos + this->vscroll.cap, (int)this->servers.Length());

   318

   319

		for (int i = this->vscroll.pos; i < max; ++i) {

   320

			const NetworkGameList *ngl = this->servers[i];

   321

			this->DrawServerLine(ngl, y, ngl == sel);

   322

			y += NET_PRC__SIZE_OF_ROW;

   323

		}

   324

   325

		const NetworkGameList *last_joined = NetworkGameListAddItem(inet_addr(_settings_client.network.last_host), _settings_client.network.last_port);

   326

		/* Draw the last joined server, if any */

   327

		if (last_joined != NULL) this->DrawServerLine(last_joined, y = this->widget[NGWW_LASTJOINED].top + 3, last_joined == sel);

   328

   329

		/* Draw the right menu */

   330

		GfxFillRect(this->widget[NGWW_DETAILS].left + 1, 43, this->widget[NGWW_DETAILS].right - 1, 92, 157);

   331

		if (sel == NULL) {

   332

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 58, STR_NETWORK_GAME_INFO, TC_FROMSTRING);

   333

		} else if (!sel->online) {

   334

			SetDParamStr(0, sel->info.server_name);

   335

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 68, STR_JUST_RAW_STRING, TC_ORANGE); // game name

   336

   337

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 132, STR_NETWORK_SERVER_OFFLINE, TC_FROMSTRING); // server offline

   338

		} else { // show game info

   339

			uint16 y = 100;

   340

			const uint16 x = this->widget[NGWW_DETAILS].left + 5;

   341

   342

			DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, 48, STR_NETWORK_GAME_INFO, TC_FROMSTRING);

   343

   344

   345

			SetDParamStr(0, sel->info.server_name);

   346

			DrawStringCenteredTruncated(this->widget[NGWW_DETAILS].left, this->widget[NGWW_DETAILS].right, 62, STR_JUST_RAW_STRING, TC_ORANGE); // game name

   347

   348

			SetDParamStr(0, sel->info.map_name);

   349

			DrawStringCenteredTruncated(this->widget[NGWW_DETAILS].left, this->widget[NGWW_DETAILS].right, 74, STR_JUST_RAW_STRING, TC_BLACK); // map name

   350

   351

			SetDParam(0, sel->info.clients_on);

   352

			SetDParam(1, sel->info.clients_max);

   353

			SetDParam(2, sel->info.companies_on);

   354

			SetDParam(3, sel->info.companies_max);

   355

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   356

			y += 10;

   357

   358

			SetDParam(0, STR_NETWORK_LANG_ANY + sel->info.server_lang);

   359

			DrawString(x, y, STR_NETWORK_LANGUAGE, TC_GOLD); // server language

   360

			y += 10;

   361

   362

			SetDParam(0, STR_TEMPERATE_LANDSCAPE + sel->info.map_set);

   363

			DrawString(x, y, STR_NETWORK_TILESET, TC_GOLD); // tileset

   364

			y += 10;

   365

   366

			SetDParam(0, sel->info.map_width);

   367

			SetDParam(1, sel->info.map_height);

   368

			DrawString(x, y, STR_NETWORK_MAP_SIZE, TC_GOLD); // map size

   369

			y += 10;

   370

   371

			SetDParamStr(0, sel->info.server_revision);

   372

			DrawString(x, y, STR_NETWORK_SERVER_VERSION, TC_GOLD); // server version

   373

			y += 10;

   374

   375

			SetDParamStr(0, sel->info.hostname);

   376

			SetDParam(1, sel->port);

   377

			DrawString(x, y, STR_NETWORK_SERVER_ADDRESS, TC_GOLD); // server address

   378

			y += 10;

   379

   380

			SetDParam(0, sel->info.start_date);

   381

			DrawString(x, y, STR_NETWORK_START_DATE, TC_GOLD); // start date

   382

			y += 10;

   383

   384

			SetDParam(0, sel->info.game_date);

   385

			DrawString(x, y, STR_NETWORK_CURRENT_DATE, TC_GOLD); // current date

   386

			y += 10;

   387

   388

			y += 2;

   389

   390

			if (!sel->info.compatible) {

   391

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, sel->info.version_compatible ? STR_NETWORK_GRF_MISMATCH : STR_NETWORK_VERSION_MISMATCH, TC_FROMSTRING); // server mismatch

   392

			} else if (sel->info.clients_on == sel->info.clients_max) {

   393

				/* Show: server full, when clients_on == max_clients */

   394

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, STR_NETWORK_SERVER_FULL, TC_FROMSTRING); // server full

   395

			} else if (sel->info.use_password) {

   396

				DrawStringCentered(this->widget[NGWW_DETAILS].left + 115, y, STR_NETWORK_PASSWORD, TC_FROMSTRING); // password warning

   397

			}

   398

   399

			y += 10;

   400

		}

   401

	}

   402

   403

	virtual void OnClick(Point pt, int widget)

   404

	{

   405

		this->field = widget;

   406

		switch (widget) {

   407

			case NGWW_PLAYER:

   408

				ShowOnScreenKeyboard(this, NGWW_PLAYER, 0, 0);

   409

				break;

   410

   411

			case NGWW_CANCEL: // Cancel button

   412

				DeleteWindowById(WC_NETWORK_WINDOW, 0);

   413

				break;

   414

   415

			case NGWW_CONN_BTN: // 'Connection' droplist

   416

				ShowDropDownMenu(this, _lan_internet_types_dropdown, _settings_client.network.lan_internet, NGWW_CONN_BTN, 0, 0); // do it for widget NSSW_CONN_BTN

   417

				break;

   418

   419

			case NGWW_NAME: // Sort by name

   420

			case NGWW_CLIENTS: // Sort by connected clients

   421

			case NGWW_INFO: // Connectivity (green dot)

   422

				if (this->servers.SortType() == widget - NGWW_NAME) {

   423

					this->servers.ToggleSortOrder();

   424

				} else {

   425

					this->servers.SetSortType(widget - NGWW_NAME);

   426

					this->servers.ForceResort();

   427

				}

   428

				this->SetDirty();

   429

				break;

   430

   431

			case NGWW_MATRIX: { // Matrix to show networkgames

   432

				uint32 id_v = (pt.y - NET_PRC__OFFSET_TOP_WIDGET) / NET_PRC__SIZE_OF_ROW;

   433

   434

				if (id_v >= this->vscroll.cap) return; // click out of bounds

   435

				id_v += this->vscroll.pos;

   436

   437

				this->server = (id_v < this->servers.Length()) ? this->servers[id_v] : NULL;

   438

				this->SetDirty();

   439

			} break;

   440

   441

			case NGWW_LASTJOINED: {

   442

				NetworkGameList *last_joined = NetworkGameListAddItem(inet_addr(_settings_client.network.last_host), _settings_client.network.last_port);

   443

				if (last_joined != NULL) {

   444

					this->server = last_joined;

   445

					this->SetDirty();

   446

				}

   447

			} break;

   448

   449

			case NGWW_FIND: // Find server automatically

   450

				switch (_settings_client.network.lan_internet) {

   451

					case 0: NetworkUDPSearchGame(); break;

   452

					case 1: NetworkUDPQueryMasterServer(); break;

   453

				}

   454

				break;

   455

   456

			case NGWW_ADD: // Add a server

   457

				SetDParamStr(0, _settings_client.network.connect_to_ip);

   458

				ShowQueryString(

   459

					STR_JUST_RAW_STRING,

   460

					STR_NETWORK_ENTER_IP,

   461

					31 | 0x1000,  // maximum number of characters OR

   462

					250, // characters up to this width pixels, whichever is satisfied first

   463

					this, CS_ALPHANUMERAL);

   464

				break;

   465

   466

			case NGWW_START: // Start server

   467

				ShowNetworkStartServerWindow();

   468

				break;

   469

   470

			case NGWW_JOIN: // Join Game

   471

				if (this->server != NULL) {

   472

					snprintf(_settings_client.network.last_host, sizeof(_settings_client.network.last_host), "%s", inet_ntoa(*(struct in_addr *)&this->server->ip));

   473

					_settings_client.network.last_port = this->server->port;

   474

					ShowNetworkLobbyWindow(this->server);

   475

				}

   476

				break;

   477

   478

			case NGWW_REFRESH: // Refresh

   479

				if (this->server != NULL) NetworkUDPQueryServer(this->server->info.hostname, this->server->port);

   480

				break;

   481

   482

			case NGWW_NEWGRF: // NewGRF Settings

   483

				if (this->server != NULL) ShowNewGRFSettings(false, false, false, &this->server->info.grfconfig);

   484

				break;

   485

   486

            case NGWW_NEWGRF_DL: // NewGRF Download