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 "network/network_data.h"

    12

#include "newgrf.h"

    13

#include "newgrf_config.h"

    14

#include "core/alloc_func.hpp"

    15

#include "string_func.h"

    16

    17

#include "fileio.h"

    18

#include "fios.h"

    19

#include <sys/stat.h>

    20

    21

    22

GRFConfig *_all_grfs;

    23

GRFConfig *_grfconfig;

    24

GRFConfig *_grfconfig_newgame;

    25

GRFConfig *_grfconfig_static;

    26

    27

    28

/* Calculate the MD5 Sum for a GRF */

    29

static bool CalcGRFMD5Sum(GRFConfig *config)

    30

{

    31

	FILE *f;

    32

	Md5 checksum;

    33

	uint8 buffer[1024];

    34

	size_t len, size;

    35

    36

	/* open the file */

    37

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

    38

	if (f == NULL) return false;

    39

    40

	/* calculate md5sum */

    41

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

    42

		size -= len;

    43

		checksum.Append(buffer, len);

    44

	}

    45

	checksum.Finish(config->md5sum);

    46

    47

	FioFCloseFile(f);

    48

    49

	return true;

    50

}

    51

    52

    53

/* Find the GRFID and calculate the md5sum */

    54

bool FillGRFDetails(GRFConfig *config, bool is_static)

    55

{

    56

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

    57

		config->status = GCS_NOT_FOUND;

    58

		return false;

    59

	}

    60

    61

	/* Find and load the Action 8 information */

    62

	LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN);

    63

    64

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

    65

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

    66

    67

	if (is_static) {

    68

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

    69

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    70

    71

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

    72

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

    73

	}

    74

    75

	return CalcGRFMD5Sum(config);

    76

}

    77

    78

    79

void ClearGRFConfig(GRFConfig **config)

    80

{

    81

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

    82

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

    83

		free((*config)->filename);

    84

		free((*config)->name);

    85

		free((*config)->info);

    86

    87

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

    88

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

    89

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

    90

			free((*config)->error);

    91

		}

    92

	}

    93

	free(*config);

    94

	*config = NULL;

    95

}

    96

    97

    98

/* Clear a GRF Config list */

    99

void ClearGRFConfigList(GRFConfig **config)

   100

{

   101

	GRFConfig *c, *next;

   102

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

   103

		next = c->next;

   104

		ClearGRFConfig(&c);

   105

	}

   106

	*config = NULL;

   107

}

   108

   109

   110

/** Copy a GRF Config list

   111

 * @param dst pointer to destination list

   112

 * @param src pointer to source list values

   113

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

   114

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

   115

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

   116

{

   117

	/* Clear destination as it will be overwritten */

   118

	ClearGRFConfigList(dst);

   119

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

   120

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

   121

		*c = *src;

   122

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

   123

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

   124

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

   125

		if (src->error     != NULL) {

   126

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

   127

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

   128

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

   129

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

   130

		}

   131

   132

		ClrBit(c->flags, GCF_INIT_ONLY);

   133

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

   134

   135

		*dst = c;

   136

		dst = &c->next;

   137

	}

   138

   139

	return dst;

   140

}

   141

   142

/**

   143

 * Removes duplicates from lists of GRFConfigs. These duplicates

   144

 * are introduced when the _grfconfig_static GRFs are appended

   145

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

   146

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

   147

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

   148

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

   149

 *

   150

 * This function _assumes_ that all static GRFs are placed after

   151

 * the non-static GRFs.

   152

 *

   153

 * @param list the list to remove the duplicates from

   154

 */

   155

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   156

{

   157

	GRFConfig *prev;

   158

	GRFConfig *cur;

   159

   160

	if (list == NULL) return;

   161

   162

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

   163

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

   164

   165

		prev->next = cur->next;

   166

		ClearGRFConfig(&cur);

   167

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

   168

	}

   169

   170

	RemoveDuplicatesFromGRFConfigList(list->next);

   171

}

   172

   173

/**

   174

 * Appends the static GRFs to a list of GRFs

   175

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

   176

 */

   177

void AppendStaticGRFConfigs(GRFConfig **dst)

   178

{

   179

	GRFConfig **tail = dst;

   180

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

   181

   182

	CopyGRFConfigList(tail, _grfconfig_static, false);

   183

	RemoveDuplicatesFromGRFConfigList(*dst);

   184

}

   185

   186

/** Appends an element to a list of GRFs

   187

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

   188

 * @param el the new tail to be */

   189

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

   190

{

   191

	GRFConfig **tail = dst;

   192

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

   193

	*tail = el;

   194

   195

	RemoveDuplicatesFromGRFConfigList(*dst);

   196

}

   197

   198

   199

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

   200

void ResetGRFConfig(bool defaults)

   201

{

   202

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   203

	AppendStaticGRFConfigs(&_grfconfig);

   204

}

   205

   206

   207

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

   208

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

   209

 * <ul>

   210

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

   211

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

   212

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

   213

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

   214

 * </ul> */

   215

GRFListCompatibility IsGoodGRFConfigList()

   216

{

   217

	GRFListCompatibility res = GLC_ALL_GOOD;

   218

   219

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

   220

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

   221

		if (f == NULL) {

   222

			char buf[256];

   223

   224

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

   225

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

   226

			f = FindGRFConfig(c->grfid);

   227

			if (f != NULL) {

   228

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

   229

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

   230

				SetBit(c->flags, GCF_COMPATIBLE);

   231

   232

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

   233

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   234

				goto compatible_grf;

   235

			}

   236

   237

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

   238

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

   239

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

   240

   241

			c->status = GCS_NOT_FOUND;

   242

			res = GLC_NOT_FOUND;

   243

		} else {

   244

compatible_grf:

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

				free(c->filename);

   253

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

   254

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

   255

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

   256

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

   257

				c->error = NULL;

   258

			}

   259

		}

   260

	}

   261

   262

	return res;

   263

}

   264

   265

static bool ScanPathAddGrf(const char *filename)

   266

{

   267

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

   268

	c->filename = strdup(filename);

   269

   270

	bool added = true;

   271

	if (FillGRFDetails(c, false)) {

   272

		if (_all_grfs == NULL) {

   273

			_all_grfs = c;

   274

		} else {

   275

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

   276

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

   277

			GRFConfig **pd, *d;

   278

			bool stop = false;

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

					stop = true;

   286

				} else if (stop) {

   287

					break;

   288

				}

   289

			}

   290

			if (added) {

   291

				c->next = d;

   292

				*pd = c;

   293

			}

   294

		}

   295

	} else {

   296

		added = false;

   297

	}

   298

   299

	if (!added) {

   300

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

   301

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

   302

		free(c->filename);

   303

		free(c->name);

   304

		free(c->info);

   305

		free(c);

   306

	}

   307

   308

	return added;

   309

}

   310

   311

/* Scan a path for NewGRFs */

   312

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

   313

{

   314

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

   315

   316

	uint num = 0;

   317

	struct stat sb;

   318

	struct dirent *dirent;

   319

	DIR *dir;

   320

   321

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

   322

   323

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

   324

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

   325

		char filename[MAX_PATH];

   326

   327

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

   328

   329

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

   330

   331

		if (sb.st_mode & S_IFDIR) {

   332

			/* Directory */

   333

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

   334

			AppendPathSeparator(filename, lengthof(filename));

   335

			num += ScanPath(filename, basepath_length);

   336

		} else if (sb.st_mode & S_IFREG) {

   337

			/* File */

   338

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

   339

   340

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

   341

			if (ext == NULL) continue;

   342

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

   343

   344

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

   345

		}

   346

	}

   347

   348

	closedir(dir);

   349

   350

	return num;

   351

}

   352

   353

static uint ScanTar(TarFileList::iterator tar)

   354

{

   355

	uint num = 0;

   356

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

   357

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

   358

   359

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

   360

	if (ext == NULL) return false;

   361

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

   362

   363

	if (ScanPathAddGrf(filename)) num++;

   364

   365

	return num;

   366

}

   367

   368

/**

   369

 * Simple sorter for GRFS

   370

 * @param p1 the first GRFConfig *

   371

 * @param p2 the second GRFConfig *

   372

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

   373

 */

   374

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

   375

{

   376

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

   377

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

   378

   379

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

   380

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

   381

}

   382

   383

/* Scan for all NewGRFs */

   384

void ScanNewGRFFiles()

   385

{

   386

	Searchpath sp;

   387

	char path[MAX_PATH];

   388

	TarFileList::iterator tar;

   389

	uint num = 0;

   390

   391

	ClearGRFConfigList(&_all_grfs);

   392

   393

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

   394

	FOR_ALL_SEARCHPATHS(sp) {

   395

		FioAppendDirectory(path, MAX_PATH, sp, DATA_DIR);

   396

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

   397

	}

   398

	FOR_ALL_TARS(tar) {

   399

		num += ScanTar(tar);

   400

	}

   401

   402

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

   403

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

   404

   405

	/* Sort the linked list using quicksort.

   406

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

   407

	 * then remake the linked list. */

   408

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

   409

   410

	uint i = 0;

   411

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

   412

		to_sort[i] = p;

   413

	}

   414

	/* Number of files is not necessarily right */

   415

	num = i;

   416

   417

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

   418

   419

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

   420

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

   421

	}

   422

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

   423

	_all_grfs = to_sort[0];

   424

   425

	free(to_sort);

   426

}

   427

   428

   429

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

   430

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

   431

{

   432

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

   433

		if (c->grfid == grfid) {

   434

			if (md5sum == NULL) return c;

   435

   436

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

   437

		}

   438

	}

   439

   440

	return NULL;

   441

}

   442

   443

#ifdef ENABLE_NETWORK

   444

   445

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

   446

struct UnknownGRF : public GRFIdentifier {

   447

	UnknownGRF *next;

   448

	char   name[NETWORK_GRF_NAME_LENGTH];

   449

};

   450

   451

/**

   452

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

   453

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

   454

 *

   455

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

   456

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

   457

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

   458

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

   459

 *

   460

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

   461

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

   462

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

   463

 *               exist in the fake list of GRFConfigs.

   464

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

   465

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

   466

 *         freed by the caller.

   467

 */

   468

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

   469

{

   470

	UnknownGRF *grf;

   471

	static UnknownGRF *unknown_grfs = NULL;

   472

   473

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

   474

		if (grf->grfid == grfid) {

   475

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

   476

		}

   477

	}

   478

   479

	if (!create) return NULL;

   480

   481

	grf = CallocT<UnknownGRF>(1);

   482

	grf->grfid = grfid;

   483

	grf->next  = unknown_grfs;

   484

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

   485

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

   486

   487

	unknown_grfs = grf;

   488

	return grf->name;

   489

}

   490

   491

#endif /* ENABLE_NETWORK */

   492

   493

   494