1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "macros.h"

     7

#include "debug.h"

     8

#include "variables.h"

     9

#include "string.h"

    10

#include "saveload.h"

    11

#include "md5.h"

    12

#include "network/network_data.h"

    13

#include "newgrf.h"

    14

#include "newgrf_config.h"

    15

#include "helpers.hpp"

    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

	char filename[MAX_PATH];

    37

	md5_state_t md5state;

    38

	md5_byte_t buffer[1024];

    39

	size_t len;

    40

    41

	/* open the file */

    42

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

    43

	f = fopen(filename, "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 (!FioCheckFileExists(config->filename)) {

    63

		SETBIT(config->flags, GCF_NOT_FOUND);

    64

		return false;

    65

	}

    66

    67

	/* Find and load the Action 8 information */

    68

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

    69

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

    70

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    71

    72

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

    73

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

    74

    75

	if (is_static) {

    76

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

    77

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    78

    79

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

    80

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

    81

	}

    82

    83

	return CalcGRFMD5Sum(config);

    84

}

    85

    86

    87

void ClearGRFConfig(GRFConfig **config)

    88

{

    89

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

    90

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

    91

		free((*config)->filename);

    92

		free((*config)->name);

    93

		free((*config)->info);

    94

		free((*config)->error);

    95

	}

    96

	free(*config);

    97

	*config = NULL;

    98

}

    99

   100

   101

/* Clear a GRF Config list */

   102

void ClearGRFConfigList(GRFConfig **config)

   103

{

   104

	GRFConfig *c, *next;

   105

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

   106

		next = c->next;

   107

		ClearGRFConfig(&c);

   108

	}

   109

	*config = NULL;

   110

}

   111

   112

   113

/** Copy a GRF Config list

   114

 * @param dst pointer to destination list

   115

 * @param src pointer to source list values

   116

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

   117

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

   118

{

   119

	/* Clear destination as it will be overwritten */

   120

	ClearGRFConfigList(dst);

   121

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

   122

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

   123

		*c = *src;

   124

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

   125

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

   126

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

   127

		if (src->error    != NULL) {

   128

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

   129

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

   130

		}

   131

   132

		*dst = c;

   133

		dst = &c->next;

   134

	}

   135

   136

	return dst;

   137

}

   138

   139

/**

   140

 * Removes duplicates from lists of GRFConfigs. These duplicates

   141

 * are introduced when the _grfconfig_static GRFs are appended

   142

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

   143

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

   144

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

   145

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

   146

 *

   147

 * This function _assumes_ that all static GRFs are placed after

   148

 * the non-static GRFs.

   149

 *

   150

 * @param list the list to remove the duplicates from

   151

 */

   152

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   153

{

   154

	GRFConfig *prev;

   155

	GRFConfig *cur;

   156

   157

	if (list == NULL) return;

   158

   159

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

   160

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

   161

   162

		prev->next = cur->next;

   163

		ClearGRFConfig(&cur);

   164

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

   165

	}

   166

   167

	RemoveDuplicatesFromGRFConfigList(list->next);

   168

}

   169

   170

/**

   171

 * Appends the static GRFs to a list of GRFs

   172

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

   173

 */

   174

void AppendStaticGRFConfigs(GRFConfig **dst)

   175

{

   176

	GRFConfig **tail = dst;

   177

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

   178

   179

	CopyGRFConfigList(tail, _grfconfig_static);

   180

	RemoveDuplicatesFromGRFConfigList(*dst);

   181

}

   182

   183

/** Appends an element to a list of GRFs

   184

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

   185

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

   186

{

   187

	GRFConfig **tail = dst;

   188

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

   189

	*tail = el;

   190

   191

	RemoveDuplicatesFromGRFConfigList(*dst);

   192

}

   193

   194

   195

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

   196

void ResetGRFConfig(bool defaults)

   197

{

   198

	GRFConfig **c = &_grfconfig;

   199

   200

	if (defaults) {

   201

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   202

	} else {

   203

		ClearGRFConfigList(c);

   204

	}

   205

   206

	AppendStaticGRFConfigs(&_grfconfig);

   207

}

   208

   209

   210

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

   211

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

   212

 * <ul>

   213

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

   214

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

   215

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

   216

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

   217

 * </ul> */

   218

GCF_Flags IsGoodGRFConfigList(void)

   219

{

   220

	GCF_Flags res = GCF_ACTIVATED;

   221

   222

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

   223

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

   224

		if (f == NULL) {

   225

			char buf[256];

   226

   227

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

   228

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

   229

			f = FindGRFConfig(c->grfid);

   230

			if (f != NULL) {

   231

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

   232

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

   233

				SETBIT(c->flags, GCF_COMPATIBLE);

   234

   235

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

   236

				if (res != GCF_NOT_FOUND) res = GCF_COMPATIBLE;

   237

				goto compatible_grf;

   238

			}

   239

   240

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

   241

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

   242

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

   243

   244

			SETBIT(c->flags, GCF_NOT_FOUND);

   245

			res = GCF_NOT_FOUND;

   246

		} else {

   247

compatible_grf:

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

				free(c->filename);

   256

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

   257

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

   260

				c->error = NULL;

   261

			}

   262

		}

   263

	}

   264

   265

	return res;

   266

}

   267

   268

   269

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

   270

   271

/* Scan a path for NewGRFs */

   272

static uint ScanPath(const char *path)

   273

{

   274

	uint num = 0;

   275

	struct stat sb;

   276

	struct dirent *dirent;

   277

	DIR *dir;

   278

   279

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

   280

   281

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

   282

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

   283

		char filename[MAX_PATH];

   284

   285

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

   286

   287

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

   288

   289

		if (sb.st_mode & S_IFDIR) {

   290

			/* Directory */

   291

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

   292

			num += ScanPath(filename);

   293

		} else if (sb.st_mode & S_IFREG) {

   294

			/* File */

   295

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

   296

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

   297

   298

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

   299

			if (ext == NULL) continue;

   300

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

   301

   302

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

   303

			c->filename = strdup(file);

   304

   305

			if (FillGRFDetails(c, false)) {

   306

				if (_all_grfs == NULL) {

   307

					_all_grfs = c;

   308

				} else {

   309

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

   310

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

   311

					GRFConfig **pd, *d;

   312

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

   313

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

   314

					}

   315

					c->next = d;

   316

					*pd = c;

   317

				}

   318

   319

				num++;

   320

			} else {

   321

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

   322

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

   323

				free(c->filename);

   324

				free(c->name);

   325

				free(c->info);

   326

				free(c);

   327

			}

   328

		}

   329

	}

   330

   331

	closedir(dir);

   332

   333

	return num;

   334

}

   335

   336

   337

/* Scan for all NewGRFs */

   338

void ScanNewGRFFiles(void)

   339

{

   340

	uint num;

   341

   342

	ClearGRFConfigList(&_all_grfs);

   343

   344

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

   345

	num = ScanPath(_paths.data_dir);

   346

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

   347

}

   348

   349

   350

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

   351

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

   352

{

   353

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

   354

		if (c->grfid == grfid) {

   355

			if (md5sum == NULL) return c;

   356

   357

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

   358

		}

   359

	}

   360

   361

	return NULL;

   362

}

   363

   364

#ifdef ENABLE_NETWORK

   365

   366

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

   367

typedef struct UnknownGRF UnknownGRF;

   368

struct UnknownGRF : public GRFIdentifier {

   369

	UnknownGRF *next;

   370

	char   name[NETWORK_GRF_NAME_LENGTH];

   371

};

   372

   373

/**

   374

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

   375

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

   376

 *

   377

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

   378

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

   379

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

   380

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

   381

 *

   382

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

   383

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

   384

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

   385

 *               exist in the fake list of GRFConfigs.

   386

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

   387

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

   388

 *         freed by the caller.

   389

 */

   390

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

   391

{

   392

	UnknownGRF *grf;

   393

	static UnknownGRF *unknown_grfs = NULL;

   394

   395

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

   396

		if (grf->grfid == grfid) {

   397

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

   398

		}

   399

	}

   400

   401

	if (!create) return NULL;

   402

   403

	grf = CallocT<UnknownGRF>(1);

   404

	grf->grfid = grfid;

   405

	grf->next  = unknown_grfs;

   406

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

   407

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

   408

   409

	unknown_grfs = grf;

   410

	return grf->name;

   411

}

   412

   413

#endif /* ENABLE_NETWORK */

   414

   415

   416

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

   417

GRFConfig *GetGRFConfig(uint32 grfid)

   418

{

   419

	GRFConfig *c;

   420

   421

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

   422

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

   423

	}

   424

   425

	return NULL;

   426

}

   427

   428

   429

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

   430

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

   431

{

   432

	uint i;

   433

   434

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

   435

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

   436

   437

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

   438

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

   439

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

   440

	}

   441

	return dst;

   442

}

   443

   444

   445

static const SaveLoad _grfconfig_desc[] = {

   446

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

   447

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   448

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   449

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

   450

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   451

	SLE_END()

   452

};

   453

   454

   455

static void Save_NGRF(void)

   456

{

   457

	int index = 0;

   458

   459

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

   460

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

   461

		SlSetArrayIndex(index++);

   462

		SlObject(c, _grfconfig_desc);

   463

	}

   464

}

   465

   466

   467

static void Load_NGRF(void)

   468

{

   469

	ClearGRFConfigList(&_grfconfig);

   470

	while (SlIterateArray() != -1) {

   471

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

   472

		SlObject(c, _grfconfig_desc);

   473

		AppendToGRFConfigList(&_grfconfig, c);

   474

	}

   475

   476

	/* Append static NewGRF configuration */

   477

	AppendStaticGRFConfigs(&_grfconfig);

   478

}

   479

   480

extern const ChunkHandler _newgrf_chunk_handlers[] = {

   481

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

   482

};

   483

   484