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

# include <dirent.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 void FiosGetDrives(void);

    38

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

    39

    40

/* get the name of an oldstyle savegame */

    41

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

    42

    43

/**

    44

 * Allocate a new FiosItem.

    45

 * @return A pointer to the newly allocated FiosItem.

    46

 */

    47

FiosItem *FiosAlloc(void)

    48

{

    49

	if (_fios_count == _fios_alloc) {

    50

		_fios_alloc += 256;

    51

		_fios_items = ReallocT(_fios_items, _fios_alloc);

    52

	}

    53

	return &_fios_items[_fios_count++];

    54

}

    55

    56

/**

    57

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

    58

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

    59

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

    60

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

    61

 */

    62

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

    63

{

    64

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

    65

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

    66

	int r;

    67

    68

	if (_savegame_sort_order & SORT_BY_NAME) {

    69

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

    70

	} else {

    71

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

    72

	}

    73

    74

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    75

	return r;

    76

}

    77

    78

/**

    79

 * Free the list of savegames

    80

 */

    81

void FiosFreeSavegameList(void)

    82

{

    83

	free(_fios_items);

    84

	_fios_items = NULL;

    85

	_fios_alloc = _fios_count = 0;

    86

}

    87

    88

/**

    89

 * Get descriptive texts. Returns the path and free space

    90

 * left on the device

    91

 * @param path string describing the path

    92

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

    93

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

    94

 */

    95

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

    96

{

    97

	*path = _fios_path;

    98

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

    99

}

   100

   101

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

   102

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

   103

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

   104

char *FiosBrowseTo(const FiosItem *item)

   105

{

   106

	char *s;

   107

	char *path = _fios_path;

   108

   109

	switch (item->type) {

   110

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

   111

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

   112

#endif

   113

   114

	case FIOS_TYPE_PARENT:

   115

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

   116

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

   117

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

   118

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

   119

		}

   120

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

   121

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

   122

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

   123

#endif

   124

		break;

   125

   126

	case FIOS_TYPE_DIR:

   127

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

   128

		strcat(path, item->name);

   129

		break;

   130

   131

	case FIOS_TYPE_DIRECT:

   132

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

   133

		s = strrchr(path, PATHSEPCHAR);

   134

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

   135

		break;

   136

   137

	case FIOS_TYPE_FILE:

   138

	case FIOS_TYPE_OLDFILE:

   139

	case FIOS_TYPE_SCENARIO:

   140

	case FIOS_TYPE_OLD_SCENARIO:

   141

	case FIOS_TYPE_PNG:

   142

	case FIOS_TYPE_BMP:

   143

	{

   144

		static char str_buffr[512];

   145

   146

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

   147

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

   148

		if (FiosIsRoot(path)) {

   149

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

   150

		} else // XXX - only next line!

   151

#endif

   152

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

   153

   154

		return str_buffr;

   155

	}

   156

	}

   157

   158

	return NULL;

   159

}

   160

   161

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

   162

{

   163

	const char *extension, *period;

   164

   165

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

   166

   167

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

   168

	period = strrchr(name, '.');

   169

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

   170

   171

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

   172

}

   173

   174

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

   175

# define unlink _wunlink

   176

#endif

   177

   178

bool FiosDelete(const char *name)

   179

{

   180

	char filename[512];

   181

   182

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

   183

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

   184

}

   185

   186

bool FileExists(const char *filename)

   187

{

   188

#if defined(WINCE)

   189

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

   190

	HANDLE hand;

   191

   192

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

   193

	if (hand == INVALID_HANDLE_VALUE) return 1;

   194

	CloseHandle(hand);

   195

	return 0;

   196

#else

   197

	return access(filename, 0) == 0;

   198

#endif

   199

}

   200

   201

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

   202

   203

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

   204

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

   205

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

   206

 *  @param callback 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 = 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

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

   234

				fios = FiosAlloc();

   235

				fios->type = FIOS_TYPE_DIR;

   236

				fios->mtime = 0;

   237

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

   238

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

   239

				str_validate(fios->title);

   240

			}

   241

		}

   242

		closedir(dir);

   243

	}

   244

   245

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

   246

	{

   247

		byte order = _savegame_sort_order;

   248

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   249

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

   250

		_savegame_sort_order = order;

   251

	}

   252

   253

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

   254

	sort_start = _fios_count;

   255

   256

	/* Show files */

   257

	dir = opendir(_fios_path);

   258

	if (dir != NULL) {

   259

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

   260

			char fios_title[64];

   261

			char *t;

   262

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

   263

   264

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

   265

   266

			/* File has no extension, skip it */

   267

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

   268

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

   269

   270

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

   271

			if (type != FIOS_TYPE_INVALID) {

   272

				fios = FiosAlloc();

   273

				fios->mtime = sb.st_mtime;

   274

				fios->type = type;

   275

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

   276

   277

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

   278

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

   279

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

   280

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

   281

				str_validate(fios->title);

   282

			}

   283

		}

   284

		closedir(dir);

   285

	}

   286

   287

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

   288

   289

	/* Show drives */

   290

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   291

   292

	_fios_num = _fios_count;

   293

	return _fios_items;

   294

}

   295

   296

/**

   297

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

   298

 * @param mode Save/load mode.

   299

 * @param file Name of the file to check.

   300

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

   301

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

   302

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

   303

 * @see FiosGetFileList

   304

 * @see FiosGetSavegameList

   305

 */

   306

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

   307

{

   308

	/* Show savegame files

   309

	 * .SAV OpenTTD saved game

   310

	 * .SS1 Transport Tycoon Deluxe preset game

   311

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   312

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

   313

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

   314

   315

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

   316

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

   317

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

   318

			GetOldSaveGameName(title, _fios_path, file);

   319

			return FIOS_TYPE_OLDFILE;

   320

		}

   321

	}

   322

   323

	return FIOS_TYPE_INVALID;

   324

}

   325

   326

/**

   327

 * Get a list of savegames.

   328

 * @param mode Save/load mode.

   329

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

   330

 * @see FiosGetFileList

   331

 */

   332

FiosItem *FiosGetSavegameList(int mode)

   333

{

   334

	static char *_fios_save_path = NULL;

   335

   336

	if (_fios_save_path == NULL) {

   337

		_fios_save_path = MallocT<char>(MAX_PATH);

   338

		ttd_strlcpy(_fios_save_path, _paths.save_dir, MAX_PATH);

   339

	}

   340

   341

	_fios_path = _fios_save_path;

   342

   343

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   344

}

   345

   346

/**

   347

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

   348

 * @param mode Save/load mode.

   349

 * @param file Name of the file to check.

   350

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

   351

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

   352

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

   353

 * @see FiosGetFileList

   354

 * @see FiosGetScenarioList

   355

 */

   356

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

   357

{

   358

	/* Show scenario files

   359

	 * .SCN OpenTTD style scenario file

   360

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   361

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   362

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

   363

   364

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

   365

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

   366

			GetOldSaveGameName(title, _fios_path, file);

   367

			return FIOS_TYPE_OLD_SCENARIO;

   368

		}

   369

	}

   370

   371

	return FIOS_TYPE_INVALID;

   372

}

   373

   374

/**

   375

 * Get a list of scenarios.

   376

 * @param mode Save/load mode.

   377

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

   378

 * @see FiosGetFileList

   379

 */

   380

FiosItem *FiosGetScenarioList(int mode)

   381

{

   382

	static char *_fios_scn_path = NULL;

   383

   384

	if (_fios_scn_path == NULL) {

   385

		_fios_scn_path = MallocT<char>(MAX_PATH);

   386

		ttd_strlcpy(_fios_scn_path, _paths.scenario_dir, MAX_PATH);

   387

	}

   388

   389

	_fios_path = _fios_scn_path;

   390

   391

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   392

}

   393

   394

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

   395

{

   396

	/* Show heightmap files

   397

	 * .PNG PNG Based heightmap files

   398

	 * .BMP BMP Based heightmap files

   399

	 */

   400

   401

#ifdef WITH_PNG

   402

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

   403

#endif /* WITH_PNG */

   404

   405

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

   406

   407

	return FIOS_TYPE_INVALID;

   408

}

   409

   410

// Get a list of Heightmaps

   411

FiosItem *FiosGetHeightmapList(int mode)

   412

{

   413

	static char *_fios_hmap_path = NULL;

   414

   415

	if (_fios_hmap_path == NULL) {

   416

		_fios_hmap_path = MallocT<char>(MAX_PATH);

   417

		strcpy(_fios_hmap_path, _paths.heightmap_dir);

   418

	}

   419

   420

	_fios_path = _fios_hmap_path;

   421

   422

	return FiosGetFileList(mode, &FiosGetHeightmapListCallback);

   423

}