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"

    17

#include "gfx_func.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

/**

    30

 * Update the palettes of the graphics from the config file.

    31

 * This is needed because the config file gets read and parsed

    32

 * before the palette is chosen (one can configure the base

    33

 * graphics set governing the palette in the config after all).

    34

 * As a result of this we update the settings from the config

    35

 * once we have determined the palette.

    36

 */

    37

void UpdateNewGRFConfigPalette()

    38

{

    39

	for (GRFConfig *c = _grfconfig_newgame; c != NULL; c = c->next) c->windows_paletted = (_use_palette == PAL_WINDOWS);

    40

	for (GRFConfig *c = _grfconfig_static;  c != NULL; c = c->next) c->windows_paletted = (_use_palette == PAL_WINDOWS);

    41

}

    42

    43

/* Calculate the MD5 Sum for a GRF */

    44

static bool CalcGRFMD5Sum(GRFConfig *config)

    45

{

    46

	FILE *f;

    47

	Md5 checksum;

    48

	uint8 buffer[1024];

    49

	size_t len, size;

    50

    51

	/* open the file */

    52

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

    53

	if (f == NULL) return false;

    54

    55

	/* calculate md5sum */

    56

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

    57

		size -= len;

    58

		checksum.Append(buffer, len);

    59

	}

    60

	checksum.Finish(config->md5sum);

    61

    62

	FioFCloseFile(f);

    63

    64

	return true;

    65

}

    66

    67

    68

/* Find the GRFID and calculate the md5sum */

    69

bool FillGRFDetails(GRFConfig *config, bool is_static)

    70

{

    71

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

    72

		config->status = GCS_NOT_FOUND;

    73

		return false;

    74

	}

    75

    76

	/* Find and load the Action 8 information */

    77

	LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN);

    78

    79

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

    80

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

    81

    82

	if (is_static) {

    83

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

    84

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    85

    86

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

    87

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

    88

	}

    89

    90

	config->windows_paletted = (_use_palette == PAL_WINDOWS);

    91

    92

	return CalcGRFMD5Sum(config);

    93

}

    94

    95

    96

void ClearGRFConfig(GRFConfig **config)

    97

{

    98

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

    99

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

   100

		free((*config)->filename);

   101

		free((*config)->name);

   102

		free((*config)->info);

   103

   104

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

   105

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

   106

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

   107

			free((*config)->error);

   108

		}

   109

	}

   110

	free(*config);

   111

	*config = NULL;

   112

}

   113

   114

   115

/* Clear a GRF Config list */

   116

void ClearGRFConfigList(GRFConfig **config)

   117

{

   118

	GRFConfig *c, *next;

   119

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

   120

		next = c->next;

   121

		ClearGRFConfig(&c);

   122

	}

   123

	*config = NULL;

   124

}

   125

   126

   127

/** Copy a GRF Config list

   128

 * @param dst pointer to destination list

   129

 * @param src pointer to source list values

   130

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

   131

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

   132

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

   133

{

   134

	/* Clear destination as it will be overwritten */

   135

	ClearGRFConfigList(dst);

   136

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

   137

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

   138

		*c = *src;

   139

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

   140

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

   141

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

   142

		if (src->error     != NULL) {

   143

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

   144

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

   145

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

   146

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

   147

		}

   148

   149

		ClrBit(c->flags, GCF_INIT_ONLY);

   150

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

   151

   152

		*dst = c;

   153

		dst = &c->next;

   154

	}

   155

   156

	return dst;

   157

}

   158

   159

/**

   160

 * Removes duplicates from lists of GRFConfigs. These duplicates

   161

 * are introduced when the _grfconfig_static GRFs are appended

   162

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

   163

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

   164

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

   165

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

   166

 *

   167

 * This function _assumes_ that all static GRFs are placed after

   168

 * the non-static GRFs.

   169

 *

   170

 * @param list the list to remove the duplicates from

   171

 */

   172

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   173

{

   174

	GRFConfig *prev;

   175

	GRFConfig *cur;

   176

   177

	if (list == NULL) return;

   178

   179

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

   180

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

   181

   182

		prev->next = cur->next;

   183

		ClearGRFConfig(&cur);

   184

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

   185

	}

   186

   187

	RemoveDuplicatesFromGRFConfigList(list->next);

   188

}

   189

   190

/**

   191

 * Appends the static GRFs to a list of GRFs

   192

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

   193

 */

   194

void AppendStaticGRFConfigs(GRFConfig **dst)

   195

{

   196

	GRFConfig **tail = dst;

   197

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

   198

   199

	CopyGRFConfigList(tail, _grfconfig_static, false);

   200

	RemoveDuplicatesFromGRFConfigList(*dst);

   201

}

   202

   203

/** Appends an element to a list of GRFs

   204

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

   205

 * @param el the new tail to be */

   206

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

   207

{

   208

	GRFConfig **tail = dst;

   209

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

   210

	*tail = el;

   211

   212

	RemoveDuplicatesFromGRFConfigList(*dst);

   213

}

   214

   215

   216

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

   217

void ResetGRFConfig(bool defaults)

   218

{

   219

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   220

	AppendStaticGRFConfigs(&_grfconfig);

   221

}

   222

   223

   224

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

   225

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

   226

 * <ul>

   227

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

   228

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

   229

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

   230

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

   231

 * </ul> */

   232

GRFListCompatibility IsGoodGRFConfigList()

   233

{

   234

	GRFListCompatibility res = GLC_ALL_GOOD;

   235

   236

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

   237

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

   238

		if (f == NULL) {

   239

			char buf[256];

   240

   241

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

   242

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

   243

			f = FindGRFConfig(c->grfid);

   244

			if (f != NULL) {

   245

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

   246

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

   247

				SetBit(c->flags, GCF_COMPATIBLE);

   248

   249

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

   250

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   251

				GamelogGRFCompatible(f);

   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

			GamelogGRFRemove(c->grfid);

   260

   261

			c->status = GCS_NOT_FOUND;

   262

			res = GLC_NOT_FOUND;

   263

		} else {

   264

compatible_grf:

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

				free(c->filename);

   273

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

   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

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

   286

class GRFFileScanner : FileScanner {

   287

public:

   288

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

   289

   290

	/** Do the scan for GRFs. */

   291

	static uint DoScan()

   292

	{

   293

		GRFFileScanner fs;

   294

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

   295

	}

   296

};

   297

   298

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

   299

{

   300

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

   301

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

   302

   303

	bool added = true;

   304

	if (FillGRFDetails(c, false)) {

   305

		if (_all_grfs == NULL) {

   306

			_all_grfs = c;

   307

		} else {

   308

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

   309

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

   310

			GRFConfig **pd, *d;

   311

			bool stop = false;

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

					stop = true;

   319

				} else if (stop) {

   320

					break;

   321

				}

   322

			}

   323

			if (added) {

   324

				c->next = d;

   325

				*pd = c;

   326

			}

   327

		}

   328

	} else {

   329

		added = false;

   330

	}

   331

   332

	if (!added) {

   333

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

   334

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

   335

		free(c->filename);

   336

		free(c->name);

   337

		free(c->info);

   338

		free(c);

   339

	}

   340

   341

	return added;

   342

}

   343

   344

/**

   345

 * Simple sorter for GRFS

   346

 * @param p1 the first GRFConfig *

   347

 * @param p2 the second GRFConfig *

   348

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

   349

 */

   350

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

   351

{

   352

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

   353

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

   354

   355

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

   356

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

   357

}

   358

   359

/* Scan for all NewGRFs */

   360

void ScanNewGRFFiles()

   361

{

   362

	ClearGRFConfigList(&_all_grfs);

   363

   364

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

   365

	uint num = GRFFileScanner::DoScan();

   366

   367

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

   368

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

   369

   370

	/* Sort the linked list using quicksort.

   371

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

   372

	 * then remake the linked list. */

   373

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

   374

   375

	uint i = 0;

   376

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

   377

		to_sort[i] = p;

   378

	}

   379

	/* Number of files is not necessarily right */

   380

	num = i;

   381

   382

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

   383

   384

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

   385

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

   386

	}

   387

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

   388

	_all_grfs = to_sort[0];

   389

   390

	free(to_sort);

   391

}

   392

   393

   394

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

   395

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

   396

{

   397

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

   398

		if (c->grfid == grfid) {

   399

			if (md5sum == NULL) return c;

   400

   401

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

   402

		}

   403

	}

   404

   405

	return NULL;

   406

}

   407

   408

#ifdef ENABLE_NETWORK

   409

   410

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

   411

struct UnknownGRF : public GRFIdentifier {

   412

	UnknownGRF *next;

   413

	char   name[NETWORK_GRF_NAME_LENGTH];

   414

};

   415

   416

/**

   417

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

   418

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

   419

 *

   420

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

   421

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

   422

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

   423

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

   424

 *

   425

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

   426

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

   427

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

   428

 *               exist in the fake list of GRFConfigs.

   429

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

   430

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

   431

 *         freed by the caller.

   432

 */

   433

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

   434

{

   435

	UnknownGRF *grf;

   436

	static UnknownGRF *unknown_grfs = NULL;

   437

   438

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

   439

		if (grf->grfid == grfid) {

   440

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

   441

		}

   442

	}

   443

   444

	if (!create) return NULL;

   445

   446

	grf = CallocT<UnknownGRF>(1);

   447

	grf->grfid = grfid;

   448

	grf->next  = unknown_grfs;

   449

	strecpy(grf->name, UNKNOWN_GRF_NAME_PLACEHOLDER, lastof(grf->name));

   450

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

   451

   452

	unknown_grfs = grf;

   453

	return grf->name;

   454

}

   455

   456

#endif /* ENABLE_NETWORK */

   457

   458

   459

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

   460

GRFConfig *GetGRFConfig(uint32 grfid)

   461

{

   462

	GRFConfig *c;

   463

   464

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

   465

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

   466

	}

   467

   468

	return NULL;

   469

}

   470

   471

   472

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

   473

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

   474

{

   475

	uint i;

   476

   477

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

   478

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

   479

   480

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

   481

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

   482

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

   483

	}

   484

	return dst;

   485

}

   486

   487

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

   488

static const uint32 OPENTTD_GRAPHICS_BASE_GRF_ID = BSWAP32(0xFF4F5400);

   489

   490

/**

   491

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

   492

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