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"

    25

    26

#ifdef ENABLE_NETWORK

    27

	#include "table/strings.h"

    28

	#include "network.h"

    29

#endif /*ENABLE_NETWORK*/

    30

    31

// ** scriptfile handling ** //

    32

static FILE *_script_file;

    33

static bool _script_running;

    34

    35

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

    36

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

    37

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

    38

    39

    40

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

    41

/* variable and command hooks   */

    42

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

    43

    44

#ifdef ENABLE_NETWORK

    45

    46

static inline bool NetworkAvailable(void)

    47

{

    48

	if (!_network_available) {

    49

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

    50

		return false;

    51

	}

    52

	return true;

    53

}

    54

    55

DEF_CONSOLE_HOOK(ConHookServerOnly)

    56

{

    57

	if (!NetworkAvailable()) return false;

    58

    59

	if (!_network_server) {

    60

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

    61

		return false;

    62

	}

    63

	return true;

    64

}

    65

    66

DEF_CONSOLE_HOOK(ConHookClientOnly)

    67

{

    68

	if (!NetworkAvailable()) return false;

    69

    70

	if (_network_server) {

    71

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

    72

		return false;

    73

	}

    74

	return true;

    75

}

    76

    77

DEF_CONSOLE_HOOK(ConHookNeedNetwork)

    78

{

    79

	if (!NetworkAvailable()) return false;

    80

    81

	if (!_networking) {

    82

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

    83

		return false;

    84

	}

    85

	return true;

    86

}

    87

    88

DEF_CONSOLE_HOOK(ConHookNoNetwork)

    89

{

    90

	if (_networking) {

    91

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

    92

		return false;

    93

	}

    94

	return true;

    95

}

    96

    97

#endif /* ENABLE_NETWORK */

    98

    99

static void IConsoleHelp(const char *str)

   100

{

   101

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

   102

}

   103

   104

DEF_CONSOLE_CMD(ConResetEngines)

   105

{

   106

	if (argc == 0) {

   107

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

   108

		return true;

   109

	}

   110

   111

	StartupEngines();

   112

	return true;

   113

}

   114

   115

#ifdef _DEBUG

   116

DEF_CONSOLE_CMD(ConResetTile)

   117

{

   118

	if (argc == 0) {

   119

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

   120

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

   121

		return true;

   122

	}

   123

   124

	if (argc == 2) {

   125

		uint32 result;

   126

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

   127

			DoClearSquare((TileIndex)result);

   128

			return true;

   129

		}

   130

	}

   131

   132

	return false;

   133

}

   134

   135

DEF_CONSOLE_CMD(ConStopAllVehicles)

   136

{

   137

	Vehicle* v;

   138

	if (argc == 0) {

   139

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

   140

		return true;

   141

	}

   142

   143

	FOR_ALL_VEHICLES(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

	return true;

   153

}

   154

#endif /* _DEBUG */

   155

   156

DEF_CONSOLE_CMD(ConScrollToTile)

   157

{

   158

	if (argc == 0) {

   159

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

   160

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

   161

		return true;

   162

	}

   163

   164

	if (argc == 2) {

   165

		uint32 result;

   166

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

   167

			if (result >= MapSize()) {

   168

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

   169

				return true;

   170

			}

   171

			ScrollMainWindowToTile((TileIndex)result);

   172

			return true;

   173

		}

   174

	}

   175

   176

	return false;

   177

}

   178

   179

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

   180

extern void BuildFileList(void);

   181

extern void SetFiosType(const byte fiostype);

   182

   183

/* Save the map to a file */

   184

DEF_CONSOLE_CMD(ConSave)

   185

{

   186

	if (argc == 0) {

   187

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

   188

		return true;

   189

	}

   190

   191

	if (argc == 2) {

   192

		char buf[200];

   193

   194

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

   195

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

   196

   197

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

   198

			IConsolePrint(_icolour_err, "SaveMap failed");

   199

		} else {

   200

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

   201

		}

   202

		return true;

   203

	}

   204

   205

	return false;

   206

}

   207

   208

static const FiosItem* GetFiosItem(const char* file)

   209

{

   210

	int i;

   211

   212

	_saveload_mode = SLD_LOAD_GAME;

   213

	BuildFileList();

   214

   215

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

   216

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

   217

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

   218

	}

   219

   220

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

   221

		char* endptr;

   222

   223

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

   224

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

   225

	}

   226

   227

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

   228

}

   229

   230

   231

DEF_CONSOLE_CMD(ConLoad)

   232

{

   233

	const FiosItem *item;

   234

	const char *file;

   235

   236

	if (argc == 0) {

   237

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

   238

		return true;

   239

	}

   240

   241

	if (argc != 2) return false;

   242

   243

	file = argv[1];

   244

	item = GetFiosItem(file);

   245

	if (item != NULL) {

   246

		switch (item->type) {

   247

			case FIOS_TYPE_FILE: case FIOS_TYPE_OLDFILE: {

   248

				_switch_mode = SM_LOAD;

   249

				SetFiosType(item->type);

   250

   251

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

   252

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

   253

			} break;

   254

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

   255

		}

   256

	} else {

   257

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

   258

	}

   259

   260

	FiosFreeSavegameList();

   261

	return true;

   262

}

   263

   264

   265

DEF_CONSOLE_CMD(ConRemove)

   266

{

   267

	const FiosItem* item;

   268

	const char* file;

   269

   270

	if (argc == 0) {

   271

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

   272

		return true;

   273

	}

   274

   275

	if (argc != 2) return false;

   276

   277

	file = argv[1];

   278

	item = GetFiosItem(file);

   279

	if (item != NULL) {

   280

		if (!FiosDelete(item->name))

   281

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

   282

	} else {

   283

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

   284

	}

   285

   286

	FiosFreeSavegameList();

   287

	return true;

   288

}

   289

   290

   291

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

   292

DEF_CONSOLE_CMD(ConListFiles)

   293

{

   294

	int i;

   295

   296

	if (argc == 0) {

   297

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

   298

		return true;

   299

	}

   300

   301

	BuildFileList();

   302

   303

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

   304

		const FiosItem *item = &_fios_list[i];

   305

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

   306

	}

   307

   308

	FiosFreeSavegameList();

   309

	return true;

   310

}

   311

   312

/* Change the dir via console */

   313

DEF_CONSOLE_CMD(ConChangeDirectory)

   314

{

   315

	const FiosItem *item;

   316

	const char *file;

   317

   318

	if (argc == 0) {

   319

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

   320

		return true;

   321

	}

   322

   323

	if (argc != 2) return false;

   324

   325

	file = argv[1];

   326

	item = GetFiosItem(file);

   327

	if (item != NULL) {

   328

		switch (item->type) {

   329

			case FIOS_TYPE_DIR: case FIOS_TYPE_DRIVE: case FIOS_TYPE_PARENT:

   330

				FiosBrowseTo(item);

   331

				break;

   332

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

   333

		}

   334

	} else {

   335

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

   336

	}

   337

   338

	FiosFreeSavegameList();

   339

	return true;

   340

}

   341

   342

DEF_CONSOLE_CMD(ConPrintWorkingDirectory)

   343

{

   344

	const char *path;

   345

   346

	if (argc == 0) {

   347

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

   348

		return true;

   349

	}

   350

   351

	// XXX - Workaround for broken file handling

   352

	FiosGetSavegameList(SLD_LOAD_GAME);

   353

	FiosFreeSavegameList();

   354

   355

	FiosGetDescText(&path, NULL);

   356

	IConsolePrint(_icolour_def, path);

   357

	return true;

   358

}

   359

   360

DEF_CONSOLE_CMD(ConClearBuffer)

   361

{

   362

	if (argc == 0) {

   363

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

   364

		return true;

   365

	}

   366

   367

	IConsoleClearBuffer();

   368

	InvalidateWindow(WC_CONSOLE, 0);

   369

	return true;

   370

}

   371

   372

   373

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

   374

// * Network Core Console Commands * //

   375

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

   376

#ifdef ENABLE_NETWORK

   377

   378

DEF_CONSOLE_CMD(ConBan)

   379

{

   380

	NetworkClientInfo *ci;

   381

	const char *banip = NULL;

   382

	uint32 index;

   383

   384

	if (argc == 0) {

   385

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

   386

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

   387

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

   388

		return true;

   389

	}

   390

   391

	if (argc != 2) return false;

   392

   393

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

   394

		index = atoi(argv[1]);

   395

		ci = NetworkFindClientInfoFromIndex(index);

   396

	} else { // banning IP

   397

		ci = NetworkFindClientInfoFromIP(argv[1]);

   398

		if (ci == NULL) {

   399

			banip = argv[1];

   400

			index = (uint32)-1;

   401

		} else {

   402

			index = ci->client_index;

   403

		}

   404

	}

   405

   406

	if (index == NETWORK_SERVER_INDEX) {

   407

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

   408

		return true;

   409

	}

   410

   411

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

   412

		IConsoleError("Invalid client");

   413

		return true;

   414

	}

   415

   416

	if (ci != NULL) {

   417

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

   418

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

   419

		IConsolePrint(_icolour_def, "Client banned");

   420

	} else {

   421

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

   422

	}

   423

   424

	/* Add user to ban-list */

   425

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

   426

		if (_network_ban_list[index] == NULL) {

   427

			_network_ban_list[index] = strdup(banip);

   428

			break;

   429

		}

   430

	}

   431

   432

	return true;

   433

}

   434

   435

DEF_CONSOLE_CMD(ConUnBan)

   436

{

   437

	uint i, index;

   438

   439

	if (argc == 0) {

   440

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

   441

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

   442

		return true;

   443

	}

   444

   445

	if (argc != 2) return false;

   446

   447

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

   448

	index--;

   449

   450

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

   451

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

   452

   453

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

   454

			free(_network_ban_list[i]);

   455

			_network_ban_list[i] = NULL;

   456

			IConsolePrint(_icolour_def, "IP unbanned.");

   457

			return true;

   458

		}

   459

	}

   460

   461

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

   462

	return true;

   463

}

   464

   465

DEF_CONSOLE_CMD(ConBanList)

   466

{

   467

	uint i;

   468

   469

	if (argc == 0) {

   470

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

   471

		return true;

   472

	}

   473

   474

	IConsolePrint(_icolour_def, "Banlist: ");

   475

   476

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

   477

		if (_network_ban_list[i] != NULL)

   478

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

   479

	}

   480

   481

	return true;

   482

}