1

/* $Id$ */

     2

     3

/** @file fios.cpp

     4

 * This file contains functions for building file lists for the save/load dialogs.

     5

 */

     6

     7

#include "stdafx.h"

     8

#include "openttd.h"

     9

#include "variables.h"

    10

#include "heightmap.h"

    11

#include "fios.h"

    12

#include "fileio.h"

    13

#include "functions.h"

    14

#include "string_func.h"

    15

#include <sys/types.h>

    16

#include <sys/stat.h>

    17

    18

#ifdef WIN32

    19

# include <tchar.h>

    20

# ifndef UNICODE

    21

#  include <io.h>

    22

# endif

    23

# define access _taccess

    24

# define unlink _tunlink

    25

#else

    26

# include <unistd.h>

    27

#endif /* WIN32 */

    28

    29

#include "table/strings.h"

    30

    31

/* Variables to display file lists */

    32

SmallVector<FiosItem, 32> _fios_items;

    33

static char *_fios_path;

    34

SmallFiosItem _file_to_saveload;

    35

    36

/* OS-specific functions are taken from their respective files (win32/unix/os2 .c) */

    37

extern bool FiosIsRoot(const char *path);

    38

extern bool FiosIsValidFile(const char *path, const struct dirent *ent, struct stat *sb);

    39

extern bool FiosIsHiddenFile(const struct dirent *ent);

    40

extern void FiosGetDrives();

    41

extern bool FiosGetDiskFreeSpace(const char *path, uint32 *tot);

    42

    43

/* get the name of an oldstyle savegame */

    44

extern void GetOldSaveGameName(char *title, const char *path, const char *file);

    45

    46

/**

    47

 * Compare two FiosItem's. Used with qsort when sorting the file list.

    48

 * @param a A pointer to the first FiosItem to compare.

    49

 * @param b A pointer to the second FiosItem to compare.

    50

 * @return -1, 0 or 1, depending on how the two items should be sorted.

    51

 */

    52

int CDECL compare_FiosItems(const void *a, const void *b)

    53

{

    54

	const FiosItem *da = (const FiosItem *)a;

    55

	const FiosItem *db = (const FiosItem *)b;

    56

	int r;

    57

    58

	if (_savegame_sort_order & SORT_BY_NAME) {

    59

		r = strcasecmp(da->title, db->title);

    60

	} else {

    61

		r = da->mtime < db->mtime ? -1 : 1;

    62

	}

    63

    64

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    65

	return r;

    66

}

    67

    68

/** Clear the list */

    69

void FiosFreeSavegameList()

    70

{

    71

	_fios_items.Clear();

    72

	_fios_items.Compact();

    73

};

    74

    75

/**

    76

 * Get descriptive texts. Returns the path and free space

    77

 * left on the device

    78

 * @param path string describing the path

    79

 * @param total_free total free space in megabytes, optional (can be NULL)

    80

 * @return StringID describing the path (free space or failure)

    81

 */

    82

StringID FiosGetDescText(const char **path, uint32 *total_free)

    83

{

    84

	*path = _fios_path;

    85

	return FiosGetDiskFreeSpace(*path, total_free) ? STR_4005_BYTES_FREE : STR_4006_UNABLE_TO_READ_DRIVE;

    86

}

    87

    88

/* Browse to a new path based on the passed FiosItem struct

    89

 * @param *item FiosItem object telling us what to do

    90

 * @return a string if we have given a file as a target, otherwise NULL */

    91

char *FiosBrowseTo(const FiosItem *item)

    92

{

    93

	char *path = _fios_path;

    94

    95

	switch (item->type) {

    96

		case FIOS_TYPE_DRIVE:

    97

#if defined(WINCE)

    98

			sprintf(path, PATHSEP "");

    99

#elif defined(WIN32) || defined(__OS2__)

   100

			sprintf(path, "%c:" PATHSEP, item->title[0]);

   101

#endif

   102

		/* Fallthrough */

   103

		case FIOS_TYPE_INVALID:

   104

			break;

   105

   106

		case FIOS_TYPE_PARENT: {

   107

			/* Check for possible NULL ptr (not required for UNIXes, but AmigaOS-alikes) */

   108

			char *s = strrchr(path, PATHSEPCHAR);

   109

			if (s != NULL && s != path) {

   110

				s[0] = '\0'; // Remove last path separator character, so we can go up one level.

   111

			}

   112

			s = strrchr(path, PATHSEPCHAR);

   113

			if (s != NULL) s[1] = '\0'; // go up a directory

   114

#if defined(__MORPHOS__) || defined(__AMIGAOS__)

   115

			/* On MorphOS or AmigaOS paths look like: "Volume:directory/subdirectory" */

   116

			else if ((s = strrchr(path, ':')) != NULL) s[1] = '\0';

   117

#endif

   118

			break;

   119

		}

   120

   121

		case FIOS_TYPE_DIR:

   122

			strcat(path, item->name);

   123

			strcat(path, PATHSEP);

   124

			break;

   125

   126

		case FIOS_TYPE_DIRECT:

   127

			sprintf(path, "%s", item->name);

   128

			break;

   129

   130

		case FIOS_TYPE_FILE:

   131

		case FIOS_TYPE_OLDFILE:

   132

		case FIOS_TYPE_SCENARIO:

   133

		case FIOS_TYPE_OLD_SCENARIO:

   134

		case FIOS_TYPE_PNG:

   135

		case FIOS_TYPE_BMP:

   136

		{

   137

			static char str_buffr[512];

   138

			snprintf(str_buffr, lengthof(str_buffr), "%s%s", path, item->name);

   139

			return str_buffr;

   140

		}

   141

	}

   142

   143

	return NULL;

   144

}

   145

   146

void FiosMakeSavegameName(char *buf, const char *name, size_t size)

   147

{

   148

	const char *extension, *period;

   149

   150

	extension = (_game_mode == GM_EDITOR) ? ".scn" : ".sav";

   151

   152

	/* Don't append the extension if it is already there */

   153

	period = strrchr(name, '.');

   154

	if (period != NULL && strcasecmp(period, extension) == 0) extension = "";

   155

#if  defined(__MORPHOS__) || defined(__AMIGAOS__)

   156

	if (_fios_path != NULL) {

   157

		unsigned char sepchar = _fios_path[(strlen(_fios_path) - 1)];

   158

   159

		if (sepchar != ':' && sepchar != '/') {

   160

			snprintf(buf, size, "%s" PATHSEP "%s%s", _fios_path, name, extension);

   161

		} else {

   162

			snprintf(buf, size, "%s%s%s", _fios_path, name, extension);

   163

		}

   164

	} else {

   165

		snprintf(buf, size, "%s%s", name, extension);

   166

	}

   167

#else

   168

	snprintf(buf, size, "%s" PATHSEP "%s%s", _fios_path, name, extension);

   169

#endif

   170

}

   171

   172

#if defined(WIN32)

   173

# define unlink _tunlink

   174

#endif

   175

   176

bool FiosDelete(const char *name)

   177

{

   178

	char filename[512];

   179

   180

	FiosMakeSavegameName(filename, name, lengthof(filename));

   181

	return unlink(OTTD2FS(filename)) == 0;

   182

}

   183

   184

bool FileExists(const char *filename)

   185

{

   186

#if defined(WINCE)

   187

	/* There is always one platform that doesn't support basic commands... */

   188

	HANDLE hand = CreateFile(OTTD2FS(filename), 0, 0, NULL, OPEN_EXISTING, 0, NULL);

   189

	if (hand == INVALID_HANDLE_VALUE) return 1;

   190

	CloseHandle(hand);

   191

	return 0;

   192

#else

   193

	return access(OTTD2FS(filename), 0) == 0;

   194

#endif

   195

}

   196

   197

typedef FiosType fios_getlist_callback_proc(SaveLoadDialogMode mode, const char *filename, const char *ext, char *title);

   198

   199

/** Create a list of the files in a directory, according to some arbitrary rule.

   200

 *  @param mode The mode we are in. Some modes don't allow 'parent'.

   201

 *  @param callback_proc The function that is called where you need to do the filtering.

   202

 *  @return Return the list of files. */

   203

static FiosItem *FiosGetFileList(SaveLoadDialogMode mode, fios_getlist_callback_proc *callback_proc)

   204

{

   205

	struct stat sb;

   206

	struct dirent *dirent;

   207

	DIR *dir;

   208

	FiosItem *fios;

   209

	int sort_start;

   210

	char d_name[sizeof(fios->name)];

   211

   212

	_fios_items.Clear();

   213

   214

	/* A parent directory link exists if we are not in the root directory */

   215

	if (!FiosIsRoot(_fios_path) && mode != SLD_NEW_GAME) {

   216

		fios = _fios_items.Append();

   217

		fios->type = FIOS_TYPE_PARENT;

   218

		fios->mtime = 0;

   219

		ttd_strlcpy(fios->name, "..", lengthof(fios->name));

   220

		ttd_strlcpy(fios->title, ".. (Parent directory)", lengthof(fios->title));

   221

	}

   222

   223

	/* Show subdirectories */

   224

	if (mode != SLD_NEW_GAME && (dir = ttd_opendir(_fios_path)) != NULL) {

   225

		while ((dirent = readdir(dir)) != NULL) {

   226

			ttd_strlcpy(d_name, FS2OTTD(dirent->d_name), sizeof(d_name));

   227

   228

			/* found file must be directory, but not '.' or '..' */

   229

			if (FiosIsValidFile(_fios_path, dirent, &sb) && (sb.st_mode & S_IFDIR) &&

   230

					(!FiosIsHiddenFile(dirent) || strncasecmp(d_name, PERSONAL_DIR, strlen(d_name)) == 0) &&

   231

					strcmp(d_name, ".") != 0 && strcmp(d_name, "..") != 0) {

   232

				fios = _fios_items.Append();

   233

				fios->type = FIOS_TYPE_DIR;

   234

				fios->mtime = 0;

   235

				ttd_strlcpy(fios->name, d_name, lengthof(fios->name));

   236

				snprintf(fios->title, lengthof(fios->title), "%s" PATHSEP " (Directory)", d_name);

   237

				str_validate(fios->title);

   238

			}

   239

		}

   240

		closedir(dir);

   241

	}

   242

   243

	/* Sort the subdirs always by name, ascending, remember user-sorting order */

   244

	{

   245

		byte order = _savegame_sort_order;

   246

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   247

		qsort(_fios_items.Begin(), _fios_items.Length(), sizeof(FiosItem), compare_FiosItems);

   248

		_savegame_sort_order = order;

   249

	}

   250

   251

	/* This is where to start sorting for the filenames */

   252

	sort_start = _fios_items.Length();

   253

   254

	/* Show files */

   255

	dir = ttd_opendir(_fios_path);

   256

	if (dir != NULL) {

   257

		while ((dirent = readdir(dir)) != NULL) {

   258

			char fios_title[64];

   259

			char *t;

   260

			ttd_strlcpy(d_name, FS2OTTD(dirent->d_name), sizeof(d_name));

   261

   262

			if (!FiosIsValidFile(_fios_path, dirent, &sb) || !(sb.st_mode & S_IFREG) || FiosIsHiddenFile(dirent)) continue;

   263

   264

			/* File has no extension, skip it */

   265

			if ((t = strrchr(d_name, '.')) == NULL) continue;

   266

			fios_title[0] = '\0'; // reset the title;

   267

   268

			FiosType type = callback_proc(mode, d_name, t, fios_title);

   269

			if (type != FIOS_TYPE_INVALID) {

   270

				fios = _fios_items.Append();

   271

				fios->mtime = sb.st_mtime;

   272

				fios->type = type;

   273

				ttd_strlcpy(fios->name, d_name, lengthof(fios->name));

   274

   275

				/* Some callbacks want to lookup the title of the file. Allow that.

   276

				 * If we just copy the title from the filename, strip the extension */

   277

				t = (fios_title[0] == '\0') ? *t = '\0', d_name : fios_title;

   278

				ttd_strlcpy(fios->title, t, lengthof(fios->title));

   279

				str_validate(fios->title);

   280

			}

   281

		}

   282

		closedir(dir);

   283

	}

   284

   285

	qsort(_fios_items.Get(sort_start), _fios_items.Length() - sort_start, sizeof(FiosItem), compare_FiosItems);

   286

   287

	/* Show drives */

   288

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   289

   290

	_fios_items.Compact();

   291

   292

	return _fios_items.Begin();

   293

}

   294

   295

/**

   296

 * Callback for FiosGetFileList. It tells if a file is a savegame or not.

   297

 * @param mode Save/load mode.

   298

 * @param file Name of the file to check.

   299

 * @param ext A pointer to the extension identifier inside file

   300

 * @param title Buffer if a callback wants to lookup the title of the file

   301

 * @return a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a savegame

   302

 * @see FiosGetFileList

   303

 * @see FiosGetSavegameList

   304

 */

   305

static FiosType FiosGetSavegameListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title)

   306

{

   307

	/* Show savegame files

   308

	 * .SAV OpenTTD saved game

   309

	 * .SS1 Transport Tycoon Deluxe preset game

   310

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   311

	 * .SV2 Transport Tycoon Deluxe (Patch) saved 2-player game */

   312

	if (strcasecmp(ext, ".sav") == 0) return FIOS_TYPE_FILE;

   313

   314

	if (mode == SLD_LOAD_GAME || mode == SLD_LOAD_SCENARIO) {

   315

		if (strcasecmp(ext, ".ss1") == 0 || strcasecmp(ext, ".sv1") == 0 ||

   316

				strcasecmp(ext, ".sv2") == 0) {

   317

			GetOldSaveGameName(title, _fios_path, file);

   318

			return FIOS_TYPE_OLDFILE;

   319

		}

   320

	}

   321

   322

	return FIOS_TYPE_INVALID;

   323

}

   324

   325

/**

   326

 * Get a list of savegames.

   327

 * @param mode Save/load mode.

   328

 * @return A pointer to an array of FiosItem representing all the files to be shown in the save/load dialog.

   329

 * @see FiosGetFileList

   330

 */

   331

void FiosGetSavegameList(SaveLoadDialogMode mode)

   332

{

   333

	static char *fios_save_path = NULL;

   334

   335

	if (fios_save_path == NULL) {

   336

		fios_save_path = MallocT<char>(MAX_PATH);

   337

		FioGetDirectory(fios_save_path, MAX_PATH, SAVE_DIR);

   338

	}

   339

   340

	_fios_path = fios_save_path;

   341

   342

	FiosGetFileList(mode, &FiosGetSavegameListCallback);

   343

}

   344

   345

/**

   346

 * Callback for FiosGetFileList. It tells if a file is a scenario or not.

   347

 * @param mode Save/load mode.

   348

 * @param file Name of the file to check.

   349

 * @param ext A pointer to the extension identifier inside file

   350

 * @param title Buffer if a callback wants to lookup the title of the file

   351

 * @return a FIOS_TYPE_* type of the found file, FIOS_TYPE_INVALID if not a scenario

   352

 * @see FiosGetFileList

   353

 * @see FiosGetScenarioList

   354

 */

   355

static FiosType FiosGetScenarioListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title)

   356

{

   357

	/* Show scenario files

   358

	 * .SCN OpenTTD style scenario file

   359

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   360

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   361

	if (strcasecmp(ext, ".scn") == 0) return FIOS_TYPE_SCENARIO;

   362

   363

	if (mode == SLD_LOAD_GAME || mode == SLD_LOAD_SCENARIO || mode == SLD_NEW_GAME) {

   364

		if (strcasecmp(ext, ".sv0") == 0 || strcasecmp(ext, ".ss0") == 0 ) {

   365

			GetOldSaveGameName(title, _fios_path, file);

   366

			return FIOS_TYPE_OLD_SCENARIO;

   367

		}

   368

	}

   369

   370

	return FIOS_TYPE_INVALID;

   371

}

   372

   373

/**

   374

 * Get a list of scenarios.

   375

 * @param mode Save/load mode.

   376

 * @return A pointer to an array of FiosItem representing all the files to be shown in the save/load dialog.

   377

 * @see FiosGetFileList

   378

 */

   379

void FiosGetScenarioList(SaveLoadDialogMode mode)

   380

{

   381

	static char *fios_scn_path = NULL;

   382

   383

	/* Copy the default path on first run or on 'New Game' */

   384

	if (fios_scn_path == NULL) {

   385

		fios_scn_path = MallocT<char>(MAX_PATH);

   386

		FioGetDirectory(fios_scn_path, MAX_PATH, SCENARIO_DIR);

   387

	}

   388

   389

	_fios_path = fios_scn_path;

   390

   391

	FiosGetFileList(mode, &FiosGetScenarioListCallback);

   392

}

   393

   394

static FiosType FiosGetHeightmapListCallback(SaveLoadDialogMode mode, const char *file, const char *ext, char *title)

   395

{

   396

	/* Show heightmap files

   397

	 * .PNG PNG Based heightmap files

   398

	 * .BMP BMP Based heightmap files

   399

	 */

   400

   401

#ifdef WITH_PNG

   402

	if (strcasecmp(ext, ".png") == 0) return FIOS_TYPE_PNG;

   403

#endif /* WITH_PNG */

   404

   405

	if (strcasecmp(ext, ".bmp") == 0) return FIOS_TYPE_BMP;

   406

   407

	return FIOS_TYPE_INVALID;

   408

}

   409

   410

/* Get a list of Heightmaps */

   411

void FiosGetHeightmapList(SaveLoadDialogMode mode)

   412

{

   413

	static char *fios_hmap_path = NULL;

   414

   415

	if (fios_hmap_path == NULL) {

   416

		fios_hmap_path = MallocT<char>(MAX_PATH);

   417

		FioGetDirectory(fios_hmap_path, MAX_PATH, HEIGHTMAP_DIR);

   418

	}

   419

   420

	_fios_path = fios_hmap_path;

   421

   422

	FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   423

}