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

/* Adds a GRF from the global _all_grfs list to the list for the current game.

   114

 * Useful for adding compulsory grfs to older games.

   115

 */

   116

void AddGRFTToGameListByGRFid(uint32 grfid)

   117

{

   118

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

   119

		if (c->grfid == grfid) {

   120

			/* The required GRF is already in the list; for it to be loaded properly */

   121

			ClrBit(c->flags, GCF_INIT_ONLY);

   122

			return;

   123

		}

   124

	}

   125

   126

	/* Copy GRF details from scanned list */

   127

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

   128

	const GRFConfig *src = FindGRFConfig(grfid, NULL);

   129

	*c = *src;

   130

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

   131

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

   132

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

   133

	c->next = NULL;

   134

   135

	AppendToGRFConfigList(&_grfconfig, c);

   136

}

   137

   138

/** Copy a GRF Config list

   139

 * @param dst pointer to destination list

   140

 * @param src pointer to source list values

   141

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

   142

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

   143

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

   144

{

   145

	/* Clear destination as it will be overwritten */

   146

	ClearGRFConfigList(dst);

   147

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

   148

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

   149

		*c = *src;

   150

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

   151

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

   152

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

   153

		if (src->error     != NULL) {

   154

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

   155

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

   156

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

   157

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

   158

		}

   159

   160

		ClrBit(c->flags, GCF_INIT_ONLY);

   161

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

   162

   163

		*dst = c;

   164

		dst = &c->next;

   165

	}

   166

   167

	return dst;

   168

}

   169

   170

/**

   171

 * Removes duplicates from lists of GRFConfigs. These duplicates

   172

 * are introduced when the _grfconfig_static GRFs are appended

   173

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

   174

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

   175

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

   176

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

   177

 *

   178

 * This function _assumes_ that all static GRFs are placed after

   179

 * the non-static GRFs.

   180

 *

   181

 * @param list the list to remove the duplicates from

   182

 */

   183

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   184

{

   185

	GRFConfig *prev;

   186

	GRFConfig *cur;

   187

   188

	if (list == NULL) return;

   189

   190

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

   191

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

   192

   193

		prev->next = cur->next;

   194

		ClearGRFConfig(&cur);

   195

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

   196

	}

   197

   198

	RemoveDuplicatesFromGRFConfigList(list->next);

   199

}

   200

   201

/**

   202

 * Appends the static GRFs to a list of GRFs

   203

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

   204

 */

   205

void AppendStaticGRFConfigs(GRFConfig **dst)

   206

{

   207

	GRFConfig **tail = dst;

   208

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

   209

   210

	CopyGRFConfigList(tail, _grfconfig_static, false);

   211

	RemoveDuplicatesFromGRFConfigList(*dst);

   212

}

   213

   214

/** Appends an element to a list of GRFs

   215

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

   216

 * @param el the new tail to be */

   217

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

   218

{

   219

	GRFConfig **tail = dst;

   220

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

   221

	*tail = el;

   222

   223

	RemoveDuplicatesFromGRFConfigList(*dst);

   224

}

   225

   226

   227

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

   228

void ResetGRFConfig(bool defaults)

   229

{

   230

	CopyGRFConfigList(&_grfconfig, _grfconfig_newgame, !defaults);

   231

	AddGRFTToGameListByGRFid(0x4450414F); // OAPD - airportsbasic.grf

   232

	AddGRFTToGameListByGRFid(0x5850414F); // OAPX - airportsextended.grf

   233

	AppendStaticGRFConfigs(&_grfconfig);

   234

}

   235

   236

   237

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

   238

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

   239

 * <ul>

   240

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

   241

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

   242

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

   243

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

   244

 * </ul> */

   245

GRFListCompatibility IsGoodGRFConfigList()

   246

{

   247

	GRFListCompatibility res = GLC_ALL_GOOD;

   248

   249

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

   250

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

   251

		if (f == NULL) {

   252

			char buf[256];

   253

   254

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

   255

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

   256

			f = FindGRFConfig(c->grfid);

   257

			if (f != NULL) {

   258

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

   259

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

   260

				SetBit(c->flags, GCF_COMPATIBLE);

   261

   262

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

   263

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   264

				goto compatible_grf;

   265

			}

   266

   267

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

   268

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

   269

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

   270

   271

			c->status = GCS_NOT_FOUND;

   272

			res = GLC_NOT_FOUND;

   273

		} else {

   274

compatible_grf:

   275

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

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

				free(c->filename);

   283

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

   284

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

   285

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

   286

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

   287

				c->error = NULL;

   288

			}

   289

		}

   290

	}

   291

   292

	return res;

   293

}

   294

   295

static bool ScanPathAddGrf(const char *filename)

   296

{

   297

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

   298

	c->filename = strdup(filename);

   299

   300

	bool added = true;

   301

	if (FillGRFDetails(c, false)) {

   302

		if (_all_grfs == NULL) {

   303

			_all_grfs = c;

   304

		} else {

   305

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

   306

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

   307

			GRFConfig **pd, *d;

   308

			bool stop = false;

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

					stop = true;

   316

				} else if (stop) {

   317

					break;

   318

				}

   319

			}

   320

			if (added) {

   321

				c->next = d;

   322

				*pd = c;

   323

			}

   324

		}

   325

	} else {

   326

		added = false;

   327

	}

   328

   329

	if (!added) {

   330

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

   331

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

   332

		free(c->filename);

   333

		free(c->name);

   334

		free(c->info);

   335

		free(c);

   336

	}

   337

   338

	return added;

   339

}

   340

   341

/* Scan a path for NewGRFs */

   342

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

   343

{

   344

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

   345

   346

	uint num = 0;

   347

	struct stat sb;

   348

	struct dirent *dirent;

   349

	DIR *dir;

   350

   351

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

   352

   353

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

   354

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

   355

		char filename[MAX_PATH];

   356

   357

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

   358

   359

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

   360

   361

		if (sb.st_mode & S_IFDIR) {

   362

			/* Directory */

   363

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

   364

			AppendPathSeparator(filename, lengthof(filename));

   365

			num += ScanPath(filename, basepath_length);

   366

		} else if (sb.st_mode & S_IFREG) {

   367

			/* File */

   368

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

   369

   370

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

   371

			if (ext == NULL) continue;

   372

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

   373

   374

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

   375

		}

   376

	}

   377

   378

	closedir(dir);

   379

   380

	return num;

   381

}

   382

   383

static uint ScanTar(TarFileList::iterator tar)

   384

{

   385

	uint num = 0;

   386

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

   387

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

   388

   389

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

   390

	if (ext == NULL) return false;

   391

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

   392

   393

	if (ScanPathAddGrf(filename)) num++;

   394

   395

	return num;

   396

}

   397

   398

/**

   399

 * Simple sorter for GRFS

   400

 * @param p1 the first GRFConfig *

   401

 * @param p2 the second GRFConfig *

   402

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

   403

 */

   404

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

   405

{

   406

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

   407

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

   408

   409

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

   410

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

   411

}

   412

   413

/* Scan for all NewGRFs */

   414

void ScanNewGRFFiles()

   415

{

   416

	Searchpath sp;

   417

	char path[MAX_PATH];

   418

	TarFileList::iterator tar;

   419

	uint num = 0;

   420

   421

	ClearGRFConfigList(&_all_grfs);

   422

   423

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

   424

	FOR_ALL_SEARCHPATHS(sp) {

   425

		FioAppendDirectory(path, MAX_PATH, sp, DATA_DIR);

   426

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

   427

	}

   428

	FOR_ALL_TARS(tar) {

   429

		num += ScanTar(tar);

   430

	}

   431

   432

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

   433

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

   434

   435

	/* Sort the linked list using quicksort.

   436

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

   437

	 * then remake the linked list. */

   438

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

   439

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

   440

   441

	uint i = 0;

   442

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

   443

		to_sort[i] = p;

   444

	}

   445

	/* Number of files is not necessarily right */

   446

	num = i;

   447

   448

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

   449

   450

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

   451

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

   452

	}

   453

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

   454

	_all_grfs = to_sort[0];

   455

}

   456

   457

   458

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

   459

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

   460

{

   461

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

   462

		if (c->grfid == grfid) {

   463

			if (md5sum == NULL) return c;

   464

   465

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

   466

		}

   467

	}

   468

   469

	return NULL;

   470

}

   471

   472

#ifdef ENABLE_NETWORK

   473

   474

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

   475

struct UnknownGRF : public GRFIdentifier {

   476

	UnknownGRF *next;

   477

	char   name[NETWORK_GRF_NAME_LENGTH];

   478

};

   479

   480

/**

   481

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

   482

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

   483

 *

   484

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

   485

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

   486

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

   487

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

   488

 *

   489

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

   490

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

   491

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

   492

 *               exist in the fake list of GRFConfigs.

   493

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

   494

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