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

    24

    25

#ifdef ENABLE_NETWORK

    26

	#include "table/strings.h"

    27

	#include "network.h"

    28

#endif /*ENABLE_NETWORK*/

    29

    30

// ** scriptfile handling ** //

    31

static FILE *_script_file;

    32

static bool _script_running;

    33

    34

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

    35

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

    36

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

    37

    38

    39

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

    40

/* variable and command hooks   */

    41

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

    42

    43

#ifdef ENABLE_NETWORK

    44

    45

static inline bool NetworkAvailable(void)

    46

{

    47

	if (!_network_available) {

    48

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

    49

		return false;

    50

	}

    51

	return true;

    52

}

    53

    54

DEF_CONSOLE_HOOK(ConHookServerOnly)

    55

{

    56

	if (!NetworkAvailable()) return false;

    57

    58

	if (!_network_server) {

    59

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

    60

		return false;

    61

	}

    62

	return true;

    63

}

    64

    65

DEF_CONSOLE_HOOK(ConHookClientOnly)

    66

{

    67

	if (!NetworkAvailable()) return false;

    68

    69

	if (_network_server) {

    70

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

    71

		return false;

    72

	}

    73

	return true;

    74

}

    75

    76

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    77

{

    78

	if (!NetworkAvailable()) return false;

    79

    80

	if (!_networking) {

    81

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

    82

		return false;

    83

	}

    84

	return true;

    85

}

    86

    87

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    88

{

    89

	if (_networking) {

    90

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

    91

		return false;

    92

	}

    93

	return true;

    94

}

    95

    96

#endif /* ENABLE_NETWORK */

    97

    98

static void IConsoleHelp(const char *str)

    99

{

   100

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

   101

}

   102

   103

DEF_CONSOLE_CMD(ConResetEngines)

   104

{

   105

	if (argc == 0) {

   106

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

   107

		return true;

   108

	}

   109

   110

	StartupEngines();

   111

	return true;

   112

}

   113

   114

#ifdef _DEBUG

   115

DEF_CONSOLE_CMD(ConResetTile)

   116

{

   117

	if (argc == 0) {

   118

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

   119

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

   120

		return true;

   121

	}

   122

   123

	if (argc == 2) {

   124

		uint32 result;

   125

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

   126

			DoClearSquare((TileIndex)result);

   127

			return true;

   128

		}

   129

	}

   130

   131

	return false;

   132

}

   133

   134

DEF_CONSOLE_CMD(ConStopAllVehicles)

   135

{

   136

	Vehicle* v;

   137

	if (argc == 0) {

   138

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

   139

		return true;

   140

	}

   141

   142

	FOR_ALL_VEHICLES(v) {

   143

		if (IsValidVehicle(v)) {

   144

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

   145

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

   146

			if (v->type == VEH_Train)

   147

				v->u.rail.days_since_order_progr = 0;

   148

			v->vehstatus |= VS_STOPPED;

   149

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

   150

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   151

		}

   152

	}

   153

	return true;

   154

}

   155

#endif /* _DEBUG */

   156

   157

DEF_CONSOLE_CMD(ConScrollToTile)

   158

{

   159

	if (argc == 0) {

   160

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

   161

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

   162

		return true;

   163

	}

   164

   165

	if (argc == 2) {

   166

		uint32 result;

   167

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

   168

			ScrollMainWindowToTile((TileIndex)result);

   169

			return true;

   170

		}

   171

	}

   172

   173

	return false;

   174

}

   175

   176

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

   177

extern void BuildFileList(void);

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

   190

   191

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

   192

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

   193

   194

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

   195

			IConsolePrint(_icolour_err, "SaveMap failed");

   196

		} else {

   197

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

   198

		}

   199

		return true;

   200

	}

   201

   202

	return false;

   203

}

   204

   205

static const FiosItem* GetFiosItem(const char* file)

   206

{

   207

	int i;

   208

   209

	_saveload_mode = SLD_LOAD_GAME;

   210

	BuildFileList();

   211

   212

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

   213

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

   214

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

   215

	}

   216

   217

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

   218

		char* endptr;

   219

   220

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

   221

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

   222

	}

   223

   224

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

   225

}

   226

   227

   228

DEF_CONSOLE_CMD(ConLoad)

   229

{

   230

	const FiosItem *item;

   231

	const char *file;

   232

   233

	if (argc == 0) {

   234

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

   235

		return true;

   236

	}

   237

   238

	if (argc != 2) return false;

   239

   240

	file = argv[1];

   241

	item = GetFiosItem(file);

   242

	if (item != NULL) {

   243

		switch (item->type) {

   244

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   245

				_switch_mode = SM_LOAD;

   246

				SetFiosType(item->type);

   247

   248

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

   249

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

   250

			} break;

   251

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

   252

		}

   253

	} else {

   254

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

   255

	}

   256

   257

	FiosFreeSavegameList();

   258

	return true;

   259

}

   260

   261

   262

DEF_CONSOLE_CMD(ConRemove)

   263

{

   264

	const FiosItem* item;

   265

	const char* file;

   266

   267

	if (argc == 0) {

   268

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

   269

		return true;

   270

	}

   271

   272

	if (argc != 2) return false;

   273

   274

	file = argv[1];

   275

	item = GetFiosItem(file);

   276

	if (item != NULL) {

   277

		if (!FiosDelete(item->name))

   278

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

   279

	} else {

   280

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

   281

	}

   282

   283

	FiosFreeSavegameList();

   284

	return true;

   285

}

   286

   287

   288

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

   289

DEF_CONSOLE_CMD(ConListFiles)

   290

{

   291

	int i;

   292

   293

	if (argc == 0) {

   294

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

   295

		return true;

   296

	}

   297

   298

	BuildFileList();

   299

   300

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

   301

		const FiosItem *item = &_fios_list[i];

   302

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

   303

	}

   304

   305

	FiosFreeSavegameList();

   306

	return true;

   307

}

   308

   309

/* Change the dir via console */

   310

DEF_CONSOLE_CMD(ConChangeDirectory)

   311

{

   312

	const FiosItem *item;

   313

	const char *file;

   314

   315

	if (argc == 0) {

   316

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

   317

		return true;

   318

	}

   319

   320

	if (argc != 2) return false;

   321

   322

	file = argv[1];

   323

	item = GetFiosItem(file);

   324

	if (item != NULL) {

   325

		switch (item->type) {

   326

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   327

				FiosBrowseTo(item);

   328

				break;

   329

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

   330

		}

   331

	} else {

   332

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

   333

	}

   334

   335

	FiosFreeSavegameList();

   336

	return true;

   337

}

   338

   339

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   340

{

   341

	const char *path;

   342

   343

	if (argc == 0) {

   344

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

   345

		return true;

   346

	}

   347

   348

	// XXX - Workaround for broken file handling

   349

	FiosGetSavegameList(SLD_LOAD_GAME);

   350

	FiosFreeSavegameList();

   351

   352

	FiosGetDescText(&path, NULL);

   353

	IConsolePrint(_icolour_def, path);

   354

	return true;

   355

}

   356

   357

DEF_CONSOLE_CMD(ConClearBuffer)

   358

{

   359

	if (argc == 0) {

   360

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

   361

		return true;

   362

	}

   363

   364

	IConsoleClearBuffer();

   365

	InvalidateWindow(WC_CONSOLE, 0);

   366

	return true;

   367

}

   368

   369

   370

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

   371

// * Network Core Console Commands * //

   372

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

   373

#ifdef ENABLE_NETWORK

   374

   375

DEF_CONSOLE_CMD(ConBan)

   376

{

   377

	NetworkClientInfo *ci;

   378

	const char *banip = NULL;

   379

	uint32 index;

   380

   381

	if (argc == 0) {

   382

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

   383

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

   384

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

   385

		return true;

   386

	}

   387

   388

	if (argc != 2) return false;

   389

   390

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

   391

		index = atoi(argv[1]);

   392

		ci = NetworkFindClientInfoFromIndex(index);

   393

	} else { // banning IP

   394

		ci = NetworkFindClientInfoFromIP(argv[1]);

   395

		if (ci == NULL) {

   396

			banip = argv[1];

   397

			index = (uint32)-1;

   398

		} else {

   399

			index = ci->client_index;

   400

		}

   401

	}

   402

   403

	if (index == NETWORK_SERVER_INDEX) {

   404

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

   405

		return true;

   406

	}

   407

   408

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

   409

		IConsoleError("Invalid client");

   410

		return true;

   411

	}

   412

   413

	if (ci != NULL) {

   414

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

   415

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

   416

		IConsolePrint(_icolour_def, "Client banned");

   417

	} else {

   418

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

   419

	}

   420

   421

	/* Add user to ban-list */

   422

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

   423

		if (_network_ban_list[index] == NULL) {

   424

			_network_ban_list[index] = strdup(banip);

   425

			break;

   426

		}

   427

	}

   428

   429

	return true;

   430

}

   431

   432

DEF_CONSOLE_CMD(ConUnBan)

   433

{

   434

	uint i, index;

   435

   436

	if (argc == 0) {

   437

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

   438

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

   439

		return true;

   440

	}

   441

   442

	if (argc != 2) return false;

   443

   444

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

   445

	index--;

   446

   447

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

   448

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

   449

   450

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

   451

			free(_network_ban_list[i]);

   452

			_network_ban_list[i] = NULL;

   453

			IConsolePrint(_icolour_def, "IP unbanned.");

   454

			return true;

   455

		}

   456

	}

   457

   458

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

   459

	return true;

   460

}

   461

   462

DEF_CONSOLE_CMD(ConBanList)

   463

{

   464

	uint i;

   465

   466

	if (argc == 0) {

   467

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

   468

		return true;

   469

	}

   470

   471

	IConsolePrint(_icolour_def, "Banlist: ");

   472

   473

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

   474

		if (_network_ban_list[i] != NULL)

   475

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

   476

	}

   477

   478

	return true;

   479

}

   480

   481

DEF_CONSOLE_CMD(ConPauseGame)

   482

{