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 "core/alloc_func.hpp"

    14

#include "functions.h"

    15

#include "string_func.h"

    16

#include <sys/types.h>

    17

#include <sys/stat.h>

    18

    19

#ifdef WIN32

    20

# include <tchar.h>

    21

# include <io.h>

    22

# define access _taccess

    23

# define unlink _tunlink

    24

#else

    25

# include <unistd.h>

    26

#endif /* WIN32 */

    27

    28

#include "table/strings.h"

    29

    30

/* Variables to display file lists */

    31

int _fios_num;

    32

    33

static char *_fios_path;

    34

static FiosItem *_fios_items;

    35

SmallFiosItem _file_to_saveload;

    36

static int _fios_count, _fios_alloc;

    37

    38

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

    39

extern bool FiosIsRoot(const char *path);

    40

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

    41

extern bool FiosIsHiddenFile(const struct dirent *ent);

    42

extern void FiosGetDrives();

    43

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

    44

    45

/* get the name of an oldstyle savegame */

    46

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

    47

    48

/**

    49

 * Allocate a new FiosItem.

    50

 * @return A pointer to the newly allocated FiosItem.

    51

 */

    52

FiosItem *FiosAlloc()

    53

{

    54

	if (_fios_count == _fios_alloc) {

    55

		_fios_alloc += 256;

    56

		_fios_items = ReallocT(_fios_items, _fios_alloc);

    57

	}

    58

	return &_fios_items[_fios_count++];

    59

}

    60

    61

/**

    62

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

    63

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

    64

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

    65

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

    66

 */

    67

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

    68

{

    69

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

    70

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

    71

	int r;

    72

    73

	if (_savegame_sort_order & SORT_BY_NAME) {

    74

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

    75

	} else {

    76

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

    77

	}

    78

    79

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    80

	return r;

    81

}

    82

    83

/**

    84

 * Free the list of savegames

    85

 */

    86

void FiosFreeSavegameList()

    87

{

    88

	free(_fios_items);

    89

	_fios_items = NULL;

    90

	_fios_alloc = _fios_count = 0;

    91

}

    92

    93

/**

    94

 * Get descriptive texts. Returns the path and free space

    95

 * left on the device

    96

 * @param path string describing the path

    97

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

    98

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

    99

 */

   100

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

   101

{

   102

	*path = _fios_path;

   103

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

   104

}

   105

   106

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

   107

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

   108

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

   109

char *FiosBrowseTo(const FiosItem *item)

   110

{

   111

	char *path = _fios_path;

   112

   113

	switch (item->type) {

   114

		case FIOS_TYPE_DRIVE:

   115

#if defined(WINCE)

   116

			sprintf(path, PATHSEP "");

   117

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

   118

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

   119

#endif

   120

		/* Fallthrough */

   121

		case FIOS_TYPE_INVALID:

   122

			break;

   123

   124

		case FIOS_TYPE_PARENT: {

   125

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

   126

			char *s = strrchr(path, PATHSEPCHAR);

   127

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

   128

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

   129

			}

   130

			s = strrchr(path, PATHSEPCHAR);

   131

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

   132

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

   133

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

   134

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

   135

#endif

   136

			break;

   137

		}

   138

   139

		case FIOS_TYPE_DIR:

   140

			strcat(path, item->name);

   141

			strcat(path, PATHSEP);

   142

			break;

   143

   144

		case FIOS_TYPE_DIRECT:

   145

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

   146

			break;

   147

   148

		case FIOS_TYPE_FILE:

   149

		case FIOS_TYPE_OLDFILE:

   150

		case FIOS_TYPE_SCENARIO:

   151

		case FIOS_TYPE_OLD_SCENARIO:

   152

		case FIOS_TYPE_PNG:

   153

		case FIOS_TYPE_BMP:

   154

		{

   155

			static char str_buffr[512];

   156

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

   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

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

   174

	if (_fios_path != NULL) {

   175

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

   176

   177

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

   178

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

   179

		} else {

   180

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

   181

		}

   182

	} else {

   183

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

   184

	}

   185

#else

   186

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

   187

#endif

   188

}

   189

   190

#if defined(WIN32)

   191

# define unlink _tunlink

   192

#endif

   193

   194

bool FiosDelete(const char *name)

   195

{

   196

	char filename[512];

   197

   198

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

   199

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

   200

}

   201

   202

bool FileExists(const char *filename)

   203

{

   204

#if defined(WINCE)

   205

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

   206

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

   207

	if (hand == INVALID_HANDLE_VALUE) return 1;

   208

	CloseHandle(hand);

   209

	return 0;

   210

#else

   211

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

   212

#endif

   213

}

   214

   215

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

   216

   217

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

   218

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

   219

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

   220

 *  @return Return the list of files. */

   221

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

   222

{

   223

	struct stat sb;

   224

	struct dirent *dirent;

   225

	DIR *dir;

   226

	FiosItem *fios;

   227

	int sort_start;

   228

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

   229

   230

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

   231

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

   232

		fios = FiosAlloc();

   233

		fios->type = FIOS_TYPE_PARENT;

   234

		fios->mtime = 0;

   235

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

   236

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

   237

	}

   238

   239

	/* Show subdirectories */

   240

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

   241

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

   242

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

   243

   244

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

   245

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

   246

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

   247

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

   248

				fios = FiosAlloc();

   249

				fios->type = FIOS_TYPE_DIR;

   250

				fios->mtime = 0;

   251

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

   252

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

   253

				str_validate(fios->title);

   254

			}

   255

		}

   256

		closedir(dir);

   257

	}

   258

   259

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

   260

	{

   261

		byte order = _savegame_sort_order;

   262

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   263

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

   264

		_savegame_sort_order = order;

   265

	}

   266

   267

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

   268

	sort_start = _fios_count;

   269

   270

	/* Show files */

   271

	dir = ttd_opendir(_fios_path);

   272

	if (dir != NULL) {

   273

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

   274

			char fios_title[64];

   275

			char *t;

   276

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

   277

   278

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

   279

   280

			/* File has no extension, skip it */

   281

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

   282

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

   283

   284

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

   285

			if (type != FIOS_TYPE_INVALID) {

   286

				fios = FiosAlloc();

   287

				fios->mtime = sb.st_mtime;

   288

				fios->type = type;

   289

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

   290

   291

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

   292

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

   293

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

   294

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

   295

				str_validate(fios->title);

   296

			}

   297

		}

   298

		closedir(dir);

   299

	}

   300

   301

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

   302

   303

	/* Show drives */

   304

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   305

   306

	_fios_num = _fios_count;

   307

	return _fios_items;

   308

}

   309

   310

/**

   311

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

   312

 * @param mode Save/load mode.

   313

 * @param file Name of the file to check.

   314

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

   315

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

   316

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

   317

 * @see FiosGetFileList

   318

 * @see FiosGetSavegameList

   319

 */

   320

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

   321

{

   322

	/* Show savegame files

   323

	 * .SAV OpenTTD saved game

   324

	 * .SS1 Transport Tycoon Deluxe preset game

   325

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   326

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

   327

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

   328

   329

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

   330

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

   331

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

   332

			GetOldSaveGameName(title, _fios_path, file);

   333

			return FIOS_TYPE_OLDFILE;

   334

		}

   335

	}

   336

   337

	return FIOS_TYPE_INVALID;

   338

}

   339

   340

/**

   341

 * Get a list of savegames.

   342

 * @param mode Save/load mode.

   343

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

   344

 * @see FiosGetFileList

   345

 */

   346

FiosItem *FiosGetSavegameList(SaveLoadDialogMode mode)

   347

{

   348

	static char *fios_save_path = NULL;

   349

   350

	if (fios_save_path == NULL) {

   351

		fios_save_path = MallocT<char>(MAX_PATH);

   352

		FioGetDirectory(fios_save_path, MAX_PATH, SAVE_DIR);

   353

	}

   354

   355

	_fios_path = fios_save_path;

   356

   357

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   358

}

   359

   360

/**

   361

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

   362

 * @param mode Save/load mode.

   363

 * @param file Name of the file to check.

   364

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

   365

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

   366

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

   367

 * @see FiosGetFileList

   368

 * @see FiosGetScenarioList

   369

 */

   370

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

   371

{

   372

	/* Show scenario files

   373

	 * .SCN OpenTTD style scenario file

   374

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   375

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   376

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

   377

   378

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

   379

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

   380

			GetOldSaveGameName(title, _fios_path, file);

   381

			return FIOS_TYPE_OLD_SCENARIO;

   382

		}

   383

	}

   384

   385

	return FIOS_TYPE_INVALID;

   386

}

   387

   388

/**

   389

 * Get a list of scenarios.

   390

 * @param mode Save/load mode.

   391

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

   392

 * @see FiosGetFileList

   393

 */

   394

FiosItem *FiosGetScenarioList(SaveLoadDialogMode mode)

   395

{

   396

	static char *fios_scn_path = NULL;

   397

   398

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

   399

	if (fios_scn_path == NULL) {

   400

		fios_scn_path = MallocT<char>(MAX_PATH);

   401

		FioGetDirectory(fios_scn_path, MAX_PATH, SCENARIO_DIR);

   402

	}

   403

   404

	_fios_path = fios_scn_path;

   405

   406

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   407

}

   408

   409

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

   410

{

   411

	/* Show heightmap files

   412

	 * .PNG PNG Based heightmap files

   413

	 * .BMP BMP Based heightmap files

   414

	 */

   415

   416

#ifdef WITH_PNG

   417

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

   418

#endif /* WITH_PNG */

   419

   420

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

   421

   422

	return FIOS_TYPE_INVALID;

   423

}

   424

   425

/* Get a list of Heightmaps */

   426

FiosItem *FiosGetHeightmapList(SaveLoadDialogMode mode)

   427

{

   428

	static char *fios_hmap_path = NULL;

   429

   430

	if (fios_hmap_path == NULL) {

   431

		fios_hmap_path = MallocT<char>(MAX_PATH);

   432

		FioGetDirectory(fios_hmap_path, MAX_PATH, HEIGHTMAP_DIR);

   433

	}

   434

   435

	_fios_path = fios_hmap_path;

   436

   437

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   438

}