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

    10

#include "variables.h"

    11

#include "functions.h"

    12

#include "heightmap.h"

    13

#include "helpers.hpp"

    14

#include "table/strings.h"

    15

#include "fios.h"

    16

#include "fileio.h"

    17

#include <sys/types.h>

    18

#include <sys/stat.h>

    19

    20

#ifdef WIN32

    21

# include <tchar.h>

    22

# include <io.h>

    23

#else

    24

# include <unistd.h>

    25

#endif /* WIN32 */

    26

    27

/* Variables to display file lists */

    28

int _fios_num;

    29

    30

static char *_fios_path;

    31

static FiosItem *_fios_items;

    32

static int _fios_count, _fios_alloc;

    33

    34

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

    35

extern bool FiosIsRoot(const char *path);

    36

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

    37

extern bool FiosIsHiddenFile(const struct dirent *ent);

    38

extern void FiosGetDrives();

    39

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

    40

    41

/* get the name of an oldstyle savegame */

    42

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

    43

    44

/**

    45

 * Allocate a new FiosItem.

    46

 * @return A pointer to the newly allocated FiosItem.

    47

 */

    48

FiosItem *FiosAlloc()

    49

{

    50

	if (_fios_count == _fios_alloc) {

    51

		_fios_alloc += 256;

    52

		_fios_items = ReallocT(_fios_items, _fios_alloc);

    53

	}

    54

	return &_fios_items[_fios_count++];

    55

}

    56

    57

/**

    58

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

    59

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

    60

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

    61

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

    62

 */

    63

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

    64

{

    65

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

    66

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

    67

	int r;

    68

    69

	if (_savegame_sort_order & SORT_BY_NAME) {

    70

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

    71

	} else {

    72

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

    73

	}

    74

    75

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    76

	return r;

    77

}

    78

    79

/**

    80

 * Free the list of savegames

    81

 */

    82

void FiosFreeSavegameList()

    83

{

    84

	free(_fios_items);

    85

	_fios_items = NULL;

    86

	_fios_alloc = _fios_count = 0;

    87

}

    88

    89

/**

    90

 * Get descriptive texts. Returns the path and free space

    91

 * left on the device

    92

 * @param path string describing the path

    93

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

    94

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

    95

 */

    96

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

    97

{

    98

	*path = _fios_path;

    99

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

   100

}

   101

   102

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

   103

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

   104

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

   105

char *FiosBrowseTo(const FiosItem *item)

   106

{

   107

	char *s;

   108

	char *path = _fios_path;

   109

   110

	switch (item->type) {

   111

#if defined(WINCE)

   112

	case FIOS_TYPE_DRIVE: sprintf(path, PATHSEP ""); break;

   113

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

   114

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

   115

#endif

   116

   117

	case FIOS_TYPE_PARENT:

   118

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

   119

		s = strrchr(path, PATHSEPCHAR);

   120

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

   121

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

   122

		}

   123

		s = strrchr(path, PATHSEPCHAR);

   124

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

   125

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

   126

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

   127

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

   128

#endif

   129

		break;

   130

   131

	case FIOS_TYPE_DIR:

   132

		strcat(path, item->name);

   133

		strcat(path, PATHSEP);

   134

		break;

   135

   136

	case FIOS_TYPE_DIRECT:

   137

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

   138

		break;

   139

   140

	case FIOS_TYPE_FILE:

   141

	case FIOS_TYPE_OLDFILE:

   142

	case FIOS_TYPE_SCENARIO:

   143

	case FIOS_TYPE_OLD_SCENARIO:

   144

	case FIOS_TYPE_PNG:

   145

	case FIOS_TYPE_BMP:

   146

	{

   147

		static char str_buffr[512];

   148

   149

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

   150

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

   151

		if (FiosIsRoot(path)) {

   152

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

   153

		} else // XXX - only next line!

   154

#endif

   155

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

   156

   157

		return str_buffr;

   158

	}

   159

	}

   160

   161

	return NULL;

   162

}

   163

   164

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

   165

{

   166

	const char *extension, *period;

   167

   168

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

   169

   170

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

   171

	period = strrchr(name, '.');

   172

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

   173

   174

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

   175

}

   176

   177

#if defined(WIN32)

   178

# define unlink _tunlink

   179

#endif

   180

   181

bool FiosDelete(const char *name)

   182

{

   183

	char filename[512];

   184

   185

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

   186

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

   187

}

   188

   189

bool FileExists(const char *filename)

   190

{

   191

#if defined(WINCE)

   192

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

   193

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

   194

	if (hand == INVALID_HANDLE_VALUE) return 1;

   195

	CloseHandle(hand);

   196

	return 0;

   197

#else

   198

	return access(filename, 0) == 0;

   199

#endif

   200

}

   201

   202

typedef byte fios_getlist_callback_proc(int mode, const char *filename, const char *ext, char *title);

   203

   204

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

   205

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

   206

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

   207

 *  @return Return the list of files. */

   208

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

   209

{

   210

	struct stat sb;

   211

	struct dirent *dirent;

   212

	DIR *dir;

   213

	FiosItem *fios;

   214

	int sort_start;

   215

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

   216

   217

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

   218

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

   219

		fios = FiosAlloc();

   220

		fios->type = FIOS_TYPE_PARENT;

   221

		fios->mtime = 0;

   222

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

   223

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

   224

	}

   225

   226

	/* Show subdirectories */

   227

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

   228

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

   229

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

   230

   231

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

   232

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

   233

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

   234

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

   235

				fios = FiosAlloc();

   236

				fios->type = FIOS_TYPE_DIR;

   237

				fios->mtime = 0;

   238

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

   239

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

   240

				str_validate(fios->title);

   241

			}

   242

		}

   243

		closedir(dir);

   244

	}

   245

   246

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

   247

	{

   248

		byte order = _savegame_sort_order;

   249

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   250

		qsort(_fios_items, _fios_count, sizeof(FiosItem), compare_FiosItems);

   251

		_savegame_sort_order = order;

   252

	}

   253

   254

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

   255

	sort_start = _fios_count;

   256

   257

	/* Show files */

   258

	dir = ttd_opendir(_fios_path);

   259

	if (dir != NULL) {

   260

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

   261

			char fios_title[64];

   262

			char *t;

   263

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

   264

   265

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

   266

   267

			/* File has no extension, skip it */

   268

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

   269

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

   270

   271

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

   272

			if (type != FIOS_TYPE_INVALID) {

   273

				fios = FiosAlloc();

   274

				fios->mtime = sb.st_mtime;

   275

				fios->type = type;

   276

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

   277

   278

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

   279

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

   280

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

   281

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

   282

				str_validate(fios->title);

   283

			}

   284

		}

   285

		closedir(dir);

   286

	}

   287

   288

	qsort(_fios_items + sort_start, _fios_count - sort_start, sizeof(FiosItem), compare_FiosItems);

   289

   290

	/* Show drives */

   291

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   292

   293

	_fios_num = _fios_count;

   294

	return _fios_items;

   295

}

   296

   297

/**

   298

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

   299

 * @param mode Save/load mode.

   300

 * @param file Name of the file to check.

   301

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

   302

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

   303

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

   304

 * @see FiosGetFileList

   305

 * @see FiosGetSavegameList

   306

 */

   307

static byte FiosGetSavegameListCallback(int mode, const char *file, const char *ext, char *title)

   308

{

   309

	/* Show savegame files

   310

	 * .SAV OpenTTD saved game

   311

	 * .SS1 Transport Tycoon Deluxe preset game

   312

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   313

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

   314

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

   315

   316

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

   317

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

   318

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

   319

			GetOldSaveGameName(title, _fios_path, file);

   320

			return FIOS_TYPE_OLDFILE;

   321

		}

   322

	}

   323

   324

	return FIOS_TYPE_INVALID;

   325

}

   326

   327

/**

   328

 * Get a list of savegames.

   329

 * @param mode Save/load mode.

   330

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

   331

 * @see FiosGetFileList

   332

 */

   333

FiosItem *FiosGetSavegameList(int mode)

   334

{

   335

	static char *_fios_save_path = NULL;

   336

   337

	if (_fios_save_path == NULL) {

   338

		_fios_save_path = MallocT<char>(MAX_PATH);

   339

		FioGetDirectory(_fios_save_path, MAX_PATH, SAVE_DIR);

   340

	}

   341

   342

	_fios_path = _fios_save_path;

   343

   344

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   345

}

   346

   347

/**

   348

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

   349

 * @param mode Save/load mode.

   350

 * @param file Name of the file to check.

   351

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

   352

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

   353

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

   354

 * @see FiosGetFileList

   355

 * @see FiosGetScenarioList

   356

 */

   357

static byte FiosGetScenarioListCallback(int mode, const char *file, const char *ext, char *title)

   358

{

   359

	/* Show scenario files

   360

	 * .SCN OpenTTD style scenario file

   361

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   362

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   363

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

   364

   365

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

   366

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

   367

			GetOldSaveGameName(title, _fios_path, file);

   368

			return FIOS_TYPE_OLD_SCENARIO;

   369

		}

   370

	}

   371

   372

	return FIOS_TYPE_INVALID;

   373

}

   374

   375

/**

   376

 * Get a list of scenarios.

   377

 * @param mode Save/load mode.

   378

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

   379

 * @see FiosGetFileList

   380

 */

   381

FiosItem *FiosGetScenarioList(int mode)

   382

{

   383

	static char *_fios_scn_path = NULL;

   384

   385

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

   386

	if (_fios_scn_path == NULL) {

   387

		_fios_scn_path = MallocT<char>(MAX_PATH);

   388

		FioGetDirectory(_fios_scn_path, MAX_PATH, SCENARIO_DIR);

   389

	}

   390

   391

	_fios_path = _fios_scn_path;

   392

   393

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   394

}

   395

   396

static byte FiosGetHeightmapListCallback(int mode, const char *file, const char *ext, char *title)

   397

{

   398

	/* Show heightmap files

   399

	 * .PNG PNG Based heightmap files

   400

	 * .BMP BMP Based heightmap files

   401

	 */

   402

   403

#ifdef WITH_PNG

   404

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

   405

#endif /* WITH_PNG */

   406

   407

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

   408

   409

	return FIOS_TYPE_INVALID;

   410

}

   411

   412

/* Get a list of Heightmaps */

   413

FiosItem *FiosGetHeightmapList(int mode)

   414

{

   415

	static char *_fios_hmap_path = NULL;

   416

   417

	if (_fios_hmap_path == NULL) {

   418

		_fios_hmap_path = MallocT<char>(MAX_PATH);

   419

		FioGetDirectory(_fios_hmap_path, MAX_PATH, HEIGHTMAP_DIR);

   420

	}

   421

   422

	_fios_path = _fios_hmap_path;

   423

   424

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   425

}