1

/* $Id$ */

     2

     3

/** @file fileio.cpp Standard In/Out file operations */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "fileio.h"

     8

#include "functions.h"

     9

#include "string.h"

    10

#include "macros.h"

    11

#include "variables.h"

    12

#include "debug.h"

    13

#include "fios.h"

    14

#ifdef WIN32

    15

#include <windows.h>

    16

#else

    17

#include <pwd.h>

    18

#include <unistd.h>

    19

#include <sys/stat.h>

    20

#endif

    21

    22

/*************************************************/

    23

/* FILE IO ROUTINES ******************************/

    24

/*************************************************/

    25

    26

#define FIO_BUFFER_SIZE 512

    27

#define MAX_HANDLES 64

    28

    29

struct Fio {

    30

	byte *buffer, *buffer_end;          ///< position pointer in local buffer and last valid byte of buffer

    31

	uint32 pos;                         ///< current (system) position in file

    32

	FILE *cur_fh;                       ///< current file handle

    33

	const char *filename;               ///< current filename

    34

	FILE *handles[MAX_HANDLES];         ///< array of file handles we can have open

    35

	byte buffer_start[FIO_BUFFER_SIZE]; ///< local buffer when read from file

    36

	const char *filenames[MAX_HANDLES]; ///< array of filenames we (should) have open

    37

#if defined(LIMITED_FDS)

    38

	uint open_handles;                  ///< current amount of open handles

    39

	uint usage_count[MAX_HANDLES];      ///< count how many times this file has been opened

    40

#endif /* LIMITED_FDS */

    41

};

    42

    43

static Fio _fio;

    44

    45

/* Get current position in file */

    46

uint32 FioGetPos()

    47

{

    48

	return _fio.pos + (_fio.buffer - _fio.buffer_start) - FIO_BUFFER_SIZE;

    49

}

    50

    51

const char *FioGetFilename()

    52

{

    53

	return _fio.filename;

    54

}

    55

    56

void FioSeekTo(uint32 pos, int mode)

    57

{

    58

	if (mode == SEEK_CUR) pos += FioGetPos();

    59

	_fio.buffer = _fio.buffer_end = _fio.buffer_start + FIO_BUFFER_SIZE;

    60

	_fio.pos = pos;

    61

	fseek(_fio.cur_fh, _fio.pos, SEEK_SET);

    62

}

    63

    64

#if defined(LIMITED_FDS)

    65

static void FioRestoreFile(int slot)

    66

{

    67

	/* Do we still have the file open, or should we reopen it? */

    68

	if (_fio.handles[slot] == NULL) {

    69

		DEBUG(misc, 6, "Restoring file '%s' in slot '%d' from disk", _fio.filenames[slot], slot);

    70

		FioOpenFile(slot, _fio.filenames[slot]);

    71

	}

    72

	_fio.usage_count[slot]++;

    73

}

    74

#endif /* LIMITED_FDS */

    75

    76

/* Seek to a file and a position */

    77

void FioSeekToFile(uint8 slot, uint32 pos)

    78

{

    79

	FILE *f;

    80

#if defined(LIMITED_FDS)

    81

	/* Make sure we have this file open */

    82

	FioRestoreFile(slot);

    83

#endif /* LIMITED_FDS */

    84

	f = _fio.handles[slot];

    85

	assert(f != NULL);

    86

	_fio.cur_fh = f;

    87

	_fio.filename = _fio.filenames[slot];

    88

	FioSeekTo(pos, SEEK_SET);

    89

}

    90

    91

byte FioReadByte()

    92

{

    93

	if (_fio.buffer == _fio.buffer_end) {

    94

		_fio.pos += FIO_BUFFER_SIZE;

    95

		fread(_fio.buffer = _fio.buffer_start, 1, FIO_BUFFER_SIZE, _fio.cur_fh);

    96

	}

    97

	return *_fio.buffer++;

    98

}

    99

   100

void FioSkipBytes(int n)

   101

{

   102

	for (;;) {

   103

		int m = min(_fio.buffer_end - _fio.buffer, n);

   104

		_fio.buffer += m;

   105

		n -= m;

   106

		if (n == 0) break;

   107

		FioReadByte();

   108

		n--;

   109

	}

   110

}

   111

   112

uint16 FioReadWord()

   113

{

   114

	byte b = FioReadByte();

   115

	return (FioReadByte() << 8) | b;

   116

}

   117

   118

uint32 FioReadDword()

   119

{

   120

	uint b = FioReadWord();

   121

	return (FioReadWord() << 16) | b;

   122

}

   123

   124

void FioReadBlock(void *ptr, uint size)

   125

{

   126

	FioSeekTo(FioGetPos(), SEEK_SET);

   127

	_fio.pos += size;

   128

	fread(ptr, 1, size, _fio.cur_fh);

   129

}

   130

   131

static inline void FioCloseFile(int slot)

   132

{

   133

	if (_fio.handles[slot] != NULL) {

   134

		fclose(_fio.handles[slot]);

   135

		_fio.handles[slot] = NULL;

   136

#if defined(LIMITED_FDS)

   137

		_fio.open_handles--;

   138

#endif /* LIMITED_FDS */

   139

	}

   140

}

   141

   142

void FioCloseAll()

   143

{

   144

	int i;

   145

   146

	for (i = 0; i != lengthof(_fio.handles); i++)

   147

		FioCloseFile(i);

   148

}

   149

   150

#if defined(LIMITED_FDS)

   151

static void FioFreeHandle()

   152

{

   153

	/* If we are about to open a file that will exceed the limit, close a file */

   154

	if (_fio.open_handles + 1 == LIMITED_FDS) {

   155

		uint i, count;

   156

		int slot;

   157

   158

		count = UINT_MAX;

   159

		slot = -1;

   160

		/* Find the file that is used the least */

   161

		for (i = 0; i < lengthof(_fio.handles); i++) {

   162

			if (_fio.handles[i] != NULL && _fio.usage_count[i] < count) {

   163

				count = _fio.usage_count[i];

   164

				slot  = i;

   165

			}

   166

		}

   167

		assert(slot != -1);

   168

		DEBUG(misc, 6, "Closing filehandler '%s' in slot '%d' because of fd-limit", _fio.filenames[slot], slot);

   169

		FioCloseFile(slot);

   170

	}

   171

}

   172

#endif /* LIMITED_FDS */

   173

   174

void FioOpenFile(int slot, const char *filename)

   175

{

   176

	FILE *f;

   177

   178

#if defined(LIMITED_FDS)

   179

	FioFreeHandle();

   180

#endif /* LIMITED_FDS */

   181

	f = FioFOpenFile(filename);

   182

	if (f == NULL) error("Cannot open file '%s'", filename);

   183

	uint32 pos = ftell(f);

   184

   185

	FioCloseFile(slot); // if file was opened before, close it

   186

	_fio.handles[slot] = f;

   187

	_fio.filenames[slot] = filename;

   188

#if defined(LIMITED_FDS)

   189

	_fio.usage_count[slot] = 0;

   190

	_fio.open_handles++;

   191

#endif /* LIMITED_FDS */

   192

	FioSeekToFile(slot, pos);

   193

}

   194

   195

const char *_subdirs[NUM_SUBDIRS] = {

   196

	"",

   197

	"save" PATHSEP,

   198

	"save" PATHSEP "autosave" PATHSEP,

   199

	"scenario" PATHSEP,

   200

	"scenario" PATHSEP "heightmap" PATHSEP,

   201

	"gm" PATHSEP,

   202

	"data" PATHSEP,

   203

	"lang" PATHSEP

   204

};

   205

   206

const char *_searchpaths[NUM_SEARCHPATHS];

   208

   209

/**

   210

 * Check whether the given file exists

   211

 * @param filename the file to try for existance

   212

 * @param subdir the subdirectory to look in

   213

 * @return true if and only if the file can be opened

   214

 */

   215

bool FioCheckFileExists(const char *filename, Subdirectory subdir)

   216

{

   217

	FILE *f = FioFOpenFile(filename, "rb", subdir);

   218

	if (f == NULL) return false;

   219

   220

	fclose(f);

   221

	return true;

   222

}

   223

   224

char *FioGetFullPath(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir, const char *filename)

   225

{

   226

	assert(subdir < NUM_SUBDIRS);

   227

	assert(sp < NUM_SEARCHPATHS);

   228

   229

	snprintf(buf, buflen, "%s%s%s", _searchpaths[sp], _subdirs[subdir], filename);

   230

	return buf;

   231

}

   232

   233

char *FioFindFullPath(char *buf, size_t buflen, Subdirectory subdir, const char *filename)

   234

{

   235

	Searchpath sp;

   236

	assert(subdir < NUM_SUBDIRS);

   237

   238

	FOR_ALL_SEARCHPATHS(sp) {

   239

		FioGetFullPath(buf, buflen, sp, subdir, filename);

   240

		if (FileExists(buf)) break;

   241

	}

   242

   243

	return buf;

   244

}

   245

   246

char *FioAppendDirectory(char *buf, size_t buflen, Searchpath sp, Subdirectory subdir)

   247

{

   248

	assert(subdir < NUM_SUBDIRS);

   249

	assert(sp < NUM_SEARCHPATHS);

   250

   251

	snprintf(buf, buflen, "%s%s", _searchpaths[sp], _subdirs[subdir]);

   252

	return buf;

   253

}

   254

   255

char *FioGetDirectory(char *buf, size_t buflen, Subdirectory subdir)

   256

{

   257

	Searchpath sp;

   258

   259

	/* Find and return the first valid directory */

   260

	FOR_ALL_SEARCHPATHS(sp) {

   261

		char *ret = FioAppendDirectory(buf, buflen, sp, subdir);

   262

		if (FileExists(buf)) return ret;

   263

	}

   264

   265

	/* Could not find the directory, fall back to a base path */

   266

	ttd_strlcpy(buf, _personal_dir, buflen);

   267

   268

	return buf;

   269

}

   270

   271

FILE *FioFOpenFileSp(const char *filename, const char *mode, Searchpath sp, Subdirectory subdir, size_t *filesize)

   272

{

   273

#if defined(WIN32) && defined(UNICODE)

   274

	/* fopen is implemented as a define with ellipses for

   275

	 * Unicode support (prepend an L). As we are not sending

   276

	 * a string, but a variable, it 'renames' the variable,

   277

	 * so make that variable to makes it compile happily */

   278

	wchar_t Lmode[5];

   279

	MultiByteToWideChar(CP_ACP, 0, mode, -1, Lmode, lengthof(Lmode));

   280

#endif

   281

	FILE *f = NULL;

   282

	char buf[MAX_PATH];

   283

   284

	if (subdir == NO_DIRECTORY) {

   285

		ttd_strlcpy(buf, filename, lengthof(buf));

   286

	} else {

   287

		snprintf(buf, lengthof(buf), "%s%s%s", _searchpaths[sp], _subdirs[subdir], filename);

   288

	}

   289

   290

	f = fopen(buf, mode);

   291

#if !defined(WIN32)

   292

	if (f == NULL) {

   293

		strtolower(buf + strlen(_searchpaths[sp]) - 1);

   294

		f = fopen(buf, mode);

   295

	}

   296

#endif

   297

	if (f != NULL && filesize != NULL) {

   298

		/* Find the size of the file */

   299

		fseek(f, 0, SEEK_END);

   300

		*filesize = ftell(f);

   301

		fseek(f, 0, SEEK_SET);

   302

	}

   303

	return f;

   304

}

   305

   399

/** Opens OpenTTD files somewhere in a personal or global directory */

   400

FILE *FioFOpenFile(const char *filename, const char *mode, Subdirectory subdir, size_t *filesize)

   401

{

   402

	FILE *f = NULL;

   403

	Searchpath sp;

   404

   405

	assert(subdir < NUM_SUBDIRS || subdir == NO_DIRECTORY);

   406

   407

	FOR_ALL_SEARCHPATHS(sp) {

   408

		f = FioFOpenFileSp(filename, mode, sp, subdir, filesize);

   409

		if (f != NULL || subdir == NO_DIRECTORY) break;

   410

	}

   419

   420

	return f;

   421

}

   422

   423

/**

   424

 * Create a directory with the given name

   425

 * @param name the new name of the directory

   426

 */

   427

void FioCreateDirectory(const char *name)

   428

{

   429

#if defined(WIN32) || defined(WINCE)

   430

	CreateDirectory(OTTD2FS(name), NULL);

   431

#elif defined(OS2) && !defined(__INNOTEK_LIBC__)

   432

	mkdir(OTTD2FS(name));

   433

#else

   434

	mkdir(OTTD2FS(name), 0755);

   435

#endif

   436

}

   437

   438

/**

   439

 * Appends, if necessary, the path separator character to the end of the string.

   440

 * It does not add the path separator to zero-sized strings.

   441

 * @param buf    string to append the separator to

   442

 * @param buflen the length of the buf

   443

 */

   444

void AppendPathSeparator(char *buf, size_t buflen)

   445

{

   446

	size_t s = strlen(buf);

   447

   448

	/* Length of string + path separator + '\0' */

   449

	if (s != 0 && buf[s - 1] != PATHSEPCHAR && s + 2 < buflen) {

   450

		buf[s]     = PATHSEPCHAR;

   451

		buf[s + 1] = '\0';

   452

	}

   453

}

   454

   455

/**

   456

 * Allocates and files a variable with the full path

   457

 * based on the given directory.

   458

 * @param dir the directory to base the path on

   459

 * @return the malloced full path

   460

 */

   461

char *BuildWithFullPath(const char *dir)

   462

{

   463

	char *dest = MallocT<char>(MAX_PATH);

   464

	ttd_strlcpy(dest, dir, MAX_PATH);

   465

   466

	/* Check if absolute or relative path */

   467

	const char *s = strchr(dest, PATHSEPCHAR);

   468

   469

	/* Add absolute path */

   470

	if (s == NULL || dest != s) {

   471

		getcwd(dest, MAX_PATH);

   472

		AppendPathSeparator(dest, MAX_PATH);

   473

		ttd_strlcat(dest, dir, MAX_PATH);

   474

	}

   475

	AppendPathSeparator(dest, MAX_PATH);

   476

   477

	return dest;

   478

}

   479

   480

#if defined(WIN32) || defined(WINCE)

   481

/**

   482

 * Determine the base (personal dir and game data dir) paths

   483

 * @param exe the path from the current path to the executable

   484

 * @note defined in the OS related files (os2.cpp, win32.cpp, unix.cpp etc)

   485

 */

   486

extern void DetermineBasePaths(const char *exe);

   487

#else /* defined(WIN32) || defined(WINCE) */

   488

   489

/**

   490

 * Changes the working directory to the path of the give executable.

   491

 * For OSX application bundles '.app' is the required extension of the bundle,

   492

 * so when we crop the path to there, when can remove the name of the bundle

   493

 * in the same way we remove the name from the executable name.