1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "console.h"

     4

#include "debug.h"

     5

#include "engine.h"

     6

#include "functions.h"

     7

#include "string.h"

     8

#include "variables.h"

     9

#include "network_data.h"

    10

#include "network_client.h"

    11

#include "network_server.h"

    12

#include "network_udp.h"

    13

#include "command.h"

    14

#include "settings.h"

    15

#include "hal.h" /* for file list */

    17

    18

// ** scriptfile handling ** //

    19

static FILE *_script_file;

    20

static bool _script_running;

    21

    22

// ** console command / variable defines ** //

    23

#define DEF_CONSOLE_CMD(function) static bool function(byte argc, char *argv[])

    24

#define DEF_CONSOLE_HOOK(function) static bool function(void)

    25

    26

    27

/* **************************** */

    28

/* variable and command hooks   */

    29

/* **************************** */

    30

    31

#ifdef ENABLE_NETWORK

    32

    33

static inline bool NetworkAvailable(void)

    34

{

    35

	if (!_network_available) {

    36

		IConsoleError("You cannot use this command because there is no network available.");

    37

		return false;

    38

	}

    39

	return true;

    40

}

    41

    42

DEF_CONSOLE_HOOK(ConHookServerOnly)

    43

{

    44

	if (!NetworkAvailable()) return false;

    45

    46

	if (!_network_server) {

    47

		IConsoleError("This command/variable is only available to a network server.");

    48

		return false;

    49

	}

    50

	return true;

    51

}

    52

    53

DEF_CONSOLE_HOOK(ConHookClientOnly)

    54

{

    55

	if (!NetworkAvailable()) return false;

    56

    57

	if (_network_server) {

    58

		IConsoleError("This command/variable is not available to a network server.");

    59

		return false;

    60

	}

    61

	return true;

    62

}

    63

    64

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    65

{

    66

	if (!NetworkAvailable()) return false;

    67

    68

	if (!_networking) {

    69

		IConsoleError("Not connected. This command/variable is only available in multiplayer.");

    70

		return false;

    71

	}

    72

	return true;

    73

}

    74

    75

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    76

{

    77

	if (_networking) {

    78

		IConsoleError("This command/variable is forbidden in multiplayer.");

    79

		return false;

    80

	}

    81

	return true;

    82

}

    83

    84

#endif /* ENABLE_NETWORK */

    85

    86

static void IConsoleHelp(const char *str)

    87

{

    88

	IConsolePrintF(_icolour_warn, "- %s", str);

    89

}

    90

   113

DEF_CONSOLE_CMD(ConResetEngines)

   114

{

   115

	if (argc == 0) {

   116

		IConsoleHelp("Reset status data of all engines. This might solve some issues with 'lost' engines. Usage: 'resetengines'");

   117

		return true;

   118

	}

   119

   120

	StartupEngines();

   121

	return true;

   122

}

   123

   124

#ifdef _DEBUG

   125

DEF_CONSOLE_CMD(ConResetTile)

   126

{

   127

	if (argc == 0) {

   128

		IConsoleHelp("Reset a tile to bare land. Usage: 'resettile <tile>'");

   129

		IConsoleHelp("Tile can be either decimal (34161) or hexadecimal (0x4a5B)");

   130

		return true;

   131

	}

   132

   133

	if (argc == 2) {

   134

		uint32 result;

   135

		if (GetArgumentInteger(&result, argv[1])) {

   136

			DoClearSquare((TileIndex)result);

   137

			return true;

   138

		}

   139

	}

   140

   141

	return false;

   142

}

   143

#endif /* _DEBUG */

   144

   145

DEF_CONSOLE_CMD(ConScrollToTile)

   146

{

   147

	if (argc == 0) {

   148

		IConsoleHelp("Center the screen on a given tile. Usage: 'scrollto <tile>'");

   149

		IConsoleHelp("Tile can be either decimal (34161) or hexadecimal (0x4a5B)");

   150

		return true;

   151

	}

   152

   153

	if (argc == 2) {

   154

		uint32 result;

   155

		if (GetArgumentInteger(&result, argv[1])) {

   156

			ScrollMainWindowToTile((TileIndex)result);

   157

			return true;

   158

		}

   159

	}

   160

   161

	return false;

   162

}

   163

   164

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm);

   165

extern void BuildFileList(void);

   166

extern void SetFiosType(const byte fiostype);

   167

   168

/* Save the map to a file */

   169

DEF_CONSOLE_CMD(ConSave)

   170

{

   171

	if (argc == 0) {

   172

		IConsoleHelp("Save the current game. Usage: 'save <filename>'");

   173

		return true;

   174

	}

   175

   176

	if (argc == 2) {

   177

		char buf[200];

   178

   179

		snprintf(buf, lengthof(buf), "%s%s%s.sav", _path.save_dir, PATHSEP, argv[1]);

   180

		IConsolePrint(_icolour_def, "Saving map...");

   181

   182

		if (SaveOrLoad(buf, SL_SAVE) != SL_OK) {

   183

			IConsolePrint(_icolour_err, "SaveMap failed");

   184

		} else

   185

			IConsolePrintF(_icolour_def, "Map sucessfully saved to %s", buf);

   186

		return true;

   187

	}

   188

   189

	return false;

   190

}

   191

   192

static const FiosItem* GetFiosItem(const char* file)

   193

{

   194

	int i;

   195

   196

	_saveload_mode = SLD_LOAD_GAME;

   197

	BuildFileList();

   198

   199

	for (i = 0; i < _fios_num; i++) {

   200

		if (strcmp(file, _fios_list[i].name) == 0) break;

   201

	}

   202

   203

	if (i == _fios_num) { /* If no name matches, try to parse it as number */

   204

		char* endptr;

   205

   206

		i = strtol(file, &endptr, 10);

   207

		if (file == endptr || *endptr != '\0') i = -1;

   208

	}

   209

   210

	return IS_INT_INSIDE(i, 0, _fios_num) ? &_fios_list[i] : NULL;

   211

}

   212

   213

   214

DEF_CONSOLE_CMD(ConLoad)

   215

{

   216

	const FiosItem *item;

   217

	const char *file;

   218

   219

	if (argc == 0) {

   220

		IConsoleHelp("Load a game by name or index. Usage: 'load <file \\ number>'");

   221

		return true;

   222

	}

   223

   224

	if (argc != 2) return false;

   225

   226

	file = argv[1];

   227

	item = GetFiosItem(file);

   228

	if (item != NULL) {

   229

		switch (item->type) {

   230

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE:

   231

				_switch_mode = SM_LOAD;

   232

				SetFiosType(item->type);

   233

				strcpy(_file_to_saveload.name, FiosBrowseTo(item));

   234

				break;

   235

			default: IConsolePrintF(_icolour_err, "%s: Not a savegame.", file);

   236

		}

   237

	} else

   238

		IConsolePrintF(_icolour_err, "%s: No such file or directory.", file);

   239

   240

	FiosFreeSavegameList();

   241

	return true;

   242

}

   243

   244

/* List all the files in the current dir via console */

   245

DEF_CONSOLE_CMD(ConListFiles)

   246

{

   247

	int i;

   248

   249

	if (argc == 0) {

   250

		IConsoleHelp("List all loadable savegames and directories in the current dir via console. Usage: 'ls \\ dir'");

   251

		return true;

   252

	}

   253

   254

	BuildFileList();

   255

   256

	for (i = 0; i < _fios_num; i++) {

   257

		const FiosItem *item = &_fios_list[i];

   258

		IConsolePrintF(_icolour_def, "%d) %s", i, (item->title[0] != '\0') ? item->title : item->name);

   259

	}

   260

   261

	FiosFreeSavegameList();

   262

	return true;

   263

}

   264

   265

/* Change the dir via console */

   266

DEF_CONSOLE_CMD(ConChangeDirectory)

   267

{

   268

	const FiosItem *item;

   269

	const char *file;

   270

   271

	if (argc == 0) {

   272

		IConsoleHelp("Change the dir via console. Usage: 'cd <directory \\ number>'");

   273

		return true;

   274

	}

   275

   276

	if (argc != 2) return false;

   277

   278

	file = argv[1];

   279

	item = GetFiosItem(file);

   280

	if (item != NULL) {

   281

		switch (item->type) {

   282

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   283

				FiosBrowseTo(item);

   284

				break;

   285

			default: IConsolePrintF(_icolour_err, "%s: Not a directory.", file);

   286

		}

   287

	} else

   288

		IConsolePrintF(_icolour_err, "%s: No such file or directory.", file);

   289

   290

	FiosFreeSavegameList();

   291

	return true;

   292

}

   293

   294

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   295

{

   296

	const char *path;

   297

   298

	if (argc == 0) {

   299

		IConsoleHelp("Print out the current working directory. Usage: 'pwd'");

   300

		return true;

   301

	}

   302

   303

	// XXX - Workaround for broken file handling

   304

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   305

	FiosFreeSavegameList();

   306

   307

	FiosGetDescText(&path, NULL);

   308

	IConsolePrint(_icolour_def, path);

   309

	return true;

   310

}

   311

   312

DEF_CONSOLE_CMD(ConClearBuffer)

   313

{

   314

	if (argc == 0) {

   315

		IConsoleHelp("Clear the console buffer. Usage: 'clear'");

   316

		return true;

   317

	}

   318

   319

	IConsoleClearBuffer();

   320

	InvalidateWindow(WC_CONSOLE, 0);

   321

	return true;

   322

}

   323

   324

   325

// ********************************* //

   326

// * Network Core Console Commands * //

   327

// ********************************* //

   328

#ifdef ENABLE_NETWORK

   329

   330

DEF_CONSOLE_CMD(ConBan)

   331

{

   332

	NetworkClientInfo *ci;

   333

	uint32 index;

   334

   335

	if (argc == 0) {

   336

		IConsoleHelp("Ban a player from a network game. Usage: 'ban <client-id>'");

   337

		IConsoleHelp("For client-id's, see the command 'clients'");

   338

		return true;

   339

	}

   340

   341

	if (argc != 2) return false;

   342

   343

	index = atoi(argv[1]);

   344

   345

	if (index == NETWORK_SERVER_INDEX) {

   346

		IConsolePrint(_icolour_def, "Silly boy, you can not ban yourself!");

   347

		return true;

   348

	}

   349

	if (index == 0) {

   350

		IConsoleError("Invalid Client-ID");

   351

		return true;

   352

	}

   353

   354

	ci = NetworkFindClientInfoFromIndex(index);

   355

   356

	if (ci != NULL) {

   357

		uint i;

   358

		/* Add user to ban-list */

   359

		for (i = 0; i < lengthof(_network_ban_list); i++) {

   360

			if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0') {

   361

				_network_ban_list[i] = strdup(inet_ntoa(*(struct in_addr *)&ci->client_ip));

   362

				break;

   363

			}

   364

		}

   365

   366

		SEND_COMMAND(PACKET_SERVER_ERROR)(NetworkFindClientStateFromIndex(index), NETWORK_ERROR_KICKED);

   367

	} else

   368

		IConsoleError("Client-ID not found");

   369

   370

	return true;

   371

}

   372

   373

DEF_CONSOLE_CMD(ConUnBan)

   374

{

   375

	uint i;

   376

   377

	if (argc == 0) {

   378

		IConsoleHelp("Unban a player from a network game. Usage: 'unban <ip>'");

   379

		return true;

   380

	}

   381

   382

	if (argc != 2) return false;

   383

   384

	for (i = 0; i < lengthof(_network_ban_list); i++) {

   385

		if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0')

   386

			continue;

   387

   388

		if (strncmp(_network_ban_list[i], argv[1], strlen(_network_ban_list[i])) == 0) {

   389

			_network_ban_list[i][0] = '\0';

   390

			IConsolePrint(_icolour_def, "IP unbanned.");

   391

			return true;

   392

		}

   393

	}

   394

   395

	IConsolePrint(_icolour_def, "IP not in ban-list.");

   396

	return true;

   397

}

   398

   399

DEF_CONSOLE_CMD(ConBanList)

   400

{

   401

	uint i;

   402

   403

	if (argc == 0) {

   404

		IConsoleHelp("List the IP's of banned clients: Usage 'banlist'");

   405

		return true;

   406

	}

   407

   408

	IConsolePrint(_icolour_def, "Banlist: ");

   409

   410

	for (i = 0; i < lengthof(_network_ban_list); i++) {

   411

		if (_network_ban_list[i] == NULL || _network_ban_list[i][0] == '\0')

   412

			continue;

   413

   414

		IConsolePrintF(_icolour_def, "  %d) %s", i + 1, _network_ban_list[i]);

   415

	}

   416

   417

	return true;

   418

}

   419

   420

DEF_CONSOLE_CMD(ConPauseGame)

   421

{

   422

	if (argc == 0) {

   423

		IConsoleHelp("Pause a network game. Usage: 'pause'");

   424

		return true;

   425

	}

   426

   427

	if (_pause == 0) {

   428

		DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   429

		IConsolePrint(_icolour_def, "Game paused.");

   430

	} else

   431

		IConsolePrint(_icolour_def, "Game is already paused.");

   432

   433

	return true;

   434

}

   435

   436

DEF_CONSOLE_CMD(ConUnPauseGame)

   437

{

   438

	if (argc == 0) {

   439

		IConsoleHelp("Unpause a network game. Usage: 'unpause'");

   440

		return true;

   441

	}

   442

   443

	if (_pause != 0) {

   444

		DoCommandP(0, 0, 0, NULL, CMD_PAUSE);

   445

		IConsolePrint(_icolour_def, "Game unpaused.");

   446

	} else

   447

		IConsolePrint(_icolour_def, "Game is already unpaused.");

   448

   449

	return true;

   450

}

   451

   452

DEF_CONSOLE_CMD(ConRcon)

   453

{

   454

	if (argc == 0) {

   455

		IConsoleHelp("Remote control the server from another client. Usage: 'rcon <password> <command>'");

   456

		IConsoleHelp("Remember to enclose the command in quotes, otherwise only the first parameter is sent");

   457

		return true;

   458

	}

   459

   460

	if (argc < 3) return false;

   461

   462

	SEND_COMMAND(PACKET_CLIENT_RCON)(argv[1], argv[2]);

   463

	return true;

   464

}

   465

   466

DEF_CONSOLE_CMD(ConStatus)

   467

{

   468

	static const char *stat_str[] = {"inactive", "authorized", "waiting", "loading map", "map done", "ready", "active"};

   469

	const char *status;

   470

	const NetworkClientState *cs;

   471

   472

	if (argc == 0) {

   473

		IConsoleHelp("List the status of all clients connected to the server: Usage 'status'");

   474

		return true;

   475

	}

   476

   477

	FOR_ALL_CLIENTS(cs) {

   478

		int lag = NetworkCalculateLag(cs);

   479

		const NetworkClientInfo *ci = DEREF_CLIENT_INFO(cs);

   480

   481

		status = (cs->status <= STATUS_ACTIVE) ? stat_str[cs->status] : "unknown";

   482

		IConsolePrintF(8, "Client #%d/%s  status: %s  frame-lag: %d  play-as: %d  unique-id: %s",

   483

			cs->index, ci->client_name, status, lag, ci->client_playas, ci->unique_id);