1

/* $Id$ */

     2

     3

/** @file console_cmds.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "console.h"

     8

#include "debug.h"

     9

#include "engine.h"

    10

#include "landscape.h"

    11

#include "saveload.h"

    12

#include "string.h"

    13

#include "variables.h"

    14

#include "network/network_data.h"

    15

#include "network/network_client.h"

    16

#include "network/network_server.h"

    17

#include "network/network_udp.h"

    18

#include "command_func.h"

    19

#include "settings.h"

    20

#include "fios.h"

    21

#include "fileio.h"

    22

#include "vehicle.h"

    23

#include "station.h"

    24

#include "screenshot.h"

    25

#include "genworld.h"

    26

#include "network/network.h"

    27

#include "strings_func.h"

    28

#include "viewport.h"

    29

#include "window_func.h"

    30

#include "functions.h"

    31

#include "map_func.h"

    33

    34

// ** scriptfile handling ** //

    35

static FILE *_script_file;

    36

static bool _script_running;

    37

    38

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

    39

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

    40

#define DEF_CONSOLE_HOOK(function) static bool function()

    41

    42

    43

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

    44

/* variable and command hooks   */

    45

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

    46

    47

#ifdef ENABLE_NETWORK

    48

    49

static inline bool NetworkAvailable()

    50

{

    51

	if (!_network_available) {

    52

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

    53

		return false;

    54

	}

    55

	return true;

    56

}

    57

    58

DEF_CONSOLE_HOOK(ConHookServerOnly)

    59

{

    60

	if (!NetworkAvailable()) return false;

    61

    62

	if (!_network_server) {

    63

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

    64

		return false;

    65

	}

    66

	return true;

    67

}

    68

    69

DEF_CONSOLE_HOOK(ConHookClientOnly)

    70

{

    71

	if (!NetworkAvailable()) return false;

    72

    73

	if (_network_server) {

    74

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

    75

		return false;

    76

	}

    77

	return true;

    78

}

    79

    80

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    81

{

    82

	if (!NetworkAvailable()) return false;

    83

    84

	if (!_networking) {

    85

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

    86

		return false;

    87

	}

    88

	return true;

    89

}

    90

    91

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    92

{

    93

	if (_networking) {

    94

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

    95

		return false;

    96

	}

    97

	return true;

    98

}

    99

   100

#endif /* ENABLE_NETWORK */

   101

   102

static void IConsoleHelp(const char *str)

   103

{

   104

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

   105

}

   106

   107

DEF_CONSOLE_CMD(ConResetEngines)

   108

{

   109

	if (argc == 0) {

   110

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

   111

		return true;

   112

	}

   113

   114

	StartupEngines();

   115

	return true;

   116

}

   117

   118

#ifdef _DEBUG

   119

DEF_CONSOLE_CMD(ConResetTile)

   120

{

   121

	if (argc == 0) {

   122

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

   123

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

   124

		return true;

   125

	}

   126

   127

	if (argc == 2) {

   128

		uint32 result;

   129

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

   130

			DoClearSquare((TileIndex)result);

   131

			return true;

   132

		}

   133

	}

   134

   135

	return false;

   136

}

   137

   138

DEF_CONSOLE_CMD(ConStopAllVehicles)

   139

{

   140

	Vehicle* v;

   141

	if (argc == 0) {

   142

		IConsoleHelp("Stops all vehicles in the game. For debugging only! Use at your own risk... Usage: 'stopall'");

   143

		return true;

   144

	}

   145

   146

	FOR_ALL_VEHICLES(v) {

   147

		/* Code ripped from CmdStartStopTrain. Can't call it, because of

   148

		 * ownership problems, so we'll duplicate some code, for now */

   149

		v->vehstatus |= VS_STOPPED;

   150

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   151

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   152

	}

   153

	return true;

   154

}

   155

#endif /* _DEBUG */

   156

   157

DEF_CONSOLE_CMD(ConScrollToTile)

   158

{

   159

	if (argc == 0) {

   160

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

   161

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

   162

		return true;

   163

	}

   164

   165

	if (argc == 2) {

   166

		uint32 result;

   167

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

   168

			if (result >= MapSize()) {

   169

				IConsolePrint(_icolour_err, "Tile does not exist");

   170

				return true;

   171

			}

   172

			ScrollMainWindowToTile((TileIndex)result);

   173

			return true;

   174

		}

   175

	}

   176

   177

	return false;

   178

}

   179

   180

extern void BuildFileList();

   181

extern void SetFiosType(const byte fiostype);

   182

   183

/* Save the map to a file */

   184

DEF_CONSOLE_CMD(ConSave)

   185

{

   186

	if (argc == 0) {

   187

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

   188

		return true;

   189

	}

   190

   191

	if (argc == 2) {

   192

		char *filename = str_fmt("%s.sav", argv[1]);

   193

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

   194

   195

		if (SaveOrLoad(filename, SL_SAVE, SAVE_DIR) != SL_OK) {

   196

			IConsolePrint(_icolour_err, "Saving map failed");

   197

		} else {

   198

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

   199

		}

   200

		free(filename);

   201

		return true;

   202

	}

   203

   204

	return false;

   205

}

   206

   207

/* Explicitly save the configuration */

   208

DEF_CONSOLE_CMD(ConSaveConfig)

   209

{

   210

	if (argc == 0) {

   211

		IConsoleHelp("Saves the current config, typically to 'openttd.cfg'.");

   212

		return true;

   213

	}

   214

   215

	SaveToConfig();

   216

	IConsolePrint(_icolour_def, "Saved config.");

   217

	return true;

   218

}

   219

   220

static const FiosItem* GetFiosItem(const char* file)

   221

{

   222

	int i;

   223

   224

	_saveload_mode = SLD_LOAD_GAME;

   225

	BuildFileList();

   226

   227

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

   228

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

   229

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

   230

	}

   231

   232

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

   233

		char* endptr;

   234

   235

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

   236

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

   237

	}

   238

   239

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

   240

}

   241

   242

   243

DEF_CONSOLE_CMD(ConLoad)

   244

{

   245

	const FiosItem *item;

   246

	const char *file;

   247

   248

	if (argc == 0) {

   249

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

   250

		return true;

   251

	}

   252

   253

	if (argc != 2) return false;

   254

   255

	file = argv[1];

   256

	item = GetFiosItem(file);

   257

	if (item != NULL) {

   258

		switch (item->type) {

   259

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   260

				_switch_mode = SM_LOAD;

   261

				SetFiosType(item->type);

   262

   263

				ttd_strlcpy(_file_to_saveload.name, FiosBrowseTo(item), sizeof(_file_to_saveload.name));

   264

				ttd_strlcpy(_file_to_saveload.title, item->title, sizeof(_file_to_saveload.title));

   265

			} break;

   266

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

   267

		}

   268

	} else {

   269

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

   270

	}

   271

   272

	FiosFreeSavegameList();

   273

	return true;

   274

}

   275

   276

   277

DEF_CONSOLE_CMD(ConRemove)

   278

{

   279

	const FiosItem* item;

   280

	const char* file;

   281

   282

	if (argc == 0) {

   283

		IConsoleHelp("Remove a savegame by name or index. Usage: 'rm <file | number>'");

   284

		return true;

   285

	}

   286

   287

	if (argc != 2) return false;

   288

   289

	file = argv[1];

   290

	item = GetFiosItem(file);

   291

	if (item != NULL) {

   292

		if (!FiosDelete(item->name))

   293

			IConsolePrintF(_icolour_err, "%s: Failed to delete file", file);

   294

	} else {

   295

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

   296

	}

   297

   298

	FiosFreeSavegameList();

   299

	return true;

   300

}

   301

   302

   303

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

   304

DEF_CONSOLE_CMD(ConListFiles)

   305

{

   306

	int i;

   307

   308

	if (argc == 0) {

   309

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

   310

		return true;

   311

	}

   312

   313

	BuildFileList();

   314

   315

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

   316

		const FiosItem *item = &_fios_list[i];

   317

		IConsolePrintF(_icolour_def, "%d) %s", i, item->title);

   318

	}

   319

   320

	FiosFreeSavegameList();

   321

	return true;

   322

}

   323

   324

/* Change the dir via console */

   325

DEF_CONSOLE_CMD(ConChangeDirectory)

   326

{

   327

	const FiosItem *item;

   328

	const char *file;

   329

   330

	if (argc == 0) {

   331

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

   332

		return true;

   333

	}

   334

   335

	if (argc != 2) return false;

   336

   337

	file = argv[1];

   338

	item = GetFiosItem(file);

   339

	if (item != NULL) {

   340

		switch (item->type) {

   341

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   342

				FiosBrowseTo(item);

   343

				break;

   344

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

   345

		}

   346

	} else {

   347

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

   348

	}

   349

   350

	FiosFreeSavegameList();

   351

	return true;

   352

}

   353

   354

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   355

{

   356

	const char *path;

   357

   358

	if (argc == 0) {

   359

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

   360

		return true;

   361

	}

   362

   363

	// XXX - Workaround for broken file handling

   364

	FiosGetSavegameList(SLD_LOAD_GAME);

   365

	FiosFreeSavegameList();

   366

   367

	FiosGetDescText(&path, NULL);

   368

	IConsolePrint(_icolour_def, path);

   369

	return true;

   370

}

   371

   372

DEF_CONSOLE_CMD(ConClearBuffer)

   373

{

   374

	if (argc == 0) {

   375

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

   376

		return true;

   377

	}

   378

   379

	IConsoleClearBuffer();

   380

	InvalidateWindow(WC_CONSOLE, 0);

   381

	return true;

   382

}

   383

   384

   385

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

   386

// * Network Core Console Commands * //

   387

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

   388

#ifdef ENABLE_NETWORK

   389

   390

DEF_CONSOLE_CMD(ConBan)

   391

{

   392

	NetworkClientInfo *ci;

   393

	const char *banip = NULL;

   394

	uint32 index;

   395

   396

	if (argc == 0) {

   397

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

   398

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

   399

		IConsoleHelp("If the client is no longer online, you can still ban his/her IP");

   400

		return true;

   401

	}

   402

   403

	if (argc != 2) return false;

   404

   405

	if (strchr(argv[1], '.') == NULL) { // banning with ID

   406

		index = atoi(argv[1]);

   407

		ci = NetworkFindClientInfoFromIndex(index);

   408

	} else { // banning IP

   409

		ci = NetworkFindClientInfoFromIP(argv[1]);

   410

		if (ci == NULL) {

   411

			banip = argv[1];

   412

			index = (uint32)-1;

   413

		} else {

   414

			index = ci->client_index;

   415

		}

   416

	}

   417

   418

	if (index == NETWORK_SERVER_INDEX) {

   419

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

   420

		return true;

   421

	}

   422

   423

	if (index == 0 || (ci == NULL && index != (uint32)-1)) {

   424

		IConsoleError("Invalid client");

   425

		return true;

   426

	}

   427

   428

	if (ci != NULL) {

   429

		banip = inet_ntoa(*(struct in_addr *)&ci->client_ip);

   430

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

   431

		IConsolePrint(_icolour_def, "Client banned");

   432

	} else {

   433

		IConsolePrint(_icolour_def, "Client not online, banned IP");

   434

	}

   435

   436

	/* Add user to ban-list */

   437

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

   438

		if (_network_ban_list[index] == NULL) {

   439

			_network_ban_list[index] = strdup(banip);

   440

			break;

   441

		}

   442

	}

   443

   444

	return true;

   445

}

   446

   447

DEF_CONSOLE_CMD(ConUnBan)

   448

{

   449

	uint i, index;

   450

   451

	if (argc == 0) {

   452

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

   453

		IConsoleHelp("For a list of banned IP's, see the command 'banlist'");

   454

		return true;

   455

	}

   456

   457

	if (argc != 2) return false;

   458

   459

	index = (strchr(argv[1], '.') == NULL) ? atoi(argv[1]) : 0;

   460

	index--;

   461

   462

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

   463

		if (_network_ban_list[i] == NULL) continue;

   464

   465

		if (strcmp(_network_ban_list[i], argv[1]) == 0 || index == i) {

   466

			free(_network_ban_list[i]);

   467

			_network_ban_list[i] = NULL;

   468

			IConsolePrint(_icolour_def, "IP unbanned.");

   469

			return true;

   470

		}

   471

	}

   472

   473

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

   474

	return true;

   475

}

   476

   477

DEF_CONSOLE_CMD(ConBanList)

   478

{

   479

	uint i;

   480

   481

	if (argc == 0) {

   482

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