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"

    19

#include "command_func.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"

    31

    32

// ** scriptfile handling ** //

    33

static FILE *_script_file;

    34

static bool _script_running;

    35

    36

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

    37

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

    38

#define DEF_CONSOLE_HOOK(function) static bool function()

    39

    40

    41

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

    42

/* variable and command hooks   */

    43

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

    44

    45

#ifdef ENABLE_NETWORK

    46

    47

static inline bool NetworkAvailable()

    48

{

    49

	if (!_network_available) {

    50

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

    51

		return false;

    52

	}

    53

	return true;

    54

}

    55

    56

DEF_CONSOLE_HOOK(ConHookServerOnly)

    57

{

    58

	if (!NetworkAvailable()) return false;

    59

    60

	if (!_network_server) {

    61

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

    62

		return false;

    63

	}

    64

	return true;

    65

}

    66

    67

DEF_CONSOLE_HOOK(ConHookClientOnly)

    68

{

    69

	if (!NetworkAvailable()) return false;

    70

    71

	if (_network_server) {

    72

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

    73

		return false;

    74

	}

    75

	return true;

    76

}

    77

    78

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    79

{

    80

	if (!NetworkAvailable()) return false;

    81

    82

	if (!_networking) {

    83

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

    84

		return false;

    85

	}

    86

	return true;

    87

}

    88

    89

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    90

{

    91

	if (_networking) {

    92

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

    93

		return false;

    94

	}

    95

	return true;

    96

}

    97

    98

#endif /* ENABLE_NETWORK */

    99

   100

static void IConsoleHelp(const char *str)

   101

{

   102

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

   103

}

   104

   105

DEF_CONSOLE_CMD(ConResetEngines)

   106

{

   107

	if (argc == 0) {

   108

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

   109

		return true;

   110

	}

   111

   112

	StartupEngines();

   113

	return true;

   114

}

   115

   116

#ifdef _DEBUG

   117

DEF_CONSOLE_CMD(ConResetTile)

   118

{

   119

	if (argc == 0) {

   120

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

   121

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

   122

		return true;

   123

	}

   124

   125

	if (argc == 2) {

   126

		uint32 result;

   127

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

   128

			DoClearSquare((TileIndex)result);

   129

			return true;

   130

		}

   131

	}

   132

   133

	return false;

   134

}

   135

   136

DEF_CONSOLE_CMD(ConStopAllVehicles)

   137

{

   138

	Vehicle* v;

   139

	if (argc == 0) {

   140

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

   141

		return true;

   142

	}

   143

   144

	FOR_ALL_VEHICLES(v) {

   145

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

   146

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

   147

		v->vehstatus |= VS_STOPPED;

   148

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

   149

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   150

	}

   151

	return true;

   152

}

   153

#endif /* _DEBUG */

   154

   155

DEF_CONSOLE_CMD(ConScrollToTile)

   156

{

   157

	if (argc == 0) {

   158

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

   159

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

   160

		return true;

   161

	}

   162

   163

	if (argc == 2) {

   164

		uint32 result;

   165

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

   166

			if (result >= MapSize()) {

   167

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

   168

				return true;

   169

			}

   170

			ScrollMainWindowToTile((TileIndex)result);

   171

			return true;

   172

		}

   173

	}

   174

   175

	return false;

   176

}

   177

   178

extern void BuildFileList();

   179

extern void SetFiosType(const byte fiostype);

   180

   181

/* Save the map to a file */

   182

DEF_CONSOLE_CMD(ConSave)

   183

{

   184

	if (argc == 0) {

   185

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

   186

		return true;

   187

	}

   188

   189

	if (argc == 2) {

   190

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

   191

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

   192

   193

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

   194

			IConsolePrint(_icolour_err, "Saving map failed");

   195

		} else {

   196

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

   197

		}

   198

		free(filename);

   199

		return true;

   200

	}

   201

   202

	return false;

   203

}

   204

   205

/* Explicitly save the configuration */

   206

DEF_CONSOLE_CMD(ConSaveConfig)

   207

{

   208

	if (argc == 0) {

   209

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

   210

		return true;

   211

	}

   212

   213

	SaveToConfig();

   214

	IConsolePrint(_icolour_def, "Saved config.");

   215

	return true;

   216

}

   217

   218

static const FiosItem* GetFiosItem(const char* file)

   219

{

   220

	int i;

   221

   222

	_saveload_mode = SLD_LOAD_GAME;

   223

	BuildFileList();

   224

   225

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

   226

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

   227

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

   228

	}

   229

   230

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

   231

		char* endptr;

   232

   233

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

   234

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

   235

	}

   236

   237

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

   238

}

   239

   240

   241

DEF_CONSOLE_CMD(ConLoad)

   242

{

   243

	const FiosItem *item;

   244

	const char *file;

   245

   246

	if (argc == 0) {

   247

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

   248

		return true;

   249

	}

   250

   251

	if (argc != 2) return false;

   252

   253

	file = argv[1];

   254

	item = GetFiosItem(file);

   255

	if (item != NULL) {

   256

		switch (item->type) {

   257

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   258

				_switch_mode = SM_LOAD;

   259

				SetFiosType(item->type);

   260

   261

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

   262

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

   263

			} break;

   264

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

   265

		}

   266

	} else {

   267

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

   268

	}

   269

   270

	FiosFreeSavegameList();

   271

	return true;

   272

}

   273

   274

   275

DEF_CONSOLE_CMD(ConRemove)

   276

{

   277

	const FiosItem* item;

   278

	const char* file;

   279

   280

	if (argc == 0) {

   281

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

   282

		return true;

   283

	}

   284

   285

	if (argc != 2) return false;

   286

   287

	file = argv[1];

   288

	item = GetFiosItem(file);

   289

	if (item != NULL) {

   290

		if (!FiosDelete(item->name))

   291

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

   292

	} else {

   293

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

   294

	}

   295

   296

	FiosFreeSavegameList();

   297

	return true;

   298

}

   299

   300

   301

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

   302

DEF_CONSOLE_CMD(ConListFiles)

   303

{

   304

	int i;

   305

   306

	if (argc == 0) {

   307

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

   308

		return true;

   309

	}

   310

   311

	BuildFileList();

   312

   313

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

   314

		const FiosItem *item = &_fios_list[i];

   315

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

   316

	}

   317

   318

	FiosFreeSavegameList();

   319

	return true;

   320

}

   321

   322

/* Change the dir via console */

   323

DEF_CONSOLE_CMD(ConChangeDirectory)

   324

{

   325

	const FiosItem *item;

   326

	const char *file;

   327

   328

	if (argc == 0) {

   329

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

   330

		return true;

   331

	}

   332

   333

	if (argc != 2) return false;

   334

   335

	file = argv[1];

   336

	item = GetFiosItem(file);

   337

	if (item != NULL) {

   338

		switch (item->type) {

   339

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   340

				FiosBrowseTo(item);

   341

				break;

   342

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

   343

		}

   344

	} else {

   345

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

   346

	}

   347

   348

	FiosFreeSavegameList();

   349

	return true;

   350

}

   351

   352

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   353

{

   354

	const char *path;

   355

   356

	if (argc == 0) {

   357

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

   358

		return true;

   359

	}

   360

   361

	// XXX - Workaround for broken file handling

   362

	FiosGetSavegameList(SLD_LOAD_GAME);

   363

	FiosFreeSavegameList();

   364

   365

	FiosGetDescText(&path, NULL);

   366

	IConsolePrint(_icolour_def, path);

   367

	return true;

   368

}

   369

   370

DEF_CONSOLE_CMD(ConClearBuffer)

   371

{

   372

	if (argc == 0) {

   373

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

   374

		return true;

   375

	}

   376

   377

	IConsoleClearBuffer();

   378

	InvalidateWindow(WC_CONSOLE, 0);

   379

	return true;

   380

}

   381

   382

   383

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

   384

// * Network Core Console Commands * //

   385

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

   386

#ifdef ENABLE_NETWORK

   387

   388

DEF_CONSOLE_CMD(ConBan)

   389

{

   390

	NetworkClientInfo *ci;

   391

	const char *banip = NULL;

   392

	uint32 index;

   393

   394

	if (argc == 0) {

   395

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

   396

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

   397

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

   398

		return true;

   399

	}

   400

   401

	if (argc != 2) return false;

   402

   403

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

   404

		index = atoi(argv[1]);

   405

		ci = NetworkFindClientInfoFromIndex(index);

   406

	} else { // banning IP

   407

		ci = NetworkFindClientInfoFromIP(argv[1]);

   408

		if (ci == NULL) {

   409

			banip = argv[1];

   410

			index = (uint32)-1;

   411

		} else {

   412

			index = ci->client_index;

   413

		}

   414

	}

   415

   416

	if (index == NETWORK_SERVER_INDEX) {

   417

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

   418

		return true;

   419

	}

   420

   421

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

   422

		IConsoleError("Invalid client");

   423

		return true;

   424

	}

   425

   426

	if (ci != NULL) {

   427

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

   428

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

   429

		IConsolePrint(_icolour_def, "Client banned");

   430

	} else {

   431

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

   432

	}

   433

   434

	/* Add user to ban-list */

   435

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

   436

		if (_network_ban_list[index] == NULL) {

   437

			_network_ban_list[index] = strdup(banip);

   438

			break;

   439

		}

   440

	}

   441

   442

	return true;

   443

}

   444

   445

DEF_CONSOLE_CMD(ConUnBan)

   446

{

   447

	uint i, index;

   448

   449

	if (argc == 0) {

   450

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

   451

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

   452

		return true;

   453

	}

   454

   455

	if (argc != 2) return false;

   456

   457

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

   458

	index--;

   459

   460

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

   461

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

   462

   463

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

   464

			free(_network_ban_list[i]);

   465

			_network_ban_list[i] = NULL;

   466

			IConsolePrint(_icolour_def, "IP unbanned.");

   467

			return true;

   468

		}

   469

	}

   470

   471

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

   472

	return true;

   473

}

   474

   475

DEF_CONSOLE_CMD(ConBanList)

   476

{

   477

	uint i;

   478

   479

	if (argc == 0) {

   480

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

   481

		return true;

   482

	}