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 "hal.h" /* for file list */

    19

#include "vehicle.h"

    20

#include "station.h"

    21

#include "strings.h"

    22

    23

#ifdef ENABLE_NETWORK

    24

	#include "table/strings.h"

    25

	#include "network.h"

    26

#endif /*ENABLE_NETWORK*/

    27

    28

// ** scriptfile handling ** //

    29

static FILE *_script_file;

    30

static bool _script_running;

    31

    32

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

    33

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

    34

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

    35

    36

    37

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

    38

/* variable and command hooks   */

    39

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

    40

    41

#ifdef ENABLE_NETWORK

    42

    43

static inline bool NetworkAvailable(void)

    44

{

    45

	if (!_network_available) {

    46

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

    47

		return false;

    48

	}

    49

	return true;

    50

}

    51

    52

DEF_CONSOLE_HOOK(ConHookServerOnly)

    53

{

    54

	if (!NetworkAvailable()) return false;

    55

    56

	if (!_network_server) {

    57

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

    58

		return false;

    59

	}

    60

	return true;

    61

}

    62

    63

DEF_CONSOLE_HOOK(ConHookClientOnly)

    64

{

    65

	if (!NetworkAvailable()) return false;

    66

    67

	if (_network_server) {

    68

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

    69

		return false;

    70

	}

    71

	return true;

    72

}

    73

    74

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    75

{

    76

	if (!NetworkAvailable()) return false;

    77

    78

	if (!_networking) {

    79

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

    80

		return false;

    81

	}

    82

	return true;

    83

}

    84

    85

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    86

{

    87

	if (_networking) {

    88

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

    89

		return false;

    90

	}

    91

	return true;

    92

}

    93

    94

#endif /* ENABLE_NETWORK */

    95

    96

static void IConsoleHelp(const char *str)

    97

{

    98

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

    99

}

   100

   101

DEF_CONSOLE_CMD(ConResetEngines)

   102

{

   103

	if (argc == 0) {

   104

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

   105

		return true;

   106

	}

   107

   108

	StartupEngines();

   109

	return true;

   110

}

   111

   112

#ifdef _DEBUG

   113

DEF_CONSOLE_CMD(ConResetTile)

   114

{

   115

	if (argc == 0) {

   116

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

   117

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

   118

		return true;

   119

	}

   120

   121

	if (argc == 2) {

   122

		uint32 result;

   123

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

   124

			DoClearSquare((TileIndex)result);

   125

			return true;

   126

		}

   127

	}

   128

   129

	return false;

   130

}

   131

   132

DEF_CONSOLE_CMD(ConStopAllVehicles)

   133

{

   134

	Vehicle* v;

   135

	if (argc == 0) {

   136

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

   137

		return true;

   138

	}

   139

   140

	FOR_ALL_VEHICLES(v) {

   141

		if (IsValidVehicle(v)) {

   142

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

   143

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

   144

			if (v->type == VEH_Train)

   145

				v->u.rail.days_since_order_progr = 0;

   146

			v->vehstatus |= VS_STOPPED;

   147

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

   148

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   149

		}

   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

			ScrollMainWindowToTile((TileIndex)result);

   167

			return true;

   168

		}

   169

	}

   170

   171

	return false;

   172

}

   173

   174

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

   175

extern void BuildFileList(void);

   176

extern void SetFiosType(const byte fiostype);

   177

   178

/* Save the map to a file */

   179

DEF_CONSOLE_CMD(ConSave)

   180

{

   181

	if (argc == 0) {

   182

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

   183

		return true;

   184

	}

   185

   186

	if (argc == 2) {

   187

		char buf[200];

   188

   189

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

   190

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

   191

   192

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

   193

			IConsolePrint(_icolour_err, "SaveMap failed");

   194

		} else

   195

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

   196

		return true;

   197

	}

   198

   199

	return false;

   200

}

   201

   202

static const FiosItem* GetFiosItem(const char* file)

   203

{

   204

	int i;

   205

   206

	_saveload_mode = SLD_LOAD_GAME;

   207

	BuildFileList();

   208

   209

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

   210

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

   211

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

   212

	}

   213

   214

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

   215

		char* endptr;

   216

   217

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

   218

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

   219

	}

   220

   221

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

   222

}

   223

   224

   225

DEF_CONSOLE_CMD(ConLoad)

   226

{

   227

	const FiosItem *item;

   228

	const char *file;

   229

   230

	if (argc == 0) {

   231

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

   232

		return true;

   233

	}

   234

   235

	if (argc != 2) return false;

   236

   237

	file = argv[1];

   238

	item = GetFiosItem(file);

   239

	if (item != NULL) {

   240

		switch (item->type) {

   241

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   242

				_switch_mode = SM_LOAD;

   243

				SetFiosType(item->type);

   244

   245

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

   246

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

   247

			} break;

   248

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

   249

		}

   250

	} else

   251

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

   252

   253

	FiosFreeSavegameList();

   254

	return true;

   255

}

   256

   257

   258

DEF_CONSOLE_CMD(ConRemove)

   259

{

   260

	const FiosItem* item;

   261

	const char* file;

   262

   263

	if (argc == 0) {

   264

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

   265

		return true;

   266

	}

   267

   268

	if (argc != 2) return false;

   269

   270

	file = argv[1];

   271

	item = GetFiosItem(file);

   272

	if (item != NULL) {

   273

		if (!FiosDelete(item->name))

   274

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

   275

	} else

   276

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

   277

   278

	FiosFreeSavegameList();

   279

	return true;

   280

}

   281

   282

   283

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

   284

DEF_CONSOLE_CMD(ConListFiles)

   285

{

   286

	int i;

   287

   288

	if (argc == 0) {

   289

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

   290

		return true;

   291

	}

   292

   293

	BuildFileList();

   294

   295

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

   296

		const FiosItem *item = &_fios_list[i];

   297

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

   298

	}

   299

   300

	FiosFreeSavegameList();

   301

	return true;

   302

}

   303

   304

/* Change the dir via console */

   305

DEF_CONSOLE_CMD(ConChangeDirectory)

   306

{

   307

	const FiosItem *item;

   308

	const char *file;

   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

	file = argv[1];

   318

	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(_icolour_err, "%s: Not a directory.", file);

   325

		}

   326

	} else

   327

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

   328

   329

	FiosFreeSavegameList();

   330

	return true;

   331

}

   332

   333

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   334

{

   335

	const char *path;

   336

   337

	if (argc == 0) {

   338

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

   339

		return true;

   340

	}

   341

   342

	// XXX - Workaround for broken file handling

   343

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   344

	FiosFreeSavegameList();

   345

   346

	FiosGetDescText(&path, NULL);

   347

	IConsolePrint(_icolour_def, path);

   348

	return true;

   349

}

   350

   351

DEF_CONSOLE_CMD(ConClearBuffer)

   352

{

   353

	if (argc == 0) {

   354

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

   355

		return true;

   356

	}

   357

   358

	IConsoleClearBuffer();

   359

	InvalidateWindow(WC_CONSOLE, 0);

   360

	return true;

   361

}

   362

   363

   364

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

   365

// * Network Core Console Commands * //

   366

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

   367

#ifdef ENABLE_NETWORK

   368

   369

DEF_CONSOLE_CMD(ConBan)

   370

{

   371

	NetworkClientInfo *ci;

   372

	const char *banip = NULL;

   373

	uint32 index;

   374

   375

	if (argc == 0) {

   376

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

   377

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

   378

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

   379

		return true;

   380

	}

   381

   382

	if (argc != 2) return false;

   383

   384

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

   385

		index = atoi(argv[1]);

   386

		ci = NetworkFindClientInfoFromIndex(index);

   387

	} else { // banning IP

   388

		ci = NetworkFindClientInfoFromIP(argv[1]);

   389

		if (ci == NULL) {

   390

			banip = argv[1];

   391

			index = (uint32)-1;

   392

		} else {

   393

			index = ci->client_index;

   394

		}

   395

	}

   396

   397

	if (index == NETWORK_SERVER_INDEX) {

   398

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

   399

		return true;

   400

	}

   401

   402

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

   403

		IConsoleError("Invalid client");

   404

		return true;

   405

	}

   406

   407

	if (ci != NULL) {

   408

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

   409

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

   410

		IConsolePrint(_icolour_def, "Client banned");

   411

	} else

   412

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

   413

   414

	/* Add user to ban-list */

   415

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

   416

		if (_network_ban_list[index] == NULL) {

   417

			_network_ban_list[index] = strdup(banip);

   418

			break;

   419

		}

   420

	}

   421

   422

	return true;

   423

}

   424

   425

DEF_CONSOLE_CMD(ConUnBan)

   426

{

   427

	uint i, index;

   428

   429

	if (argc == 0) {

   430

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

   431

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

   432

		return true;

   433

	}

   434

   435

	if (argc != 2) return false;

   436

   437

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

   438

	index--;

   439

   440

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

   441

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

   442

   444

			free(_network_ban_list[i]);

   445

			_network_ban_list[i] = NULL;

   446

			IConsolePrint(_icolour_def, "IP unbanned.");

   447

			return true;

   448

		}

   449

	}

   450

   451

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

   452

	return true;

   453

}

   454

   455

DEF_CONSOLE_CMD(ConBanList)

   456

{

   457

	uint i;

   458

   459

	if (argc == 0) {

   460

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

   461

		return true;

   462

	}

   463

   464

	IConsolePrint(_icolour_def, "Banlist: ");

   465

   466

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

   467

		if (_network_ban_list[i] != NULL)

   468

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

   469

	}

   470

   471

	return true;

   472

}

   473

   474

DEF_CONSOLE_CMD(ConPauseGame)

   475

{

   476

	if (argc == 0) {

   477

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

   478

		return true;

   479

	}

   480

   481

	if (_pause == 0) {

   482

		DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   483

		IConsolePrint(_icolour_def, "Game paused.");