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 */

    78

{

    79

	FILE *f;

    80

#if defined(LIMITED_FDS)

    81

	/* Make sure we have this file open */

    83

#endif /* LIMITED_FDS */

    85

	assert(f != NULL);

    86

	_fio.cur_fh = f;

    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);

   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 */

   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];

   207

   208

/**

   209

 * Check whether the given file exists

   210

 * @param filename the file to try for existance

   211

 * @param subdir the subdirectory to look in

   212

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

   213

 */

   214

bool FioCheckFileExists(const char *filename, Subdirectory subdir)

   215

{

   216

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

   217

	if (f == NULL) return false;

   218

   219

	fclose(f);

   220

	return true;

   221

}

   222

   223

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

   224

{

   225

	assert(subdir < NUM_SUBDIRS);

   226

	assert(sp < NUM_SEARCHPATHS);

   227

   228

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

   229

	return buf;

   230

}

   231

   232

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

   233

{

   234

	Searchpath sp;

   235

	assert(subdir < NUM_SUBDIRS);

   236

   237

	FOR_ALL_SEARCHPATHS(sp) {

   238

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

   239

		if (FileExists(buf)) break;

   240

	}

   241

   242

	return buf;

   243

}

   244

   245

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

   246

{

   247

	assert(subdir < NUM_SUBDIRS);

   248

	assert(sp < NUM_SEARCHPATHS);

   249

   250

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

   251

	return buf;

   252

}

   253

   254

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

   255

{

   256

	Searchpath sp;

   257

   258

	/* Find and return the first valid directory */

   259

	FOR_ALL_SEARCHPATHS(sp) {

   260

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

   261

		if (FileExists(buf)) return ret;

   262

	}

   263

   264

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

   265

	ttd_strlcpy(buf, _personal_dir, buflen);

   266

   267

	return buf;

   268

}

   269

   270

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

   271

{

   272

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

   273

	/* fopen is implemented as a define with ellipses for

   274

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

   275

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

   276

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

   277

	wchar_t Lmode[5];

   278

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

   279

#endif

   280

	FILE *f = NULL;

   281

	char buf[MAX_PATH];

   282

   283

	if (subdir == NO_DIRECTORY) {

   284

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

   285

	} else {

   286

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

   287

	}

   288

   289

	f = fopen(buf, mode);

   290

#if !defined(WIN32)

   291

	if (f == NULL) {

   292

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

   293

		f = fopen(buf, mode);

   294

	}

   295

#endif

   296

	return f;

   297

}

   298

   299

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

   300

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

   301

{

   302

	FILE *f = NULL;

   303

	Searchpath sp;

   304

   305

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

   306

   307

	FOR_ALL_SEARCHPATHS(sp) {

   308

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

   309

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

   310

	}

   311

   312

	return f;

   313

}

   314

   315

/**

   316

 * Create a directory with the given name

   317

 * @param name the new name of the directory

   318

 */

   319

void FioCreateDirectory(const char *name)

   320

{

   321

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

   322

	CreateDirectory(OTTD2FS(name), NULL);

   323

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

   324

	mkdir(OTTD2FS(name));

   325

#else

   326

	mkdir(OTTD2FS(name), 0755);

   327

#endif

   328

}

   329

   330

/**

   331

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

   332

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

   333

 * @param buf    string to append the separator to

   334

 * @param buflen the length of the buf

   335

 */

   336

void AppendPathSeparator(char *buf, size_t buflen)

   337

{

   338

	size_t s = strlen(buf);

   339

   340

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

   341

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

   342

		buf[s]     = PATHSEPCHAR;

   343

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

   344

	}

   345

}

   346

   347

/**

   348

 * Allocates and files a variable with the full path

   349

 * based on the given directory.

   350

 * @param dir the directory to base the path on

   351

 * @return the malloced full path

   352

 */

   353

char *BuildWithFullPath(const char *dir)

   354

{

   355

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

   356

	ttd_strlcpy(dest, dir, MAX_PATH);

   357

   358

	/* Check if absolute or relative path */

   359

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

   360

   361

	/* Add absolute path */

   362

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

   363

		getcwd(dest, MAX_PATH);

   364

		AppendPathSeparator(dest, MAX_PATH);

   365

		ttd_strlcat(dest, dir, MAX_PATH);

   366

	}

   367

	AppendPathSeparator(dest, MAX_PATH);

   368

   369

	return dest;

   370

}

   371

   372

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

   373

/**

   374

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

   375

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

   376

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

   377

 */

   378

extern void DetermineBasePaths(const char *exe);

   379

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

   380

   381

/**

   382

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

   383

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

   384

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

   385

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

   386

 * @param exe the path to the executable

   387

 */

   388

void ChangeWorkingDirectory(const char *exe)

   389

{

   390

#ifdef WITH_COCOA

   391

	char *app_bundle = strchr(exe, '.');

   392

	while (app_bundle != NULL && strncasecmp(app_bundle, ".app", 4) != 0) app_bundle = strchr(&app_bundle[1], '.');

   393

   394

	if (app_bundle != NULL) app_bundle[0] = '\0';

   395

#endif /* WITH_COCOA */

   396

	char *s = strrchr(exe, PATHSEPCHAR);

   397

	if (s != NULL) {

   398

		*s = '\0';

   399

		chdir(exe);

   400

		*s = PATHSEPCHAR;

   401

	}

   402

#ifdef WITH_COCOA

   403

	if (app_bundle != NULL) app_bundle[0] = '.';

   404

#endif /* WITH_COCOA */

   405

}

   406

   407

/**

   408

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

   409

 * @param exe the path to the executable

   410

 */

   411

void DetermineBasePaths(const char *exe)

   412

{

   413

	char tmp[MAX_PATH];

   414

#if defined(__MORPHOS__) || defined(__AMIGA__) || !defined(WITH_PERSONAL_DIR)

   415

	_searchpaths[SP_PERSONAL_DIR] = NULL;

   416

#else

   417

	const char *homedir = getenv("HOME");

   418

   419

	if (homedir == NULL) {

   420

		const struct passwd *pw = getpwuid(getuid());

   421

		homedir = (pw == NULL) ? "" : pw->pw_dir;

   422

	}

   423

   424

	snprintf(tmp, MAX_PATH, "%s" PATHSEP "%s", homedir, PERSONAL_DIR);

   425

	AppendPathSeparator(tmp, MAX_PATH);

   426

   427

	_searchpaths[SP_PERSONAL_DIR] = strdup(tmp);

   428

#endif

   429

	_searchpaths[SP_SHARED_DIR] = NULL;

   430

   431

#if defined(__MORPHOS__) || defined(__AMIGA__)

   432

	_searchpaths[SP_WORKING_DIR] = NULL;

   433

#else

   434

	getcwd(tmp, MAX_PATH);

   435

	AppendPathSeparator(tmp, MAX_PATH);

   436

	_searchpaths[SP_WORKING_DIR] = strdup(tmp);

   437

#endif

   438

   439

	/* Change the working directory to that one of the executable */

   440

	ChangeWorkingDirectory((char*)exe);

   441

	getcwd(tmp, MAX_PATH);

   442

	AppendPathSeparator(tmp, MAX_PATH);

   443

	_searchpaths[SP_BINARY_DIR] = strdup(tmp);

   444

   445

#if defined(__MORPHOS__) || defined(__AMIGA__)

   446

	_searchpaths[SP_INSTALLATION_DIR] = NULL;

   447

#else

   448

	snprintf(tmp, MAX_PATH, "%s", GLOBAL_DATA_DIR);

   449

	AppendPathSeparator(tmp, MAX_PATH);

   450

	_searchpaths[SP_INSTALLATION_DIR] = strdup(tmp);

   451

#endif

   452

#ifdef WITH_COCOA

   453

extern void cocoaSetApplicationBundleDir();

   454

	cocoaSetApplicationBundleDir();

   455

#else

   456

	_searchpaths[SP_APPLICATION_BUNDLE_DIR] = NULL;

   457

#endif

   458

}

   459

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

   460

   461

char *_personal_dir;

   462

   463

/**

   464

 * Acquire the base paths (personal dir and game data dir),

   465

 * fill all other paths (save dir, autosave dir etc) and

   466

 * make the save and scenario directories.

   467

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

   468

 */

   469

void DeterminePaths(const char *exe)

   470

{

   471

	DetermineBasePaths(exe);

   472

   473

	Searchpath sp;

   474

	FOR_ALL_SEARCHPATHS(sp) DEBUG(misc, 4, "%s added as search path", _searchpaths[sp]);

   475

   476

	if (_config_file != NULL) {

   477

		_personal_dir = strdup(_config_file);

   478

		char *end = strrchr(_personal_dir , PATHSEPCHAR);

   479

		if (end == NULL) {

   480

			_personal_dir[0] = '\0';

   481

		} else {

   482

			end[1] = '\0';

   483

		}

   484

	} else {

   485

		char personal_dir[MAX_PATH];

   486

		FioFindFullPath(personal_dir, lengthof(personal_dir), BASE_DIR, "openttd.cfg");

   487

   488

		if (FileExists(personal_dir)) {

   489

			char *end = strrchr(personal_dir, PATHSEPCHAR);

   490

			if (end != NULL) end[1] = '\0';

   491

			_personal_dir = strdup(personal_dir);

   492

			_config_file = str_fmt("%sopenttd.cfg", _personal_dir);