1

/* $Id$ */

     2

     3

/** @file newgrf_config.cpp */

     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

#ifdef WIN32

    22

# include <io.h>

    23

#endif /* WIN32 */

    24

    25

    26

GRFConfig *_all_grfs;

    27

GRFConfig *_grfconfig;

    28

GRFConfig *_grfconfig_newgame;

    29

GRFConfig *_grfconfig_static;

    30

    31

    32

/* Calculate the MD5 Sum for a GRF */

    33

static bool CalcGRFMD5Sum(GRFConfig *config)

    34

{

    35

	FILE *f;

    36

	Md5 checksum;

    37

	uint8 buffer[1024];

    38

	size_t len, size;

    39

    40

	/* open the file */

    41

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

    42

	if (f == NULL) return false;

    43

    44

	/* calculate md5sum */

    45

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

    46

		size -= len;

    47

		checksum.Append(buffer, len);

    48

	}

    49

	checksum.Finish(config->md5sum);

    50

    51

	FioFCloseFile(f);

    52

    53

	return true;

    54

}

    55

    56

    57

/* Find the GRFID and calculate the md5sum */

    58

bool FillGRFDetails(GRFConfig *config, bool is_static)

    59

{

    60

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

    61

		config->status = GCS_NOT_FOUND;

    62

		return false;

    63

	}

    64

    65

	/* Find and load the Action 8 information */

    66

	LoadNewGRFFile(config, CONFIG_SLOT, GLS_FILESCAN);

    67

    68

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

    69

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

    70

    71

	if (is_static) {

    72

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

    73

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    74

    75

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

    76

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

    77

	}

    78

    79

	return CalcGRFMD5Sum(config);

    80

}

    81

    82

    83

void ClearGRFConfig(GRFConfig **config)

    84

{

    85

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

    86

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

    87

		free((*config)->filename);

    88

		free((*config)->name);

    89

		free((*config)->info);

    90

    91

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

    92

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

    93

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

    94

			free((*config)->error);

    95

		}

    96

	}

    97

	free(*config);

    98

	*config = NULL;

    99

}

   100

   101

   102

/* Clear a GRF Config list */

   103

void ClearGRFConfigList(GRFConfig **config)

   104

{

   105

	GRFConfig *c, *next;

   106

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

   107

		next = c->next;

   108

		ClearGRFConfig(&c);

   109

	}

   110

	*config = NULL;

   111

}

   112

   113

   114

/** Copy a GRF Config list

   115

 * @param dst pointer to destination list

   116

 * @param src pointer to source list values

   117

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

   118

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

   119

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

   120

{

   121

	/* Clear destination as it will be overwritten */

   122

	ClearGRFConfigList(dst);

   123

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

   124

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

   125

		*c = *src;

   126

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

   127

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

   128

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

   129

		if (src->error     != NULL) {

   130

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

   131

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

   132

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

   133

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

   134

		}

   135

   136

		ClrBit(c->flags, GCF_INIT_ONLY);

   137

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

   138

   139

		*dst = c;

   140

		dst = &c->next;

   141

	}

   142

   143

	return dst;

   144

}

   145

   146

/**

   147

 * Removes duplicates from lists of GRFConfigs. These duplicates

   148

 * are introduced when the _grfconfig_static GRFs are appended

   149

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

   150

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

   151

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

   152

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

   153

 *

   154

 * This function _assumes_ that all static GRFs are placed after

   155

 * the non-static GRFs.

   156

 *

   157

 * @param list the list to remove the duplicates from

   158

 */

   159

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   160

{

   161

	GRFConfig *prev;

   162

	GRFConfig *cur;

   163

   164

	if (list == NULL) return;

   165

   166

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

   167

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

   168

   169

		prev->next = cur->next;

   170

		ClearGRFConfig(&cur);

   171

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

   172

	}

   173

   174

	RemoveDuplicatesFromGRFConfigList(list->next);

   175

}

   176

   177

/**

   178

 * Appends the static GRFs to a list of GRFs

   179

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

   180

 */

   181

void AppendStaticGRFConfigs(GRFConfig **dst)

   182

{

   183

	GRFConfig **tail = dst;

   184

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

   185

   186

	CopyGRFConfigList(tail, _grfconfig_static, false);

   187

	RemoveDuplicatesFromGRFConfigList(*dst);

   188

}

   189

   190

/** Appends an element to a list of GRFs

   191

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

   192

 * @param el the new tail to be */

   193

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

   194

{

   195

	GRFConfig **tail = dst;

   196

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

   197

	*tail = el;

   198

   199

	RemoveDuplicatesFromGRFConfigList(*dst);

   200

}

   201

   202

   203

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

   204

void ResetGRFConfig(bool defaults)

   205

{

   206

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   207

	AppendStaticGRFConfigs(&_grfconfig);

   208

}

   209

   210

   211

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

   212

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

   213

 * <ul>

   214

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

   215

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

   216

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

   217

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

   218

 * </ul> */

   219

GRFListCompatibility IsGoodGRFConfigList()

   220

{

   221

	GRFListCompatibility res = GLC_ALL_GOOD;

   222

   223

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

   224

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

   225

		if (f == NULL) {

   226

			char buf[256];

   227

   228

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

   229

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

   230

			f = FindGRFConfig(c->grfid);

   231

			if (f != NULL) {

   232

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

   233

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

   234

				SetBit(c->flags, GCF_COMPATIBLE);

   235

   236

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

   237

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   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

			c->status = GCS_NOT_FOUND;

   246

			res = GLC_NOT_FOUND;

   247

		} else {

   248

compatible_grf:

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

				free(c->filename);

   257

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

   258

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

   259

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

   260

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

   261

				c->error = NULL;

   262

			}

   263

		}

   264

	}

   265

   266

	return res;

   267

}

   268

   269

static bool ScanPathAddGrf(const char *filename)

   270

{

   271

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

   272

	c->filename = strdup(filename);

   273

   274

	bool added = true;

   275

	if (FillGRFDetails(c, false)) {

   276

		if (_all_grfs == NULL) {

   277

			_all_grfs = c;

   278

		} else {

   279

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

   280

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

   281

			GRFConfig **pd, *d;

   282

			bool stop = false;

   283

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

   284

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

   285

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

   286

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

   287

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

   288

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

   289

					stop = true;

   290

				} else if (stop) {

   291

					break;

   292

				}

   293

			}

   294

			if (added) {

   295

				c->next = d;

   296

				*pd = c;

   297

			}

   298

		}

   299

	} else {

   300

		added = false;

   301

	}

   302

   303

	if (!added) {

   304

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

   305

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

   306

		free(c->filename);

   307

		free(c->name);

   308

		free(c->info);

   309

		free(c);

   310

	}

   311

   312

	return added;

   313

}

   314

   315

/* Scan a path for NewGRFs */

   316

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

   317

{

   318

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

   319

   320

	uint num = 0;

   321

	struct stat sb;

   322

	struct dirent *dirent;

   323

	DIR *dir;

   324

   325

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

   326

   327

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

   328

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

   329

		char filename[MAX_PATH];

   330

   331

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

   332

   333

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

   334

   335

		if (sb.st_mode & S_IFDIR) {

   336

			/* Directory */

   337

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

   338

			AppendPathSeparator(filename, lengthof(filename));

   339

			num += ScanPath(filename, basepath_length);

   340

		} else if (sb.st_mode & S_IFREG) {

   341

			/* File */

   342

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

   343

   344

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

   345

			if (ext == NULL) continue;

   346

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

   347

   348

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

   349

		}

   350

	}

   351

   352

	closedir(dir);

   353

   354

	return num;

   355

}

   356

   357

static uint ScanTar(TarFileList::iterator tar)

   358

{

   359

	uint num = 0;

   360

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

   361

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

   362

   363

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

   364

	if (ext == NULL) return false;

   365

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

   366

   367

	if (ScanPathAddGrf(filename)) num++;

   368

   369

	return num;

   370

}

   371

   372

/**

   373

 * Simple sorter for GRFS

   374

 * @param p1 the first GRFConfig *

   375

 * @param p2 the second GRFConfig *

   376

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

   377

 */

   378

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

   379

{

   380

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

   381

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

   382

   383

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

   384

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

   385

}

   386

   387

/* Scan for all NewGRFs */

   388

void ScanNewGRFFiles()

   389

{

   390

	Searchpath sp;

   391

	char path[MAX_PATH];

   392

	TarFileList::iterator tar;

   393

	uint num = 0;

   394

   395

	ClearGRFConfigList(&_all_grfs);

   396

   397

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

   398

	FOR_ALL_SEARCHPATHS(sp) {

   399

		FioAppendDirectory(path, MAX_PATH, sp, DATA_DIR);

   400

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

   401

	}

   402

	FOR_ALL_TARS(tar) {

   403

		num += ScanTar(tar);

   404

	}

   405

   406

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

   407

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

   408

   409

	/* Sort the linked list using quicksort.

   410

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

   411

	 * then remake the linked list. */

   412

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

   413

	if (to_sort == NULL) return; // No memory, then don't sort

   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

   431

   432

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

   433

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

   434

{

   435

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

   436

		if (c->grfid == grfid) {

   437

			if (md5sum == NULL) return c;

   438

   439

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

   440

		}

   441

	}

   442

   443

	return NULL;

   444

}

   445

   446

#ifdef ENABLE_NETWORK

   447

   448

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

   449

struct UnknownGRF : public GRFIdentifier {

   450

	UnknownGRF *next;

   451

	char   name[NETWORK_GRF_NAME_LENGTH];

   452

};

   453

   454

/**

   455

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

   456

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

   457

 *

   458

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

   459

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

   460

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

   461

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

   462

 *

   463

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

   464

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

   465

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

   466

 *               exist in the fake list of GRFConfigs.

   467

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

   468

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

   469

 *         freed by the caller.

   470

 */

   471

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

   472

{

   473

	UnknownGRF *grf;

   474

	static UnknownGRF *unknown_grfs = NULL;

   475

   476

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

   477

		if (grf->grfid == grfid) {

   478

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

   479

		}

   480

	}

   481

   482

	if (!create) return NULL;

   483

   484

	grf = CallocT<UnknownGRF>(1);

   485

	grf->grfid = grfid;

   486

	grf->next  = unknown_grfs;

   487

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

   488

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

   489

   490

	unknown_grfs = grf;

   491

	return grf->name;

   492

}

   493

   494

#endif /* ENABLE_NETWORK */