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 "functions.h"

    11

#include "landscape.h"

    12

#include "saveload.h"

    13

#include "string.h"

    14

#include "variables.h"

    15

#include "network/network_data.h"

    16

#include "network/network_client.h"

    17

#include "network/network_server.h"

    18

#include "network/network_udp.h"

    20

#include "settings.h"

    21

#include "fios.h"

    22

#include "fileio.h"

    23

#include "vehicle.h"

    24

#include "station.h"

    25

#include "screenshot.h"

    26

#include "genworld.h"

    27

#include "date.h"

    28

#include "network/network.h"

    29

#include "strings_func.h"

    30

    31

// ** scriptfile handling ** //

    32

static FILE *_script_file;

    33

static bool _script_running;

    34

    35

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

    36

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

    37

#define DEF_CONSOLE_HOOK(function) static bool function()

    38

    39

    40

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

    41

/* variable and command hooks   */

    42

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

    43

    44

#ifdef ENABLE_NETWORK

    45

    46

static inline bool NetworkAvailable()

    47

{

    48

	if (!_network_available) {

    49

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

    50

		return false;

    51

	}

    52

	return true;

    53

}

    54

    55

DEF_CONSOLE_HOOK(ConHookServerOnly)

    56

{

    57

	if (!NetworkAvailable()) return false;

    58

    59

	if (!_network_server) {

    60

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

    61

		return false;

    62

	}

    63

	return true;

    64

}

    65

    66

DEF_CONSOLE_HOOK(ConHookClientOnly)

    67

{

    68

	if (!NetworkAvailable()) return false;

    69

    70

	if (_network_server) {

    71

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

    72

		return false;

    73

	}

    74

	return true;

    75

}

    76

    77

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    78

{

    79

	if (!NetworkAvailable()) return false;

    80

    81

	if (!_networking) {

    82

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

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    89

{

    90

	if (_networking) {

    91

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

    92

		return false;

    93

	}

    94

	return true;

    95

}

    96

    97

#endif /* ENABLE_NETWORK */

    98

    99

static void IConsoleHelp(const char *str)

   100

{

   101

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

   102

}

   103

   104

DEF_CONSOLE_CMD(ConResetEngines)

   105

{

   106

	if (argc == 0) {

   107

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

   108

		return true;

   109

	}

   110

   111

	StartupEngines();

   112

	return true;

   113

}

   114

   115

#ifdef _DEBUG

   116

DEF_CONSOLE_CMD(ConResetTile)

   117

{

   118

	if (argc == 0) {

   119

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

   120

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

   121

		return true;

   122

	}

   123

   124

	if (argc == 2) {

   125

		uint32 result;

   126

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

   127

			DoClearSquare((TileIndex)result);

   128

			return true;

   129

		}

   130

	}

   131

   132

	return false;

   133

}

   134

   135

DEF_CONSOLE_CMD(ConStopAllVehicles)

   136

{

   137

	Vehicle* v;

   138

	if (argc == 0) {

   139

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

   140

		return true;

   141

	}

   142

   143

	FOR_ALL_VEHICLES(v) {

   144

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

   145

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

   146

		v->vehstatus |= VS_STOPPED;

   147

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

   148

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   149

	}

   150

	return true;

   151

}

   152

#endif /* _DEBUG */

   153

   154

DEF_CONSOLE_CMD(ConScrollToTile)

   155

{

   156

	if (argc == 0) {

   157

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

   158

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

   159

		return true;

   160

	}

   161

   162

	if (argc == 2) {

   163

		uint32 result;

   164

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

   165

			if (result >= MapSize()) {

   166

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

   167

				return true;

   168

			}

   169

			ScrollMainWindowToTile((TileIndex)result);

   170

			return true;

   171

		}

   172

	}

   173

   174

	return false;

   175

}

   176

   177

extern void BuildFileList();

   178

extern void SetFiosType(const byte fiostype);

   179

   180

/* Save the map to a file */

   181

DEF_CONSOLE_CMD(ConSave)

   182

{

   183

	if (argc == 0) {

   184

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

   185

		return true;

   186

	}

   187

   188

	if (argc == 2) {

   189

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

   190

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

   191

   192

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

   193

			IConsolePrint(_icolour_err, "Saving map failed");

   194

		} else {

   195

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

   196

		}

   197

		free(filename);

   198

		return true;

   199

	}

   200

   201

	return false;

   202

}

   203

   204

/* Explicitly save the configuration */

   205

DEF_CONSOLE_CMD(ConSaveConfig)

   206

{

   207

	if (argc == 0) {

   208

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

   209

		return true;

   210

	}

   211

   212

	SaveToConfig();

   213

	IConsolePrint(_icolour_def, "Saved config.");

   214

	return true;

   215

}

   216

   217

static const FiosItem* GetFiosItem(const char* file)

   218

{

   219

	int i;

   220

   221

	_saveload_mode = SLD_LOAD_GAME;

   222

	BuildFileList();

   223

   224

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

   225

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

   226

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

   227

	}

   228

   229

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

   230

		char* endptr;

   231

   232

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

   233

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

   234

	}

   235

   236

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

   237

}

   238

   239

   240

DEF_CONSOLE_CMD(ConLoad)

   241

{

   242

	const FiosItem *item;

   243

	const char *file;

   244

   245

	if (argc == 0) {

   246

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

   247

		return true;

   248

	}

   249

   250

	if (argc != 2) return false;

   251

   252

	file = argv[1];

   253

	item = GetFiosItem(file);

   254

	if (item != NULL) {

   255

		switch (item->type) {

   256

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   257

				_switch_mode = SM_LOAD;

   258

				SetFiosType(item->type);

   259

   260

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

   261

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

   262

			} break;

   263

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

   264

		}

   265

	} else {

   266

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

   267

	}

   268

   269

	FiosFreeSavegameList();

   270

	return true;

   271

}

   272

   273

   274

DEF_CONSOLE_CMD(ConRemove)

   275

{

   276

	const FiosItem* item;

   277

	const char* file;

   278

   279

	if (argc == 0) {

   280

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

   281

		return true;

   282

	}

   283

   284

	if (argc != 2) return false;

   285

   286

	file = argv[1];

   287

	item = GetFiosItem(file);

   288

	if (item != NULL) {

   289

		if (!FiosDelete(item->name))

   290

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

   291

	} else {

   292

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

   293

	}

   294

   295

	FiosFreeSavegameList();

   296

	return true;

   297

}

   298

   299

   300

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

   301

DEF_CONSOLE_CMD(ConListFiles)

   302

{

   303

	int i;

   304

   305

	if (argc == 0) {

   306

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

   307

		return true;

   308

	}

   309

   310

	BuildFileList();

   311

   312

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

   313

		const FiosItem *item = &_fios_list[i];

   314

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

   315

	}

   316

   317

	FiosFreeSavegameList();

   318

	return true;

   319

}

   320

   321

/* Change the dir via console */

   322

DEF_CONSOLE_CMD(ConChangeDirectory)

   323

{

   324

	const FiosItem *item;

   325

	const char *file;

   326

   327

	if (argc == 0) {

   328

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

   329

		return true;

   330

	}

   331

   332

	if (argc != 2) return false;

   333

   334

	file = argv[1];

   335

	item = GetFiosItem(file);

   336

	if (item != NULL) {

   337

		switch (item->type) {

   338

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   339

				FiosBrowseTo(item);

   340

				break;

   341

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

   342

		}

   343

	} else {

   344

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

   345

	}

   346

   347

	FiosFreeSavegameList();

   348

	return true;

   349

}

   350

   351

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   352

{

   353

	const char *path;

   354

   355

	if (argc == 0) {

   356

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

   357

		return true;

   358

	}

   359

   360

	// XXX - Workaround for broken file handling

   361

	FiosGetSavegameList(SLD_LOAD_GAME);

   362

	FiosFreeSavegameList();

   363

   364

	FiosGetDescText(&path, NULL);

   365

	IConsolePrint(_icolour_def, path);

   366

	return true;

   367

}

   368

   369

DEF_CONSOLE_CMD(ConClearBuffer)

   370

{

   371

	if (argc == 0) {

   372

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

   373

		return true;

   374

	}

   375

   376

	IConsoleClearBuffer();

   377

	InvalidateWindow(WC_CONSOLE, 0);

   378

	return true;

   379

}

   380

   381

   382

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

   383

// * Network Core Console Commands * //

   384

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

   385

#ifdef ENABLE_NETWORK

   386

   387

DEF_CONSOLE_CMD(ConBan)

   388

{

   389

	NetworkClientInfo *ci;

   390

	const char *banip = NULL;

   391

	uint32 index;

   392

   393

	if (argc == 0) {

   394

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

   395

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

   396

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

   397

		return true;

   398

	}

   399

   400

	if (argc != 2) return false;

   401

   402

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

   403

		index = atoi(argv[1]);

   404

		ci = NetworkFindClientInfoFromIndex(index);

   405

	} else { // banning IP

   406

		ci = NetworkFindClientInfoFromIP(argv[1]);

   407

		if (ci == NULL) {

   408

			banip = argv[1];

   409

			index = (uint32)-1;

   410

		} else {

   411

			index = ci->client_index;

   412

		}

   413

	}

   414

   415

	if (index == NETWORK_SERVER_INDEX) {

   416

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

   417

		return true;

   418

	}

   419

   420

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

   421

		IConsoleError("Invalid client");

   422

		return true;

   423

	}

   424

   425

	if (ci != NULL) {

   426

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

   427

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

   428

		IConsolePrint(_icolour_def, "Client banned");

   429

	} else {

   430

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

   431

	}

   432

   433

	/* Add user to ban-list */

   434

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

   435

		if (_network_ban_list[index] == NULL) {

   436

			_network_ban_list[index] = strdup(banip);

   437

			break;

   438

		}

   439

	}

   440

   441

	return true;

   442

}

   443

   444

DEF_CONSOLE_CMD(ConUnBan)

   445

{

   446

	uint i, index;

   447

   448

	if (argc == 0) {

   449

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

   450

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

   451

		return true;

   452

	}

   453

   454

	if (argc != 2) return false;

   455

   456

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

   457

	index--;

   458

   459

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

   460

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

   461

   462

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

   463

			free(_network_ban_list[i]);

   464

			_network_ban_list[i] = NULL;

   465

			IConsolePrint(_icolour_def, "IP unbanned.");

   466

			return true;

   467

		}

   468

	}

   469

   470

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

   471

	return true;

   472

}

   473

   474

DEF_CONSOLE_CMD(ConBanList)

   475

{

   476

	uint i;

   477

   478

	if (argc == 0) {

   479

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

   480

		return true;

   481

	}

   482