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"

    24

#include "../functions.h"

    25

#include "../window_func.h"

    26

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

    27

#include "../string_func.h"

    28

#include "../gfx_func.h"

    29

#include "../player_func.h"

    30

#include "../settings_type.h"

    31

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

    32

#include "../querystring_gui.h"

    33

#include "../sortlist_type.h"

    34

    35

#include "table/strings.h"

    36

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

    37

    38

#define BGC 5

    39

#define BTC 15

    40

    41

static bool _chat_tab_completion_active;

    42

    43

static void ShowNetworkStartServerWindow();

    44

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    45

extern void SwitchMode(int new_mode);

    46

    47

static const StringID _connection_types_dropdown[] = {

    48

	STR_NETWORK_LAN_INTERNET,

    49

	STR_NETWORK_INTERNET_ADVERTISE,

    50

	INVALID_STRING_ID

    51

};

    52

    53

static const StringID _lan_internet_types_dropdown[] = {

    54

	STR_NETWORK_LAN,

    55

	STR_NETWORK_INTERNET,

    56

	INVALID_STRING_ID

    57

};

    58

    59

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

    60

    61

void SortNetworkLanguages()

    62

{

    63

	/* Init the strings */

    64

	if (_language_dropdown[0] == STR_NULL) {

    65

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

    66

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    67

	}

    68

    69

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

    70

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

    71

}

    72

    73

enum {

    74

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    75

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    76

	NET_PRC__SIZE_OF_ROW                = 14,

    77

};

    78

    79

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

    80

 * found on the network.

    81

 * @param unselect unselect the currently selected item */

    82

void UpdateNetworkGameWindow(bool unselect)

    83

{

    84

	InvalidateWindowData(WC_NETWORK_WINDOW, 0, unselect);

    85

}

    86

    87

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

    88

enum NetworkGameWindowWidgets {

    89

	NGWW_CLOSE,         ///< Close 'X' button

    90

	NGWW_CAPTION,       ///< Caption of the window

    91

	NGWW_RESIZE,        ///< Resize button

    92

    93

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

    94

	NGWW_CONN_BTN,      ///< 'Connection' droplist button

    95

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

    96

    97

	NGWW_NAME,          ///< 'Name' button

    98

	NGWW_CLIENTS,       ///< 'Clients' button

    99

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

   100

   101

	NGWW_MATRIX,        ///< Panel with list of games

   102

	NGWW_SCROLLBAR,     ///< Scrollbar of matrix

   103

   104

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

   105

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

   106

   107

	NGWW_DETAILS,       ///< Panel with game details

   108

	NGWW_JOIN,          ///< 'Join game' button

   109

	NGWW_REFRESH,       ///< 'Refresh server' button

   110

	NGWW_NEWGRF,        ///< 'NewGRF Settings' button

   111

   112

	NGWW_FIND,          ///< 'Find server' button

   113

	NGWW_ADD,           ///< 'Add server' button

   114

	NGWW_START,         ///< 'Start server' button

   115

	NGWW_CANCEL,        ///< 'Cancel' button

   116

};

   117

   118

typedef GUIList<NetworkGameList*> GUIGameServerList;

   119

   120

class NetworkGameWindow : public QueryStringBaseWindow {

   121

protected:

   122

	/* Runtime saved values */

   123

	static Listing last_sorting;

   124

   125

	/* Constants for sorting servers */

   126

	static GUIGameServerList::SortFunction *const sorter_funcs[];

   127

   128

	byte field;                  ///< selected text-field

   129

	NetworkGameList *server;     ///< selected server

   130

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

   131

   132

	/**

   133

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

   134

	 * an item has been added or deleted for example

   135

	 */

   136

	void BuildNetworkGameList()

   137

	{

   138

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

   139

   140

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

   141

		this->servers.Clear();

   142

   143

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

   144

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

   145

		}

   146

   147

		this->servers.Compact();

   148

		this->servers.RebuildDone();

   149

	}

   150

   151

	/** Sort servers by name. */

   152

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

   153

	{

   154

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

   155

	}

   156

   157

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

   158

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

   159

	 * higher maximum is preferred. */

   160

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

   161

	{

   162

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

   163

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

   164

   165

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

   166

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

   167

   168

		return r;

   169

	}

   170

   171

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

   172

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

   173

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

   174

	{

   175

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

   176

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

   177

   178

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

   179

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

   180

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

   181

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

   182

		/* Passworded servers should be below unpassworded servers */

   183

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

   184

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

   185

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

   186

   187

		return r;

   188

	}

   189

   190

	/** Sort the server list */

   191

	void SortNetworkGameList()

   192

	{

   193

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

   194

   195

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

   196

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

   197

		 * shuffling the ->next pointers */

   198

		_network_game_list = this->servers[0];

   199

		NetworkGameList *item = _network_game_list;

   200

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

   201

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

   202

			item = item->next;

   203

		}

   204

		item->next = NULL;

   205

	}

   206

   207

	/**

   208

	 * Draw a single server line.

   209

	 * @param cur_item  the server to draw.

   210

	 * @param y         from where to draw?

   211

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

   212

	 */

   213

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

   214

	{

   215

		/* show highlighted item with a different colour */

   216

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

   217

   218

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

   219

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

   220

   221

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

   222

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

   223

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

   224

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

   225

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

   226

   227

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

   228

		if (cur_item->online) {

   229

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

   230

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

   231

   232

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

   233

			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);

   234

   235

			/* draw flag according to server language */

   236

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

   237

		}

   238

	}

   239

   240

public:

   241

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

   242

	{

   243

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

   244

		this->afilter = CS_ALPHANUMERAL;

   245

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

   246

   247

		UpdateNetworkGameWindow(true);

   248

   249

		this->vscroll.cap = 11;

   250

		this->resize.step_height = NET_PRC__SIZE_OF_ROW;

   251

   252

		this->field = NGWW_PLAYER;

   253

		this->server = NULL;

   254

   255

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

   256

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

   257

		this->servers.ForceRebuild();

   258

		this->SortNetworkGameList();

   259

   260

		this->FindWindowPlacementAndResize(desc);

   261

	}

   262

   263

	~NetworkGameWindow()

   264

	{

   265

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

   266

	}

   267

   268

	virtual void OnPaint()

   269

	{

   270

		const NetworkGameList *sel = this->server;

   271

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

   272

   273

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

   274

			this->BuildNetworkGameList();

   275

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

   276

		}

   277

		this->SortNetworkGameList();

   278

   279

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

   280

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

   281

		/* 'Join' button disabling conditions */

   282

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

   283

				!sel->online || // Server offline

   284

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

   285

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

   286

   287

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

   288

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

   289

				!sel->online ||

   290

				sel->info.grfconfig == NULL);

   291

   292

		SetDParam(0, 0x00);

   293

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

   294

		this->DrawWidgets();

   295

   296

		/* Edit box to set player name */

   297

		this->DrawEditBox(NGWW_PLAYER);

   298

   299

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

   300

   301

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

   302

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

   303

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

   304

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

   305

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

   306

		}

   307

   308

		uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   309

   310

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

   311

   312

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

   313

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

   314

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

   315

			y += NET_PRC__SIZE_OF_ROW;

   316

		}

   317

   318

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

   319

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

   320

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

   321

   322

		/* Draw the right menu */

   323

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

   324

		if (sel == NULL) {

   325

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

   326

		} else if (!sel->online) {

   327

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

   328

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

   329

   330

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

   331

		} else { // show game info

   332

			uint16 y = 100;

   333

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

   334

   335

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

   336

   337

   338

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

   339

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

   340

   341

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

   342

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

   343

   344

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

   345

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

   346

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

   347

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

   348

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   349

			y += 10;

   350

   351

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

   352

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

   353

			y += 10;

   354

   355

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

   356

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

   357

			y += 10;

   358

   359

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

   360

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

   361

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

   362

			y += 10;

   363

   364

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

   365

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

   366

			y += 10;

   367

   368

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

   369

			SetDParam(1, sel->port);

   370

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

   371

			y += 10;

   372

   373

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

   374

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

   375

			y += 10;

   376

   377

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

   378

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

   379

			y += 10;

   380

   381

			y += 2;

   382

   383

			if (!sel->info.compatible) {

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

			}

   391

   392

			y += 10;

   393

		}

   394

	}

   395

   396

	virtual void OnClick(Point pt, int widget)

   397

	{

   398

		this->field = widget;

   399

		switch (widget) {

   400

			case NGWW_PLAYER:

   401

				ShowOnScreenKeyboard(this, NGWW_PLAYER, 0, 0);

   402

				break;

   403

   404

			case NGWW_CANCEL: // Cancel button

   405

				DeleteWindowById(WC_NETWORK_WINDOW, 0);

   406

				break;

   407

   408

			case NGWW_CONN_BTN: // 'Connection' droplist

   409

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

   410

				break;

   411

   412

			case NGWW_NAME: // Sort by name

   413

			case NGWW_CLIENTS: // Sort by connected clients

   414

			case NGWW_INFO: // Connectivity (green dot)

   415

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

   416

					this->servers.ToggleSortOrder();

   417

				} else {

   418

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

   419

					this->servers.ForceResort();

   420

				}

   421

				this->SetDirty();

   422

				break;

   423

   424

			case NGWW_MATRIX: { // Matrix to show networkgames

   425

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

   426

   427

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

   428

				id_v += this->vscroll.pos;

   429

   430

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

   431

				this->SetDirty();

   432

			} break;

   433

   434

			case NGWW_LASTJOINED: {

   435

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

   436

				if (last_joined != NULL) {

   437

					this->server = last_joined;

   438

					this->SetDirty();

   439

				}

   440

			} break;

   441

   442

			case NGWW_FIND: // Find server automatically

   443

				switch (_settings_client.network.lan_internet) {

   444

					case 0: NetworkUDPSearchGame(); break;

   445

					case 1: NetworkUDPQueryMasterServer(); break;

   446

				}

   447

				break;

   448

   449

			case NGWW_ADD: // Add a server

   450

				ShowQueryString(

   451

					BindCString(_settings_client.network.connect_to_ip),

   452

					STR_NETWORK_ENTER_IP,

   453

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

   454

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

   455

					this, CS_ALPHANUMERAL);

   456

				break;

   457

   458

			case NGWW_START: // Start server

   459

				ShowNetworkStartServerWindow();

   460

				break;

   461

   462

			case NGWW_JOIN: // Join Game

   463

				if (this->server != NULL) {

   464

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

   465

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

   466

					ShowNetworkLobbyWindow(this->server);

   467

				}

   468

				break;

   469

   470

			case NGWW_REFRESH: // Refresh

   471

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

   472

				break;

   473

   474

			case NGWW_NEWGRF: // NewGRF Settings

   475

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

   476

				break;

   477

		}

   478

	}

   479

   480

	virtual void OnDropdownSelect(int widget, int index)

   481

	{

   482

		switch (widget) {

   483

			case NGWW_CONN_BTN:

   484

				_settings_client.network.lan_internet = index;

   485

				break;

   486

   487

			default:

   488

				NOT_REACHED();