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

#include "../player_base.h"

    35

    36

#include "table/strings.h"

    37

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

    38

    39

    40

static bool _chat_tab_completion_active;

    41

    42

static void ShowNetworkStartServerWindow();

    43

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    44

extern void SwitchMode(int new_mode);

    45

    46

static const StringID _connection_types_dropdown[] = {

    47

	STR_NETWORK_LAN_INTERNET,

    48

	STR_NETWORK_INTERNET_ADVERTISE,

    49

	INVALID_STRING_ID

    50

};

    51

    52

static const StringID _lan_internet_types_dropdown[] = {

    53

	STR_NETWORK_LAN,

    54

	STR_NETWORK_INTERNET,

    55

	INVALID_STRING_ID

    56

};

    57

    58

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

    59

    60

void SortNetworkLanguages()

    61

{

    62

	/* Init the strings */

    63

	if (_language_dropdown[0] == STR_NULL) {

    64

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

    65

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    66

	}

    67

    68

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

    69

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

    70

}

    71

    72

enum {

    73

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    74

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    75

	NET_PRC__SIZE_OF_ROW                = 14,

    76

};

    77

    78

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

    79

 * found on the network.

    80

 * @param unselect unselect the currently selected item */

    81

void UpdateNetworkGameWindow(bool unselect)

    82

{

    83

	InvalidateWindowData(WC_NETWORK_WINDOW, 0, unselect);

    84

}

    85

    86

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

    87

enum NetworkGameWindowWidgets {

    88

	NGWW_CLOSE,         ///< Close 'X' button

    89

	NGWW_CAPTION,       ///< Caption of the window

    90

	NGWW_RESIZE,        ///< Resize button

    91

    92

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

    93

	NGWW_CONN_BTN,      ///< 'Connection' droplist button

    94

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

    95

    96

	NGWW_NAME,          ///< 'Name' button

    97

	NGWW_CLIENTS,       ///< 'Clients' button

    98

	NGWW_MAPSIZE,       ///< 'Map size' button

    99

	NGWW_DATE,          ///< 'Date' button

   100

	NGWW_YEARS,         ///< 'Years' button

   101

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

   102

   103

	NGWW_MATRIX,        ///< Panel with list of games

   104

	NGWW_SCROLLBAR,     ///< Scrollbar of matrix

   105

   106

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

   107

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

   108

   109

	NGWW_DETAILS,       ///< Panel with game details

   110

	NGWW_JOIN,          ///< 'Join game' button

   111

	NGWW_REFRESH,       ///< 'Refresh server' 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 map size */

   174

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

   175

	{

   176

		/* Sort by the area of the map. */

   177

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

   178

   179

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

   180

		return (r != 0) ? r : NGameClientSorter(a, b);

   181

	}

   182

   183

	/** Sort servers by current date */

   184

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

   185

	{

   186

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

   187

		return (r != 0) ? r : NGameClientSorter(a, b);

   188

	}

   189

   190

	/** Sort servers by the number of days the game is running */

   191

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

   192

	{

   193

		int r = (*a)->info.game_date - (*a)->info.start_date - (*b)->info.game_date + (*b)->info.start_date;

   194

		return (r != 0) ? r : NGameDateSorter(a, b);

   195

	}

   196

   197

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

   198

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

   199

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

   200

	{

   201

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

   202

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

   203

   204

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

   205

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

   206

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

   207

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

   208

		/* Passworded servers should be below unpassworded servers */

   209

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

   210

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

   211

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

   212

   213

		return r;

   214

	}

   215

   216

	/** Sort the server list */

   217

	void SortNetworkGameList()

   218

	{

   219

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

   220

   221

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

   222

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

   223

		 * shuffling the ->next pointers */

   224

		_network_game_list = this->servers[0];

   225

		NetworkGameList *item = _network_game_list;

   226

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

   227

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

   228

			item = item->next;

   229

		}

   230

		item->next = NULL;

   231

	}

   232

   233

	/**

   234

	 * Draw a single server line.

   235

	 * @param cur_item  the server to draw.

   236

	 * @param y         from where to draw?

   237

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

   238

	 */

   239

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

   240

	{

   241

		/* show highlighted item with a different colour */

   242

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

   243

   244

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

   245

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

   246

   247

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

   248

		if (cur_item->online) {

   249

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

   250

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

   251

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

   252

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

   253

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

   254

   255

			/* map size */

   256

			if (!this->IsWidgetHidden(NGWW_MAPSIZE)) {

   257

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

   258

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

   259

				DrawStringCentered(this->widget[NGWW_MAPSIZE].left + 39, y, STR_NETWORK_MAP_SIZE_SHORT, TC_BLACK);

   260

			}

   261

   262

			/* current date */

   263

			if (!this->IsWidgetHidden(NGWW_DATE)) {

   264

				YearMonthDay ymd;

   265

				ConvertDateToYMD(cur_item->info.game_date, &ymd);

   266

				SetDParam(0, ymd.year);

   267

				DrawStringCentered(this->widget[NGWW_DATE].left + 29, y, STR_JUST_INT, TC_BLACK);

   268

			}

   269

   270

			/* number of years the game is running */

   271

			if (!this->IsWidgetHidden(NGWW_YEARS)) {

   272

				YearMonthDay ymd_cur, ymd_start;

   273

				ConvertDateToYMD(cur_item->info.game_date, &ymd_cur);

   274

				ConvertDateToYMD(cur_item->info.start_date, &ymd_start);

   275

				SetDParam(0, ymd_cur.year - ymd_start.year);

   276

				DrawStringCentered(this->widget[NGWW_YEARS].left + 29, y, STR_JUST_INT, TC_BLACK);

   277

			}

   278

   279

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

   280

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

   281

   282

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

   283

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

   284

   285

			/* draw flag according to server language */

   286

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

   287

		}

   288

	}

   289

   290

public:

   291

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

   292

	{

   293

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

   294

		this->afilter = CS_ALPHANUMERAL;

   295

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

   296

   297

		UpdateNetworkGameWindow(true);

   298

   299

		this->vscroll.cap = 11;

   300

		this->resize.step_height = NET_PRC__SIZE_OF_ROW;

   301

   302

		this->field = NGWW_PLAYER;

   303

		this->server = NULL;

   304

   305

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

   306

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

   307

		this->servers.ForceRebuild();

   308

		this->SortNetworkGameList();

   309

   310

		this->FindWindowPlacementAndResize(desc);

   311

	}

   312

   313

	~NetworkGameWindow()

   314

	{

   315

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

   316

	}

   317

   318

	virtual void OnPaint()

   319

	{

   320

		const NetworkGameList *sel = this->server;

   321

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

   322

   323

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

   324

			this->BuildNetworkGameList();

   325

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

   326

		}

   327

		this->SortNetworkGameList();

   328

   329

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

   330

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

   331

		/* 'Join' button disabling conditions */

   332

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

   333

				!sel->online || // Server offline

   334

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

   335

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

   336

   337

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

   338

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

   339

				!sel->online ||

   340

				sel->info.grfconfig == NULL);

   341

   342

		SetDParam(0, 0x00);

   343

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

   344

		this->DrawWidgets();

   345

   346

		/* Edit box to set player name */

   347

		this->DrawEditBox(NGWW_PLAYER);

   348

   349

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

   350

   351

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

   352

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

   353

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

   354

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

   355

			case NGWW_MAPSIZE - NGWW_NAME: if (!this->IsWidgetHidden(NGWW_MAPSIZE)) this->DrawSortButtonState(NGWW_MAPSIZE, arrow); break;

   356

			case NGWW_DATE    - NGWW_NAME: if (!this->IsWidgetHidden(NGWW_DATE))    this->DrawSortButtonState(NGWW_DATE,    arrow); break;

   357

			case NGWW_YEARS   - NGWW_NAME: if (!this->IsWidgetHidden(NGWW_YEARS))   this->DrawSortButtonState(NGWW_YEARS,   arrow); break;

   358

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

   359

		}

   360

   361

		uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   362

   363

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

   364

   365

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

   366

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

   367

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

   368

			y += NET_PRC__SIZE_OF_ROW;

   369

		}

   370

   371

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

   372

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

   373

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

   374

   375

		/* Draw the right menu */

   376

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

   377

		if (sel == NULL) {

   378

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

   379

		} else if (!sel->online) {

   380

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

   381

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

   382

   383

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

   384

		} else { // show game info

   385

			uint16 y = 100;

   386

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

   387

   388

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

   389

   390

   391

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

   392

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

   393

   394

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

   395

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

   396

   397

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

   398

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

   399

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

   400

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

   401

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   402

			y += 10;

   403

   404

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

   405

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

   406

			y += 10;

   407

   408

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

   409

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

   410

			y += 10;

   411

   412

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

   413

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

   414

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

   415

			y += 10;

   416

   417

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

   418

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

   419

			y += 10;

   420

   421

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

   422

			SetDParam(1, sel->port);

   423

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

   424

			y += 10;

   425

   426

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

   427

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

   428

			y += 10;

   429

   430

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

   431

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

   432

			y += 10;

   433

   434

			y += 2;

   435

   436

			if (!sel->info.compatible) {

   437

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

   438

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

   439

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

   440

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

   441

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

   442

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

   443

			}

   444

   445

			y += 10;

   446

		}

   447

	}

   448

   449

	virtual void OnClick(Point pt, int widget)

   450

	{

   451

		this->field = widget;

   452

		switch (widget) {

   453

			case NGWW_PLAYER:

   454

				ShowOnScreenKeyboard(this, NGWW_PLAYER, 0, 0);

   455

				break;

   456

   457

			case NGWW_CANCEL: // Cancel button

   458

				DeleteWindowById(WC_NETWORK_WINDOW, 0);

   459

				break;

   460

   461

			case NGWW_CONN_BTN: // 'Connection' droplist

   462

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

   463

				break;

   464

   465

			case NGWW_NAME:    // Sort by name

   466

			case NGWW_CLIENTS: // Sort by connected clients

   467

			case NGWW_MAPSIZE: // Sort by map size

   468

			case NGWW_DATE:    // Sort by date

   469

			case NGWW_YEARS:   // Sort by years

   470

			case NGWW_INFO:    // Connectivity (green dot)

   471

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

   472

					this->servers.ToggleSortOrder();

   473

				} else {

   474

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

   475

					this->servers.ForceResort();

   476

				}

   477

				this->SetDirty();

   478

				break;

   479

   480

			case NGWW_MATRIX: { // Matrix to show networkgames

   481

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

   482

   483

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

   484

				id_v += this->vscroll.pos;

   485

   486

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

   487