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

     9

#include "variables.h"

    10

#include "debug.h"

    11

#include "fios.h"

    12

#include "core/alloc_func.hpp"

    13

#include "core/math_func.hpp"

    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

#if defined(LIMITED_FDS)

    37

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

    38

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

    39

#endif /* LIMITED_FDS */

    40

};

    41

    42

static Fio _fio;

    43

    44

/* Get current position in file */

    45

uint32 FioGetPos()

    46

{

    47

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

    48

}

    49

    50

const char *FioGetFilename()

    51

{

    52

	return _fio.filename;

    53

}

    54

    55

void FioSeekTo(uint32 pos, int mode)

    56

{

    57

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

    58

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

    59

	_fio.pos = pos;

    60

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

    61

}

    62

    63

#if defined(LIMITED_FDS)

    64

static void FioRestoreFile(int slot)

    65

{

    66

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

    67

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

    68

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

    69

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

    70

	}

    71

	_fio.usage_count[slot]++;

    72

}

    73

#endif /* LIMITED_FDS */

    74

    75

/* Seek to a file and a position */

    76

void FioSeekToFile(uint8 slot, uint32 pos)

    77

{

    78

	FILE *f;

    79

#if defined(LIMITED_FDS)

    80

	/* Make sure we have this file open */

    81

	FioRestoreFile(slot);

    82

#endif /* LIMITED_FDS */

    83

	f = _fio.handles[slot];

    84

	assert(f != NULL);

    85

	_fio.cur_fh = f;

    86

	_fio.filename = _fio.filenames[slot];

    87

	FioSeekTo(pos, SEEK_SET);

    88

}

    89

    90

byte FioReadByte()

    91

{

    92

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

    93

		_fio.pos += FIO_BUFFER_SIZE;

    94

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

    95

	}

    96

	return *_fio.buffer++;

    97

}

    98

    99

void FioSkipBytes(int n)

   100

{

   101

	for (;;) {

   102

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

   103

		_fio.buffer += m;

   104

		n -= m;

   105

		if (n == 0) break;

   106

		FioReadByte();

   107

		n--;

   108

	}

   109

}

   110

   111

uint16 FioReadWord()

   112

{

   113

	byte b = FioReadByte();

   114

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

   115

}

   116

   117

uint32 FioReadDword()

   118

{

   119

	uint b = FioReadWord();

   120

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

   121

}

   122

   123

void FioReadBlock(void *ptr, uint size)

   124

{

   125

	FioSeekTo(FioGetPos(), SEEK_SET);

   126

	_fio.pos += size;

   127

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

   128

}

   129

   130

static inline void FioCloseFile(int slot)

   131

{

   132

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

   133

		fclose(_fio.handles[slot]);

   134

		_fio.handles[slot] = NULL;

   135

#if defined(LIMITED_FDS)

   136

		_fio.open_handles--;

   137

#endif /* LIMITED_FDS */

   138

	}

   139

}

   140

   141

void FioCloseAll()

   142

{

   143

	int i;

   144

   145

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

   146

		FioCloseFile(i);

   147

}

   148

   149

#if defined(LIMITED_FDS)

   150

static void FioFreeHandle()

   151

{

   152

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

   153

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

   154

		uint i, count;

   155

		int slot;

   156

   157

		count = UINT_MAX;

   158

		slot = -1;

   159

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

   160

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

   161

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

   162

				count = _fio.usage_count[i];

   163

				slot  = i;

   164

			}

   165

		}

   166

		assert(slot != -1);

   167

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

   168

		FioCloseFile(slot);

   169

	}

   170

}

   171

#endif /* LIMITED_FDS */

   172

   173

void FioOpenFile(int slot, const char *filename)

   174

{

   175

	FILE *f;

   176

   177

#if defined(LIMITED_FDS)

   178

	FioFreeHandle();

   179

#endif /* LIMITED_FDS */

   180

	f = FioFOpenFile(filename);

   181

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

   182

	uint32 pos = ftell(f);

   183

   184

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

   185

	_fio.handles[slot] = f;

   186

	_fio.filenames[slot] = filename;

   187

#if defined(LIMITED_FDS)

   188

	_fio.usage_count[slot] = 0;

   189

	_fio.open_handles++;

   190

#endif /* LIMITED_FDS */

   191

	FioSeekToFile(slot, pos);

   192

}

   193

   194

const char *_subdirs[NUM_SUBDIRS] = {

   195

	"",

   196

	"save" PATHSEP,

   197

	"save" PATHSEP "autosave" PATHSEP,

   198

	"scenario" PATHSEP,

   199

	"scenario" PATHSEP "heightmap" PATHSEP,

   200

	"gm" PATHSEP,

   201

	"data" PATHSEP,

   202

	"lang" PATHSEP

   203

};

   204

   205

const char *_searchpaths[NUM_SEARCHPATHS];

   206

TarList _tar_list;

   207

TarFileList _tar_filelist;

   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

	FioFCloseFile(f);

   221

	return true;

   222

}

   223

   224

/**

   225

 * Close a file in a safe way.

   226

 */

   227

void FioFCloseFile(FILE *f)

   228

{

   229

	fclose(f);

   230

}

   231

   232

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

   233

{

   234

	assert(subdir < NUM_SUBDIRS);

   235

	assert(sp < NUM_SEARCHPATHS);

   236

   237

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

   238

	return buf;

   239

}

   240

   241

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

   242

{

   243

	Searchpath sp;

   244

	assert(subdir < NUM_SUBDIRS);

   245

   246

	FOR_ALL_SEARCHPATHS(sp) {

   247

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

   248

		if (FileExists(buf)) break;

   249

	}

   250

   251

	return buf;

   252

}

   253

   254

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

   255

{

   256

	assert(subdir < NUM_SUBDIRS);

   257

	assert(sp < NUM_SEARCHPATHS);

   258

   259

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

   260

	return buf;

   261

}

   262

   263

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

   264

{

   265

	Searchpath sp;

   266

   267

	/* Find and return the first valid directory */

   268

	FOR_ALL_SEARCHPATHS(sp) {

   269

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

   270

		if (FileExists(buf)) return ret;

   271

	}

   272

   273

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

   274

	ttd_strlcpy(buf, _personal_dir, buflen);

   275

   276

	return buf;

   277

}

   278

   279

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

   280

{

   281

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

   282

	/* fopen is implemented as a define with ellipses for

   283

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

   284

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

   285

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

   286

	wchar_t Lmode[5];

   287

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

   288

#endif

   289

	FILE *f = NULL;

   290

	char buf[MAX_PATH];

   291

   292

	if (subdir == NO_DIRECTORY) {

   293

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

   294

	} else {

   295

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

   296

	}

   297

   298

#if defined(WIN32)

   299

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

   300

#endif

   301

   302

	f = fopen(buf, mode);

   303

#if !defined(WIN32)

   304

	if (f == NULL) {

   305

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

   306

		f = fopen(buf, mode);

   307

	}

   308

#endif

   309

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

   310

		/* Find the size of the file */

   311

		fseek(f, 0, SEEK_END);

   312

		*filesize = ftell(f);

   313

		fseek(f, 0, SEEK_SET);

   314

	}

   315

	return f;

   316

}

   317

   318

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

   319

{

   320

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

   321

	assert(f != NULL);

   322

   323

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

   324

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

   325

	return f;

   326

}

   327

   328

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

   329

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

   330

{

   331

	FILE *f = NULL;

   332

	Searchpath sp;

   333

   334

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

   335

   336

	FOR_ALL_SEARCHPATHS(sp) {

   337

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

   338

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

   339

	}

   340

   341

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

   342

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

   343

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

   344

		char *lcfilename = strdup(filename);

   345

		strtolower(lcfilename);

   346

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

   347

		free(lcfilename);

   348

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

   349

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

   350

		}

   351

	}

   352

   353

	/* Sometimes a full path is given. To support

   354

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

   355

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

   356

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

   357

	}

   358

   359

	return f;

   360

}

   361

   362

/**

   363

 * Create a directory with the given name

   364

 * @param name the new name of the directory

   365

 */

   366

void FioCreateDirectory(const char *name)

   367

{

   368

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

   369

	CreateDirectory(OTTD2FS(name), NULL);

   370

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

   371

	mkdir(OTTD2FS(name));

   372

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

   373

	char buf[MAX_PATH];

   374

	ttd_strlcpy(buf, name, MAX_PATH);

   375

   376

	size_t len = strlen(name) - 1;

   377

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

   378

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

   379

	}

   380

   381

	mkdir(OTTD2FS(buf), 0755);

   382

#else

   383

	mkdir(OTTD2FS(name), 0755);

   384

#endif

   385

}

   386

   387

/**

   388

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

   389

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

   390

 * @param buf    string to append the separator to

   391

 * @param buflen the length of the buf

   392

 */

   393

void AppendPathSeparator(char *buf, size_t buflen)

   394

{

   395

	size_t s = strlen(buf);

   396

   397

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

   398

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

   399

		buf[s]     = PATHSEPCHAR;

   400

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

   401

	}

   402

}

   403

   404

/**

   405

 * Allocates and files a variable with the full path

   406

 * based on the given directory.

   407

 * @param dir the directory to base the path on

   408

 * @return the malloced full path

   409

 */

   410

char *BuildWithFullPath(const char *dir)

   411

{

   412

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

   413

	ttd_strlcpy(dest, dir, MAX_PATH);

   414

   415

	/* Check if absolute or relative path */

   416

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

   417

   418

	/* Add absolute path */

   419

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

   420

		getcwd(dest, MAX_PATH);

   421

		AppendPathSeparator(dest, MAX_PATH);

   422

		ttd_strlcat(dest, dir, MAX_PATH);

   423

	}

   424

	AppendPathSeparator(dest, MAX_PATH);

   425

   426

	return dest;

   427

}

   428

   429

static bool TarListAddFile(const char *filename)

   430

{

   431

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

   432

	typedef struct TarHeader {

   433

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

   434

		char mode[8];

   435

		char uid[8];

   436

		char gid[8];

   437

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

   438

		char mtime[12];

   439

		char chksum[8];

   440

		char typeflag;

   441

		char linkname[100];

   442

		char magic[6];

   443

		char version[2];

   444

		char uname[32];

   445

		char gname[32];

   446

		char devmajor[8];

   447

		char devminor[8];

   448

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

   449

   450

		char unused[12];

   451

	} TarHeader;

   452

   453

	/* Check if we already seen this file */

   454

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

   455

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

   456

   457

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

   458

	assert(f != NULL);

   459

   460

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

   461

	tar_entry->filename = strdup(filename);

   462

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

   463

   464

	TarHeader th;

   465

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

   466

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

   467

	int num = 0, pos = 0;

   468

   469

	/* Make a char of 512 empty bytes */

   470

	char empty[512];

   471

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

   472

   473

	while (!feof(f)) {

   474

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

   475

		pos += 512;

   476

   477

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

   478

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

   479

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

   480

			if (memcmp(&th, &empty[0], 512) == 0) continue;

   481

   482

			DEBUG(misc, 0, "The file '%s' isn't a valid tar-file", filename);

   483

			return false;

   484

		}

   485

   486

		name[0] = '\0';

   487

		int len = 0;

   488

   489

		/* The prefix contains the directory-name */

   490

		if (th.prefix[0] != '\0') {

   491

			memcpy(name, th.prefix, sizeof(th.prefix));

   492

			name[sizeof(th.prefix)] = '\0';