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_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, is_static ? GLS_SAFETYSCAN : GLS_FILESCAN);

    74

    75

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

    76

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

    77

    78

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

    79

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

    80

    81

	return CalcGRFMD5Sum(config);

    82

}

    83

    84

    85

void ClearGRFConfig(GRFConfig **config)

    86

{

    87

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

    88

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

    89

		free((*config)->filename);

    90

		free((*config)->name);

    91

		free((*config)->info);

    92

	}

    93

	free(*config);

    94

	*config = NULL;

    95

}

    96

    97

    98

/* Clear a GRF Config list */

    99

void ClearGRFConfigList(GRFConfig **config)

   100

{

   101

	GRFConfig *c, *next;

   102

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

   103

		next = c->next;

   104

		ClearGRFConfig(&c);

   105

	}

   106

	*config = NULL;

   107

}

   108

   109

   110

/** Copy a GRF Config list

   111

 * @param dst pointer to destination list

   112

 * @param srt pointer to source list values

   113

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

   114

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

   115

{

   116

	GRFConfig *c;

   117

   118

	/* Clear destination as it will be overwritten */

   119

	ClearGRFConfigList(dst);

   120

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

   121

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

   122

		*c = *src;

   123

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

   124

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

   125

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

   126

   127

		*dst = c;

   128

		dst = &c->next;

   129

	}

   130

   131

	return dst;

   132

}

   133

   134

/**

   135

 * Removes duplicates from lists of GRFConfigs. These duplicates

   136

 * are introduced when the _grfconfig_static GRFs are appended

   137

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

   138

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

   139

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

   140

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

   141

 *

   142

 * This function _assumes_ that all static GRFs are placed after

   143

 * the non-static GRFs.

   144

 *

   145

 * @param list the list to remove the duplicates from

   146

 */

   147

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   148

{

   149

	GRFConfig *prev;

   150

	GRFConfig *cur;

   151

   152

	if (list == NULL) return;

   153

   154

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

   155

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

   156

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

   157

		prev->next = cur->next;

   158

		ClearGRFConfig(&cur);

   159

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

   160

	}

   161

   162

	RemoveDuplicatesFromGRFConfigList(list->next);

   163

}

   164

   165

/**

   166

 * Appends the static GRFs to a list of GRFs

   167

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

   168

 */

   169

void AppendStaticGRFConfigs(GRFConfig **dst)

   170

{

   171

	GRFConfig **tail = dst;

   172

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

   173

   174

	CopyGRFConfigList(tail, _grfconfig_static);

   175

	RemoveDuplicatesFromGRFConfigList(*dst);

   176

}

   177

   178

   179

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

   180

void ResetGRFConfig(bool defaults)

   181

{

   182

	GRFConfig **c = &_grfconfig;

   183

   184

	if (defaults) c = CopyGRFConfigList(c, _grfconfig_newgame);

   185

	AppendStaticGRFConfigs(&_grfconfig);

   186

}

   187

   188

   189

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

   190

bool IsGoodGRFConfigList(void)

   191

{

   192

	bool res = true;

   193

	GRFConfig *c;

   194

   195

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

   196

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

   197

		if (f == NULL) {

   198

			char buf[512], *p = buf;

   199

			uint i;

   200

   201

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

   202

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

   203

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

   204

			}

   205

			ShowInfo(buf);

   206

   207

			res = false;

   208

		} else {

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

				free(c->filename);

   217

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

   218

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

   219

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

   220

			}

   221

		}

   222

	}

   223

   224

	return res;

   225

}

   226

   227

   228

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

   229

   230

/* Scan a path for NewGRFs */

   231

static uint ScanPath(const char *path)

   232

{

   233

	uint num = 0;

   234

	struct stat sb;

   235

	struct dirent *dirent;

   236

	DIR *dir;

   237

	GRFConfig *c;

   238

   239

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

   240

   241

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

   242

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

   243

		char filename[MAX_PATH];

   244

   245

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

   246

   247

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

   248

   249

		if (sb.st_mode & S_IFDIR) {

   250

			/* Directory */

   251

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

   252

			num += ScanPath(filename);

   253

		} else if (sb.st_mode & S_IFREG) {

   254

			/* File */

   255

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

   256

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

   257

   258

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

   259

			if (ext == NULL) continue;

   260

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

   261

   262

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

   263

			c->filename = strdup(file);

   264

   265

			if (FillGRFDetails(c, false)) {

   266

				if (_all_grfs == NULL) {

   267

					_all_grfs = c;

   268

				} else {

   269

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

   270

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

   271

					GRFConfig **pd, *d;

   272

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

   273

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

   274

					}

   275

					c->next = d;

   276

					*pd = c;

   277

				}

   278

   279

				num++;

   280

			} else {

   281

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

   282

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

   283

				free(c->filename);

   284

				free(c->name);

   285

				free(c->info);

   286

				free(c);

   287

			}

   288

		}

   289

	}

   290

   291

	closedir(dir);

   292

   293

	return num;

   294

}

   295

   296

   297

/* Scan for all NewGRFs */

   298

void ScanNewGRFFiles(void)

   299

{

   300

	uint num;

   301

   302

	ClearGRFConfigList(&_all_grfs);

   303

   304

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

   305

	num = ScanPath(_paths.data_dir);

   306

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

   307

}

   308

   309

   310

/* Find a NewGRF in the scanned list */

   311

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

   312

{

   313

	GRFConfig *c;

   314

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

   315

   316

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

   317

		if (c->grfid == grfid) {

   318

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

   319

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

   320

		}

   321

	}

   322

   323

	return NULL;

   324

}

   325

   326

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

   327

typedef struct UnknownGRF UnknownGRF;

   328

struct UnknownGRF {

   329

	UnknownGRF *next;

   330

	uint32 grfid;

   331

	uint8  md5sum[16];

   332

	char   name[NETWORK_GRF_NAME_LENGTH];

   333

};

   334

   335

/**

   336

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

   337

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

   338

 *

   339

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

   340

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

   341

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

   342

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

   343

 *

   344

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

   345

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

   346

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

   347

 *               exist in the fake list of GRFConfigs.

   348

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

   349

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

   350

 *         freed by the caller.

   351

 */

   352

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

   353

{

   354

	UnknownGRF *grf;

   355

	static UnknownGRF *unknown_grfs = NULL;

   356

   357

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

   358

		if (grf->grfid == grfid) {

   359

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

   360

		}

   361

	}

   362

   363

	if (!create) return NULL;

   364

   365

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

   366

	grf->grfid = grfid;

   367

	grf->next  = unknown_grfs;

   368

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

   369

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

   370

   371

	unknown_grfs = grf;

   372

	return grf->name;

   373

}

   374

   375

   376

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

   377

GRFConfig *GetGRFConfig(uint32 grfid)

   378

{

   379

	GRFConfig *c;

   380

   381

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

   382

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

   383

	}

   384

   385

	return NULL;

   386

}

   387

   388

   389

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

   390

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

   391

{

   392

	uint i;

   393

   394

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

   395

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

   396

   397

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

   398

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

   399

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

   400

	}

   401

	return dst;

   402

}

   403

   404

   405

static const SaveLoad _grfconfig_desc[] = {

   406

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

   407

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   408

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   409

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

   410

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   411

	SLE_END()

   412

};

   413

   414

   415

static void Save_NGRF(void)

   416

{

   417

	GRFConfig *c;

   418

	int index = 0;

   419

   420

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

   421

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

   422

		SlSetArrayIndex(index++);

   423

		SlObject(c, _grfconfig_desc);

   424

	}

   425

}

   426

   427

   428

static void Load_NGRF(void)

   429

{

   430

	GRFConfig *first = NULL;

   431

	GRFConfig **last = &first;

   432

   433

	while (SlIterateArray() != -1) {

   434

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

   435

		SlObject(c, _grfconfig_desc);

   436

   437

		/* Append our configuration to the list */

   438

		*last = c;

   439

		last = &c->next;

   440

	}

   441

   442

	/* Append static NewGRF configuration */

   443

	CopyGRFConfigList(last, _grfconfig_static);

   444

   445

	ClearGRFConfigList(&_grfconfig);

   446

	_grfconfig = first;

   447

	AppendStaticGRFConfigs(&_grfconfig);

   448

}

   449

   450

const ChunkHandler _newgrf_chunk_handlers[] = {

   451

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

   452

};

   453

   454