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 "table/strings.h"

    15

#include "fios.h"

    16

#include <sys/types.h>

    17

#include <sys/stat.h>

    18

    19

#ifdef WIN32

    20

# include <io.h>

    21

#else

    22

# include <unistd.h>

    23

# include <dirent.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 = realloc(_fios_items, _fios_alloc * sizeof(FiosItem));

    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

bool FiosDelete(const char *name)

   174

{

   175

	char filename[512];

   176

   177

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

   178

	return unlink(filename) == 0;

   179

}

   180

   181

bool FileExists(const char *filename)

   182

{

   183

	return access(filename, 0) == 0;

   184

}

   185

   186

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

   187

   188

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

   189

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

   190

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

   191

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

   192

 *  @return Return the list of files. */

   193

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

   194

{

   195

	struct stat sb;

   196

	struct dirent *dirent;

   197

	DIR *dir;

   198

	FiosItem *fios;

   199

	int sort_start;

   200

   201

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

   202

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

   203

		fios = FiosAlloc();

   204

		fios->type = FIOS_TYPE_PARENT;

   205

		fios->mtime = 0;

   206

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

   207

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

   208

	}

   209

   210

	/* Show subdirectories */

   211

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

   212

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

   213

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

   214

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

   215

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

   216

				fios = FiosAlloc();

   217

				fios->type = FIOS_TYPE_DIR;

   218

				fios->mtime = 0;

   219

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

   220

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

   221

				str_validate(fios->title);

   222

			}

   223

		}

   224

		closedir(dir);

   225

	}

   226

   227

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

   228

	{

   229

		byte order = _savegame_sort_order;

   230

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   231

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

   232

		_savegame_sort_order = order;

   233

	}

   234

   235

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

   236

	sort_start = _fios_count;

   237

   238

	/* Show files */

   239

	dir = opendir(_fios_path);

   240

	if (dir != NULL) {

   241

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

   242

			char fios_title[64];

   243

			char *t;

   244

			byte type;

   245

   246

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

   247

   248

			/* File has no extension, skip it */

   249

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

   250

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

   251

   252

			type = callback_proc(mode, dirent->d_name, t, fios_title);

   253

			if (type != FIOS_TYPE_INVALID) {

   254

				fios = FiosAlloc();

   255

				fios->mtime = sb.st_mtime;

   256

				fios->type = type;

   257

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

   258

   259

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

   260

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

   261

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

   262

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

   263

				str_validate(fios->title);

   264

			}

   265

		}

   266

		closedir(dir);

   267

	}

   268

   269

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

   270

   271

	/* Show drives */

   272

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   273

   274

	_fios_num = _fios_count;

   275

	return _fios_items;

   276

}

   277

   278

/**

   279

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

   280

 * @param mode Save/load mode.

   281

 * @param file Name of the file to check.

   282

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

   283

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

   284

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

   285

 * @see FiosGetFileList

   286

 * @see FiosGetSavegameList

   287

 */

   288

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

   289

{

   290

	/* Show savegame files

   291

	 * .SAV OpenTTD saved game

   292

	 * .SS1 Transport Tycoon Deluxe preset game

   293

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   294

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

   295

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

   296

   297

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

   298

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

   299

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

   300

			GetOldSaveGameName(title, _fios_path, file);

   301

			return FIOS_TYPE_OLDFILE;

   302

		}

   303

	}

   304

   305

	return FIOS_TYPE_INVALID;

   306

}

   307

   308

/**

   309

 * Get a list of savegames.

   310

 * @param mode Save/load mode.

   311

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

   312

 * @see FiosGetFileList

   313

 */

   314

FiosItem *FiosGetSavegameList(int mode)

   315

{

   316

	static char *_fios_save_path = NULL;

   317

   318

	if (_fios_save_path == NULL) {

   319

		_fios_save_path = malloc(MAX_PATH);

   320

		ttd_strlcpy(_fios_save_path, _path.save_dir, MAX_PATH);

   321

	}

   322

   323

	_fios_path = _fios_save_path;

   324

   325

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   326

}

   327

   328

/**

   329

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

   330

 * @param mode Save/load mode.

   331

 * @param file Name of the file to check.

   332

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

   333

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

   334

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

   335

 * @see FiosGetFileList

   336

 * @see FiosGetScenarioList

   337

 */

   338

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

   339

{

   340

	/* Show scenario files

   341

	 * .SCN OpenTTD style scenario file

   342

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   343

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   344

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

   345

   346

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

   347

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

   348

			GetOldSaveGameName(title, _fios_path, file);

   349

			return FIOS_TYPE_OLD_SCENARIO;

   350

		}

   351

	}

   352

   353

	return FIOS_TYPE_INVALID;

   354

}

   355

   356

/**

   357

 * Get a list of scenarios.

   358

 * @param mode Save/load mode.

   359

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

   360

 * @see FiosGetFileList

   361

 */

   362

FiosItem *FiosGetScenarioList(int mode)

   363

{

   364

	static char *_fios_scn_path = NULL;

   365

   366

	if (_fios_scn_path == NULL) {

   367

		_fios_scn_path = malloc(MAX_PATH);

   368

		ttd_strlcpy(_fios_scn_path, _path.scenario_dir, MAX_PATH);

   369

	}

   370

   371

	_fios_path = _fios_scn_path;

   372

   373

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   374

}

   375

   376

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

   377

{

   378

	/* Show heightmap files

   379

	 * .PNG PNG Based heightmap files

   380

	 * .BMP BMP Based heightmap files

   381

	 */

   382

   383

#ifdef WITH_PNG

   384

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

   385

#endif /* WITH_PNG */

   386

   387

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

   388

   389

	return FIOS_TYPE_INVALID;

   390

}

   391

   392

// Get a list of Heightmaps

   393

FiosItem *FiosGetHeightmapList(int mode)

   394

{

   395

	static char *_fios_hmap_path = NULL;

   396

   397

	if (_fios_hmap_path == NULL) {

   398

		_fios_hmap_path = malloc(MAX_PATH);

   399

		strcpy(_fios_hmap_path, _path.heightmap_dir);

   400

	}

   401

   402

	_fios_path = _fios_hmap_path;

   403

   404

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   405

}