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

    18

#include "tar_type.h"

    19

#include "fileio.h"

    20

#include "fios.h"

    21

#include <sys/stat.h>

    22

    23

    24

GRFConfig *_all_grfs;

    25

GRFConfig *_grfconfig;

    26

GRFConfig *_grfconfig_newgame;

    27

GRFConfig *_grfconfig_static;

    28

    29

    30

/* Calculate the MD5 Sum for a GRF */

    31

static bool CalcGRFMD5Sum(GRFConfig *config)

    32

{

    33

	FILE *f;

    34

	Md5 checksum;

    35

	uint8 buffer[1024];

    36

	size_t len, size;

    37

    38

	/* open the file */

    39

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

    40

	if (f == NULL) return false;

    41

    42

	/* calculate md5sum */

    43

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

    44

		size -= len;

    45

		checksum.Append(buffer, len);

    46

	}

    47

	checksum.Finish(config->md5sum);

    48

    49

	FioFCloseFile(f);

    50

    51

	return true;

    52

}

    53

    54

    55

/* Find the GRFID and calculate the md5sum */

    56

bool FillGRFDetails(GRFConfig *config, bool is_static)

    57

{

    58

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

    59

		config->status = GCS_NOT_FOUND;

    60

		return false;

    61

	}

    62

    63

	/* Find and load the Action 8 information */

    64

	LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN);

    65

    66

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

    67

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

    68

    69

	if (is_static) {

    70

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

    71

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    72

    73

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

    74

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

    75

	}

    76

    77

	return CalcGRFMD5Sum(config);

    78

}

    79

    80

    81

void ClearGRFConfig(GRFConfig **config)

    82

{

    83

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

    84

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

    85

		free((*config)->filename);

    86

		free((*config)->name);

    87

		free((*config)->info);

    88

    89

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

    90

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

    91

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

    92

			free((*config)->error);

    93

		}

    94

	}

    95

	free(*config);

    96

	*config = NULL;

    97

}

    98

    99

   100

/* Clear a GRF Config list */

   101

void ClearGRFConfigList(GRFConfig **config)

   102

{

   103

	GRFConfig *c, *next;

   104

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

   105

		next = c->next;

   106

		ClearGRFConfig(&c);

   107

	}

   108

	*config = NULL;

   109

}

   110

   111

   112

/** Copy a GRF Config list

   113

 * @param dst pointer to destination list

   114

 * @param src pointer to source list values

   115

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

   116

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

   117

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

   118

{

   119

	/* Clear destination as it will be overwritten */

   120

	ClearGRFConfigList(dst);

   121

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

   122

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

   123

		*c = *src;

   124

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

   125

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

   126

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

   127

		if (src->error     != NULL) {

   128

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

   129

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

   130

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

   131

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

   132

		}

   133

   134

		ClrBit(c->flags, GCF_INIT_ONLY);

   135

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

   136

   137

		*dst = c;

   138

		dst = &c->next;

   139

	}

   140

   141

	return dst;

   142

}

   143

   144

/**

   145

 * Removes duplicates from lists of GRFConfigs. These duplicates

   146

 * are introduced when the _grfconfig_static GRFs are appended

   147

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

   148

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

   149

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

   150

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

   151

 *

   152

 * This function _assumes_ that all static GRFs are placed after

   153

 * the non-static GRFs.

   154

 *

   155

 * @param list the list to remove the duplicates from

   156

 */

   157

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   158

{

   159

	GRFConfig *prev;

   160

	GRFConfig *cur;

   161

   162

	if (list == NULL) return;

   163

   164

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

   165

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

   166

   167

		prev->next = cur->next;

   168

		ClearGRFConfig(&cur);

   169

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

   170

	}

   171

   172

	RemoveDuplicatesFromGRFConfigList(list->next);

   173

}

   174

   175

/**

   176

 * Appends the static GRFs to a list of GRFs

   177

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

   178

 */

   179

void AppendStaticGRFConfigs(GRFConfig **dst)

   180

{

   181

	GRFConfig **tail = dst;

   182

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

   183

   184

	CopyGRFConfigList(tail, _grfconfig_static, false);

   185

	RemoveDuplicatesFromGRFConfigList(*dst);

   186

}

   187

   188

/** Appends an element to a list of GRFs

   189

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

   190

 * @param el the new tail to be */

   191

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

   192

{

   193

	GRFConfig **tail = dst;

   194

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

   195

	*tail = el;

   196

   197

	RemoveDuplicatesFromGRFConfigList(*dst);

   198

}

   199

   200

   201

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

   202

void ResetGRFConfig(bool defaults)

   203

{

   204

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   205

	AppendStaticGRFConfigs(&_grfconfig);

   206

}

   207

   208

   209

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

   210

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

   211

 * <ul>

   212

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

   213

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

   214

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

   215

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

   216

 * </ul> */

   217

GRFListCompatibility IsGoodGRFConfigList()

   218

{

   219

	GRFListCompatibility res = GLC_ALL_GOOD;

   220

   221

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

   222

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

   223

		if (f == NULL) {

   224

			char buf[256];

   225

   226

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

   227

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

   228

			f = FindGRFConfig(c->grfid);

   229

			if (f != NULL) {

   230

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

   231

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

   232

				SetBit(c->flags, GCF_COMPATIBLE);

   233

   234

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

   235

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   236

				GamelogGRFCompatible(f);

   237

				goto compatible_grf;

   238

			}

   239

   240

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

   241

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

   242

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

   243

   244

			GamelogGRFRemove(c->grfid);

   245

   246

			c->status = GCS_NOT_FOUND;

   247

			res = GLC_NOT_FOUND;

   248

		} else {

   249

compatible_grf:

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

				free(c->filename);

   258

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

   259

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

   260

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

   261

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

   262

				c->error = NULL;

   263

			}

   264

		}

   265

	}

   266

   267

	return res;

   268

}

   269

   270

static bool ScanPathAddGrf(const char *filename)

   271

{

   272

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

   273

	c->filename = strdup(filename);

   274

   275

	bool added = true;

   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

			bool stop = false;

   284

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

   285

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

   286

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

   287

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

   288

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

   289

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

   290

					stop = true;

   291

				} else if (stop) {

   292

					break;

   293

				}

   294

			}

   295

			if (added) {

   296

				c->next = d;

   297

				*pd = c;

   298

			}

   299

		}

   300

	} else {

   301

		added = false;

   302

	}

   303

   304

	if (!added) {

   305

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

   306

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

   307

		free(c->filename);

   308

		free(c->name);

   309

		free(c->info);

   310

		free(c);

   311

	}

   312

   313

	return added;

   314

}

   315

   316

/* Scan a path for NewGRFs */

   317

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

   318

{

   319

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

   320

   321

	uint num = 0;

   322

	struct stat sb;

   323

	struct dirent *dirent;

   324

	DIR *dir;

   325

   326

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

   327

   328

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

   329

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

   330

		char filename[MAX_PATH];

   331

   332

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

   333

   334

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

   335

   336

		if (sb.st_mode & S_IFDIR) {

   337

			/* Directory */

   338

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

   339

			AppendPathSeparator(filename, lengthof(filename));

   340

			num += ScanPath(filename, basepath_length);

   341

		} else if (sb.st_mode & S_IFREG) {

   342

			/* File */

   343

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

   344

   345

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

   346

			if (ext == NULL) continue;

   347

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

   348

   349

			if (ScanPathAddGrf(filename + basepath_length)) num++;

   350

		}

   351

	}

   352

   353

	closedir(dir);

   354

   355

	return num;

   356

}

   357

   358

static uint ScanTar(TarFileList::iterator tar)

   359

{

   360

	uint num = 0;

   361

	const char *filename = (*tar).first.c_str();

   362

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

   363

   364

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

   365

	if (ext == NULL) return false;

   366

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

   367

   368

	if (ScanPathAddGrf(filename)) num++;

   369

   370

	return num;

   371

}

   372

   373

/**

   374

 * Simple sorter for GRFS

   375

 * @param p1 the first GRFConfig *

   376

 * @param p2 the second GRFConfig *

   377

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

   378

 */

   379

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

   380

{

   381

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

   382

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

   383

   384

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

   385

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

   386

}

   387

   388

/* Scan for all NewGRFs */

   389

void ScanNewGRFFiles()

   390

{

   391

	Searchpath sp;

   392

	char path[MAX_PATH];

   393

	TarFileList::iterator tar;

   394

	uint num = 0;

   395

   396

	ClearGRFConfigList(&_all_grfs);

   397

   398

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

   399

	FOR_ALL_SEARCHPATHS(sp) {

   400

		FioAppendDirectory(path, MAX_PATH, sp, DATA_DIR);

   401

		num += ScanPath(path, strlen(path));

   402

	}

   403

	FOR_ALL_TARS(tar) {

   404

		num += ScanTar(tar);

   405

	}

   406

   407

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

   408

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

   409

   410

	/* Sort the linked list using quicksort.

   411

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

   412

	 * then remake the linked list. */

   413

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

   414

   415

	uint i = 0;

   416

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

   417

		to_sort[i] = p;

   418

	}

   419

	/* Number of files is not necessarily right */

   420

	num = i;

   421

   422

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

   423

   424

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

   425

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

   426

	}

   427

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

   428

	_all_grfs = to_sort[0];

   429

   430

	free(to_sort);

   431

}

   432

   433

   434

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

   435

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

   436

{

   437

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

   438

		if (c->grfid == grfid) {

   439

			if (md5sum == NULL) return c;

   440

   441

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

   442

		}

   443

	}

   444

   445

	return NULL;

   446

}

   447

   448

#ifdef ENABLE_NETWORK

   449

   450

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

   451

struct UnknownGRF : public GRFIdentifier {

   452

	UnknownGRF *next;

   453

	char   name[NETWORK_GRF_NAME_LENGTH];

   454

};

   455

   456

/**

   457

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

   458

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

   459

 *

   460

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

   461

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

   462

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

   463

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

   464

 *

   465

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

   466

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

   467

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

   468

 *               exist in the fake list of GRFConfigs.

   469

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

   470

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

   471

 *         freed by the caller.

   472

 */

   473

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

   474

{

   475

	UnknownGRF *grf;

   476

	static UnknownGRF *unknown_grfs = NULL;

   477

   478

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

   479

		if (grf->grfid == grfid) {

   480

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

   481

		}

   482

	}

   483

   484

	if (!create) return NULL;

   485

   486

	grf = CallocT<UnknownGRF>(1);

   487

	grf->grfid = grfid;

   488

	grf->next  = unknown_grfs;

   489

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

   490

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

   491

   492

	unknown_grfs = grf;

   493

	return grf->name;