1

/* $Id$ */

     2

     3

/** @file console_cmds.cpp Implementation of the console hooks. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "console_internal.h"

     8

#include "debug.h"

     9

#include "engine_func.h"

    10

#include "landscape.h"

    11

#include "saveload.h"

    12

#include "variables.h"

    13

#include "network/network.h"

    14

#include "network/network_func.h"

    15

#include "command_func.h"

    16

#include "settings_func.h"

    17

#include "fios.h"

    18

#include "fileio.h"

    19

#include "screenshot.h"

    20

#include "genworld.h"

    21

#include "strings_func.h"

    22

#include "viewport_func.h"

    23

#include "window_func.h"

    24

#include "functions.h"

    25

#include "map_func.h"

    26

#include "date_func.h"

    27

#include "vehicle_func.h"

    28

#include "string_func.h"

    29

#include "player_func.h"

    30

#include "player_base.h"

    31

#include "settings_type.h"

    32

    33

#ifdef ENABLE_NETWORK

    34

	#include "table/strings.h"

    35

#endif /* ENABLE_NETWORK */

    36

    37

// ** scriptfile handling ** //

    38

static FILE *_script_file;

    39

static bool _script_running;

    40

    41

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

    42

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

    43

#define DEF_CONSOLE_HOOK(function) static bool function()

    44

    45

    46

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

    47

/* variable and command hooks   */

    48

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

    49

    50

#ifdef ENABLE_NETWORK

    51

    52

static inline bool NetworkAvailable()

    53

{

    54

	if (!_network_available) {

    55

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

    56

		return false;

    57

	}

    58

	return true;

    59

}

    60

    61

DEF_CONSOLE_HOOK(ConHookServerOnly)

    62

{

    63

	if (!NetworkAvailable()) return false;

    64

    65

	if (!_network_server) {

    66

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

    67

		return false;

    68

	}

    69

	return true;

    70

}

    71

    72

DEF_CONSOLE_HOOK(ConHookClientOnly)

    73

{

    74

	if (!NetworkAvailable()) return false;

    75

    76

	if (_network_server) {

    77

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

    78

		return false;

    79

	}

    80

	return true;

    81

}

    82

    83

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    84

{

    85

	if (!NetworkAvailable()) return false;

    86

    87

	if (!_networking) {

    88

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

    89

		return false;

    90

	}

    91

	return true;

    92

}

    93

    94

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    95

{

    96

	if (_networking) {

    97

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

    98

		return false;

    99

	}

   100

	return true;

   101

}

   102

   103

#endif /* ENABLE_NETWORK */

   104

   105

static void IConsoleHelp(const char *str)

   106

{

   107

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

   108

}

   109

   110

DEF_CONSOLE_CMD(ConResetEngines)

   111

{

   112

	if (argc == 0) {

   113

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

   114

		return true;

   115

	}

   116

   117

	StartupEngines();

   118

	return true;

   119

}

   120

   121

#ifdef _DEBUG

   122

DEF_CONSOLE_CMD(ConResetTile)

   123

{

   124

	if (argc == 0) {

   125

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

   126

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

   127

		return true;

   128

	}

   129

   130

	if (argc == 2) {

   131

		uint32 result;

   132

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

   133

			DoClearSquare((TileIndex)result);

   134

			return true;

   135

		}

   136

	}

   137

   138

	return false;

   139

}

   140

   141

DEF_CONSOLE_CMD(ConStopAllVehicles)

   142

{

   143

	if (argc == 0) {

   144

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

   145

		return true;

   146

	}

   147

   148

	StopAllVehicles();

   149

	return true;

   150

}

   151

#endif /* _DEBUG */

   152

   153

DEF_CONSOLE_CMD(ConScrollToTile)

   154

{

   155

	if (argc == 0) {

   156

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

   157

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

   158

		return true;

   159

	}

   160

   161

	if (argc == 2) {

   162

		uint32 result;

   163

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

   164

			if (result >= MapSize()) {

   165

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

   166

				return true;

   167

			}

   168

			ScrollMainWindowToTile((TileIndex)result);

   169

			return true;

   170

		}

   171

	}

   172

   173

	return false;

   174

}

   175

   176

extern void BuildFileList();

   177

extern void SetFiosType(const byte fiostype);

   178

   179

/* Save the map to a file */

   180

DEF_CONSOLE_CMD(ConSave)

   181

{

   182

	if (argc == 0) {

   183

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

   184

		return true;

   185

	}

   186

   187

	if (argc == 2) {

   188

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

   189

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

   190

   191

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

   192

			IConsolePrint(CC_ERROR, "Saving map failed");

   193

		} else {

   194

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

   195

		}

   196

		free(filename);

   197

		return true;

   198

	}

   199

   200

	return false;

   201

}

   202

   203

/* Explicitly save the configuration */

   204

DEF_CONSOLE_CMD(ConSaveConfig)

   205

{

   206

	if (argc == 0) {

   207

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

   208

		return true;

   209

	}

   210

   211

	SaveToConfig();

   212

	IConsolePrint(CC_DEFAULT, "Saved config.");

   213

	return true;

   214

}

   215

   216

static const FiosItem* GetFiosItem(const char* file)

   217

{

   218

	_saveload_mode = SLD_LOAD_GAME;

   219

	BuildFileList();

   220

   221

	for (const FiosItem *item = _fios_items.Begin(); item != _fios_items.End(); item++) {

   222

		if (strcmp(file, item->name) == 0) return item;

   223

		if (strcmp(file, item->title) == 0) return item;

   224

	}

   225

   226

	/* If no name matches, try to parse it as number */

   227

	char *endptr;

   228

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

   229

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

   230

   231

	return IsInsideMM(i, 0, _fios_items.Length()) ? _fios_items.Get(i) : NULL;

   232

}

   233

   234

   235

DEF_CONSOLE_CMD(ConLoad)

   236

{

   237

	if (argc == 0) {

   238

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

   239

		return true;

   240

	}

   241

   242

	if (argc != 2) return false;

   243

   244

	const char *file = argv[1];

   245

	const FiosItem *item = GetFiosItem(file);

   246

	if (item != NULL) {

   247

		switch (item->type) {

   248

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   249

				_switch_mode = SM_LOAD;

   250

				SetFiosType(item->type);

   251

   252

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

   253

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

   254

			} break;

   255

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

   256

		}

   257

	} else {

   258

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

   259

	}

   260

   261

	FiosFreeSavegameList();

   262

	return true;

   263

}

   264

   265

   266

DEF_CONSOLE_CMD(ConRemove)

   267

{

   268

	if (argc == 0) {

   269

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

   270

		return true;

   271

	}

   272

   273

	if (argc != 2) return false;

   274

   275

	const char *file = argv[1];

   276

	const FiosItem *item = GetFiosItem(file);

   277

	if (item != NULL) {

   278

		if (!FiosDelete(item->name))

   279

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

   280

	} else {

   281

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

   282

	}

   283

   284

	FiosFreeSavegameList();

   285

	return true;

   286

}

   287

   288

   289

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

   290

DEF_CONSOLE_CMD(ConListFiles)

   291

{

   292

	if (argc == 0) {

   293

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

   294

		return true;

   295

	}

   296

   297

	BuildFileList();

   298

   299

	for (uint i = 0; i < _fios_items.Length(); i++) {

   300

		IConsolePrintF(CC_DEFAULT, "%d) %s", i, _fios_items[i].title);

   301

	}

   302

   303

	FiosFreeSavegameList();

   304

	return true;

   305

}

   306

   307

/* Change the dir via console */

   308

DEF_CONSOLE_CMD(ConChangeDirectory)

   309

{

   310

	if (argc == 0) {

   311

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

   312

		return true;

   313

	}

   314

   315

	if (argc != 2) return false;

   316

   317

	const char *file = argv[1];

   318

	const FiosItem *item = GetFiosItem(file);

   319

	if (item != NULL) {

   320

		switch (item->type) {

   321

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   322

				FiosBrowseTo(item);

   323

				break;

   324

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

   325

		}

   326

	} else {

   327

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

   328

	}

   329

   330

	FiosFreeSavegameList();

   331

	return true;

   332

}

   333

   334

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   335

{

   336

	const char *path;

   337

   338

	if (argc == 0) {

   339

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

   340

		return true;

   341

	}

   342

   343

	// XXX - Workaround for broken file handling

   344

	FiosGetSavegameList(SLD_LOAD_GAME);

   345

	FiosFreeSavegameList();

   346

   347

	FiosGetDescText(&path, NULL);

   348

	IConsolePrint(CC_DEFAULT, path);

   349

	return true;

   350

}

   351

   352

DEF_CONSOLE_CMD(ConClearBuffer)

   353

{

   354

	if (argc == 0) {

   355

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

   356

		return true;

   357

	}

   358

   359

	IConsoleClearBuffer();

   360

	InvalidateWindow(WC_CONSOLE, 0);

   361

	return true;

   362

}

   363

   364

   365

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

   366

// * Network Core Console Commands * //

   367

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

   368

#ifdef ENABLE_NETWORK

   369

   370

DEF_CONSOLE_CMD(ConBan)

   371

{

   372

	NetworkClientInfo *ci;

   373

	const char *banip = NULL;

   374

	uint32 index;

   375

   376

	if (argc == 0) {

   377

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

   378

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

   379

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

   380

		return true;

   381

	}

   382

   383

	if (argc != 2) return false;

   384

   385

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

   386

		index = atoi(argv[1]);

   387

		ci = NetworkFindClientInfoFromIndex(index);

   388

	} else { // banning IP

   389

		ci = NetworkFindClientInfoFromIP(argv[1]);

   390

		if (ci == NULL) {

   391

			banip = argv[1];

   392

			index = (uint32)-1;

   393

		} else {

   394

			index = ci->client_index;

   395

		}

   396

	}

   397

   398

	if (index == NETWORK_SERVER_INDEX) {

   399

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

   400

		return true;

   401

	}

   402

   403

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

   404

		IConsoleError("Invalid client");

   405

		return true;

   406

	}

   407

   408

	if (ci != NULL) {

   409

		banip = GetPlayerIP(ci);

   410

		NetworkServerSendError(index, NETWORK_ERROR_KICKED);

   411

		IConsolePrint(CC_DEFAULT, "Client banned");

   412

	} else {

   413

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

   414

	}

   415

   416

	/* Add user to ban-list */

   417

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

   418

		if (_network_ban_list[index] == NULL) {

   419

			_network_ban_list[index] = strdup(banip);

   420

			break;

   421

		}

   422

	}

   423

   424

	return true;

   425

}

   426

   427

DEF_CONSOLE_CMD(ConUnBan)

   428

{

   429

	uint i, index;

   430

   431

	if (argc == 0) {

   432

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

   433

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

   434

		return true;

   435

	}

   436

   437

	if (argc != 2) return false;

   438

   439

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

   440

	index--;

   441

   442

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

   443

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

   444

   445

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

   446

			free(_network_ban_list[i]);

   447

			_network_ban_list[i] = NULL;

   448

			IConsolePrint(CC_DEFAULT, "IP unbanned.");

   449

			return true;

   450

		}

   451

	}

   452

   453

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

   454

	return true;

   455

}

   456

   457

DEF_CONSOLE_CMD(ConBanList)

   458

{

   459

	uint i;

   460

   461

	if (argc == 0) {

   462

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

   463

		return true;

   464

	}

   465

   466

	IConsolePrint(CC_DEFAULT, "Banlist: ");

   467

   468

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

   469

		if (_network_ban_list[i] != NULL)

   470

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

   471

	}

   472

   473

	return true;

   474

}

   475

   476

DEF_CONSOLE_CMD(ConPauseGame)

   477

{

   478

	if (argc == 0) {

   479

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

   480

		return true;

   481

	}