1

/* $Id$ */

     2

     3

/** @file newgrf_config.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "debug.h"

    10

#include "variables.h"

    11

#include "string.h"

    12

#include "saveload.h"

    13

#include "md5.h"

    14

#include "network/network_data.h"

    15

#include "newgrf.h"

    16

#include "newgrf_config.h"

    17

#include "helpers.hpp"

    18

    19

#include "fileio.h"

    20

#include "fios.h"

    21

#include <sys/stat.h>

    22

    23

#ifdef WIN32

    24

# include <io.h>

    25

#endif /* WIN32 */

    26

    27

    28

GRFConfig *_all_grfs;

    29

GRFConfig *_grfconfig;

    30

GRFConfig *_grfconfig_newgame;

    31

GRFConfig *_grfconfig_static;

    32

    33

    34

/* Calculate the MD5 Sum for a GRF */

    35

static bool CalcGRFMD5Sum(GRFConfig *config)

    36

{

    37

	FILE *f;

    38

	md5_state_t md5state;

    39

	md5_byte_t buffer[1024];

    40

	size_t len;

    41

    42

	/* open the file */

    43

	f = FioFOpenFile(config->full_path);

    44

	if (f == NULL) return false;

    45

    46

	/* calculate md5sum */

    47

	md5_init(&md5state);

    48

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

    49

		md5_append(&md5state, buffer, len);

    50

	}

    51

	md5_finish(&md5state, config->md5sum);

    52

    53

	fclose(f);

    54

    55

	return true;

    56

}

    57

    58

    59

/* Find the GRFID and calculate the md5sum */

    60

bool FillGRFDetails(GRFConfig *config, bool is_static)

    61

{

    62

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

    63

		config->status = GCS_NOT_FOUND;

    64

		return false;

    65

	}

    66

    67

	if (config->filename == NULL) {

    68

		const char *t = strrchr(config->full_path, PATHSEPCHAR);

    69

		config->filename = strdup(t != NULL ? t + 1 : config->full_path);

    70

	}

    71

    72

	/* Find and load the Action 8 information */

    73

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

    74

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

    75

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    76

    77

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

    78

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

    79

    80

	if (is_static) {

    81

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

    82

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    83

    84

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

    85

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

    86

	}

    87

    88

	return CalcGRFMD5Sum(config);

    89

}

    90

    91

    92

void ClearGRFConfig(GRFConfig **config)

    93

{

    94

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

    95

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

    96

		free((*config)->filename);

    97

		free((*config)->full_path);

    98

		free((*config)->name);

    99

		free((*config)->info);

   106

	}

   107

	free(*config);

   108

	*config = NULL;

   109

}

   110

   111

   112

/* Clear a GRF Config list */

   113

void ClearGRFConfigList(GRFConfig **config)

   114

{

   115

	GRFConfig *c, *next;

   116

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

   117

		next = c->next;

   118

		ClearGRFConfig(&c);

   119

	}

   120

	*config = NULL;

   121

}

   122

   123

   124

/** Copy a GRF Config list

   125

 * @param dst pointer to destination list

   126

 * @param src pointer to source list values

   127

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

   128

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

   129

{

   130

	/* Clear destination as it will be overwritten */

   131

	ClearGRFConfigList(dst);

   132

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

   133

		GRFConfig *c = CallocT<GRFConfig>(1);

   134

		*c = *src;

   135

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

   136

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

   137

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

   138

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

   139

		if (src->error     != NULL) {

   140

			c->error = CallocT<GRFError>(1);

   141

			memcpy(c->error, src->error, sizeof(GRFError));

   144

		}

   145

   146

		*dst = c;

   147

		dst = &c->next;

   148

	}

   149

   150

	return dst;

   151

}

   152

   153

/**

   154

 * Removes duplicates from lists of GRFConfigs. These duplicates

   155

 * are introduced when the _grfconfig_static GRFs are appended

   156

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

   157

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

   158

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

   159

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

   160

 *

   161

 * This function _assumes_ that all static GRFs are placed after

   162

 * the non-static GRFs.

   163

 *

   164

 * @param list the list to remove the duplicates from

   165

 */

   166

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   167

{

   168

	GRFConfig *prev;

   169

	GRFConfig *cur;

   170

   171

	if (list == NULL) return;

   172

   173

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

   174

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

   175

   176

		prev->next = cur->next;

   177

		ClearGRFConfig(&cur);

   178

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

   179

	}

   180

   181

	RemoveDuplicatesFromGRFConfigList(list->next);

   182

}

   183

   184

/**

   185

 * Appends the static GRFs to a list of GRFs

   186

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

   187

 */

   188

void AppendStaticGRFConfigs(GRFConfig **dst)

   189

{

   190

	GRFConfig **tail = dst;

   191

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

   192

   193

	CopyGRFConfigList(tail, _grfconfig_static);

   194

	RemoveDuplicatesFromGRFConfigList(*dst);

   195

}

   196

   197

/** Appends an element to a list of GRFs

   198

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

   199

 * @param el the new tail to be */

   200

void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el)

   201

{

   202

	GRFConfig **tail = dst;

   203

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

   204

	*tail = el;

   205

   206

	RemoveDuplicatesFromGRFConfigList(*dst);

   207

}

   208

   209

   210

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

   211

void ResetGRFConfig(bool defaults)

   212

{

   213

	GRFConfig **c = &_grfconfig;

   214

   215

	if (defaults) {

   216

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   217

	} else {

   218

		ClearGRFConfigList(c);

   219

	}

   220

   221

	AppendStaticGRFConfigs(&_grfconfig);

   222

}

   223

   224

   225

/** Check if all GRFs in the GRF config from a savegame can be loaded.

   226

 * @return will return any of the following 3 values:<br>

   227

 * <ul>

   228

 * <li> GLC_ALL_GOOD: No problems occured, all GRF files were found and loaded

   229

 * <li> GLC_COMPATIBLE: For one or more GRF's no exact match was found, but a

   230

 *     compatible GRF with the same grfid was found and used instead

   231

 * <li> GLC_NOT_FOUND: For one or more GRF's no match was found at all

   232

 * </ul> */

   233

GRFListCompatibility IsGoodGRFConfigList()

   234

{

   235

	GRFListCompatibility res = GLC_ALL_GOOD;

   236

   237

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

   238

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

   239

		if (f == NULL) {

   240

			char buf[256];

   241

   242

			/* If we have not found the exactly matching GRF try to find one with the

   243

			 * same grfid, as it most likely is compatible */

   244

			f = FindGRFConfig(c->grfid);

   245

			if (f != NULL) {

   246

				md5sumToString(buf, lastof(buf), c->md5sum);

   247

				DEBUG(grf, 1, "NewGRF %08X (%s) not found; checksum %s. Compatibility mode on", BSWAP32(c->grfid), c->filename, buf);

   248

				SETBIT(c->flags, GCF_COMPATIBLE);

   249

   250

				/* Non-found has precedence over compatibility load */

   251

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   252

				goto compatible_grf;

   253

			}

   254

   255

			/* No compatible grf was found, mark it as disabled */

   256

			md5sumToString(buf, lastof(buf), c->md5sum);

   257

			DEBUG(grf, 0, "NewGRF %08X (%s) not found; checksum %s", BSWAP32(c->grfid), c->filename, buf);

   258

   259

			c->status = GCS_NOT_FOUND;

   260

			res = GLC_NOT_FOUND;

   261

		} else {

   262

compatible_grf:

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

				free(c->filename);

   271

				free(c->full_path);

   272

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

   273

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

   274

				memcpy(c->md5sum, f->md5sum, sizeof(c->md5sum));

   275

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

   276

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

   277

				c->error = NULL;

   278

			}

   279

		}

   280

	}

   281

   282

	return res;

   283

}

   284

   285

   286

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

   287

   288

/* Scan a path for NewGRFs */

   289

static uint ScanPath(const char *path, int basepath_length)

   290

{

   291

	uint num = 0;

   292

	struct stat sb;

   293

	struct dirent *dirent;

   294

	DIR *dir;

   295

   296

	if (path == NULL || (dir = ttd_opendir(path)) == NULL) return 0;

   297

   298

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

   299

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

   300

		char filename[MAX_PATH];

   301

   302

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

   303

   304

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

   305

   306

		if (sb.st_mode & S_IFDIR) {

   307

			/* Directory */

   308

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

   309

			AppendPathSeparator(filename, lengthof(filename));

   310

			num += ScanPath(filename, basepath_length);

   311

		} else if (sb.st_mode & S_IFREG) {

   312

			/* File */

   313

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

   314

   315

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

   316

			if (ext == NULL) continue;

   317

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

   318

   319

			GRFConfig *c = CallocT<GRFConfig>(1);

   320

			c->full_path = strdup(filename + basepath_length);

   321

   322

			bool added = true;

   323

			if (FillGRFDetails(c, false)) {

   324

				if (_all_grfs == NULL) {

   325

					_all_grfs = c;

   326

				} else {

   327

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

   328

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

   329

					GRFConfig **pd, *d;

   330

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

   331

						if (c->grfid == d->grfid && memcmp(c->md5sum, d->md5sum, sizeof(c->md5sum)) == 0) added = false;

   332

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

   333

					}

   334

					if (added) {

   335

						c->next = d;

   336

						*pd = c;

   337

					}

   338

				}

   339

			} else {

   340

				added = false;

   341

			}

   342

   343

			if (!added) {

   344

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

   345

				 * 'system' NewGRF or it's already known, so forget about it. */

   346

				free(c->filename);

   347

				free(c->full_path);

   348

				free(c->name);

   349

				free(c->info);

   350

				free(c);

   351

			} else {

   352

				num++;

   353

			}

   354

		}

   355

	}

   356

   357

	closedir(dir);

   358

   359

	return num;

   360

}

   361

   362

   363

/* Scan for all NewGRFs */

   364

void ScanNewGRFFiles()

   365

{

   366

	uint num;

   367

   368

	ClearGRFConfigList(&_all_grfs);

   369

   370

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

   371

	num  = ScanPath(_paths.data_dir, strlen(_paths.data_dir));

   372

	if (_paths.second_data_dir != NULL) {

   373

		num += ScanPath(_paths.second_data_dir, strlen(_paths.second_data_dir));

   374

	}

   375

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

   376

}

   377

   378

   379

/* Find a NewGRF in the scanned list, if md5sum is NULL, we don't care about it*/

   380

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

   381

{

   382

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

   383

		if (c->grfid == grfid) {

   384

			if (md5sum == NULL) return c;

   385

   386

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

   387

		}

   388

	}

   389

   390

	return NULL;

   391

}

   392

   393

#ifdef ENABLE_NETWORK

   394

   395

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

   396

struct UnknownGRF : public GRFIdentifier {

   397

	UnknownGRF *next;

   398

	char   name[NETWORK_GRF_NAME_LENGTH];

   399

};

   400

   401

/**

   402

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

   403

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

   404

 *

   405

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

   406

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

   407

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

   408

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

   409

 *

   410

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

   411

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

   412

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

   413

 *               exist in the fake list of GRFConfigs.

   414

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

   415

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

   416

 *         freed by the caller.

   417

 */

   418

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

   419

{

   420

	UnknownGRF *grf;

   421

	static UnknownGRF *unknown_grfs = NULL;

   422

   423

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

   424

		if (grf->grfid == grfid) {

   425

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

   426

		}

   427

	}

   428

   429

	if (!create) return NULL;

   430

   431

	grf = CallocT<UnknownGRF>(1);

   432

	grf->grfid = grfid;

   433

	grf->next  = unknown_grfs;

   434

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

   435

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

   436

   437

	unknown_grfs = grf;

   438

	return grf->name;

   439

}

   440

   441

#endif /* ENABLE_NETWORK */

   442

   443

   444

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

   445

GRFConfig *GetGRFConfig(uint32 grfid)

   446

{

   447

	GRFConfig *c;

   448

   449

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

   450

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

   451

	}

   452

   453

	return NULL;

   454

}

   455

   456

   457

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

   458

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

   459

{

   460

	uint i;

   461

   462

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

   463

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

   464

   465

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

   466

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

   467

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

   468

	}

   469

	return dst;

   470

}

   471

   472

   473

static const SaveLoad _grfconfig_desc[] = {

   474

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

   475

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   476

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   477

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

   478

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   479

	SLE_END()

   480

};

   481

   482

   483

static void Save_NGRF()

   484

{

   485

	int index = 0;

   486

   487

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

   488

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

   489

		SlSetArrayIndex(index++);

   490

		SlObject(c, _grfconfig_desc);

   491

	}

   492

}

   493

   494

   495

static void Load_NGRF()

   496

{

   497

	ClearGRFConfigList(&_grfconfig);

   498

	while (SlIterateArray() != -1) {