1

/* $Id$ */

     2

     3

/** @file newgrf_config.cpp Finding NewGRFs and configuring them. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "variables.h"

     9

#include "saveload.h"

    10

#include "md5.h"

    11

#include "newgrf.h"

    12

#include "newgrf_config.h"

    13

#include "core/alloc_func.hpp"

    14

#include "string_func.h"

    15

#include "gamelog.h"

    16

#include "network/network_type.h"

    18

    19

#include "fileio_func.h"

    20

#include "fios.h"

    21

    22

    23

GRFConfig *_all_grfs;

    24

GRFConfig *_grfconfig;

    25

GRFConfig *_grfconfig_newgame;

    26

GRFConfig *_grfconfig_static;

    27

    28

    29

/* Calculate the MD5 Sum for a GRF */

    30

static bool CalcGRFMD5Sum(GRFConfig *config)

    31

{

    32

	FILE *f;

    33

	Md5 checksum;

    34

	uint8 buffer[1024];

    35

	size_t len, size;

    36

    37

	/* open the file */

    38

	f = FioFOpenFile(config->filename, "rb", DATA_DIR, &size);

    39

	if (f == NULL) return false;

    40

    41

	/* calculate md5sum */

    42

	while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, f)) != 0 && size != 0) {

    43

		size -= len;

    44

		checksum.Append(buffer, len);

    45

	}

    46

	checksum.Finish(config->md5sum);

    47

    48

	FioFCloseFile(f);

    49

    50

	return true;

    51

}

    52

    53

    54

/* Find the GRFID and calculate the md5sum */

    55

bool FillGRFDetails(GRFConfig *config, bool is_static)

    56

{

    57

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

    58

		config->status = GCS_NOT_FOUND;

    59

		return false;

    60

	}

    61

    62

	/* Find and load the Action 8 information */

    63

	LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN);

    64

    65

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

    66

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

    67

    68

	if (is_static) {

    69

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

    70

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    71

    72

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

    73

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

    74

	}

    75

    78

	return CalcGRFMD5Sum(config);

    79

}

    80

    81

    82

void ClearGRFConfig(GRFConfig **config)

    83

{

    84

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

    85

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

    86

		free((*config)->filename);

    87

		free((*config)->name);

    88

		free((*config)->info);

    89

    90

		if ((*config)->error != NULL) {

    91

			free((*config)->error->custom_message);

    92

			free((*config)->error->data);

    93

			free((*config)->error);

    94

		}

    95

	}

    96

	free(*config);

    97

	*config = NULL;

    98

}

    99

   100

   101

/* Clear a GRF Config list */

   102

void ClearGRFConfigList(GRFConfig **config)

   103

{

   104

	GRFConfig *c, *next;

   105

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

   106

		next = c->next;

   107

		ClearGRFConfig(&c);

   108

	}

   109

	*config = NULL;

   110

}

   111

   112

   113

/** Copy a GRF Config list

   114

 * @param dst pointer to destination list

   115

 * @param src pointer to source list values

   116

 * @param init_only the copied GRF will be processed up to GLS_INIT

   117

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

   118

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

   119

{

   120

	/* Clear destination as it will be overwritten */

   121

	ClearGRFConfigList(dst);

   122

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

   123

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

   124

		*c = *src;

   125

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

   126

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

   127

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

   128

		if (src->error     != NULL) {

   129

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

   130

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

   131

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

   132

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

   133

		}

   134

   135

		ClrBit(c->flags, GCF_INIT_ONLY);

   136

		if (init_only) SetBit(c->flags, GCF_INIT_ONLY);

   137

   138

		*dst = c;

   139

		dst = &c->next;

   140

	}

   141

   142

	return dst;

   143

}

   144

   145

/**

   146

 * Removes duplicates from lists of GRFConfigs. These duplicates

   147

 * are introduced when the _grfconfig_static GRFs are appended

   148

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

   149

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

   150

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

   151

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

   152

 *

   153

 * This function _assumes_ that all static GRFs are placed after

   154

 * the non-static GRFs.

   155

 *

   156

 * @param list the list to remove the duplicates from

   157

 */

   158

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   159

{

   160

	GRFConfig *prev;

   161

	GRFConfig *cur;

   162

   163

	if (list == NULL) return;

   164

   165

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

   166

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

   167

   168

		prev->next = cur->next;

   169

		ClearGRFConfig(&cur);

   170

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

   171

	}

   172

   173

	RemoveDuplicatesFromGRFConfigList(list->next);

   174

}

   175

   176

/**

   177

 * Appends the static GRFs to a list of GRFs

   178

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

   179

 */

   180

void AppendStaticGRFConfigs(GRFConfig **dst)

   181

{

   182

	GRFConfig **tail = dst;

   183

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

   184

   185

	CopyGRFConfigList(tail, _grfconfig_static, false);

   186

	RemoveDuplicatesFromGRFConfigList(*dst);

   187

}

   188

   189

/** Appends an element to a list of GRFs

   190

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

   191

 * @param el the new tail to be */

   192

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

   193

{

   194

	GRFConfig **tail = dst;

   195

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

   196

	*tail = el;

   197

   198

	RemoveDuplicatesFromGRFConfigList(*dst);

   199

}

   200

   201

   202

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

   203

void ResetGRFConfig(bool defaults)

   204

{

   205

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   206

	AppendStaticGRFConfigs(&_grfconfig);

   207

}

   208

   209

   210

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

   211

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

   212

 * <ul>

   213

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

   214

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

   215

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

   216

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

   217

 * </ul> */

   218

GRFListCompatibility IsGoodGRFConfigList()

   219

{

   220

	GRFListCompatibility res = GLC_ALL_GOOD;

   221

   222

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

   223

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

   224

		if (f == NULL) {

   225

			char buf[256];

   226

   227

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

   228

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

   229

			f = FindGRFConfig(c->grfid);

   230

			if (f != NULL) {

   231

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

   232

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

   233

				SetBit(c->flags, GCF_COMPATIBLE);

   234

   235

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

   236

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   237

				GamelogGRFCompatible(f);

   238

				goto compatible_grf;

   239

			}

   240

   241

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

   242

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

   243

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

   244

   245

			GamelogGRFRemove(c->grfid);

   246

   247

			c->status = GCS_NOT_FOUND;

   248

			res = GLC_NOT_FOUND;

   249

		} else {

   250

compatible_grf:

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

				free(c->filename);

   259

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

   260

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

   261

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

   262

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

   263

				c->error = NULL;

   264

			}

   265

		}

   266

	}

   267

   268

	return res;

   269

}

   270

   271

/** Helper for scanning for files with GRF as extension */

   272

class GRFFileScanner : FileScanner {

   273

public:

   274

	/* virtual */ bool AddFile(const char *filename, size_t basepath_length);

   275

   276

	/** Do the scan for GRFs. */

   277

	static uint DoScan()

   278

	{

   279

		GRFFileScanner fs;

   280

		return fs.Scan(".grf", DATA_DIR);

   281

	}

   282

};

   283

   284

bool GRFFileScanner::AddFile(const char *filename, size_t basepath_length)

   285

{

   286

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

   287

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

   288

   289

	bool added = true;

   290

	if (FillGRFDetails(c, false)) {

   291

		if (_all_grfs == NULL) {

   292

			_all_grfs = c;

   293

		} else {

   294

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

   295

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

   296

			GRFConfig **pd, *d;

   297

			bool stop = false;

   298

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

   299

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

   300

				/* Because there can be multiple grfs with the same name, make sure we checked all grfs with the same name,

   301

				 *  before inserting the entry. So insert a new grf at the end of all grfs with the same name, instead of

   302

				 *  just after the first with the same name. Avoids doubles in the list. */

   303

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

   304

					stop = true;

   305

				} else if (stop) {

   306

					break;

   307

				}

   308

			}

   309

			if (added) {

   310

				c->next = d;

   311

				*pd = c;

   312

			}

   313

		}

   314

	} else {

   315

		added = false;

   316

	}

   317

   318

	if (!added) {

   319

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

   320

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

   321

		free(c->filename);

   322

		free(c->name);

   323

		free(c->info);

   324

		free(c);

   325

	}

   326

   327

	return added;

   328

}

   329

   330

/**

   331

 * Simple sorter for GRFS

   332

 * @param p1 the first GRFConfig *

   333

 * @param p2 the second GRFConfig *

   334

 * @return the same strcmp would return for the name of the NewGRF.

   335

 */

   336

static int CDECL GRFSorter(const void *p1, const void *p2)

   337

{

   338

	const GRFConfig *c1 = *(const GRFConfig **)p1;

   339

	const GRFConfig *c2 = *(const GRFConfig **)p2;

   340

   341

	return strcasecmp(c1->name != NULL ? c1->name : c1->filename,

   342

		c2->name != NULL ? c2->name : c2->filename);

   343

}

   344

   345

/* Scan for all NewGRFs */

   346

void ScanNewGRFFiles()

   347

{

   348

	ClearGRFConfigList(&_all_grfs);

   349

   350

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

   351

	uint num = GRFFileScanner::DoScan();

   352

   353

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

   354

	if (num == 0 || _all_grfs == NULL) return;

   355

   356

	/* Sort the linked list using quicksort.

   357

	 * For that we first have to make an array, the qsort and

   358

	 * then remake the linked list. */

   359

	GRFConfig **to_sort = MallocT<GRFConfig*>(num);

   360

   361

	uint i = 0;

   362

	for (GRFConfig *p = _all_grfs; p != NULL; p = p->next, i++) {

   363

		to_sort[i] = p;

   364

	}

   365

	/* Number of files is not necessarily right */

   366

	num = i;

   367

   368

	qsort(to_sort, num, sizeof(GRFConfig*), GRFSorter);

   369

   370

	for (i = 1; i < num; i++) {

   371

		to_sort[i - 1]->next = to_sort[i];

   372

	}

   373

	to_sort[num - 1]->next = NULL;

   374

	_all_grfs = to_sort[0];

   375

   376

	free(to_sort);

   377

}

   378

   379

   380

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

   381

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

   382

{

   383

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

   384

		if (c->grfid == grfid) {

   385

			if (md5sum == NULL) return c;

   386

   387

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

   388

		}

   389

	}

   390

   391

	return NULL;

   392

}

   393

   394

#ifdef ENABLE_NETWORK

   395

   396

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

   397

struct UnknownGRF : public GRFIdentifier {

   398

	UnknownGRF *next;

   399

	char   name[NETWORK_GRF_NAME_LENGTH];

   400

};

   401

   402

/**

   403

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

   404

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

   405

 *

   406

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

   407

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

   408

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

   409

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

   410

 *

   411

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

   412

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

   413

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

   414

 *               exist in the fake list of GRFConfigs.

   415

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

   416

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

   417

 *         freed by the caller.

   418

 */

   419

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

   420

{

   421

	UnknownGRF *grf;

   422

	static UnknownGRF *unknown_grfs = NULL;

   423

   424

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

   425

		if (grf->grfid == grfid) {

   426

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

   427

		}

   428

	}

   429

   430

	if (!create) return NULL;

   431

   432

	grf = CallocT<UnknownGRF>(1);

   433

	grf->grfid = grfid;

   434

	grf->next  = unknown_grfs;

   435

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

   436

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

   437

   438

	unknown_grfs = grf;

   439

	return grf->name;

   440

}

   441

   442

#endif /* ENABLE_NETWORK */

   443

   444

   445

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

   446

GRFConfig *GetGRFConfig(uint32 grfid)

   447

{

   448

	GRFConfig *c;

   449

   450

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

   451

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

   452

	}

   453

   454

	return NULL;

   455

}

   456

   457

   458

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

   459

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

   460

{

   461

	uint i;

   462

   463

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

   464

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

   465

   466

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

   467

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

   468

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

   469

	}

   470

	return dst;

   471

}

   472

   473

/** Base GRF ID for OpenTTD's base graphics GRFs. */

   474

static const uint32 OPENTTD_GRAPHICS_BASE_GRF_ID = BSWAP32(0xFF4F5400);

   475

   476

/**

   477

 * Checks whether this GRF is a OpenTTD base graphic GRF.

   478

 * @return true if and only if it is a base GRF.

   479

 */

   480

bool GRFConfig::IsOpenTTDBaseGRF() const

   481

{

   482

	return (this->grfid & 0x00FFFFFF) == OPENTTD_GRAPHICS_BASE_GRF_ID;

   483

}

   484

   485

   486

static const SaveLoad _grfconfig_desc[] = {