1

/* $Id$ */

     2

     3

/** @file newgfr_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

	char filename[MAX_PATH];

    39

	md5_state_t md5state;

    40

	md5_byte_t buffer[1024];

    41

	size_t len;

    42

    43

	/* open the file */

    44

	snprintf(filename, lengthof(filename), "%s%s", _paths.data_dir, config->filename);

    45

	f = fopen(filename, "rb");

    46

	if (f == NULL) return false;

    47

    48

	/* calculate md5sum */

    49

	md5_init(&md5state);

    50

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

    51

		md5_append(&md5state, buffer, len);

    52

	}

    53

	md5_finish(&md5state, config->md5sum);

    54

    55

	fclose(f);

    56

    57

	return true;

    58

}

    59

    60

    61

/* Find the GRFID and calculate the md5sum */

    62

bool FillGRFDetails(GRFConfig *config, bool is_static)

    63

{

    64

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

    65

		config->status = GCS_NOT_FOUND;

    66

		return false;

    67

	}

    68

    69

	/* Find and load the Action 8 information */

    70

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

    71

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

    72

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    73

    74

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

    75

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

    76

    77

	if (is_static) {

    78

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

    79

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    80

    81

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

    82

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

    83

	}

    84

    85

	return CalcGRFMD5Sum(config);

    86

}

    87

    88

    89

void ClearGRFConfig(GRFConfig **config)

    90

{

    91

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

    92

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

    93

		free((*config)->filename);

    94

		free((*config)->name);

    95

		free((*config)->info);

    96

		free((*config)->error);

    97

	}

    98

	free(*config);

    99

	*config = NULL;

   100

}

   101

   102

   103

/* Clear a GRF Config list */

   104

void ClearGRFConfigList(GRFConfig **config)

   105

{

   106

	GRFConfig *c, *next;

   107

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

   108

		next = c->next;

   109

		ClearGRFConfig(&c);

   110

	}

   111

	*config = NULL;

   112

}

   113

   114

   115

/** Copy a GRF Config list

   116

 * @param dst pointer to destination list

   117

 * @param src pointer to source list values

   118

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

   119

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

   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

		}

   133

   134

		*dst = c;

   135

		dst = &c->next;

   136

	}

   137

   138

	return dst;

   139

}

   140

   141

/**

   142

 * Removes duplicates from lists of GRFConfigs. These duplicates

   143

 * are introduced when the _grfconfig_static GRFs are appended

   144

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

   145

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

   146

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

   147

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

   148

 *

   149

 * This function _assumes_ that all static GRFs are placed after

   150

 * the non-static GRFs.

   151

 *

   152

 * @param list the list to remove the duplicates from

   153

 */

   154

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   155

{

   156

	GRFConfig *prev;

   157

	GRFConfig *cur;

   158

   159

	if (list == NULL) return;

   160

   161

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

   162

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

   163

   164

		prev->next = cur->next;

   165

		ClearGRFConfig(&cur);

   166

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

   167

	}

   168

   169

	RemoveDuplicatesFromGRFConfigList(list->next);

   170

}

   171

   172

/**

   173

 * Appends the static GRFs to a list of GRFs

   174

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

   175

 */

   176

void AppendStaticGRFConfigs(GRFConfig **dst)

   177

{

   178

	GRFConfig **tail = dst;

   179

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

   180

   181

	CopyGRFConfigList(tail, _grfconfig_static);

   182

	RemoveDuplicatesFromGRFConfigList(*dst);

   183

}

   184

   185

/** Appends an element to a list of GRFs

   186

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

   187

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

   188

{

   189

	GRFConfig **tail = dst;

   190

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

   191

	*tail = el;

   192

   193

	RemoveDuplicatesFromGRFConfigList(*dst);

   194

}

   195

   196

   197

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

   198

void ResetGRFConfig(bool defaults)

   199

{

   200

	GRFConfig **c = &_grfconfig;

   201

   202

	if (defaults) {

   203

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   204

	} else {

   205

		ClearGRFConfigList(c);

   206

	}

   207

   208

	AppendStaticGRFConfigs(&_grfconfig);

   209

}

   210

   211

   212

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

   213

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

   214

 * <ul>

   215

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

   216

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

   217

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

   218

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

   219

 * </ul> */

   220

GRFListCompatibility IsGoodGRFConfigList()

   221

{

   222

	GRFListCompatibility res = GLC_ALL_GOOD;

   223

   224

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

   225

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

   226

		if (f == NULL) {

   227

			char buf[256];

   228

   229

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

   230

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

   231

			f = FindGRFConfig(c->grfid);

   232

			if (f != NULL) {

   233

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

   234

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

   235

				SETBIT(c->flags, GCF_COMPATIBLE);

   236

   237

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

   238

				if (res != GLC_NOT_FOUND) res = GLC_COMPATIBLE;

   239

				goto compatible_grf;

   240

			}

   241

   242

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

   243

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

   244

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

   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

   271

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

   272

   273

/* Scan a path for NewGRFs */

   274

static uint ScanPath(const char *path)

   275

{

   276

	uint num = 0;

   277

	struct stat sb;

   278

	struct dirent *dirent;

   279

	DIR *dir;

   280

   281

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

   282

   283

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

   284

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

   285

		char filename[MAX_PATH];

   286

   287

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

   288

   289

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

   290

   291

		if (sb.st_mode & S_IFDIR) {

   292

			/* Directory */

   293

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

   294

			num += ScanPath(filename);

   295

		} else if (sb.st_mode & S_IFREG) {

   296

			/* File */

   297

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

   298

			char *file = filename + strlen(_paths.data_dir) + 1; // Crop base path

   299

   300

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

   301

			if (ext == NULL) continue;

   302

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

   303

   304

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

   305

			c->filename = strdup(file);

   306

   307

			if (FillGRFDetails(c, false)) {

   308

				if (_all_grfs == NULL) {

   309

					_all_grfs = c;

   310

				} else {

   311

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

   312

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

   313

					GRFConfig **pd, *d;

   314

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

   315

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

   316

					}

   317

					c->next = d;

   318

					*pd = c;

   319

				}

   320

   321

				num++;

   322

			} else {

   323

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

   324

				 * 'system' NewGRF, so forget about it. */

   325

				free(c->filename);

   326

				free(c->name);

   327

				free(c->info);

   328

				free(c);

   329

			}

   330

		}

   331

	}

   332

   333

	closedir(dir);

   334

   335

	return num;

   336

}

   337

   338

   339

/* Scan for all NewGRFs */

   340

void ScanNewGRFFiles()

   341

{

   342

	uint num;

   343

   344

	ClearGRFConfigList(&_all_grfs);

   345

   346

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

   347

	num = ScanPath(_paths.data_dir);

   348

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

   349

}

   350

   351

   352

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

   353

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

   354

{

   355

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

   356

		if (c->grfid == grfid) {

   357

			if (md5sum == NULL) return c;

   358

   359

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

   360

		}

   361

	}

   362

   363

	return NULL;

   364

}

   365

   366

#ifdef ENABLE_NETWORK

   367

   368

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

   369

struct UnknownGRF : public GRFIdentifier {

   370

	UnknownGRF *next;

   371

	char   name[NETWORK_GRF_NAME_LENGTH];

   372

};

   373

   374

/**

   375

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

   376

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

   377

 *

   378

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

   379

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

   380

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

   381

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

   382

 *

   383

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

   384

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

   385

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

   386

 *               exist in the fake list of GRFConfigs.

   387

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

   388

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

   389

 *         freed by the caller.

   390

 */

   391

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

   392

{

   393

	UnknownGRF *grf;

   394

	static UnknownGRF *unknown_grfs = NULL;

   395

   396

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

   397

		if (grf->grfid == grfid) {

   398

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

   399

		}

   400

	}

   401

   402

	if (!create) return NULL;

   403

   404

	grf = CallocT<UnknownGRF>(1);

   405

	grf->grfid = grfid;

   406

	grf->next  = unknown_grfs;

   407

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

   408

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

   409

   410

	unknown_grfs = grf;

   411

	return grf->name;

   412

}

   413

   414

#endif /* ENABLE_NETWORK */

   415

   416

   417

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

   418

GRFConfig *GetGRFConfig(uint32 grfid)

   419

{

   420

	GRFConfig *c;

   421

   422

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

   423

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

   424

	}

   425

   426

	return NULL;

   427

}

   428

   429

   430

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

   431

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

   432

{

   433

	uint i;

   434

   435

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

   436

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

   437

   438

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

   439

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

   440

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

   441

	}

   442

	return dst;

   443

}

   444

   445

   446

static const SaveLoad _grfconfig_desc[] = {

   447

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

   448

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   449

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   450

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

   451

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   452

	SLE_END()

   453

};

   454

   455

   456

static void Save_NGRF()

   457

{

   458

	int index = 0;

   459

   460

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

   461

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

   462

		SlSetArrayIndex(index++);

   463

		SlObject(c, _grfconfig_desc);

   464

	}

   465

}

   466

   467

   468

static void Load_NGRF()

   469

{

   470

	ClearGRFConfigList(&_grfconfig);

   471

	while (SlIterateArray() != -1) {

   472

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

   473

		SlObject(c, _grfconfig_desc);

   474

		AppendToGRFConfigList(&_grfconfig, c);

   475

	}

   476

   477

	/* Append static NewGRF configuration */

   478

	AppendStaticGRFConfigs(&_grfconfig);

   479

}

   480

   481

extern const ChunkHandler _newgrf_chunk_handlers[] = {

   482

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

   483

};

   484

   485

   486