1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "macros.h"

     7

#include "debug.h"

     8

#include "variables.h"

     9

#include "string.h"

    10

#include "saveload.h"

    11

#include "md5.h"

    12

#include "network/network_data.h"

    13

#include "newgrf.h"

    14

#include "newgrf_config.h"

    15

    16

#include "fileio.h"

    17

#include "fios.h"

    18

#include <sys/types.h>

    19

#include <sys/stat.h>

    20

    21

#ifdef WIN32

    22

# include <io.h>

    23

#else

    24

# include <unistd.h>

    25

# include <dirent.h>

    26

#endif /* WIN32 */

    27

    28

    29

GRFConfig *_all_grfs;

    30

GRFConfig *_grfconfig;

    31

GRFConfig *_grfconfig_newgame;

    32

GRFConfig *_grfconfig_static;

    33

    34

    35

/* Calculate the MD5 Sum for a GRF */

    36

static bool CalcGRFMD5Sum(GRFConfig *config)

    37

{

    38

	FILE *f;

    39

	char filename[MAX_PATH];

    40

	md5_state_t md5state;

    41

	md5_byte_t buffer[1024];

    42

	size_t len;

    43

    44

	/* open the file */

    45

	snprintf(filename, lengthof(filename), "%s%s", _paths.data_dir, config->filename);

    46

	f = fopen(filename, "rb");

    47

	if (f == NULL) return false;

    48

    49

	/* calculate md5sum */

    50

	md5_init(&md5state);

    51

	while ((len = fread(buffer, 1, sizeof(buffer), f)) != 0) {

    52

		md5_append(&md5state, buffer, len);

    53

	}

    54

	md5_finish(&md5state, config->md5sum);

    55

    56

	fclose(f);

    57

    58

	return true;

    59

}

    60

    61

    62

/* Find the GRFID and calculate the md5sum */

    63

bool FillGRFDetails(GRFConfig *config, bool is_static)

    64

{

    65

	if (!FioCheckFileExists(config->filename)) {

    66

		SETBIT(config->flags, GCF_NOT_FOUND);

    67

		return false;

    68

	}

    69

    70

	/* Find and load the Action 8 information */

    71

	/* 62 is the last file slot before sample.cat.

    72

	 * Should perhaps be some "don't care" value */

    73

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    74

    75

	/* Skip if the grfid is 0 (not read) or 0xFFFFFFFF (ttdp system grf) */

    76

	if (config->grfid == 0 || config->grfid == 0xFFFFFFFF) return false;

    77

    78

	if (is_static) {

    79

		/* Perform a 'safety scan' for static GRFs */

    80

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    81

    82

		/* GCF_UNSAFE is set if GLS_SAFETYSCAN finds unsafe actions */

    83

		if (HASBIT(config->flags, GCF_UNSAFE)) return false;

    84

	}

    85

    86

	return CalcGRFMD5Sum(config);

    87

}

    88

    89

    90

void ClearGRFConfig(GRFConfig **config)

    91

{

    92

	/* GCF_COPY as in NOT strdupped/alloced the filename, name and info */

    93

	if (!HASBIT((*config)->flags, GCF_COPY)) {

    94

		free((*config)->filename);

    95

		free((*config)->name);

    96

		free((*config)->info);

    97

	}

    98

	free(*config);

    99

	*config = NULL;

   100

}

   101

   102

   103

/* Clear a GRF Config list */

   104

void ClearGRFConfigList(GRFConfig **config)

   105

{

   106

	GRFConfig *c, *next;

   107

	for (c = *config; c != NULL; c = next) {

   108

		next = c->next;

   109

		ClearGRFConfig(&c);

   110

	}

   111

	*config = NULL;

   112

}

   113

   114

   115

/** Copy a GRF Config list

   116

 * @param dst pointer to destination list

   117

 * @param srt pointer to source list values

   118

 * @return pointer to the last value added to the destination list */

   119

GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src)

   120

{

   121

	GRFConfig *c;

   122

   123

	/* Clear destination as it will be overwritten */

   124

	ClearGRFConfigList(dst);

   125

	for (; src != NULL; src = src->next) {

   126

		c = calloc(1, sizeof(*c));

   127

		*c = *src;

   128

		if (src->filename != NULL) c->filename = strdup(src->filename);

   129

		if (src->name     != NULL) c->name     = strdup(src->name);

   130

		if (src->info     != NULL) c->info     = strdup(src->info);

   131

   132

		*dst = c;

   133

		dst = &c->next;

   134

	}

   135

   136

	return dst;

   137

}

   138

   139

/**

   140

 * Removes duplicates from lists of GRFConfigs. These duplicates

   141

 * are introduced when the _grfconfig_static GRFs are appended

   142

 * to the _grfconfig on a newgame or savegame. As the parameters

   143

 * of the static GRFs could be different that the parameters of

   144

 * the ones used non-statically. This can result in desyncs in

   145

 * multiplayers, so the duplicate static GRFs have to be removed.

   146

 *

   147

 * This function _assumes_ that all static GRFs are placed after

   148

 * the non-static GRFs.

   149

 *

   150

 * @param list the list to remove the duplicates from

   151

 */

   152

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   153

{

   154

	GRFConfig *prev;

   155

	GRFConfig *cur;

   156

   157

	if (list == NULL) return;

   158

   159

	for (prev = list, cur = list->next; cur != NULL; prev = cur, cur = cur->next) {

   160

		if (cur->grfid != list->grfid) continue;

   161

		assert(HASBIT(cur->flags, GCF_STATIC));

   162

		prev->next = cur->next;

   163

		ClearGRFConfig(&cur);

   164

		cur = prev; // Just go back one so it continues as normal later on

   165

	}

   166

   167

	RemoveDuplicatesFromGRFConfigList(list->next);

   168

}

   169

   170

/**

   171

 * Appends the static GRFs to a list of GRFs

   172

 * @param dst the head of the list to add to

   173

 */

   174

void AppendStaticGRFConfigs(GRFConfig **dst)

   175

{

   176

	GRFConfig **tail = dst;

   177

	while (*tail != NULL) tail = &(*tail)->next;

   178

   179

	CopyGRFConfigList(tail, _grfconfig_static);

   180

	RemoveDuplicatesFromGRFConfigList(*dst);

   181

}

   182

   183

   184

/* Reset the current GRF Config to either blank or newgame settings */

   185

void ResetGRFConfig(bool defaults)

   186

{

   187

	GRFConfig **c = &_grfconfig;

   188

   189

	if (defaults) {

   190

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   191

	} else {

   192

		ClearGRFConfigList(c);

   193

	}

   194

   195

	AppendStaticGRFConfigs(&_grfconfig);

   196

}

   197

   198

   199

/* Check if all GRFs in the GRF Config can be loaded */

   200

bool IsGoodGRFConfigList(void)

   201

{

   202

	bool res = true;

   203

	GRFConfig *c;

   204

   205

	for (c = _grfconfig; c != NULL; c = c->next) {

   206

		const GRFConfig *f = FindGRFConfig(c->grfid, c->md5sum);

   207

		if (f == NULL) {

   208

			char buf[512], *p = buf;

   209

			uint i;

   210

   211

			p += snprintf(p, lastof(buf) - p, "Couldn't find NewGRF %08X (%s) checksum ", BSWAP32(c->grfid), c->filename);

   212

			for (i = 0; i < lengthof(c->md5sum); i++) {

   213

				p += snprintf(p, lastof(buf) - p, "%02X", c->md5sum[i]);

   214

			}

   215

			ShowInfo(buf);

   216

   217

			res = false;

   218

		} else {

   219

			DEBUG(grf, 1, "Loading GRF %08X from '%s'", BSWAP32(c->grfid), f->filename);

   220

			/* The filename could be the filename as in the savegame. As we need

   221

			 * to load the GRF here, we need the correct filename, so overwrite that

   222

			 * in any case and set the name and info when it is not set already.

   223

			 * When the GCF_COPY flag is set, it is certain that the filename is

   224

			 * already a local one, so there is no need to replace it. */

   225

			if (!HASBIT(c->flags, GCF_COPY)) {

   226

				free(c->filename);

   227

				c->filename = strdup(f->filename);

   228

				if (c->name == NULL) c->name = strdup(f->name);

   229

				if (c->info == NULL) c->info = strdup(f->info);

   230

			}

   231

		}

   232

	}

   233

   234

	return res;

   235

}

   236

   237

   238

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

   239

   240

/* Scan a path for NewGRFs */

   241

static uint ScanPath(const char *path)

   242

{

   243

	uint num = 0;

   244

	struct stat sb;

   245

	struct dirent *dirent;

   246

	DIR *dir;

   247

	GRFConfig *c;

   248

   249

	if ((dir = opendir(path)) == NULL) return 0;

   250

   251

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

   252

		const char *d_name = FS2OTTD(dirent->d_name);

   253

		char filename[MAX_PATH];

   254

   255

		if (!FiosIsValidFile(path, dirent, &sb)) continue;

   256

   257

		snprintf(filename, lengthof(filename), "%s" PATHSEP "%s", path, d_name);

   258

   259

		if (sb.st_mode & S_IFDIR) {

   260

			/* Directory */

   261

			if (strcmp(d_name, ".") == 0 || strcmp(d_name, "..") == 0) continue;

   262

			num += ScanPath(filename);

   263

		} else if (sb.st_mode & S_IFREG) {

   264

			/* File */

   265

			char *ext = strrchr(filename, '.');

   266

			char *file = filename + strlen(_paths.data_dir) + 1; // Crop base path

   267

   268

			/* If no extension or extension isn't .grf, skip the file */

   269

			if (ext == NULL) continue;

   270

			if (strcasecmp(ext, ".grf") != 0) continue;

   271

   272

			c = calloc(1, sizeof(*c));

   273

			c->filename = strdup(file);

   274

   275

			if (FillGRFDetails(c, false)) {

   276

				if (_all_grfs == NULL) {

   277

					_all_grfs = c;

   278

				} else {

   279

					/* Insert file into list at a position determined by its

   280

					 * name, so the list is sorted as we go along */

   281

					GRFConfig **pd, *d;

   282

					for (pd = &_all_grfs; (d = *pd) != NULL; pd = &d->next) {

   283

						if (strcasecmp(c->name, d->name) <= 0) break;

   284

					}

   285

					c->next = d;

   286

					*pd = c;

   287

				}

   288

   289

				num++;

   290

			} else {

   291

				/* File couldn't be opened, or is either not a NewGRF or is a

   292

				 * 'system' NewGRF, so forget about it. */

   293

				free(c->filename);

   294

				free(c->name);

   295

				free(c->info);

   296

				free(c);

   297

			}

   298

		}

   299

	}

   300

   301

	closedir(dir);

   302

   303

	return num;

   304

}

   305

   306

   307

/* Scan for all NewGRFs */

   308

void ScanNewGRFFiles(void)

   309

{

   310

	uint num;

   311

   312

	ClearGRFConfigList(&_all_grfs);

   313

   314

	DEBUG(grf, 1, "Scanning for NewGRFs");

   315

	num = ScanPath(_paths.data_dir);

   316

	DEBUG(grf, 1, "Scan complete, found %d files", num);

   317

}

   318

   319

   320

/* Find a NewGRF in the scanned list */

   321

const GRFConfig *FindGRFConfig(uint32 grfid, uint8 *md5sum)

   322

{

   323

	GRFConfig *c;

   324

	static const uint8 blanksum[sizeof(c->md5sum)] = { 0 };

   325

   326

	for (c = _all_grfs; c != NULL; c = c->next) {

   327

		if (c->grfid == grfid) {

   328

			if (memcmp(blanksum, c->md5sum, sizeof(c->md5sum)) == 0) CalcGRFMD5Sum(c);

   329

			if (memcmp(md5sum, c->md5sum, sizeof(c->md5sum)) == 0) return c;

   330

		}

   331

	}

   332

   333

	return NULL;

   334

}

   335

   336

#ifdef ENABLE_NETWORK

   337

   338

/** Structure for UnknownGRFs; this is a lightweight variant of GRFConfig */

   339

typedef struct UnknownGRF UnknownGRF;

   340

struct UnknownGRF {

   341

	UnknownGRF *next;

   342

	uint32 grfid;

   343

	uint8  md5sum[16];

   344

	char   name[NETWORK_GRF_NAME_LENGTH];

   345

};

   346

   347

/**

   348

 * Finds the name of a NewGRF in the list of names for unknown GRFs. An

   349

 * unknown GRF is a GRF where the .grf is not found during scanning.

   350

 *

   351

 * The names are resolved via UDP calls to servers that should know the name,

   352

 * though the replies may not come. This leaves "<Unknown>" as name, though

   353

 * that shouldn't matter _very_ much as they need GRF crawler or so to look

   354

 * up the GRF anyway and that works better with the GRF ID.

   355

 *

   356

 * @param grfid  the GRF ID part of the 'unique' GRF identifier

   357

 * @param md5sum the MD5 checksum part of the 'unique' GRF identifier

   358

 * @param create whether to create a new GRFConfig if the GRFConfig did not

   359

 *               exist in the fake list of GRFConfigs.

   360

 * @return the GRFConfig with the given GRF ID and MD5 checksum or NULL when

   361

 *         it does not exist and create is false. This value must NEVER be

   362

 *         freed by the caller.

   363

 */

   364

char *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create)

   365

{

   366

	UnknownGRF *grf;

   367

	static UnknownGRF *unknown_grfs = NULL;

   368

   369

	for (grf = unknown_grfs; grf != NULL; grf = grf->next) {

   370

		if (grf->grfid == grfid) {

   371

			if (memcmp(md5sum, grf->md5sum, sizeof(grf->md5sum)) == 0) return grf->name;

   372

		}

   373

	}

   374

   375

	if (!create) return NULL;

   376

   377

	grf = calloc(1, sizeof(*grf));

   378

	grf->grfid = grfid;

   379

	grf->next  = unknown_grfs;

   380

	ttd_strlcpy(grf->name, UNKNOWN_GRF_NAME_PLACEHOLDER, sizeof(grf->name));

   381

	memcpy(grf->md5sum, md5sum, sizeof(grf->md5sum));

   382

   383

	unknown_grfs = grf;

   384

	return grf->name;

   385

}

   386

   387

#endif /* ENABLE_NETWORK */

   388

   389

   390

/* Retrieve a NewGRF from the current config by its grfid */

   391

GRFConfig *GetGRFConfig(uint32 grfid)

   392

{

   393

	GRFConfig *c;

   394

   395

	for (c = _grfconfig; c != NULL; c = c->next) {

   396

		if (c->grfid == grfid) return c;

   397

	}

   398

   399

	return NULL;

   400

}

   401

   402

   403

/* Build a space separated list of parameters, and terminate */

   404

char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last)

   405

{

   406

	uint i;

   407

   408

	/* Return an empty string if there are no parameters */

   409

	if (c->num_params == 0) return strecpy(dst, "", last);

   410

   411

	for (i = 0; i < c->num_params; i++) {

   412

		if (i > 0) dst = strecpy(dst, " ", last);

   413

		dst += snprintf(dst, last - dst, "%d", c->param[i]);

   414

	}

   415

	return dst;

   416

}

   417

   418

   419

static const SaveLoad _grfconfig_desc[] = {

   420

	SLE_STR(GRFConfig, filename,   SLE_STR, 0x40),

   421

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   422

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   423

	SLE_ARR(GRFConfig, param,      SLE_UINT32, 0x80),

   424

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   425

	SLE_END()

   426

};

   427

   428

   429

static void Save_NGRF(void)

   430

{

   431

	GRFConfig *c;

   432

	int index = 0;

   433

   434

	for (c = _grfconfig; c != NULL; c = c->next) {

   435

		if (HASBIT(c->flags, GCF_STATIC)) continue;

   436

		SlSetArrayIndex(index++);

   437

		SlObject(c, _grfconfig_desc);

   438

	}

   439

}

   440

   441

   442

static void Load_NGRF(void)

   443

{

   444

	GRFConfig *first = NULL;

   445

	GRFConfig **last = &first;

   446

   447

	while (SlIterateArray() != -1) {

   448

		GRFConfig *c = calloc(1, sizeof(*c));

   449

		SlObject(c, _grfconfig_desc);

   450

   451

		/* Append our configuration to the list */

   452

		*last = c;

   453

		last = &c->next;

   454

	}

   455

   456

	/* Append static NewGRF configuration */

   457

	CopyGRFConfigList(last, _grfconfig_static);

   458

   459

	ClearGRFConfigList(&_grfconfig);

   460

	_grfconfig = first;

   461

	AppendStaticGRFConfigs(&_grfconfig);

   462

}

   463

   464

const ChunkHandler _newgrf_chunk_handlers[] = {

   465

	{ 'NGRF', Save_NGRF, Load_NGRF, CH_ARRAY | CH_LAST }

   466

};

   467

   468