1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "console.h"

     6

#include "debug.h"

     7

#include "engine.h"

     8

#include "functions.h"

     9

#include "saveload.h"

    10

#include "string.h"

    11

#include "variables.h"

    12

#include "network_data.h"

    13

#include "network_client.h"

    14

#include "network_server.h"

    15

#include "network_udp.h"

    16

#include "command.h"

    17

#include "settings.h"

    18

#include "fios.h"

    19

#include "vehicle.h"

    20

#include "station.h"

    21

#include "strings.h"

    22

#include "screenshot.h"

    23

#include "genworld.h"

    24

#include "date.h"

    26

    27

// ** scriptfile handling ** //

    28

static FILE *_script_file;

    29

static bool _script_running;

    30

    31

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

    32

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

    33

#define DEF_CONSOLE_HOOK(function) static bool function(void)

    34

    35

    36

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

    37

/* variable and command hooks   */

    38

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

    39

    40

#ifdef ENABLE_NETWORK

    41

    42

static inline bool NetworkAvailable(void)

    43

{

    44

	if (!_network_available) {

    45

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

    46

		return false;

    47

	}

    48

	return true;

    49

}

    50

    51

DEF_CONSOLE_HOOK(ConHookServerOnly)

    52

{

    53

	if (!NetworkAvailable()) return false;

    54

    55

	if (!_network_server) {

    56

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

    57

		return false;

    58

	}

    59

	return true;

    60

}

    61

    62

DEF_CONSOLE_HOOK(ConHookClientOnly)

    63

{

    64

	if (!NetworkAvailable()) return false;

    65

    66

	if (_network_server) {

    67

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

    68

		return false;

    69

	}

    70

	return true;

    71

}

    72

    73

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    74

{

    75

	if (!NetworkAvailable()) return false;

    76

    77

	if (!_networking) {

    78

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

    79

		return false;

    80

	}

    81

	return true;

    82

}

    83

    84

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    85

{

    86

	if (_networking) {

    87

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

    88

		return false;

    89

	}

    90

	return true;

    91

}

    92

    93

#endif /* ENABLE_NETWORK */

    94

    95

static void IConsoleHelp(const char *str)

    96

{

    97

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

    98

}

    99

   100

DEF_CONSOLE_CMD(ConResetEngines)

   101

{

   102

	if (argc == 0) {

   103

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

   104

		return true;

   105

	}

   106

   107

	StartupEngines();

   108

	return true;

   109

}

   110

   111

#ifdef _DEBUG

   112

DEF_CONSOLE_CMD(ConResetTile)

   113

{

   114

	if (argc == 0) {

   115

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

   116

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

   117

		return true;

   118

	}

   119

   120

	if (argc == 2) {

   121

		uint32 result;

   122

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

   123

			DoClearSquare((TileIndex)result);

   124

			return true;

   125

		}

   126

	}

   127

   128

	return false;

   129

}

   130

   131

DEF_CONSOLE_CMD(ConStopAllVehicles)

   132

{

   133

	Vehicle* v;

   134

	if (argc == 0) {

   135

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

   136

		return true;

   137

	}

   138

   139

	FOR_ALL_VEHICLES(v) {

   140

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

   141

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

   142

		if (v->type == VEH_Train)

   143

			v->u.rail.days_since_order_progr = 0;

   144

		v->vehstatus |= VS_STOPPED;

   145

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

   146

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   147

	}

   148

	return true;

   149

}

   150

#endif /* _DEBUG */

   151

   152

DEF_CONSOLE_CMD(ConScrollToTile)

   153

{

   154

	if (argc == 0) {

   155

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

   156

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

   157

		return true;

   158

	}

   159

   160

	if (argc == 2) {

   161

		uint32 result;

   162

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

   163

			if (result >= MapSize()) {

   164

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

   165

				return true;

   166

			}

   167

			ScrollMainWindowToTile((TileIndex)result);

   168

			return true;

   169

		}

   170

	}

   171

   172

	return false;

   173

}

   174

   175

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm);

   176

extern void BuildFileList(void);

   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 buf[200];

   189

   190

		snprintf(buf, lengthof(buf), "%s%s%s.sav", _path.save_dir, PATHSEP, argv[1]);

   191

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

   192

   193

		if (SaveOrLoad(buf, SL_SAVE) != SL_OK) {

   194

			IConsolePrint(_icolour_err, "SaveMap failed");

   195

		} else {

   196

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

   197

		}

   198

		return true;

   199

	}

   200

   201

	return false;

   202

}

   203

   204

static const FiosItem* GetFiosItem(const char* file)

   205

{

   206

	int i;

   207

   208

	_saveload_mode = SLD_LOAD_GAME;

   209

	BuildFileList();

   210

   211

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

   212

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

   213

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

   214

	}

   215

   216

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

   217

		char* endptr;

   218

   219

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

   220

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

   221

	}

   222

   223

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

   224

}

   225

   226

   227

DEF_CONSOLE_CMD(ConLoad)

   228

{

   229

	const FiosItem *item;

   230

	const char *file;

   231

   232

	if (argc == 0) {

   233

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

   234

		return true;

   235

	}

   236

   237

	if (argc != 2) return false;

   238

   239

	file = argv[1];

   240

	item = GetFiosItem(file);

   241

	if (item != NULL) {

   242

		switch (item->type) {

   243

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   244

				_switch_mode = SM_LOAD;

   245

				SetFiosType(item->type);

   246

   247

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

   248

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

   249

			} break;

   250

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

   251

		}

   252

	} else {

   253

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

   254

	}

   255

   256

	FiosFreeSavegameList();

   257

	return true;

   258

}

   259

   260

   261

DEF_CONSOLE_CMD(ConRemove)

   262

{

   263

	const FiosItem* item;

   264

	const char* file;

   265

   266

	if (argc == 0) {

   267

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

   268

		return true;

   269

	}

   270

   271

	if (argc != 2) return false;

   272

   273

	file = argv[1];

   274

	item = GetFiosItem(file);

   275

	if (item != NULL) {

   276

		if (!FiosDelete(item->name))

   277

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

   278

	} else {

   279

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

   280

	}

   281

   282

	FiosFreeSavegameList();

   283

	return true;

   284

}

   285

   286

   287

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

   288

DEF_CONSOLE_CMD(ConListFiles)

   289

{

   290

	int i;

   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 (i = 0; i < _fios_num; i++) {

   300

		const FiosItem *item = &_fios_list[i];

   301

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

   302

	}

   303

   304

	FiosFreeSavegameList();

   305

	return true;

   306

}

   307

   308

/* Change the dir via console */

   309

DEF_CONSOLE_CMD(ConChangeDirectory)

   310

{

   311

	const FiosItem *item;

   312

	const char *file;

   313

   314

	if (argc == 0) {

   315

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

   316

		return true;

   317

	}

   318

   319

	if (argc != 2) return false;

   320

   321

	file = argv[1];

   322

	item = GetFiosItem(file);

   323

	if (item != NULL) {

   324

		switch (item->type) {

   325

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   326

				FiosBrowseTo(item);

   327

				break;

   328

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

   329

		}

   330

	} else {

   331

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

   332

	}

   333

   334

	FiosFreeSavegameList();

   335

	return true;

   336

}

   337

   338

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   339

{

   340

	const char *path;

   341

   342

	if (argc == 0) {

   343

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

   344

		return true;

   345

	}

   346

   347

	// XXX - Workaround for broken file handling

   348

	FiosGetSavegameList(SLD_LOAD_GAME);

   349

	FiosFreeSavegameList();

   350

   351

	FiosGetDescText(&path, NULL);

   352

	IConsolePrint(_icolour_def, path);

   353

	return true;

   354

}

   355

   356

DEF_CONSOLE_CMD(ConClearBuffer)

   357

{

   358

	if (argc == 0) {

   359

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

   360

		return true;

   361

	}

   362

   363

	IConsoleClearBuffer();

   364

	InvalidateWindow(WC_CONSOLE, 0);

   365

	return true;

   366

}

   367

   368

   369

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

   370

// * Network Core Console Commands * //

   371

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

   372

#ifdef ENABLE_NETWORK

   373

   374

DEF_CONSOLE_CMD(ConBan)

   375

{

   376

	NetworkClientInfo *ci;

   377

	const char *banip = NULL;

   378

	uint32 index;

   379

   380

	if (argc == 0) {

   381

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

   382

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

   383

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

   384

		return true;

   385

	}

   386

   387

	if (argc != 2) return false;

   388

   389

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

   390

		index = atoi(argv[1]);

   391

		ci = NetworkFindClientInfoFromIndex(index);

   392

	} else { // banning IP

   393

		ci = NetworkFindClientInfoFromIP(argv[1]);

   394

		if (ci == NULL) {

   395

			banip = argv[1];

   396

			index = (uint32)-1;

   397

		} else {

   398

			index = ci->client_index;

   399

		}

   400

	}

   401

   402

	if (index == NETWORK_SERVER_INDEX) {

   403

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

   404

		return true;

   405

	}

   406

   407

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

   408

		IConsoleError("Invalid client");

   409

		return true;

   410

	}

   411

   412

	if (ci != NULL) {

   413

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

   414

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

   415

		IConsolePrint(_icolour_def, "Client banned");

   416

	} else {

   417

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

   418

	}

   419

   420

	/* Add user to ban-list */

   421

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

   422

		if (_network_ban_list[index] == NULL) {

   423

			_network_ban_list[index] = strdup(banip);

   424

			break;

   425

		}

   426

	}

   427

   428

	return true;

   429

}

   430

   431

DEF_CONSOLE_CMD(ConUnBan)

   432

{

   433

	uint i, index;

   434

   435

	if (argc == 0) {

   436

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

   437

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

   438

		return true;

   439

	}

   440

   441

	if (argc != 2) return false;

   442

   443

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

   444

	index--;

   445

   446

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

   447

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

   448

   449

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

   450

			free(_network_ban_list[i]);

   451

			_network_ban_list[i] = NULL;

   452

			IConsolePrint(_icolour_def, "IP unbanned.");

   453

			return true;

   454

		}

   455

	}

   456

   457

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

   458

	return true;

   459

}

   460

   461

DEF_CONSOLE_CMD(ConBanList)

   462

{

   463

	uint i;

   464

   465

	if (argc == 0) {

   466

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

   467

		return true;

   468

	}

   469

   470

	IConsolePrint(_icolour_def, "Banlist: ");

   471

   472

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

   473

		if (_network_ban_list[i] != NULL)

   474

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

   475

	}

   476

   477

	return true;

   478

}

   479

   480

DEF_CONSOLE_CMD(ConPauseGame)

   481

{

   482

	if (argc == 0) {