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

    13

#include "network/network_data.h"

    14

#include "network/network_client.h"

    15

#include "network/network_server.h"

    16

#include "network/network_udp.h"

    17

#include "command_func.h"

    18

#include "settings_func.h"

    19

#include "fios.h"

    20

#include "fileio.h"

    21

#include "station.h"

    22

#include "screenshot.h"

    23

#include "genworld.h"

    24

#include "network/network.h"

    25

#include "strings_func.h"

    26

#include "viewport.h"

    27

#include "window_func.h"

    28

#include "functions.h"

    29

#include "map_func.h"

    30

#include "date_func.h"

    31

#include "vehicle_func.h"

    32

#include "string_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

	if (argc == 0) {

   141

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

   142

		return true;

   143

	}

   144

   145

	StopAllVehicles();

   146

	return true;

   147

}

   148

#endif /* _DEBUG */

   149

   150

DEF_CONSOLE_CMD(ConScrollToTile)

   151

{

   152

	if (argc == 0) {

   153

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

   154

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

   155

		return true;

   156

	}

   157

   158

	if (argc == 2) {

   159

		uint32 result;

   160

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

   161

			if (result >= MapSize()) {

   162

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

   163

				return true;

   164

			}

   165

			ScrollMainWindowToTile((TileIndex)result);

   166

			return true;

   167

		}

   168

	}

   169

   170

	return false;

   171

}

   172

   173

extern void BuildFileList();

   174

extern void SetFiosType(const byte fiostype);

   175

   176

/* Save the map to a file */

   177

DEF_CONSOLE_CMD(ConSave)

   178

{

   179

	if (argc == 0) {

   180

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

   181

		return true;

   182

	}

   183

   184

	if (argc == 2) {

   185

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

   186

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

   187

   188

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

   189

			IConsolePrint(_icolour_err, "Saving map failed");

   190

		} else {

   191

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

   192

		}

   193

		free(filename);

   194

		return true;

   195

	}

   196

   197

	return false;

   198

}

   199

   200

/* Explicitly save the configuration */

   201

DEF_CONSOLE_CMD(ConSaveConfig)

   202

{

   203

	if (argc == 0) {

   204

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

   205

		return true;

   206

	}

   207

   208

	SaveToConfig();

   209

	IConsolePrint(_icolour_def, "Saved config.");

   210

	return true;

   211

}

   212

   213

static const FiosItem* GetFiosItem(const char* file)

   214

{

   215

	int i;

   216

   217

	_saveload_mode = SLD_LOAD_GAME;

   218

	BuildFileList();

   219

   220

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

   221

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

   222

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

   223

	}

   224

   225

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

   226

		char* endptr;

   227

   228

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

   229

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

   230

	}

   231

   232

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

   233

}

   234

   235

   236

DEF_CONSOLE_CMD(ConLoad)

   237

{

   238

	const FiosItem *item;

   239

	const char *file;

   240

   241

	if (argc == 0) {

   242

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

   243

		return true;

   244

	}

   245

   246

	if (argc != 2) return false;

   247

   248

	file = argv[1];

   249

	item = GetFiosItem(file);

   250

	if (item != NULL) {

   251

		switch (item->type) {

   252

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   253

				_switch_mode = SM_LOAD;

   254

				SetFiosType(item->type);

   255

   256

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

   257

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

   258

			} break;

   259

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

   260

		}

   261

	} else {

   262

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

   263

	}

   264

   265

	FiosFreeSavegameList();

   266

	return true;

   267

}

   268

   269

   270

DEF_CONSOLE_CMD(ConRemove)

   271

{

   272

	const FiosItem* item;

   273

	const char* file;

   274

   275

	if (argc == 0) {

   276

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

   277

		return true;

   278

	}

   279

   280

	if (argc != 2) return false;

   281

   282

	file = argv[1];

   283

	item = GetFiosItem(file);

   284

	if (item != NULL) {

   285

		if (!FiosDelete(item->name))

   286

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

   287

	} else {

   288

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

   289

	}

   290

   291

	FiosFreeSavegameList();

   292

	return true;

   293

}

   294

   295

   296

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

   297

DEF_CONSOLE_CMD(ConListFiles)

   298

{

   299

	int i;

   300

   301

	if (argc == 0) {

   302

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

   303

		return true;

   304

	}

   305

   306

	BuildFileList();

   307

   308

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

   309

		const FiosItem *item = &_fios_list[i];

   310

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

   311

	}

   312

   313

	FiosFreeSavegameList();

   314

	return true;

   315

}

   316

   317

/* Change the dir via console */

   318

DEF_CONSOLE_CMD(ConChangeDirectory)

   319

{

   320

	const FiosItem *item;

   321

	const char *file;

   322

   323

	if (argc == 0) {

   324

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

   325

		return true;

   326

	}

   327

   328

	if (argc != 2) return false;

   329

   330

	file = argv[1];

   331

	item = GetFiosItem(file);

   332

	if (item != NULL) {

   333

		switch (item->type) {

   334

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   335

				FiosBrowseTo(item);

   336

				break;

   337

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

   338

		}

   339

	} else {

   340

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

   341

	}

   342

   343

	FiosFreeSavegameList();

   344

	return true;

   345

}

   346

   347

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   348

{

   349

	const char *path;

   350

   351

	if (argc == 0) {

   352

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

   353

		return true;

   354

	}

   355

   356

	// XXX - Workaround for broken file handling

   357

	FiosGetSavegameList(SLD_LOAD_GAME);

   358

	FiosFreeSavegameList();

   359

   360

	FiosGetDescText(&path, NULL);

   361

	IConsolePrint(_icolour_def, path);

   362

	return true;

   363

}

   364

   365

DEF_CONSOLE_CMD(ConClearBuffer)

   366

{

   367

	if (argc == 0) {

   368

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

   369

		return true;

   370

	}

   371

   372

	IConsoleClearBuffer();

   373

	InvalidateWindow(WC_CONSOLE, 0);

   374

	return true;

   375

}

   376

   377

   378

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

   379

// * Network Core Console Commands * //

   380

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

   381

#ifdef ENABLE_NETWORK

   382

   383

DEF_CONSOLE_CMD(ConBan)

   384

{

   385

	NetworkClientInfo *ci;

   386

	const char *banip = NULL;

   387

	uint32 index;

   388

   389

	if (argc == 0) {

   390

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

   391

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

   392

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

   393

		return true;

   394

	}

   395

   396

	if (argc != 2) return false;

   397

   398

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

   399

		index = atoi(argv[1]);

   400

		ci = NetworkFindClientInfoFromIndex(index);

   401

	} else { // banning IP

   402

		ci = NetworkFindClientInfoFromIP(argv[1]);

   403

		if (ci == NULL) {

   404

			banip = argv[1];

   405

			index = (uint32)-1;

   406

		} else {

   407

			index = ci->client_index;

   408

		}

   409

	}

   410

   411

	if (index == NETWORK_SERVER_INDEX) {

   412

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

   413

		return true;

   414

	}

   415

   416

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

   417

		IConsoleError("Invalid client");

   418

		return true;

   419

	}

   420

   421

	if (ci != NULL) {

   422

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

   423

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

   424

		IConsolePrint(_icolour_def, "Client banned");

   425

	} else {

   426

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

   427

	}

   428

   429

	/* Add user to ban-list */

   430

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

   431

		if (_network_ban_list[index] == NULL) {

   432

			_network_ban_list[index] = strdup(banip);

   433

			break;

   434

		}

   435

	}

   436

   437

	return true;

   438

}

   439

   440

DEF_CONSOLE_CMD(ConUnBan)

   441

{

   442

	uint i, index;

   443

   444

	if (argc == 0) {

   445

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

   446

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

   447

		return true;

   448

	}

   449

   450

	if (argc != 2) return false;

   451

   452

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

   453

	index--;

   454

   455

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

   456

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

   457

   458

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

   459

			free(_network_ban_list[i]);

   460

			_network_ban_list[i] = NULL;

   461

			IConsolePrint(_icolour_def, "IP unbanned.");

   462

			return true;

   463

		}

   464

	}

   465

   466

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

   467

	return true;

   468

}

   469

   470

DEF_CONSOLE_CMD(ConBanList)

   471

{

   472

	uint i;

   473

   474

	if (argc == 0) {

   475

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

   476

		return true;

   477

	}

   478

   479

	IConsolePrint(_icolour_def, "Banlist: ");

   480

   481

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

   482