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

    14

#include "fios.h"

    15

#include <sys/types.h>

    16

#include <sys/stat.h>

    17

    18

#ifdef WIN32

    19

# include <io.h>

    20

#else

    21

# include <unistd.h>

    22

# include <dirent.h>

    23

#endif /* WIN32 */

    24

    25

/* Variables to display file lists */

    26

int _fios_num;

    27

    28

static char *_fios_path;

    29

static FiosItem *_fios_items;

    30

static int _fios_count, _fios_alloc;

    31

    32

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

    33

extern bool FiosIsRoot(const char *path);

    34

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

    35

extern void FiosGetDrives(void);

    36

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

    37

    38

/* get the name of an oldstyle savegame */

    39

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

    40

    41

/**

    42

 * Allocate a new FiosItem.

    43

 * @return A pointer to the newly allocated FiosItem.

    44

 */

    45

FiosItem *FiosAlloc(void)

    46

{

    47

	if (_fios_count == _fios_alloc) {

    48

		_fios_alloc += 256;

    49

		_fios_items = realloc(_fios_items, _fios_alloc * sizeof(FiosItem));

    50

	}

    51

	return &_fios_items[_fios_count++];

    52

}

    53

    54

/**

    55

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

    56

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

    57

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

    58

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

    59

 */

    60

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

    61

{

    62

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

    63

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

    64

	int r;

    65

    66

	if (_savegame_sort_order & SORT_BY_NAME) {

    67

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

    68

	} else {

    69

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

    70

	}

    71

    72

	if (_savegame_sort_order & SORT_DESCENDING) r = -r;

    73

	return r;

    74

}

    75

    76

/**

    77

 * Free the list of savegames

    78

 */

    79

void FiosFreeSavegameList(void)

    80

{

    81

	free(_fios_items);

    82

	_fios_items = NULL;

    83

	_fios_alloc = _fios_count = 0;

    84

}

    85

    86

/**

    87

 * Get descriptive texts. Returns the path and free space

    88

 * left on the device

    89

 * @param path string describing the path

    90

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

    91

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

    92

 */

    93

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

    94

{

    95

	*path = _fios_path;

    96

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

    97

}

    98

    99

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

   100

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

   101

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

   102

char *FiosBrowseTo(const FiosItem *item)

   103

{

   104

	char *s;

   105

	char *path = _fios_path;

   106

   107

	switch (item->type) {

   108

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

   109

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

   110

#endif

   111

   112

	case FIOS_TYPE_PARENT:

   113

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

   114

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

   115

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

   116

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

   117

		}

   118

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

   119

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

   120

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

   121

#endif

   122

		break;

   123

   124

	case FIOS_TYPE_DIR:

   125

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

   126

		strcat(path, item->name);

   127

		break;

   128

   129

	case FIOS_TYPE_DIRECT:

   130

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

   131

		s = strrchr(path, PATHSEPCHAR);

   132

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

   133

		break;

   134

   135

	case FIOS_TYPE_FILE:

   136

	case FIOS_TYPE_OLDFILE:

   137

	case FIOS_TYPE_SCENARIO:

   138

	case FIOS_TYPE_OLD_SCENARIO: {

   139

		static char str_buffr[512];

   140

   141

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

   142

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

   143

		if (FiosIsRoot(path)) {

   144

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

   145

		} else // XXX - only next line!

   146

#endif

   147

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

   148

   149

		return str_buffr;

   150

	}

   151

	}

   152

   153

	return NULL;

   154

}

   155

   156

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

   157

{

   158

	const char *extension, *period;

   159

   160

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

   161

   162

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

   163

	period = strrchr(name, '.');

   164

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

   165

   166

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

   167

}

   168

   169

bool FiosDelete(const char *name)

   170

{

   171

	char filename[512];

   172

   173

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

   174

	return unlink(filename) == 0;

   175

}

   176

   177

bool FileExists(const char *filename)

   178

{

   179

	return access(filename, 0) == 0;

   180

}

   181

   182

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

   183

   184

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

   185

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

   186

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

   187

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

   188

 *  @return Return the list of files. */

   189

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

   190

{

   191

	struct stat sb;

   192

	struct dirent *dirent;

   193

	DIR *dir;

   194

	FiosItem *fios;

   195

	int sort_start;

   196

   197

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

   198

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

   199

		fios = FiosAlloc();

   200

		fios->type = FIOS_TYPE_PARENT;

   201

		fios->mtime = 0;

   202

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

   203

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

   204

	}

   205

   206

	/* Show subdirectories */

   207

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

   208

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

   209

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

   210

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

   211

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

   212

				fios = FiosAlloc();

   213

				fios->type = FIOS_TYPE_DIR;

   214

				fios->mtime = 0;

   215

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

   216

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

   217

				str_validate(fios->title);

   218

			}

   219

		}

   220

		closedir(dir);

   221

	}

   222

   223

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

   224

	{

   225

		byte order = _savegame_sort_order;

   226

		_savegame_sort_order = SORT_BY_NAME | SORT_ASCENDING;

   227

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

   228

		_savegame_sort_order = order;

   229

	}

   230

   231

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

   232

	sort_start = _fios_count;

   233

   234

	/* Show files */

   235

	dir = opendir(_fios_path);

   236

	if (dir != NULL) {

   237

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

   238

			char fios_title[64];

   239

			char *t;

   240

			byte type;

   241

   242

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

   243

   244

			/* File has no extension, skip it */

   245

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

   246

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

   247

   248

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

   249

			if (type != FIOS_TYPE_INVALID) {

   250

				fios = FiosAlloc();

   251

				fios->mtime = sb.st_mtime;

   252

				fios->type = type;

   253

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

   254

   255

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

   256

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

   257

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

   258

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

   259

				str_validate(fios->title);

   260

			}

   261

		}

   262

		closedir(dir);

   263

	}

   264

   265

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

   266

   267

	/* Show drives */

   268

	if (mode != SLD_NEW_GAME) FiosGetDrives();

   269

   270

	_fios_num = _fios_count;

   271

	return _fios_items;

   272

}

   273

   274

/**

   275

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

   276

 * @param mode Save/load mode.

   277

 * @param file Name of the file to check.

   278

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

   279

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

   280

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

   281

 * @see FiosGetFileList

   282

 * @see FiosGetSavegameList

   283

 */

   284

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

   285

{

   286

	/* Show savegame files

   287

	 * .SAV OpenTTD saved game

   288

	 * .SS1 Transport Tycoon Deluxe preset game

   289

	 * .SV1 Transport Tycoon Deluxe (Patch) saved game

   290

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

   291

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

   292

   293

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

   294

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

   295

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

   296

			GetOldSaveGameName(title, _fios_path, file);

   297

			return FIOS_TYPE_OLDFILE;

   298

		}

   299

	}

   300

   301

	return FIOS_TYPE_INVALID;

   302

}

   303

   304

/**

   305

 * Get a list of savegames.

   306

 * @param mode Save/load mode.

   307

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

   308

 * @see FiosGetFileList

   309

 */

   310

FiosItem *FiosGetSavegameList(int mode)

   311

{

   312

	static char *_fios_save_path = NULL;

   313

   314

	if (_fios_save_path == NULL) {

   315

		_fios_save_path = malloc(MAX_PATH);

   316

		ttd_strlcpy(_fios_save_path, _path.save_dir, MAX_PATH);

   317

	}

   318

   319

	_fios_path = _fios_save_path;

   320

   321

	return FiosGetFileList(mode, &FiosGetSavegameListCallback);

   322

}

   323

   324

/**

   325

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

   326

 * @param mode Save/load mode.

   327

 * @param file Name of the file to check.

   328

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

   329

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

   330

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

   331

 * @see FiosGetFileList

   332

 * @see FiosGetScenarioList

   333

 */

   334

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

   335

{

   336

	/* Show scenario files

   337

	 * .SCN OpenTTD style scenario file

   338

	 * .SV0 Transport Tycoon Deluxe (Patch) scenario

   339

	 * .SS0 Transport Tycoon Deluxe preset scenario */

   340

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

   341

   342

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

   343

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

   344

			GetOldSaveGameName(title, _fios_path, file);

   345

			return FIOS_TYPE_OLD_SCENARIO;

   346

		}

   347

	}

   348

   349

	return FIOS_TYPE_INVALID;

   350

}

   351

   352

/**

   353

 * Get a list of scenarios.

   354

 * @param mode Save/load mode.

   355

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

   356

 * @see FiosGetFileList

   357

 */

   358

FiosItem *FiosGetScenarioList(int mode)

   359

{

   360

	static char *fios_scn_path = NULL;

   361

   362

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

   363

	if (mode == SLD_NEW_GAME || fios_scn_path == NULL) {

   364

		if (fios_scn_path == NULL) fios_scn_path = malloc(MAX_PATH);

   365

		ttd_strlcpy(fios_scn_path, _path.scenario_dir, MAX_PATH);

   366

	}

   367

   368

	_fios_path = fios_scn_path;

   369

   370

	return FiosGetFileList(mode, &FiosGetScenarioListCallback);

   371

}