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"

    29

    30

#include "table/strings.h"

    31

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

    32

    33

#define BGC 5

    34

#define BTC 15

    35

    36

struct chatquerystr_d : public querystr_d {

    37

	int dest;

    38

};

    39

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(chatquerystr_d));

    40

    41

struct network_d {

    42

	PlayerID company;        // select company in network lobby

    43

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

    44

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

    45

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

    46

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

    47

};

    48

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_d));

    49

    50

struct network_ql_d {

    51

	network_d n;                 // see above; general stuff

    52

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

    53

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

    54

	list_d l;                    // accompanying list-administration

    55

};

    56

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(network_ql_d));

    57

    58

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

    59

static Listing _ng_sorting;

    60

    61

static char _edit_str_buf[150];

    62

static bool _chat_tab_completion_active;

    63

    64

static void ShowNetworkStartServerWindow();

    65

static void ShowNetworkLobbyWindow(NetworkGameList *ngl);

    66

extern void SwitchMode(int new_mode);

    67

    68

static const StringID _connection_types_dropdown[] = {

    69

	STR_NETWORK_LAN_INTERNET,

    70

	STR_NETWORK_INTERNET_ADVERTISE,

    71

	INVALID_STRING_ID

    72

};

    73

    74

static const StringID _lan_internet_types_dropdown[] = {

    75

	STR_NETWORK_LAN,

    76

	STR_NETWORK_INTERNET,

    77

	INVALID_STRING_ID

    78

};

    79

    80

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

    81

    82

void SortNetworkLanguages()

    83

{

    84

	/* Init the strings */

    85

	if (_language_dropdown[0] == STR_NULL) {

    86

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

    87

		_language_dropdown[NETLANG_COUNT] = INVALID_STRING_ID;

    88

	}

    89

    90

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

    91

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

    92

}

    93

    94

enum {

    95

	NET_PRC__OFFSET_TOP_WIDGET          = 54,

    96

	NET_PRC__OFFSET_TOP_WIDGET_COMPANY  = 52,

    97

	NET_PRC__SIZE_OF_ROW                = 14,

    98

};

    99

   100

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

   101

 * found on the network.

   102

 * @param unselect unselect the currently selected item */

   103

void UpdateNetworkGameWindow(bool unselect)

   104

{

   105

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

   106

}

   107

   108

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

   109

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

   110

   111

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

   112

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

   113

{

   114

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

   115

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

   116

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

   117

   118

	return _internal_sort_order ? -r : r;

   119

}

   120

   121

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

   122

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

   123

 * higher maximum is preferred. */

   124

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

   125

{

   126

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

   127

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

   128

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

   129

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

   130

   131

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

   132

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

   133

   134

	return _internal_sort_order ? -r : r;

   135

}

   136

   137

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

   138

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

   139

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

   140

{

   141

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

   142

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

   143

   144

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

   145

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

   146

   147

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

   148

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

   149

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

   150

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

   151

	/* Passworded servers should be below unpassworded servers */

   152

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

   153

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

   154

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

   155

   156

	return _internal_sort_order ? -r : r;

   157

}

   158

   159

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

   160

 * an item has been added or deleted for example

   161

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

   162

static void BuildNetworkGameList(network_ql_d *nqld)

   163

{

   164

	NetworkGameList *ngl_temp;

   165

	uint n = 0;

   166

   167

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

   168

   169

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

   170

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

   171

	if (n == 0) return;

   172

   173

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

   174

	free(nqld->sort_list);

   175

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

   176

	nqld->l.list_length = n;

   177

   178

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

   179

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

   180

	}

   181

   182

	/* Force resort */

   183

	nqld->l.flags &= ~VL_REBUILD;

   184

	nqld->l.flags |= VL_RESORT;

   185

}

   186

   187

static void SortNetworkGameList(network_ql_d *nqld)

   188

{

   189

	static NGameNameSortFunction * const ngame_sorter[] = {

   190

		&NGameNameSorter,

   191

		&NGameClientSorter,

   192

		&NGameAllowedSorter

   193

	};

   194

   195

	NetworkGameList *item;

   196

	uint i;

   197

   198

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

   199

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

   200

   201

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

   202

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

   203

   204

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

   205

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

   206

	 * shuffling the ->next pointers */

   207

	_network_game_list = nqld->sort_list[0];

   208

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

   209

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

   210

		item = item->next;

   211

	}

   212

	item->next = NULL;

   213

   214

	nqld->l.flags &= ~VL_RESORT;

   215

}

   216

   217

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

   218

enum NetworkGameWindowWidgets {

   219

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

   220

	NGWW_CONN_TXT = 4,  ///< 'Connection' droplist

   221

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

   222

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

   223

   224

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

   225

	NGWW_CLIENTS,       ///< 'Clients' button

   226

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

   227

   228

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

   229

   230

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

   231

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

   232

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

   233

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

   234

   235

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

   236

	NGWW_ADD,           ///< 'Add server' button

   237

	NGWW_START,         ///< 'Start server' button

   238

	NGWW_CANCEL,        ///< 'Cancel' button

   239

};

   240

   241

/**

   242

 * Handler of actions done in the NetworkStartServer window

   243

 *

   244

 * @param w pointer to the Window structure

   245

 * @param e pointer to window event

   246

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

   247

 * @see     struct _network_game_window_widgets

   248

 * @see     enum NetworkGameWindowWidgets

   249

 */

   250

   251

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

   252

{

   253

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

   254

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

   255

   256

	switch (e->event) {

   257

	case WE_CREATE: // Focus input box

   258

		w->vscroll.cap = 13;

   259

		w->resize.step_height = NET_PRC__SIZE_OF_ROW;

   260

   261

		nd->field = NGWW_PLAYER;

   262

		nd->server = NULL;

   263

   264

		WP(w, network_ql_d).sort_list = NULL;

   265

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

   266

		ld->sort_type = _ng_sorting.criteria;

   267

		break;

   268

   269

	case WE_PAINT: {

   270

		const NetworkGameList *sel = nd->server;

   271

		const char *arrow = (ld->flags & VL_DESC) ? DOWNARROW : UPARROW;

   272

   273

		if (ld->flags & VL_REBUILD) {

   274

			BuildNetworkGameList(&WP(w, network_ql_d));

   275

			SetVScrollCount(w, ld->list_length);

   276

		}

   277

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

   278

   279

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

   280

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

   281

		/* 'Join' button disabling conditions */

   282

		w->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

		w->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[_network_lan_internet]);

   294

		DrawWindowWidgets(w);

   295

   296

		/* Edit box to set player name */

   297

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

   298

   299

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

   300

   301

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

   302

		switch (ld->sort_type) {

   303

			case NGWW_NAME    - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_NAME].right    - 10, 42, TC_BLACK); break;

   304

			case NGWW_CLIENTS - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_CLIENTS].right - 10, 42, TC_BLACK); break;

   305

			case NGWW_INFO    - NGWW_NAME: DoDrawString(arrow, w->widget[NGWW_INFO].right    - 10, 42, TC_BLACK); break;

   306

		}

   307

   308

		{ // draw list of games

   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

   351

		/* Draw the right menu */

   352

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

   353

		if (sel == NULL) {

   354

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

   355

		} else if (!sel->online) {

   356

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

   357

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

   358

   359

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

   360

		} else { // show game info

   361

			uint16 y = 100;

   362

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

   363

   364

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

   365

   366

   367

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

   368

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

   369

   370

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

   371

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

   372

   373

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

   374

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

   375

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

   376

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

   377

			DrawString(x, y, STR_NETWORK_CLIENTS, TC_GOLD);

   378

			y += 10;

   379

   380

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

   381

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

   382

			y += 10;

   383

   384

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

   385

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

   386

			y += 10;

   387

   388

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

   389

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

   390

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

   391

			y += 10;

   392

   393

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

   394

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

   395

			y += 10;

   396

   397

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

   398

			SetDParam(1, sel->port);

   399

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

   400

			y += 10;

   401

   402

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

   403

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

   404

			y += 10;

   405

   406

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

   407

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

   408

			y += 10;

   409

   410

			y += 2;

   411

   412

			if (!sel->info.compatible) {

   413

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

   414

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

   415

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

   416

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

   417

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

   418

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

   419

			}

   420

   421

			y += 10;

   422

		}

   423

	} break;

   424

   425

	case WE_CLICK:

   426

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

   427

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

   428

		case NGWW_CANCEL: // Cancel button

   429

			DeleteWindowById(WC_NETWORK_WINDOW, 0);

   430

			break;

   431

		case NGWW_CONN_TXT: case NGWW_CONN_BTN: // 'Connection' droplist

   432

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

   433

			break;

   434

		case NGWW_NAME: // Sort by name

   435

		case NGWW_CLIENTS: // Sort by connected clients

   436

		case NGWW_INFO: // Connectivity (green dot)

   437

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

   438

			ld->flags |= VL_RESORT;

   439

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

   440

   441

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

   442

			_ng_sorting.criteria = ld->sort_type;

   443

			SetWindowDirty(w);

   444

			break;

   445

		case NGWW_MATRIX: { // Matrix to show networkgames

   446

			NetworkGameList *cur_item;

   447

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

   448

   449

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

   450

			id_v += w->vscroll.pos;

   451

   452

			cur_item = _network_game_list;

   453

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

   454

   455

			nd->server = cur_item;

   456

			SetWindowDirty(w);

   457

		} break;

   458

		case NGWW_FIND: // Find server automatically

   459

			switch (_network_lan_internet) {

   460

				case 0: NetworkUDPSearchGame(); break;

   461

				case 1: NetworkUDPQueryMasterServer(); break;

   462

			}

   463

			break;

   464

		case NGWW_ADD: { // Add a server

   465

			ShowQueryString(

   466

				BindCString(_network_default_ip),

   467

				STR_NETWORK_ENTER_IP,

   468

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

   469

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

   470

				w, CS_ALPHANUMERAL);

   471

		} break;

   472

		case NGWW_START: // Start server

   473

			ShowNetworkStartServerWindow();

   474

			break;

   475

		case NGWW_JOIN: // Join Game

   476

			if (nd->server != NULL) {

   477

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

   478

				_network_last_port = nd->server->port;

   479

				ShowNetworkLobbyWindow(nd->server);

   480

			}

   481

			break;