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

		}

   197

		return true;

   198

	}

   199

   200

	return false;

   201

}

   202

   203

static const FiosItem* GetFiosItem(const char* file)

   204

{

   205

	int i;

   206

   207

	_saveload_mode = SLD_LOAD_GAME;

   208

	BuildFileList();

   209

   210

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

   211

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

   212

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

   213

	}

   214

   215

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

   216

		char* endptr;

   217

   218

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

   219

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

   220

	}

   221

   222

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

   223

}

   224

   225

   226

DEF_CONSOLE_CMD(ConLoad)

   227

{

   228

	const FiosItem *item;

   229

	const char *file;

   230

   231

	if (argc == 0) {

   232

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

   233

		return true;

   234

	}

   235

   236

	if (argc != 2) return false;

   237

   238

	file = argv[1];

   239

	item = GetFiosItem(file);

   240

	if (item != NULL) {

   241

		switch (item->type) {

   242

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   243

				_switch_mode = SM_LOAD;

   244

				SetFiosType(item->type);

   245

   246

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

   247

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

   248

			} break;

   249

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

   250

		}

   251

	} else {

   252

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

   253

	}

   254

   255

	FiosFreeSavegameList();

   256

	return true;

   257

}

   258

   259

   260

DEF_CONSOLE_CMD(ConRemove)

   261

{

   262

	const FiosItem* item;

   263

	const char* file;

   264

   265

	if (argc == 0) {

   266

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

   267

		return true;

   268

	}

   269

   270

	if (argc != 2) return false;

   271

   272

	file = argv[1];

   273

	item = GetFiosItem(file);

   274

	if (item != NULL) {

   275

		if (!FiosDelete(item->name))

   276

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

   277

	} else {

   278

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

   279

	}

   280

   281

	FiosFreeSavegameList();

   282

	return true;

   283

}

   284

   285

   286

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

   287

DEF_CONSOLE_CMD(ConListFiles)

   288

{

   289

	int i;

   290

   291

	if (argc == 0) {

   292

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

   293

		return true;

   294

	}

   295

   296

	BuildFileList();

   297

   298

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

   299

		const FiosItem *item = &_fios_list[i];

   300

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

   301

	}

   302

   303

	FiosFreeSavegameList();

   304

	return true;

   305

}

   306

   307

/* Change the dir via console */

   308

DEF_CONSOLE_CMD(ConChangeDirectory)

   309

{

   310

	const FiosItem *item;

   311

	const char *file;

   312

   313

	if (argc == 0) {

   314

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

   315

		return true;

   316

	}

   317

   318

	if (argc != 2) return false;

   319

   320

	file = argv[1];

   321

	item = GetFiosItem(file);

   322

	if (item != NULL) {

   323

		switch (item->type) {

   324

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   325

				FiosBrowseTo(item);

   326

				break;

   327

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

   328

		}

   329

	} else {

   330

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

   331

	}

   332

   333

	FiosFreeSavegameList();

   334

	return true;

   335

}

   336

   337

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   338

{

   339

	const char *path;

   340

   341

	if (argc == 0) {

   342

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

   343

		return true;

   344

	}

   345

   346

	// XXX - Workaround for broken file handling

   347

	FiosGetSavegameList(&_fios_num, SLD_LOAD_GAME);

   348

	FiosFreeSavegameList();

   349

   350

	FiosGetDescText(&path, NULL);

   351

	IConsolePrint(_icolour_def, path);

   352

	return true;

   353

}

   354

   355

DEF_CONSOLE_CMD(ConClearBuffer)

   356

{

   357

	if (argc == 0) {

   358

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

   359

		return true;

   360

	}

   361

   362

	IConsoleClearBuffer();

   363

	InvalidateWindow(WC_CONSOLE, 0);

   364

	return true;

   365

}

   366

   367

   368

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

   369

// * Network Core Console Commands * //

   370

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

   371

#ifdef ENABLE_NETWORK

   372

   373

DEF_CONSOLE_CMD(ConBan)

   374

{

   375

	NetworkClientInfo *ci;

   376

	const char *banip = NULL;

   377

	uint32 index;

   378

   379

	if (argc == 0) {

   380

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

   381

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

   382

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

   383

		return true;

   384

	}

   385

   386

	if (argc != 2) return false;

   387

   388

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

   389

		index = atoi(argv[1]);

   390

		ci = NetworkFindClientInfoFromIndex(index);

   391

	} else { // banning IP

   392

		ci = NetworkFindClientInfoFromIP(argv[1]);

   393

		if (ci == NULL) {

   394

			banip = argv[1];

   395

			index = (uint32)-1;

   396

		} else {

   397

			index = ci->client_index;

   398

		}

   399

	}

   400

   401

	if (index == NETWORK_SERVER_INDEX) {

   402

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

   403

		return true;

   404

	}

   405

   406

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

   407

		IConsoleError("Invalid client");

   408

		return true;

   409

	}

   410

   411

	if (ci != NULL) {

   412

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

   413

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

   414

		IConsolePrint(_icolour_def, "Client banned");

   415

	} else {

   416

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

   417

	}

   418

   419

	/* Add user to ban-list */

   420

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

   421

		if (_network_ban_list[index] == NULL) {

   422

			_network_ban_list[index] = strdup(banip);

   423

			break;

   424

		}

   425

	}

   426

   427

	return true;

   428

}

   429

   430

DEF_CONSOLE_CMD(ConUnBan)

   431

{

   432

	uint i, index;

   433

   434

	if (argc == 0) {

   435

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

   436

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

   437

		return true;

   438

	}

   439

   440

	if (argc != 2) return false;

   441

   442

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

   443

	index--;

   444

   445

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

   446

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

   447

   448

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

   449

			free(_network_ban_list[i]);

   450

			_network_ban_list[i] = NULL;

   451

			IConsolePrint(_icolour_def, "IP unbanned.");

   452

			return true;

   453

		}

   454

	}

   455

   456

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

   457

	return true;

   458

}

   459

   460

DEF_CONSOLE_CMD(ConBanList)

   461

{

   462

	uint i;

   463

   464

	if (argc == 0) {

   465

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

   466

		return true;

   467

	}

   468

   469

	IConsolePrint(_icolour_def, "Banlist: ");

   470

   471

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

   472

		if (_network_ban_list[i] != NULL)

   473

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

   474

	}

   475

   476

	return true;

   477

}

   478

   479

DEF_CONSOLE_CMD(ConPauseGame)

   480

{

   481

	if (argc == 0) {

   482

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