1

/* $Id$ */

     2

     3

/** @file newgrf_config.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "debug.h"

    10

#include "variables.h"

    11

#include "string.h"

    12

#include "saveload.h"

    13

#include "md5.h"

    14

#include "network/network_data.h"

    15

#include "newgrf.h"

    16

#include "newgrf_config.h"

    17

#include "helpers.hpp"

    18

    19

#include "fileio.h"

    20

#include "fios.h"

    21

#include <sys/stat.h>

    22

    23

#ifdef WIN32

    24

# include <io.h>

    25

#endif /* WIN32 */

    26

    27

    28

GRFConfig *_all_grfs;

    29

GRFConfig *_grfconfig;

    30

GRFConfig *_grfconfig_newgame;

    31

GRFConfig *_grfconfig_static;

    32

    33

    34

/* Calculate the MD5 Sum for a GRF */

    35

static bool CalcGRFMD5Sum(GRFConfig *config)

    36

{

    37

	FILE *f;

    38

	md5_state_t md5state;

    39

	md5_byte_t buffer[1024];

    40

	size_t len;

    41

    42

	/* open the file */

    43

	f = fopen(config->full_path, "rb");

    44

	if (f == NULL) return false;

    45

    46

	/* calculate md5sum */

    47

	md5_init(&md5state);

    48

	while ((len = fread(buffer, 1, sizeof(buffer), f)) != 0) {

    49

		md5_append(&md5state, buffer, len);

    50

	}

    51

	md5_finish(&md5state, config->md5sum);

    52

    53

	fclose(f);

    54

    55

	return true;

    56

}

    57

    58

    59

/* Find the GRFID and calculate the md5sum */

    60

bool FillGRFDetails(GRFConfig *config, bool is_static)

    61

{

    62

	if (!FileExists(config->full_path)) {

    63

		config->status = GCS_NOT_FOUND;

    64

		return false;

    65

	}

    66

    67

	if (config->filename == NULL) {

    68

		config->filename = strdup(strrchr(config->full_path, PATHSEPCHAR) + 1);

    69

	}

    70

    71

	/* Find and load the Action 8 information */

    72

	/* 62 is the last file slot before sample.cat.

    73

	 * Should perhaps be some "don't care" value */

    74

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    75

    76

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

    77

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

    78

    79

	if (is_static) {

    80

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

    81

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    82

    83

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

    84

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

    85

	}

    86

    87

	return CalcGRFMD5Sum(config);

    88

}

    89

    90

    91

void ClearGRFConfig(GRFConfig **config)

    92

{

    93

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

    94

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

    95

		free((*config)->filename);

    96

		free((*config)->full_path);

    97

		free((*config)->name);

    98

		free((*config)->info);

    99

		free((*config)->error);

   100

	}

   101

	free(*config);

   102

	*config = NULL;

   103

}

   104

   105

   106

/* Clear a GRF Config list */

   107

void ClearGRFConfigList(GRFConfig **config)

   108

{

   109

	GRFConfig *c, *next;

   110

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

   111

		next = c->next;

   112

		ClearGRFConfig(&c);

   113

	}

   114

	*config = NULL;

   115

}

   116

   117

   118

/** Copy a GRF Config list

   119

 * @param dst pointer to destination list

   120

 * @param src pointer to source list values

   121

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

   122

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

   123

{

   124

	/* Clear destination as it will be overwritten */

   125

	ClearGRFConfigList(dst);

   126

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

   127

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

   128

		*c = *src;

   129

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

   130

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

   131

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

   132

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

   133

		if (src->error     != NULL) {

   134

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

   135

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

   136

		}

   137

   138

		*dst = c;

   139

		dst = &c->next;

   140

	}

   141

   142

	return dst;

   143

}

   144

   145

/**

   146

 * Removes duplicates from lists of GRFConfigs. These duplicates

   147

 * are introduced when the _grfconfig_static GRFs are appended

   148

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

   149

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

   150

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

   151

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

   152

 *

   153

 * This function _assumes_ that all static GRFs are placed after

   154

 * the non-static GRFs.

   155

 *

   156

 * @param list the list to remove the duplicates from

   157

 */

   158

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   159

{

   160

	GRFConfig *prev;

   161

	GRFConfig *cur;

   162

   163

	if (list == NULL) return;

   164

   165

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

   166

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

   167

   168

		prev->next = cur->next;

   169

		ClearGRFConfig(&cur);

   170

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

   171

	}

   172

   173

	RemoveDuplicatesFromGRFConfigList(list->next);

   174

}

   175

   176

/**

   177

 * Appends the static GRFs to a list of GRFs

   178

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

   179

 */

   180

void AppendStaticGRFConfigs(GRFConfig **dst)

   181

{

   182

	GRFConfig **tail = dst;

   183

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

   184

   185

	CopyGRFConfigList(tail, _grfconfig_static);

   186

	RemoveDuplicatesFromGRFConfigList(*dst);

   187

}

   188

   189

/** Appends an element to a list of GRFs

   192

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

   193

{

   194

	GRFConfig **tail = dst;

   195

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

   196

	*tail = el;

   197

   198

	RemoveDuplicatesFromGRFConfigList(*dst);

   199

}

   200

   201

   202

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

   203

void ResetGRFConfig(bool defaults)

   204

{

   205

	GRFConfig **c = &_grfconfig;

   206

   207

	if (defaults) {

   208

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   209

	} else {

   210

		ClearGRFConfigList(c);

   211

	}

   212

   213

	AppendStaticGRFConfigs(&_grfconfig);

   214

}

   215

   216

   217

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

   218

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

   219

 * <ul>

   220

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

   221

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

   222

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

   223

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

   224

 * </ul> */

   225

GRFListCompatibility IsGoodGRFConfigList()

   226

{

   227

	GRFListCompatibility res = GLC_ALL_GOOD;

   228

   229

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

   230

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

   231

		if (f == NULL) {

   232

			char buf[256];

   233

   234

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

   235

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

   236

			f = FindGRFConfig(c->grfid);

   237

			if (f != NULL) {

   238

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

   239

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

   240

				SETBIT(c->flags, GCF_COMPATIBLE);

   241

   242

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

   243

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   244

				goto compatible_grf;

   245

			}

   246

   247

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

   248

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

   249

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

   250

   251

			c->status = GCS_NOT_FOUND;

   252

			res = GLC_NOT_FOUND;

   253

		} else {

   254

compatible_grf:

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

				free(c->filename);

   263

				free(c->full_path);

   264

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

   265

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

   266

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

   267

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

   268

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

   269

				c->error = NULL;

   270

			}

   271

		}

   272

	}

   273

   274

	return res;

   275

}

   276

   277

   278

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

   279

   280

/* Scan a path for NewGRFs */

   281

static uint ScanPath(const char *path)

   282

{

   283

	uint num = 0;

   284

	struct stat sb;

   285

	struct dirent *dirent;

   286

	DIR *dir;

   287

   288

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

   289

   290

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

   291

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

   292

		char filename[MAX_PATH];

   293

   294

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

   295

   296

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

   297

   298

		if (sb.st_mode & S_IFDIR) {

   299

			/* Directory */

   300

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

   301

			AppendPathSeparator(filename, lengthof(filename));

   302

			num += ScanPath(filename);

   303

		} else if (sb.st_mode & S_IFREG) {

   304

			/* File */

   305

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

   306

   307

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

   308

			if (ext == NULL) continue;

   309

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

   310

   311

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

   312

			c->full_path = strdup(filename);

   313

   314

			bool added = true;

   315

			if (FillGRFDetails(c, false)) {

   316

				if (_all_grfs == NULL) {

   317

					_all_grfs = c;

   318

				} else {

   319

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

   320

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

   321

					GRFConfig **pd, *d;

   322

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

   323

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

   324

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

   325

					}

   326

					if (added) {

   327

						c->next = d;

   328

						*pd = c;

   329

					}

   330

				}

   331

			} else {

   332

				added = false;

   333

			}

   334

   335

			if (!added) {

   336

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

   337

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

   338

				free(c->filename);

   339

				free(c->full_path);

   340

				free(c->name);

   341

				free(c->info);

   342

				free(c);

   343

			} else {

   344

				num++;

   345

			}

   346

		}

   347

	}

   348

   349

	closedir(dir);

   350

   351

	return num;

   352

}

   353

   354

   355

/* Scan for all NewGRFs */

   356

void ScanNewGRFFiles()

   357

{

   358

	uint num;

   359

   360

	ClearGRFConfigList(&_all_grfs);

   361

   362

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

   363

	num  = ScanPath(_paths.data_dir);

   364

	num += ScanPath(_paths.second_data_dir);

   365

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

   366

}

   367

   368

   369

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

   370

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

   371

{

   372

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

   373

		if (c->grfid == grfid) {

   374

			if (md5sum == NULL) return c;

   375

   376

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

   377

		}

   378

	}

   379

   380

	return NULL;

   381

}

   382

   383

#ifdef ENABLE_NETWORK

   384

   385

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

   386

struct UnknownGRF : public GRFIdentifier {

   387

	UnknownGRF *next;

   388

	char   name[NETWORK_GRF_NAME_LENGTH];

   389

};

   390

   391

/**

   392

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

   393

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

   394

 *

   395

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

   396

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

   397

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

   398

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

   399

 *

   400

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

   401

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

   402

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

   403

 *               exist in the fake list of GRFConfigs.

   404

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

   405

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

   406

 *         freed by the caller.

   407

 */

   408

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

   409

{

   410

	UnknownGRF *grf;

   411

	static UnknownGRF *unknown_grfs = NULL;

   412

   413

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

   414

		if (grf->grfid == grfid) {

   415

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

   416

		}

   417

	}

   418

   419

	if (!create) return NULL;

   420

   421

	grf = CallocT<UnknownGRF>(1);

   422

	grf->grfid = grfid;

   423

	grf->next  = unknown_grfs;

   424

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

   425

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

   426

   427

	unknown_grfs = grf;

   428

	return grf->name;

   429

}

   430

   431

#endif /* ENABLE_NETWORK */

   432

   433

   434

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

   435

GRFConfig *GetGRFConfig(uint32 grfid)

   436

{

   437

	GRFConfig *c;

   438

   439

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

   440

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

   441

	}

   442

   443

	return NULL;

   444

}

   445

   446

   447

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

   448

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

   449

{

   450

	uint i;

   451

   452

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

   453

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

   454

   455

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

   456

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

   457

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

   458

	}

   459

	return dst;

   460

}

   461

   462

   463

static const SaveLoad _grfconfig_desc[] = {

   464

	SLE_STR(GRFConfig, filename,   SLE_STR, 0x40),

   465

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   466

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   467

	SLE_ARR(GRFConfig, param,      SLE_UINT32, 0x80),

   468

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   469

	SLE_END()

   470

};

   471

   472

   473

static void Save_NGRF()

   474

{

   475

	int index = 0;

   476

   477

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

   478

		if (HASBIT(c->flags, GCF_STATIC)) continue;

   479

		SlSetArrayIndex(index++);

   480

		SlObject(c, _grfconfig_desc);

   481

	}

   482

}

   483

   484

   485

static void Load_NGRF()

   486

{

   487

	ClearGRFConfigList(&_grfconfig);

   488

	while (SlIterateArray() != -1) {

   489

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

   490

		SlObject(c, _grfconfig_desc);

   491

		AppendToGRFConfigList(&_grfconfig, c);

   492

	}

   493

   494

	/* Append static NewGRF configuration */

   495

	AppendStaticGRFConfigs(&_grfconfig);

   496

}

   497

   498

extern const ChunkHandler _newgrf_chunk_handlers[] = {

   499

	{ 'NGRF', Save_NGRF, Load_NGRF, CH_ARRAY | CH_LAST }