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

     9

#include "debug.h"

    10

#include "fios.h"

    11

#include "core/alloc_func.hpp"

    12

#include "core/math_func.hpp"

    13

#include "string_func.h"

    14

#ifdef WIN32

    15

#include <windows.h>

    16

#else

    17

#include <pwd.h>

    18

#include <unistd.h>

    19

#endif

    20

#include <sys/stat.h>

    21

    22

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

    23

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

    24

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

    25

    26

#define FIO_BUFFER_SIZE 512

    27

    28

struct Fio {

    29

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

    30

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

    31

	FILE *cur_fh;                          ///< current file handle

    32

	const char *filename;                  ///< current filename

    33

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

    34

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

    35

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

    36

	char *shortnames[MAX_FILE_SLOTS];///< array of short names for spriteloader's use

    37

#if defined(LIMITED_FDS)

    38

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

    39

	uint usage_count[MAX_FILE_SLOTS];      ///< 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(uint8 slot)

    52

{

    53

	return _fio.shortnames[slot];

    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

   136

		free(_fio.shortnames[slot]);

   137

		_fio.shortnames[slot] = NULL;

   138

   139

		_fio.handles[slot] = NULL;

   140

#if defined(LIMITED_FDS)

   141

		_fio.open_handles--;

   142

#endif /* LIMITED_FDS */

   143

	}

   144

}

   145

   146

void FioCloseAll()

   147

{

   148

	int i;

   149

   150

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

   151

		FioCloseFile(i);

   152

}

   153

   154

#if defined(LIMITED_FDS)

   155

static void FioFreeHandle()

   156

{

   157

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

   158

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

   159

		uint i, count;

   160

		int slot;

   161

   162

		count = UINT_MAX;

   163

		slot = -1;

   164

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

   165

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

   166

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

   167

				count = _fio.usage_count[i];

   168

				slot  = i;

   169

			}

   170

		}

   171

		assert(slot != -1);

   172

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

   173

		FioCloseFile(slot);

   174

	}

   175

}

   176

#endif /* LIMITED_FDS */

   177

   178

void FioOpenFile(int slot, const char *filename)

   179

{

   180

	FILE *f;

   181

   182

#if defined(LIMITED_FDS)

   183

	FioFreeHandle();

   184

#endif /* LIMITED_FDS */

   185

	f = FioFOpenFile(filename);

   186

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

   187

	uint32 pos = ftell(f);

   188

   189

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

   190

	_fio.handles[slot] = f;

   191

	_fio.filenames[slot] = filename;

   192

   193

	/* Store the filename without path and extension */

   194

	const char *t = strrchr(filename, PATHSEPCHAR);

   195

	_fio.shortnames[slot] = strdup(t == NULL ? filename : t);

   196

	char *t2 = strrchr(_fio.shortnames[slot], '.');

   197

	if (t2 != NULL) *t2 = '\0';

   198

	strtolower(_fio.shortnames[slot]);

   199

   200

#if defined(LIMITED_FDS)

   201

	_fio.usage_count[slot] = 0;

   202

	_fio.open_handles++;

   203

#endif /* LIMITED_FDS */

   204

	FioSeekToFile(slot, pos);

   205

}

   206

   207

const char *_subdirs[NUM_SUBDIRS] = {

   208

	"",

   209

	"save" PATHSEP,

   210

	"save" PATHSEP "autosave" PATHSEP,

   211

	"scenario" PATHSEP,

   212

	"scenario" PATHSEP "heightmap" PATHSEP,

   213

	"gm" PATHSEP,

   214

	"data" PATHSEP,

   215

	"lang" PATHSEP

   216

};

   217

   218

const char *_searchpaths[NUM_SEARCHPATHS];

   219

TarList _tar_list;

   220

TarFileList _tar_filelist;

   221

   222

/**

   223

 * Check whether the given file exists

   224

 * @param filename the file to try for existance

   225

 * @param subdir the subdirectory to look in

   226

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

   227

 */

   228

bool FioCheckFileExists(const char *filename, Subdirectory subdir)

   229

{

   230

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

   231

	if (f == NULL) return false;

   232

   233

	FioFCloseFile(f);

   234

	return true;

   235

}

   236

   237

/**

   238

 * Close a file in a safe way.

   239

 */

   240

void FioFCloseFile(FILE *f)

   241

{

   242

	fclose(f);

   243

}

   244

   245

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

   246

{

   247

	assert(subdir < NUM_SUBDIRS);

   248

	assert(sp < NUM_SEARCHPATHS);

   249

   250

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

   251

	return buf;

   252

}

   253

   254

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

   255

{

   256

	Searchpath sp;

   257

	assert(subdir < NUM_SUBDIRS);

   258

   259

	FOR_ALL_SEARCHPATHS(sp) {

   260

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

   261

		if (FileExists(buf)) break;

   262

	}

   263

   264

	return buf;

   265

}

   266

   267

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

   268

{

   269

	assert(subdir < NUM_SUBDIRS);

   270

	assert(sp < NUM_SEARCHPATHS);

   271

   272

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

   273

	return buf;

   274

}

   275

   276

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

   277

{

   278

	Searchpath sp;

   279

   280

	/* Find and return the first valid directory */

   281

	FOR_ALL_SEARCHPATHS(sp) {

   282

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

   283

		if (FileExists(buf)) return ret;

   284

	}

   285

   286

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

   287

	ttd_strlcpy(buf, _personal_dir, buflen);

   288

   289

	return buf;

   290

}

   291

   292

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

   293

{

   294

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

   295

	/* fopen is implemented as a define with ellipses for

   296

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

   297

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

   298

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

   299

	wchar_t Lmode[5];

   300

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

   301

#endif

   302

	FILE *f = NULL;

   303

	char buf[MAX_PATH];

   304

   305

	if (subdir == NO_DIRECTORY) {

   306

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

   307

	} else {

   308

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

   309

	}

   310

   311

#if defined(WIN32)

   312

	if (mode[0] == 'r' && GetFileAttributes(OTTD2FS(buf)) == INVALID_FILE_ATTRIBUTES) return NULL;

   313

#endif

   314

   315

	f = fopen(buf, mode);

   316

#if !defined(WIN32)

   317

	if (f == NULL) {

   318

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

   319

		f = fopen(buf, mode);

   320

	}

   321

#endif

   322

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

   323

		/* Find the size of the file */

   324

		fseek(f, 0, SEEK_END);

   325

		*filesize = ftell(f);

   326

		fseek(f, 0, SEEK_SET);

   327

	}

   328

	return f;

   329

}

   330

   331

FILE *FioFOpenFileTar(TarFileListEntry *entry, size_t *filesize)

   332

{

   333

	FILE *f = fopen(entry->tar->filename, "rb");

   334

	assert(f != NULL);

   335

   336

	fseek(f, entry->position, SEEK_SET);

   337

	if (filesize != NULL) *filesize = entry->size;

   338

	return f;

   339

}

   340

   341

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

   342

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

   343

{

   344

	FILE *f = NULL;

   345

	Searchpath sp;

   346

   347

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

   348

   349

	FOR_ALL_SEARCHPATHS(sp) {

   350

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

   351

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

   352

	}

   353

   354

	/* We can only use .tar in case of data-dir, and read-mode */

   355

	if (f == NULL && subdir == DATA_DIR && mode[0] == 'r') {

   356

		/* Filenames in tars are always forced to be lowercase */

   357

		char *lcfilename = strdup(filename);

   358

		strtolower(lcfilename);

   359

		TarFileList::iterator it = _tar_filelist.find(lcfilename);

   360

		free(lcfilename);

   361

		if (it != _tar_filelist.end()) {

   362

			f = FioFOpenFileTar(&((*it).second), filesize);

   363

		}

   364

	}

   365

   366

	/* Sometimes a full path is given. To support

   367

	 * the 'subdirectory' must be 'removed'. */

   368

	if (f == NULL && subdir != NO_DIRECTORY) {

   369

		f = FioFOpenFile(filename, mode, NO_DIRECTORY, filesize);

   370

	}

   371

   372

	return f;

   373

}

   374

   375

/**

   376

 * Create a directory with the given name

   377

 * @param name the new name of the directory

   378

 */

   379

void FioCreateDirectory(const char *name)

   380

{

   381

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

   382

	CreateDirectory(OTTD2FS(name), NULL);

   383

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

   384

	mkdir(OTTD2FS(name));

   385

#elif defined(__MORPHOS__) || defined(__AMIGAOS__)

   386

	char buf[MAX_PATH];

   387

	ttd_strlcpy(buf, name, MAX_PATH);

   388

   389

	size_t len = strlen(name) - 1;

   390

	if (buf[len] == '/') {

   391

		buf[len] = '\0'; // Kill pathsep, so mkdir() will not fail

   392

	}

   393

   394

	mkdir(OTTD2FS(buf), 0755);

   395

#else

   396

	mkdir(OTTD2FS(name), 0755);

   397

#endif

   398

}

   399

   400

/**

   401

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

   402

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

   403

 * @param buf    string to append the separator to

   404

 * @param buflen the length of the buf

   405

 */

   406

void AppendPathSeparator(char *buf, size_t buflen)

   407

{

   408

	size_t s = strlen(buf);

   409

   410

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

   411

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

   412

		buf[s]     = PATHSEPCHAR;

   413

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

   414

	}

   415

}

   416

   417

/**

   418

 * Allocates and files a variable with the full path

   419

 * based on the given directory.

   420

 * @param dir the directory to base the path on

   421

 * @return the malloced full path

   422

 */

   423

char *BuildWithFullPath(const char *dir)

   424

{

   425

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

   426

	ttd_strlcpy(dest, dir, MAX_PATH);

   427

   428

	/* Check if absolute or relative path */

   429

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

   430

   431

	/* Add absolute path */

   432

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

   433

		getcwd(dest, MAX_PATH);

   434

		AppendPathSeparator(dest, MAX_PATH);

   435

		ttd_strlcat(dest, dir, MAX_PATH);

   436

	}

   437

	AppendPathSeparator(dest, MAX_PATH);

   438

   439

	return dest;

   440

}

   441

   442

static bool TarListAddFile(const char *filename)

   443

{

   444

	/* The TAR-header, repeated for every file */

   445

	typedef struct TarHeader {

   446

		char name[100];      ///< Name of the file

   447

		char mode[8];

   448

		char uid[8];

   449

		char gid[8];

   450

		char size[12];       ///< Size of the file, in ASCII

   451

		char mtime[12];

   452

		char chksum[8];

   453

		char typeflag;

   454

		char linkname[100];

   455

		char magic[6];

   456

		char version[2];

   457

		char uname[32];

   458

		char gname[32];

   459

		char devmajor[8];

   460

		char devminor[8];

   461

		char prefix[155];    ///< Path of the file

   462

   463

		char unused[12];

   464

	} TarHeader;

   465

   466

	/* Check if we already seen this file */

   467

	TarList::iterator it = _tar_list.find(filename);

   468

	if (it != _tar_list.end()) return false;

   469

   470

	FILE *f = fopen(filename, "rb");

   471

	assert(f != NULL);

   472

   473

	TarListEntry *tar_entry = MallocT<TarListEntry>(1);

   474

	tar_entry->filename = strdup(filename);

   475

	_tar_list.insert(TarList::value_type(filename, tar_entry));

   476

   477

	TarHeader th;

   478

	char buf[sizeof(th.name) + 1], *end;

   479

	char name[sizeof(th.prefix) + 1 + sizeof(th.name) + 1];

   480

	int num = 0, pos = 0;

   481

   482

	/* Make a char of 512 empty bytes */

   483

	char empty[512];

   484

	memset(&empty[0], 0, sizeof(empty));

   485

   486

	while (!feof(f)) {

   487

		fread(&th, 1, 512, f);

   488

		pos += 512;

   489

   490

		/* Check if we have the new tar-format (ustar) or the old one (a lot of zeros after 'link' field) */

   491

		if (strncmp(th.magic, "ustar", 5) != 0 && memcmp(&th.magic, &empty[0], 512 - offsetof(TarHeader, magic)) != 0) {

   492

			/* If we have only zeros in the block, it can be an end-of-file indicator */