1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

#include "../stdafx.h"

     5

#include "../openttd.h"

     6

#include "../strings_func.h"

     7

#include "network.h"

     8

#include "../date_func.h"

     9

#include "../fios.h"

    10

#include "network_data.h"

    11

#include "network_client.h"

    12

#include "network_gui.h"

    13

#include "network_gamelist.h"

    14

#include "../gui.h"

    15

#include "../window_gui.h"

    16

#include "../textbuf_gui.h"

    17

#include "../variables.h"

    18

#include "network_server.h"

    19

#include "network_udp.h"

    20

#include "../town.h"

    21

#include "../newgrf.h"

    22

#include "../functions.h"

    23

#include "../window_func.h"

    24

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

    25

#include "../string_func.h"

    26

#include "../gfx_func.h"

    27

#include "../player_func.h"

    28

#include "../settings_type.h"

    29

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

    30

    31

#include "table/strings.h"

    32

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

    33

    34

#define BGC 5

    35

#define BTC 15

    36

    37

struct chatquerystr_d : public querystr_d {

    38

	DestType dtype;

    39

	int dest;

    40

};

    41

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(chatquerystr_d));

    42

    43

struct network_d {

    44

	PlayerID company;        // select company in network lobby

    45

	byte field;              // select text-field in start-server and game-listing

    46

	byte widget_id;          ///< The widget that has the pop-up input menu

    47

	NetworkGameList *server; // selected server in lobby and game-listing

    48

	FiosItem *map;           // selected map in start-server

    49

};

    50

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    51

    52

struct network_ql_d {

    53

	network_d n;                 // see above; general stuff

    54

	querystr_d q;                // text-input in start-server and game-listing

    55

	NetworkGameList **sort_list; // list of games (sorted)

    56

	list_d l;                    // accompanying list-administration

    57

};

    58

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    59

    60

/* Global to remember sorting after window has been closed */

    61

static Listing _ng_sorting;

    62

    63

static char _edit_str_net_buf[150];

    64

static bool _chat_tab_completion_active;

    65

    66

static void ShowNetworkStartServerWindow();

    67

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    68

extern void SwitchMode(int new_mode);

    69

    70

static const StringID _connection_types_dropdown[] = {

    71

	STR_NETWORK_LAN_INTERNET,

    72

	STR_NETWORK_INTERNET_ADVERTISE,

    73

	INVALID_STRING_ID

    74

};

    75

    76

static const StringID _lan_internet_types_dropdown[] = {

    77

	STR_NETWORK_LAN,

    78

	STR_NETWORK_INTERNET,

    79

	INVALID_STRING_ID

    80

};

    81

    82

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

    83

    84

void SortNetworkLanguages()

    85

{

    86

	/* Init the strings */

    87

	if (_language_dropdown[0] == STR_NULL) {

    88

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

    89

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    90

	}

    91

    92

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

    93

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

    94

}

    95

    96

enum {

    97

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    98

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    99

	NET_PRC__SIZE_OF_ROW                = 14,

   100

};

   101

   102

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

   103

 * found on the network.

   104

 * @param unselect unselect the currently selected item */

   105

void UpdateNetworkGameWindow(bool unselect)

   106

{

   107

	SendWindowMessage(WC_NETWORK_WINDOW, 0, unselect, 0, 0);

   108

}

   109

   110

static bool _internal_sort_order; // Used for Qsort order-flipping

   111

typedef int CDECL NGameNameSortFunction(const void*, const void*);

   112

   113

/** Qsort function to sort by name. */

   114

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

   115

{

   116

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

   117

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

   118

	int r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

   119

   120

	return _internal_sort_order ? -r : r;

   121

}

   122

   123

/** Qsort function to sort by the amount of clients online on a

   124

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

   125

 * higher maximum is preferred. */

   126

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

   127

{

   128

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

   129

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

   130

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

   131

	int r = cmp1->info.clients_on - cmp2->info.clients_on;

   132

   133

	if (r == 0) r = cmp1->info.clients_max - cmp2->info.clients_max;

   134

	if (r == 0) r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

   135

   136

	return _internal_sort_order ? -r : r;

   137

}

   138

   139

/** Qsort function to sort by joinability. If both servers are the

   140

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

   141

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

   142

{

   143

	const NetworkGameList *cmp1 = *(const NetworkGameList**)a;

   144

	const NetworkGameList *cmp2 = *(const NetworkGameList**)b;

   145

   146

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

   147

	int r = StrEmpty(cmp1->info.server_revision) - StrEmpty(cmp2->info.server_revision);

   148

   149

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

   150

	if (r == 0) r = cmp2->info.version_compatible - cmp1->info.version_compatible;

   151

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

   152

	if (r == 0) r = cmp2->info.compatible - cmp1->info.compatible;

   153

	/* Passworded servers should be below unpassworded servers */

   154

	if (r == 0) r = cmp1->info.use_password - cmp2->info.use_password;

   155

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

   156

	if (r == 0) r = strcasecmp(cmp1->info.server_name, cmp2->info.server_name);

   157

   158

	return _internal_sort_order ? -r : r;

   159

}

   160

   161

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

   162

 * an item has been added or deleted for example

   163

 * @param ngl list_d struct that contains all necessary information for sorting */

   164

static void BuildNetworkGameList(network_ql_d *nqld)

   165

{

   166

	NetworkGameList *ngl_temp;

   167

	uint n = 0;

   168

   169

	if (!(nqld->l.flags & VL_REBUILD)) return;

   170

   171

	/* Count the number of games in the list */

   172

	for (ngl_temp = _network_game_list; ngl_temp != NULL; ngl_temp = ngl_temp->next) n++;

   173

	if (n == 0) return;

   174

   175

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

   176

	free(nqld->sort_list);

   177

	nqld->sort_list = MallocT<NetworkGameList*>(n);

   178

	nqld->l.list_length = n;

   179

   180

	for (n = 0, ngl_temp = _network_game_list; ngl_temp != NULL; ngl_temp = ngl_temp->next) {

   181

		nqld->sort_list[n++] = ngl_temp;

   182

	}

   183

   184

	/* Force resort */

   185

	nqld->l.flags &= ~VL_REBUILD;

   186

	nqld->l.flags |= VL_RESORT;

   187

}

   188

   189

static void SortNetworkGameList(network_ql_d *nqld)

   190

{

   191

	static NGameNameSortFunction * const ngame_sorter[] = {

   192

		&NGameNameSorter,

   193

		&NGameClientSorter,

   194

		&NGameAllowedSorter

   195

	};

   196

   197

	NetworkGameList *item;

   198

	uint i;

   199

   200

	if (!(nqld->l.flags & VL_RESORT)) return;

   201

	if (nqld->l.list_length == 0) return;

   202

   203

	_internal_sort_order = !!(nqld->l.flags & VL_DESC);

   204

	qsort(nqld->sort_list, nqld->l.list_length, sizeof(nqld->sort_list[0]), ngame_sorter[nqld->l.sort_type]);

   205

   206

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

   207

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

   208

	 * shuffling the ->next pointers */

   209

	_network_game_list = nqld->sort_list[0];

   210

	for (item = _network_game_list, i = 1; i != nqld->l.list_length; i++) {

   211

		item->next = nqld->sort_list[i];

   212

		item = item->next;

   213

	}

   214

	item->next = NULL;

   215

   216

	nqld->l.flags &= ~VL_RESORT;

   217

}

   218

   219

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

   220

enum NetworkGameWindowWidgets {

   221

	NGWW_CLOSE    = 0,  ///< Close 'X' button

   222

	NGWW_CONN_BTN = 4,  ///< 'Connection' droplist button

   223

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

   224

   225

	NGWW_NAME     = 6,  ///< 'Name' button

   226

	NGWW_CLIENTS,       ///< 'Clients' button

   227

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

   228

   229

	NGWW_MATRIX   = 9,  ///< Panel with list of games

   230

   231

	NGWW_DETAILS  = 11, ///< Panel with game details

   232

	NGWW_JOIN     = 12, ///< 'Join game' button

   233

	NGWW_REFRESH  = 13, ///< 'Refresh server' button

   234

	NGWW_NEWGRF   = 14, ///< 'NewGRF Settings' button

   235

   236

	NGWW_FIND     = 15, ///< 'Find server' button

   237

	NGWW_ADD,           ///< 'Add server' button

   238

	NGWW_START,         ///< 'Start server' button

   239

	NGWW_CANCEL,        ///< 'Cancel' button

   240

};

   241

   242

/**

   243

 * Handler of actions done in the NetworkStartServer window

   244

 *

   245

 * @param w pointer to the Window structure

   246

 * @param e pointer to window event

   247

 * @note    Uses network_ql_d (network_d, querystr_d and list_d) WP macro

   248

 * @see     struct _network_game_window_widgets

   249

 * @see     enum NetworkGameWindowWidgets

   250

 */

   251

   252

static void NetworkGameWindowWndProc(Window *w, WindowEvent *e)

   253

{

   254

	network_d *nd = &WP(w, network_ql_d).n;

   255

	list_d *ld = &WP(w, network_ql_d).l;

   256

   257

	switch (e->event) {

   258

		case WE_CREATE: // Focus input box

   259

			w->vscroll.cap = 13;

   260

			w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   261

   262

			nd->field = NGWW_PLAYER;

   263

			nd->server = NULL;

   264

   265

			WP(w, network_ql_d).sort_list = NULL;

   266

			ld->flags = VL_REBUILD | (_ng_sorting.order ? VL_DESC : VL_NONE);

   267

			ld->sort_type = _ng_sorting.criteria;

   268

			break;

   269

   270

		case WE_PAINT: {

   271

			const NetworkGameList *sel = nd->server;

   272

			const SortButtonState arrow = (ld->flags & VL_DESC) ? SBS_DOWN : SBS_UP;

   273

   274

			if (ld->flags & VL_REBUILD) {

   275

				BuildNetworkGameList(&WP(w, network_ql_d));

   276

				SetVScrollCount(w, ld->list_length);

   277

			}

   278

			if (ld->flags & VL_RESORT) SortNetworkGameList(&WP(w, network_ql_d));

   279

   280

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

   281

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

   282

			/* 'Join' button disabling conditions */

   283

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

   284

					!sel->online || // Server offline

   285

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

   286

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

   287

   288

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

   289

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

   290

					!sel->online ||

   291

					sel->info.grfconfig == NULL);

   292

   293

			SetDParam(0, 0x00);

   294

			SetDParam(1, _lan_internet_types_dropdown[_network_lan_internet]);

   295

			DrawWindowWidgets(w);

   296

   297

			/* Edit box to set player name */

   298

			DrawEditBox(w, &WP(w, network_ql_d).q, NGWW_PLAYER);

   299

   300

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

   301

   302

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

   303

			switch (ld->sort_type) {

   304

				case NGWW_NAME    - NGWW_NAME: DrawSortButtonState(w, NGWW_NAME,    arrow); break;

   305

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

   306

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

   307

			}

   308

   309

			uint16 y = NET_PRC__OFFSET_TOP_WIDGET + 3;

   310

			int32 n = 0;

   311

			int32 pos = w->vscroll.pos;

   312

			uint max_name_width = w->widget[NGWW_NAME].right - w->widget[NGWW_NAME].left - 5;

   313

			const NetworkGameList *cur_item = _network_game_list;

   314

   315

			while (pos > 0 && cur_item != NULL) {

   316

				pos--;

   317

				cur_item = cur_item->next;

   318

			}

   319

   320

			while (cur_item != NULL) {

   321

				/* show highlighted item with a different colour */

   322

				if (cur_item == sel) GfxFillRect(w->widget[NGWW_NAME].left + 1, y - 2, w->widget[NGWW_INFO].right - 1, y + 9, 10);

   323

   324

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

   325

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

   326

   327

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

   328

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

   329

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

   330

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

   331

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

   332

   333

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

   334

				if (cur_item->online) {

   335

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

   336

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

   337

   338

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

   339

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

   340

   341

					/* draw flag according to server language */

   342

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

   343

				}

   344

   345

				cur_item = cur_item->next;

   346

				y += NET_PRC__SIZE_OF_ROW;

   347

				if (++n == w->vscroll.cap) break; // max number of games in the window

   348

			}

   349

   350

			/* Draw the right menu */

   351

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

   352

			if (sel == NULL) {

   353

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

   354

			} else if (!sel->online) {

   355

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

   356

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

   357

   358

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

   359

			} else { // show game info

   360

				uint16 y = 100;

   361

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

   362

   363

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

   364

   365

   366

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

   367

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

   368

   369

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

   370

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

   371

   372

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

   373

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

   374

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

   375

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

   376

				DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   377

				y += 10;

   378

   379

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

   380

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

   381

				y += 10;

   382

   383

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

   384

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

   385

				y += 10;

   386

   387

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

   388

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

   389

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

   390

				y += 10;

   391

   392

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

   393

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

   394

				y += 10;

   395

   396

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

   397

				SetDParam(1, sel->port);

   398

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

   399

				y += 10;

   400

   401

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

   402

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

   403

				y += 10;

   404

   405

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

   406

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

   407

				y += 10;

   408

   409

				y += 2;

   410

   411

				if (!sel->info.compatible) {

   412

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

   413

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

   414

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

   415

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

   416

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

   417

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

   418

				}

   419

   420

				y += 10;

   421

			}

   422

		} break;

   423

   424

		case WE_CLICK:

   425

			nd->field = e->we.click.widget;

   426

			switch (e->we.click.widget) {

   427

				case NGWW_PLAYER:

   428

					ShowOnScreenKeyboard(w, &WP(w, network_ql_d).q,  NGWW_PLAYER, 0, 0);

   429

					break;

   430

   431

				case NGWW_CANCEL: // Cancel button

   432

					DeleteWindowById(WC_NETWORK_WINDOW, 0);

   433

					break;

   434

   435

				case NGWW_CONN_BTN: // 'Connection' droplist

   436

					ShowDropDownMenu(w, _lan_internet_types_dropdown, _network_lan_internet, NGWW_CONN_BTN, 0, 0); // do it for widget NSSW_CONN_BTN

   437

					break;

   438

   439

				case NGWW_NAME: // Sort by name

   440

				case NGWW_CLIENTS: // Sort by connected clients

   441

				case NGWW_INFO: // Connectivity (green dot)

   442

					if (ld->sort_type == e->we.click.widget - NGWW_NAME) ld->flags ^= VL_DESC;

   443

					ld->flags |= VL_RESORT;

   444

					ld->sort_type = e->we.click.widget - NGWW_NAME;

   445

   446

					_ng_sorting.order = !!(ld->flags & VL_DESC);

   447

					_ng_sorting.criteria = ld->sort_type;

   448

					SetWindowDirty(w);

   449

					break;

   450

   451

				case NGWW_MATRIX: { // Matrix to show networkgames

   452

					NetworkGameList *cur_item;

   453

					uint32 id_v = (e->we.click.pt.y - NET_PRC__OFFSET_TOP_WIDGET) / NET_PRC__SIZE_OF_ROW;

   454

   455

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

   456

					id_v += w->vscroll.pos;

   457

   458

					cur_item = _network_game_list;

   459

					for (; id_v > 0 && cur_item != NULL; id_v--) cur_item = cur_item->next;

   460

   461

					nd->server = cur_item;

   462

					SetWindowDirty(w);

   463

				} break;

   464

   465

				case NGWW_FIND: // Find server automatically

   466

					switch (_network_lan_internet) {

   467

						case 0: NetworkUDPSearchGame(); break;

   468

						case 1: NetworkUDPQueryMasterServer(); break;

   469

					}

   470

					break;

   471

   472

				case NGWW_ADD: // Add a server

   473

					ShowQueryString(

   474

						BindCString(_network_default_ip),

   475

						STR_NETWORK_ENTER_IP,

   476

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

   477

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

   478

						w, CS_ALPHANUMERAL);

   479

					break;

   480

   481

				case NGWW_START: // Start server

   482

					ShowNetworkStartServerWindow();

   483

					break;

   484

   485

				case NGWW_JOIN: // Join Game

   486

					if (nd->server != NULL) {

   487

						snprintf(_network_last_host, sizeof(_network_last_host), "%s", inet_ntoa(*(struct in_addr *)&nd->server->ip));