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

   185

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   186

	} else {

   187

		ClearGRFConfigList(c);

   188

	}

   189

   190

	AppendStaticGRFConfigs(&_grfconfig);

   191

}

   192

   193

   194

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

   195

bool IsGoodGRFConfigList(void)

   196

{

   197

	bool res = true;

   198

	GRFConfig *c;

   199

   200

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

   201

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

   202

		if (f == NULL) {

   203

			char buf[512], *p = buf;

   204

			uint i;

   205

   206

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

   207

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

   208

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

   209

			}

   210

			ShowInfo(buf);

   211

   212

			res = false;

   213

		} else {

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

				free(c->filename);

   222

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

   223

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

   224

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

   225

			}

   226

		}

   227

	}

   228

   229

	return res;

   230

}

   231

   232

   233

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

   234

   235

/* Scan a path for NewGRFs */

   236

static uint ScanPath(const char *path)

   237

{

   238

	uint num = 0;

   239

	struct stat sb;

   240

	struct dirent *dirent;

   241

	DIR *dir;

   242

	GRFConfig *c;

   243

   244

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

   245

   246

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

   247

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

   248

		char filename[MAX_PATH];

   249

   250

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

   251

   252

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

   253

   254

		if (sb.st_mode & S_IFDIR) {

   255

			/* Directory */

   256

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

   257

			num += ScanPath(filename);

   258

		} else if (sb.st_mode & S_IFREG) {

   259

			/* File */

   260

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

   261

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

   262

   263

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

   264

			if (ext == NULL) continue;

   265

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

   266

   267

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

   268

			c->filename = strdup(file);

   269

   270

			if (FillGRFDetails(c, false)) {

   271

				if (_all_grfs == NULL) {

   272

					_all_grfs = c;

   273

				} else {

   274

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

   275

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

   276

					GRFConfig **pd, *d;

   277

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

   278

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

   279

					}

   280

					c->next = d;

   281

					*pd = c;

   282

				}

   283

   284

				num++;

   285

			} else {

   286

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

   287

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

   288

				free(c->filename);

   289

				free(c->name);

   290

				free(c->info);

   291

				free(c);

   292

			}

   293

		}

   294

	}

   295

   296

	closedir(dir);

   297

   298

	return num;

   299

}

   300

   301

   302

/* Scan for all NewGRFs */

   303

void ScanNewGRFFiles(void)

   304

{

   305

	uint num;

   306

   307

	ClearGRFConfigList(&_all_grfs);

   308

   309

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

   310

	num = ScanPath(_paths.data_dir);

   311

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

   312

}

   313

   314

   315

/* Find a NewGRF in the scanned list */

   316

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

   317

{

   318

	GRFConfig *c;

   319

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

   320

   321

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

   322

		if (c->grfid == grfid) {

   323

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

   324

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

   325

		}

   326

	}

   327

   328

	return NULL;

   329

}

   330

   331

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

   332

typedef struct UnknownGRF UnknownGRF;

   333

struct UnknownGRF {

   334

	UnknownGRF *next;

   335

	uint32 grfid;

   336

	uint8  md5sum[16];

   337

	char   name[NETWORK_GRF_NAME_LENGTH];

   338

};

   339

   340

/**

   341

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

   342

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

   343

 *

   344

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

   345

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

   346

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

   347

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

   348

 *

   349

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

   350

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

   351

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

   352

 *               exist in the fake list of GRFConfigs.

   353

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

   354

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

   355

 *         freed by the caller.

   356

 */

   357

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

   358

{

   359

	UnknownGRF *grf;

   360

	static UnknownGRF *unknown_grfs = NULL;

   361

   362

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

   363

		if (grf->grfid == grfid) {

   364

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

   365

		}

   366

	}

   367

   368

	if (!create) return NULL;

   369

   370

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

   371

	grf->grfid = grfid;

   372

	grf->next  = unknown_grfs;

   373

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

   374

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

   375

   376

	unknown_grfs = grf;

   377

	return grf->name;

   378

}

   379

   380

   381

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

   382

GRFConfig *GetGRFConfig(uint32 grfid)

   383

{

   384

	GRFConfig *c;

   385

   386

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

   387

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

   388

	}

   389

   390

	return NULL;

   391

}

   392

   393

   394

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

   395

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

   396

{

   397

	uint i;

   398

   399

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

   400

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

   401

   402

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

   403

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

   404

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

   405

	}

   406

	return dst;

   407

}

   408

   409

   410

static const SaveLoad _grfconfig_desc[] = {

   411

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

   412

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   413

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   414

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

   415

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   416

	SLE_END()

   417

};

   418

   419

   420

static void Save_NGRF(void)

   421

{

   422

	GRFConfig *c;

   423

	int index = 0;

   424

   425

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

   426

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

   427

		SlSetArrayIndex(index++);

   428

		SlObject(c, _grfconfig_desc);

   429

	}

   430

}

   431

   432

   433

static void Load_NGRF(void)

   434

{

   435

	GRFConfig *first = NULL;

   436

	GRFConfig **last = &first;

   437

   438

	while (SlIterateArray() != -1) {

   439

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

   440

		SlObject(c, _grfconfig_desc);

   441

   442

		/* Append our configuration to the list */

   443

		*last = c;

   444

		last = &c->next;

   445

	}

   446

   447

	/* Append static NewGRF configuration */

   448

	CopyGRFConfigList(last, _grfconfig_static);

   449

   450

	ClearGRFConfigList(&_grfconfig);

   451

	_grfconfig = first;

   452

	AppendStaticGRFConfigs(&_grfconfig);

   453

}

   454

   455

const ChunkHandler _newgrf_chunk_handlers[] = {

   456

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

   457

};

   458

   459