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 *s;

   112

	char *path = _fios_path;

   113

   114

	switch (item->type) {

   115

#if defined(WINCE)

   116

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

   117

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

   118

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

   119

#endif

   120

   121

	case FIOS_TYPE_PARENT:

   122

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

   123

		s = strrchr(path, PATHSEPCHAR);

   124

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

   125

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

   126

		}

   127

		s = strrchr(path, PATHSEPCHAR);

   128

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

   129

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

   130

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

   131

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

   132

#endif

   133

		break;

   134

   135

	case FIOS_TYPE_DIR:

   136

		strcat(path, item->name);

   137

		strcat(path, PATHSEP);

   138

		break;

   139

   140

	case FIOS_TYPE_DIRECT:

   141

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

   142

		break;

   143

   144

	case FIOS_TYPE_FILE:

   145

	case FIOS_TYPE_OLDFILE:

   146

	case FIOS_TYPE_SCENARIO:

   147

	case FIOS_TYPE_OLD_SCENARIO:

   148

	case FIOS_TYPE_PNG:

   149

	case FIOS_TYPE_BMP:

   150

	{

   151

		static char str_buffr[512];

   152

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

   153

		return str_buffr;

   154

	}

   155

	}

   156

   157

	return NULL;

   158

}

   159

   160

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

   161

{

   162

	const char *extension, *period;

   163

   164

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

   165

   166

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

   167

	period = strrchr(name, '.');

   168

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

   169

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

   170

	if (_fios_path != NULL) {

   171

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

   172

   173

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

   174

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

   175

		} else {

   176

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

   177

		}

   178

	} else {

   179

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

   180

	}

   181

#else

   182

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

   183

#endif

   184

}

   185

   186

#if defined(WIN32)

   187

# define unlink _tunlink

   188

#endif

   189

   190

bool FiosDelete(const char *name)

   191

{

   192

	char filename[512];

   193

   194

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

   195

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

   196

}

   197

   198

bool FileExists(const char *filename)

   199

{

   200

#if defined(WINCE)

   201

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

   202

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

   203

	if (hand == INVALID_HANDLE_VALUE) return 1;

   204

	CloseHandle(hand);

   205

	return 0;

   206

#else

   207

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

   208

#endif

   209

}

   210

   211

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

   212

   213

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

   214

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

   215

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

   216

 *  @return Return the list of files. */

   217

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

   218

{

   219

	struct stat sb;

   220

	struct dirent *dirent;

   221

	DIR *dir;

   222

	FiosItem *fios;

   223

	int sort_start;

   224

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

   225

   226

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

   227

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

   228

		fios = FiosAlloc();

   229

		fios->type = FIOS_TYPE_PARENT;

   230

		fios->mtime = 0;

   231

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

   232

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

   233

	}

   234

   235

	/* Show subdirectories */

   236

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

   237

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

   238

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

   239

   240

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

   241

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

   242

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

   243

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

   244

				fios = FiosAlloc();

   245

				fios->type = FIOS_TYPE_DIR;

   246

				fios->mtime = 0;

   247

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

   248

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

   249

				str_validate(fios->title);

   250

			}

   251

		}

   252

		closedir(dir);

   253

	}

   254

   255

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

   256

	{

   257

		byte order = _savegame_sort_order;

   258

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   259

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

   260

		_savegame_sort_order = order;

   261

	}

   262

   263

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

   264

	sort_start = _fios_count;

   265

   266

	/* Show files */

   267

	dir = ttd_opendir(_fios_path);

   268

	if (dir != NULL) {

   269

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

   270

			char fios_title[64];

   271

			char *t;

   272

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

   273

   274

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

   275

   276

			/* File has no extension, skip it */

   277

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

   278

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

   279

   280

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

   281

			if (type != FIOS_TYPE_INVALID) {

   282

				fios = FiosAlloc();

   283

				fios->mtime = sb.st_mtime;

   284

				fios->type = type;

   285

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

   286

   287

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

   288

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

   289

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

   290

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

   291

				str_validate(fios->title);

   292

			}

   293

		}

   294

		closedir(dir);

   295

	}

   296

   297

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

   298

   299

	/* Show drives */

   300

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   301

   302

	_fios_num = _fios_count;

   303

	return _fios_items;

   304

}

   305

   306

/**

   307

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

   308

 * @param mode Save/load mode.

   309

 * @param file Name of the file to check.

   310

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

   311

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

   312

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

   313

 * @see FiosGetFileList

   314

 * @see FiosGetSavegameList

   315

 */

   316

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

   317

{

   318

	/* Show savegame files

   319

	 * .SAV OpenTTD saved game

   320

	 * .SS1 Transport Tycoon Deluxe preset game

   321

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   322

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

   323

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

   324

   325

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

   326

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

   327

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

   328

			GetOldSaveGameName(title, _fios_path, file);

   329

			return FIOS_TYPE_OLDFILE;

   330

		}

   331

	}

   332

   333

	return FIOS_TYPE_INVALID;

   334

}

   335

   336

/**

   337

 * Get a list of savegames.

   338

 * @param mode Save/load mode.

   339

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

   340

 * @see FiosGetFileList

   341

 */

   342

FiosItem *FiosGetSavegameList(int mode)

   343

{

   344

	static char *_fios_save_path = NULL;

   345

   346

	if (_fios_save_path == NULL) {

   347

		_fios_save_path = MallocT<char>(MAX_PATH);

   348

		FioGetDirectory(_fios_save_path, MAX_PATH, SAVE_DIR);

   349

	}

   350

   351

	_fios_path = _fios_save_path;

   352

   353

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   354

}

   355

   356

/**

   357

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

   358

 * @param mode Save/load mode.

   359

 * @param file Name of the file to check.

   360

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

   361

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

   362

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

   363

 * @see FiosGetFileList

   364

 * @see FiosGetScenarioList

   365

 */

   366

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

   367

{

   368

	/* Show scenario files

   369

	 * .SCN OpenTTD style scenario file

   370

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   371

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   372

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

   373

   374

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

   375

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

   376

			GetOldSaveGameName(title, _fios_path, file);

   377

			return FIOS_TYPE_OLD_SCENARIO;

   378

		}

   379

	}

   380

   381

	return FIOS_TYPE_INVALID;

   382

}

   383

   384

/**

   385

 * Get a list of scenarios.

   386

 * @param mode Save/load mode.

   387

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

   388

 * @see FiosGetFileList

   389

 */

   390

FiosItem *FiosGetScenarioList(int mode)

   391

{

   392

	static char *_fios_scn_path = NULL;

   393

   394

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

   395

	if (_fios_scn_path == NULL) {

   396

		_fios_scn_path = MallocT<char>(MAX_PATH);

   397

		FioGetDirectory(_fios_scn_path, MAX_PATH, SCENARIO_DIR);

   398

	}

   399

   400

	_fios_path = _fios_scn_path;

   401

   402

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   403

}

   404

   405

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

   406

{

   407

	/* Show heightmap files

   408

	 * .PNG PNG Based heightmap files

   409

	 * .BMP BMP Based heightmap files

   410

	 */

   411

   412

#ifdef WITH_PNG

   413

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

   414

#endif /* WITH_PNG */

   415

   416

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

   417

   418

	return FIOS_TYPE_INVALID;

   419

}

   420

   421

/* Get a list of Heightmaps */

   422

FiosItem *FiosGetHeightmapList(int mode)

   423

{

   424

	static char *_fios_hmap_path = NULL;

   425

   426

	if (_fios_hmap_path == NULL) {

   427

		_fios_hmap_path = MallocT<char>(MAX_PATH);

   428

		FioGetDirectory(_fios_hmap_path, MAX_PATH, HEIGHTMAP_DIR);

   429

	}

   430

   431

	_fios_path = _fios_hmap_path;

   432

   433

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   434

}