1

/* $Id$ */

     2

     3

/** @file fios.c

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

    10

#include "string.h"

    11

#include "variables.h"

    12

#include "functions.h"

    13

#include "heightmap.h"

    14

#include "helpers.hpp"

    15

#include "table/strings.h"

    16

#include "fios.h"

    17

#include <sys/types.h>

    18

#include <sys/stat.h>

    19

    20

#ifdef WIN32

    21

# include <io.h>

    22

#else

    23

# include <unistd.h>

    24

#endif /* WIN32 */

    25

    26

/* Variables to display file lists */

    27

int _fios_num;

    28

    29

static char *_fios_path;

    30

static FiosItem *_fios_items;

    31

static int _fios_count, _fios_alloc;

    32

    33

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

    34

extern bool FiosIsRoot(const char *path);

    35

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

    36

extern void FiosGetDrives(void);

    37

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

    38

    39

/* get the name of an oldstyle savegame */

    40

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

    41

    42

/**

    43

 * Allocate a new FiosItem.

    44

 * @return A pointer to the newly allocated FiosItem.

    45

 */

    46

FiosItem *FiosAlloc(void)

    47

{

    48

	if (_fios_count == _fios_alloc) {

    49

		_fios_alloc += 256;

    50

		_fios_items = ReallocT(_fios_items, _fios_alloc);

    51

	}

    52

	return &_fios_items[_fios_count++];

    53

}

    54

    55

/**

    56

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

    57

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

    58

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

    59

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

    60

 */

    61

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

    62

{

    63

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

    64

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

    65

	int r;

    66

    67

	if (_savegame_sort_order & SORT_BY_NAME) {

    68

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

    69

	} else {

    70

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

    71

	}

    72

    73

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    74

	return r;

    75

}

    76

    77

/**

    78

 * Free the list of savegames

    79

 */

    80

void FiosFreeSavegameList(void)

    81

{

    82

	free(_fios_items);

    83

	_fios_items = NULL;

    84

	_fios_alloc = _fios_count = 0;

    85

}

    86

    87

/**

    88

 * Get descriptive texts. Returns the path and free space

    89

 * left on the device

    90

 * @param path string describing the path

    91

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

    92

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

    93

 */

    94

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

    95

{

    96

	*path = _fios_path;

    97

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

    98

}

    99

   100

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

   101

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

   102

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

   103

char *FiosBrowseTo(const FiosItem *item)

   104

{

   105

	char *s;

   106

	char *path = _fios_path;

   107

   108

	switch (item->type) {

   109

#if defined(WIN32) || defined(__OS2__)

   110

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

   111

#endif

   112

   113

	case FIOS_TYPE_PARENT:

   114

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

   115

		if ((s = strrchr(path, PATHSEPCHAR)) != NULL) {

   116

			s[1] = '\0'; // go up a directory

   117

			if (!FiosIsRoot(path)) s[0] = '\0';

   118

		}

   119

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

   120

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

   121

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

   122

#endif

   123

		break;

   124

   125

	case FIOS_TYPE_DIR:

   126

		if (!FiosIsRoot(path)) strcat(path, PATHSEP);

   127

		strcat(path, item->name);

   128

		break;

   129

   130

	case FIOS_TYPE_DIRECT:

   131

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

   132

		s = strrchr(path, PATHSEPCHAR);

   133

		if (s != NULL && s[1] == '\0') s[0] = '\0'; // strip trailing slash

   134

		break;

   135

   136

	case FIOS_TYPE_FILE:

   137

	case FIOS_TYPE_OLDFILE:

   138

	case FIOS_TYPE_SCENARIO:

   139

	case FIOS_TYPE_OLD_SCENARIO:

   140

	case FIOS_TYPE_PNG:

   141

	case FIOS_TYPE_BMP:

   142

	{

   143

		static char str_buffr[512];

   144

   145

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

   146

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

   147

		if (FiosIsRoot(path)) {

   148

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

   149

		} else // XXX - only next line!

   150

#endif

   151

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

   152

   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

   170

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

   171

}

   172

   173

#if defined(WIN32) || defined(WIN64)

   174

# define unlink _wunlink

   175

#endif

   176

   177

bool FiosDelete(const char *name)

   178

{

   179

	char filename[512];

   180

   181

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

   182

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

   183

}

   184

   185

bool FileExists(const char *filename)

   186

{

   187

#if defined(WINCE)

   188

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

   189

	HANDLE hand;

   190

   191

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

   192

	if (hand == INVALID_HANDLE_VALUE) return 1;

   193

	CloseHandle(hand);

   194

	return 0;

   195

#else

   196

	return access(filename, 0) == 0;

   197

#endif

   198

}

   199

   200

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

   201

   202

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

   203

 *  @param num Will be filled with the amount of items.

   204

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

   205

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

   206

 *  @return Return the list of files. */

   207

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

   208

{

   209

	struct stat sb;

   210

	struct dirent *dirent;

   211

	DIR *dir;

   212

	FiosItem *fios;

   213

	int sort_start;

   214

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

   215

   216

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

   217

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

   218

		fios = FiosAlloc();

   219

		fios->type = FIOS_TYPE_PARENT;

   220

		fios->mtime = 0;

   221

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

   222

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

   223

	}

   224

   225

	/* Show subdirectories */

   226

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

   227

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

   228

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

   229

   230

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

   231

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

   232

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

   233

				fios = FiosAlloc();

   234

				fios->type = FIOS_TYPE_DIR;

   235

				fios->mtime = 0;

   236

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

   237

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

   238

				str_validate(fios->title);

   239

			}

   240

		}

   241

		closedir(dir);

   242

	}

   243

   244

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

   245

	{

   246

		byte order = _savegame_sort_order;

   247

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   248

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

   249

		_savegame_sort_order = order;

   250

	}

   251

   252

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

   253

	sort_start = _fios_count;

   254

   255

	/* Show files */

   256

	dir = ttd_opendir(_fios_path);

   257

	if (dir != NULL) {

   258

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

   259

			char fios_title[64];

   260

			char *t;

   261

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

   262

   263

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

   264

   265

			/* File has no extension, skip it */

   266

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

   267

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

   268

   269

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

   270

			if (type != FIOS_TYPE_INVALID) {

   271

				fios = FiosAlloc();

   272

				fios->mtime = sb.st_mtime;

   273

				fios->type = type;

   274

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

   275

   276

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

   277

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

   278

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

   279

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

   280

				str_validate(fios->title);

   281

			}

   282

		}

   283

		closedir(dir);

   284

	}

   285

   286

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

   287

   288

	/* Show drives */

   289

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   290

   291

	_fios_num = _fios_count;

   292

	return _fios_items;

   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 byte FiosGetSavegameListCallback(int 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

FiosItem *FiosGetSavegameList(int 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

		ttd_strlcpy(_fios_save_path, _paths.save_dir, MAX_PATH);

   338

	}

   339

   340

	_fios_path = _fios_save_path;

   341

   342

	return 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 byte FiosGetScenarioListCallback(int 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

FiosItem *FiosGetScenarioList(int mode)

   380

{

   381

	static char *_fios_scn_path = NULL;

   382

   383

	if (_fios_scn_path == NULL) {

   384

		_fios_scn_path = MallocT<char>(MAX_PATH);

   385

		ttd_strlcpy(_fios_scn_path, _paths.scenario_dir, MAX_PATH);

   386

	}

   387

   388

	_fios_path = _fios_scn_path;

   389

   390

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   391

}

   392

   393

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

   394

{

   395

	/* Show heightmap files

   396

	 * .PNG PNG Based heightmap files

   397

	 * .BMP BMP Based heightmap files

   398

	 */

   399

   400

#ifdef WITH_PNG

   401

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

   402

#endif /* WITH_PNG */

   403

   404

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

   405

   406

	return FIOS_TYPE_INVALID;

   407

}

   408

   409

// Get a list of Heightmaps

   410

FiosItem *FiosGetHeightmapList(int mode)

   411

{

   412

	static char *_fios_hmap_path = NULL;

   413

   414

	if (_fios_hmap_path == NULL) {

   415

		_fios_hmap_path = MallocT<char>(MAX_PATH);

   416

		strcpy(_fios_hmap_path, _paths.heightmap_dir);

   417

	}

   418

   419

	_fios_path = _fios_hmap_path;

   420

   421

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   422

}