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"

    16

    17

#include "fileio.h"

    18

#include "fios.h"

    19

#include <sys/types.h>

    20

#include <sys/stat.h>

    21

    22

#ifdef WIN32

    23

# include <io.h>

    24

#else

    25

# include <unistd.h>

    26

# include <dirent.h>

    27

#endif /* WIN32 */

    28

    29

    30

GRFConfig *_all_grfs;

    31

GRFConfig *_grfconfig;

    32

GRFConfig *_grfconfig_newgame;

    33

GRFConfig *_grfconfig_static;

    34

    35

    36

/* Calculate the MD5 Sum for a GRF */

    37

static bool CalcGRFMD5Sum(GRFConfig *config)

    38

{

    39

	FILE *f;

    40

	char filename[MAX_PATH];

    41

	md5_state_t md5state;

    42

	md5_byte_t buffer[1024];

    43

	size_t len;

    44

    45

	/* open the file */

    46

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

    47

	f = fopen(filename, "rb");

    48

	if (f == NULL) return false;

    49

    50

	/* calculate md5sum */

    51

	md5_init(&md5state);

    52

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

    53

		md5_append(&md5state, buffer, len);

    54

	}

    55

	md5_finish(&md5state, config->md5sum);

    56

    57

	fclose(f);

    58

    59

	return true;

    60

}

    61

    62

    63

/* Find the GRFID and calculate the md5sum */

    64

bool FillGRFDetails(GRFConfig *config, bool is_static)

    65

{

    66

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

    67

		SETBIT(config->flags, GCF_NOT_FOUND);

    68

		return false;

    69

	}

    70

    71

	/* Find and load the Action 8 information */

    72

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

    73

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

    74

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    75

    76

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

    77

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

    78

    79

	if (is_static) {

    80

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

    81

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    82

    83

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

    84

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

    85

	}

    86

    87

	return CalcGRFMD5Sum(config);

    88

}

    89

    90

    91

void ClearGRFConfig(GRFConfig **config)

    92

{

    93

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

    94

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

    95

		free((*config)->filename);

    96

		free((*config)->name);

    97

		free((*config)->info);

    98

	}

    99

	free(*config);

   100

	*config = NULL;

   101

}

   102

   103

   104

/* Clear a GRF Config list */

   105

void ClearGRFConfigList(GRFConfig **config)

   106

{

   107

	GRFConfig *c, *next;

   108

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

   109

		next = c->next;

   110

		ClearGRFConfig(&c);

   111

	}

   112

	*config = NULL;

   113

}

   114

   115

   116

/** Copy a GRF Config list

   117

 * @param dst pointer to destination list

   118

 * @param srt pointer to source list values

   119

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

   120

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

   121

{

   122

	GRFConfig *c;

   123

   124

	/* Clear destination as it will be overwritten */

   125

	ClearGRFConfigList(dst);

   126

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

   128

		*c = *src;

   129

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

   130

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

   131

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

   132

   133

		*dst = c;

   134

		dst = &c->next;

   135

	}

   136

   137

	return dst;

   138

}

   139

   140

/**

   141

 * Removes duplicates from lists of GRFConfigs. These duplicates

   142

 * are introduced when the _grfconfig_static GRFs are appended

   143

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

   144

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

   145

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

   146

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

   147

 *

   148

 * This function _assumes_ that all static GRFs are placed after

   149

 * the non-static GRFs.

   150

 *

   151

 * @param list the list to remove the duplicates from

   152

 */

   153

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   154

{

   155

	GRFConfig *prev;

   156

	GRFConfig *cur;

   157

   158

	if (list == NULL) return;

   159

   160

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

   161

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

   162

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

   163

		prev->next = cur->next;

   164

		ClearGRFConfig(&cur);

   165

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

   166

	}

   167

   168

	RemoveDuplicatesFromGRFConfigList(list->next);

   169

}

   170

   171

/**

   172

 * Appends the static GRFs to a list of GRFs

   173

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

   174

 */

   175

void AppendStaticGRFConfigs(GRFConfig **dst)

   176

{

   177

	GRFConfig **tail = dst;

   178

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

   179

   180

	CopyGRFConfigList(tail, _grfconfig_static);

   181

	RemoveDuplicatesFromGRFConfigList(*dst);

   182

}

   183

   184

   185

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

   186

void ResetGRFConfig(bool defaults)

   187

{

   188

	GRFConfig **c = &_grfconfig;

   189

   190

	if (defaults) {

   191

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   192

	} else {

   193

		ClearGRFConfigList(c);

   194

	}

   195

   196

	AppendStaticGRFConfigs(&_grfconfig);

   197

}

   198

   199

   200

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

   201

bool IsGoodGRFConfigList(void)

   202

{

   203

	bool res = true;

   204

	GRFConfig *c;

   205

   206

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

   207

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

   208

		if (f == NULL) {

   209

			char buf[512], *p = buf;

   210

			uint i;

   211

   212

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

   213

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

   214

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

   215

			}

   216

			ShowInfo(buf);

   217

   218

			res = false;

   219

		} else {

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

				free(c->filename);

   228

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

   229

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

   230

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

   231

			}

   232

		}

   233

	}

   234

   235

	return res;

   236

}

   237

   238

   239

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

   240

   241

/* Scan a path for NewGRFs */

   242

static uint ScanPath(const char *path)

   243

{

   244

	uint num = 0;

   245

	struct stat sb;

   246

	struct dirent *dirent;

   247

	DIR *dir;

   248

	GRFConfig *c;

   249

   250

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

   251

   252

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

   253

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

   254

		char filename[MAX_PATH];

   255

   256

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

   257

   258

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

   259

   260

		if (sb.st_mode & S_IFDIR) {

   261

			/* Directory */

   262

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

   263

			num += ScanPath(filename);

   264

		} else if (sb.st_mode & S_IFREG) {

   265

			/* File */

   266

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

   267

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

   268

   269

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

   270

			if (ext == NULL) continue;

   271

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

   272

   274

			c->filename = strdup(file);

   275

   276

			if (FillGRFDetails(c, false)) {

   277

				if (_all_grfs == NULL) {

   278

					_all_grfs = c;

   279

				} else {

   280

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

   281

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

   282

					GRFConfig **pd, *d;

   283

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

   284

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

   285

					}

   286

					c->next = d;

   287

					*pd = c;

   288

				}

   289

   290

				num++;

   291

			} else {

   292

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

   293

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

   294

				free(c->filename);

   295

				free(c->name);

   296

				free(c->info);

   297

				free(c);

   298

			}

   299

		}

   300

	}

   301

   302

	closedir(dir);

   303

   304

	return num;

   305

}

   306

   307

   308

/* Scan for all NewGRFs */

   309

void ScanNewGRFFiles(void)

   310

{

   311

	uint num;

   312

   313

	ClearGRFConfigList(&_all_grfs);

   314

   315

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

   316

	num = ScanPath(_paths.data_dir);

   317

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

   318

}

   319

   320

   321

/* Find a NewGRF in the scanned list */

   322

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

   323

{

   324

	GRFConfig *c;

   325

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

   326

   327

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

   328

		if (c->grfid == grfid) {

   329

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

   330

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

   331

		}

   332

	}

   333

   334

	return NULL;

   335

}

   336

   337

#ifdef ENABLE_NETWORK

   338

   339

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

   340

typedef struct UnknownGRF UnknownGRF;

   341

struct UnknownGRF {

   342

	UnknownGRF *next;

   343

	uint32 grfid;

   344

	uint8  md5sum[16];

   345

	char   name[NETWORK_GRF_NAME_LENGTH];

   346

};

   347

   348

/**

   349

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

   350

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

   351

 *

   352

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

   353

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

   354

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

   355

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

   356

 *

   357

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

   358

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

   359

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

   360

 *               exist in the fake list of GRFConfigs.

   361

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

   362

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

   363

 *         freed by the caller.

   364

 */

   365

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

   366

{

   367

	UnknownGRF *grf;

   368

	static UnknownGRF *unknown_grfs = NULL;

   369

   370

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

   371

		if (grf->grfid == grfid) {

   372

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

   373

		}

   374

	}

   375

   376

	if (!create) return NULL;

   377

   379

	grf->grfid = grfid;

   380

	grf->next  = unknown_grfs;

   381

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

   382

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

   383

   384

	unknown_grfs = grf;

   385

	return grf->name;

   386

}

   387

   388

#endif /* ENABLE_NETWORK */

   389

   390

   391

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

   392

GRFConfig *GetGRFConfig(uint32 grfid)

   393

{

   394

	GRFConfig *c;

   395

   396

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

   397

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

   398

	}

   399

   400

	return NULL;

   401

}

   402

   403

   404

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

   405

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

   406

{

   407

	uint i;

   408

   409

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

   410

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

   411

   412

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

   413

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

   414

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

   415

	}

   416

	return dst;

   417

}

   418

   419

   420

static const SaveLoad _grfconfig_desc[] = {

   421

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

   422

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   423

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   424

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

   425

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   426

	SLE_END()

   427

};

   428

   429

   430

static void Save_NGRF(void)

   431

{

   432

	GRFConfig *c;

   433

	int index = 0;

   434

   435

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

   436

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

   437

		SlSetArrayIndex(index++);

   438

		SlObject(c, _grfconfig_desc);

   439

	}

   440

}

   441

   442

   443

static void Load_NGRF(void)

   444

{

   445

	GRFConfig *first = NULL;

   446

	GRFConfig **last = &first;

   447

   448

	while (SlIterateArray() != -1) {

   451

		SlObject(c, _grfconfig_desc);

   452

   453

		/* Append our configuration to the list */

   454

		*last = c;

   455

		last = &c->next;

   456

	}

   457

   458

	/* Append static NewGRF configuration */

   459

	CopyGRFConfigList(last, _grfconfig_static);

   460

   461

	ClearGRFConfigList(&_grfconfig);

   462

	_grfconfig = first;

   463

	AppendStaticGRFConfigs(&_grfconfig);

   464

}

   465

   467

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

   468

};

   469

   470