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/types.h>

    20

#include <sys/stat.h>

    21

    22

#ifdef WIN32

    23

# include <io.h>

    24

#else

    25

# include <unistd.h>

    26

# include <dirent.h>

    27

#endif /* WIN32 */

    28

    29

    30

GRFConfig *_all_grfs;

    31

GRFConfig *_grfconfig;

    32

GRFConfig *_grfconfig_newgame;

    33

GRFConfig *_grfconfig_static;

    34

    35

    36

/* Calculate the MD5 Sum for a GRF */

    37

static bool CalcGRFMD5Sum(GRFConfig *config)

    38

{

    39

	FILE *f;

    40

	char filename[MAX_PATH];

    41

	md5_state_t md5state;

    42

	md5_byte_t buffer[1024];

    43

	size_t len;

    44

    45

	/* open the file */

    46

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

    47

	f = fopen(filename, "rb");

    48

	if (f == NULL) return false;

    49

    50

	/* calculate md5sum */

    51

	md5_init(&md5state);

    52

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

    53

		md5_append(&md5state, buffer, len);

    54

	}

    55

	md5_finish(&md5state, config->md5sum);

    56

    57

	fclose(f);

    58

    59

	return true;

    60

}

    61

    62

    63

/* Find the GRFID and calculate the md5sum */

    64

bool FillGRFDetails(GRFConfig *config, bool is_static)

    65

{

    66

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

    67

		SETBIT(config->flags, GCF_NOT_FOUND);

    68

		return false;

    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)->name);

    97

		free((*config)->info);

    98

	}

    99

	free(*config);

   100

	*config = NULL;

   101

}

   102

   103

   104

/* Clear a GRF Config list */

   105

void ClearGRFConfigList(GRFConfig **config)

   106

{

   107

	GRFConfig *c, *next;

   108

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

   109

		next = c->next;

   110

		ClearGRFConfig(&c);

   111

	}

   112

	*config = NULL;

   113

}

   114

   115

   116

/** Copy a GRF Config list

   117

 * @param dst pointer to destination list

   118

 * @param srt pointer to source list values

   119

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

   120

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

   121

{

   122

	/* Clear destination as it will be overwritten */

   123

	ClearGRFConfigList(dst);

   124

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

   125

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

   126

		*c = *src;

   127

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

   128

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

   129

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

   130

   131

		*dst = c;

   132

		dst = &c->next;

   133

	}

   134

   135

	return dst;

   136

}

   137

   138

/**

   139

 * Removes duplicates from lists of GRFConfigs. These duplicates

   140

 * are introduced when the _grfconfig_static GRFs are appended

   141

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

   142

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

   143

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

   144

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

   145

 *

   146

 * This function _assumes_ that all static GRFs are placed after

   147

 * the non-static GRFs.

   148

 *

   149

 * @param list the list to remove the duplicates from

   150

 */

   151

static void RemoveDuplicatesFromGRFConfigList(GRFConfig *list)

   152

{

   153

	GRFConfig *prev;

   154

	GRFConfig *cur;

   155

   156

	if (list == NULL) return;

   157

   158

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

   159

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

   160

		assert(HASBIT(cur->flags, GCF_STATIC));

   161

		prev->next = cur->next;

   162

		ClearGRFConfig(&cur);

   163

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

   164

	}

   165

   166

	RemoveDuplicatesFromGRFConfigList(list->next);

   167

}

   168

   169

/**

   170

 * Appends the static GRFs to a list of GRFs

   171

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

   172

 */

   173

void AppendStaticGRFConfigs(GRFConfig **dst)

   174

{

   175

	GRFConfig **tail = dst;

   176

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

   177

   178

	CopyGRFConfigList(tail, _grfconfig_static);

   179

	RemoveDuplicatesFromGRFConfigList(*dst);

   180

}

   181

   182

   183

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

   184

void ResetGRFConfig(bool defaults)

   185

{

   186

	GRFConfig **c = &_grfconfig;

   187

   188

	if (defaults) {

   189

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   190

	} else {

   191

		ClearGRFConfigList(c);

   192

	}

   193

   194

	AppendStaticGRFConfigs(&_grfconfig);

   195

}

   196

   197

   198

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

   199

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

   200

 * <ul>

   201

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

   202

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

   203

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

   204

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

   205

 * </ul> */

   206

GCF_Flags IsGoodGRFConfigList(void)

   207

{

   208

	GCF_Flags res = GCF_ACTIVATED;

   209

   210

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

   211

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

   212

		if (f == NULL) {

   213

			char buf[256], *p = buf;

   214

   215

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

   216

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

   217

			f = FindGRFConfig(c->grfid);

   218

			if (f != NULL) {

   219

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

   220

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

   221

				SETBIT(c->flags, GCF_COMPATIBLE);

   222

   223

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

   224

				if (res != GCF_NOT_FOUND) res = GCF_COMPATIBLE;

   225

				goto compatible_grf;

   226

			}

   227

   228

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

   229

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

   230

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

   231

   232

			SETBIT(c->flags, GCF_NOT_FOUND);

   233

			res = GCF_NOT_FOUND;

   234

		} else {

   235

compatible_grf:

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

				free(c->filename);

   244

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

   246

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

   247

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

   248

			}

   249

		}

   250

	}

   251

   252

	return res;

   253

}

   254

   255

   256

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

   257

   258

/* Scan a path for NewGRFs */

   259

static uint ScanPath(const char *path)

   260

{

   261

	uint num = 0;

   262

	struct stat sb;

   263

	struct dirent *dirent;

   264

	DIR *dir;

   265

   266

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

   267

   268

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

   269

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

   270

		char filename[MAX_PATH];

   271

   272

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

   273

   274

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

   275

   276

		if (sb.st_mode & S_IFDIR) {

   277

			/* Directory */

   278

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

   279

			num += ScanPath(filename);

   280

		} else if (sb.st_mode & S_IFREG) {

   281

			/* File */

   282

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

   283

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

   284

   285

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

   286

			if (ext == NULL) continue;

   287

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

   288

   289

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

   290

			c->filename = strdup(file);

   291

   292

			if (FillGRFDetails(c, false)) {

   293

				if (_all_grfs == NULL) {

   294

					_all_grfs = c;

   295

				} else {

   296

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

   297

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

   298

					GRFConfig **pd, *d;

   299

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

   300

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

   301

					}

   302

					c->next = d;

   303

					*pd = c;

   304

				}

   305

   306

				num++;

   307

			} else {

   308

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

   309

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

   310

				free(c->filename);

   311

				free(c->name);

   312

				free(c->info);

   313

				free(c);

   314

			}

   315

		}

   316

	}

   317

   318

	closedir(dir);

   319

   320

	return num;

   321

}

   322

   323

   324

/* Scan for all NewGRFs */

   325

void ScanNewGRFFiles(void)

   326

{

   327

	uint num;

   328

   329

	ClearGRFConfigList(&_all_grfs);

   330

   331

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

   332

	num = ScanPath(_paths.data_dir);

   333

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

   334

}

   335

   336

   337

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

   338

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

   339

{

   340

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

   341

		if (c->grfid == grfid) {

   342

			if (md5sum == NULL) return c;

   343

   344

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

   345

		}

   346

	}

   347

   348

	return NULL;

   349

}

   350

   351

#ifdef ENABLE_NETWORK

   352

   353

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

   354

typedef struct UnknownGRF UnknownGRF;

   355

struct UnknownGRF {

   356

	UnknownGRF *next;

   357

	uint32 grfid;

   358

	uint8  md5sum[16];

   359

	char   name[NETWORK_GRF_NAME_LENGTH];

   360

};

   361

   362

/**

   363

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

   364

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

   365

 *

   366

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

   367

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

   368

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

   369

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

   370

 *

   371

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

   372

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

   373

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

   374

 *               exist in the fake list of GRFConfigs.

   375

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

   376

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

   377

 *         freed by the caller.

   378

 */

   379

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

   380

{

   381

	UnknownGRF *grf;

   382

	static UnknownGRF *unknown_grfs = NULL;

   383

   384

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

   385

		if (grf->grfid == grfid) {

   386

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

   387

		}

   388

	}

   389

   390

	if (!create) return NULL;

   391

   392

	grf = CallocT<UnknownGRF>(1);

   393

	grf->grfid = grfid;

   394

	grf->next  = unknown_grfs;

   395

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

   396

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

   397

   398

	unknown_grfs = grf;

   399

	return grf->name;

   400

}

   401

   402

#endif /* ENABLE_NETWORK */

   403

   404

   405

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

   406

GRFConfig *GetGRFConfig(uint32 grfid)

   407

{

   408

	GRFConfig *c;

   409

   410

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

   411

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

   412

	}

   413

   414

	return NULL;

   415

}

   416

   417

   418

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

   419

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

   420

{

   421

	uint i;

   422

   423

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

   424

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

   425

   426

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

   427

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

   428

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

   429

	}

   430

	return dst;

   431

}

   432

   433

   434

static const SaveLoad _grfconfig_desc[] = {

   435

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

   436

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   437

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   438

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

   439

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   440

	SLE_END()

   441

};

   442

   443

   444

static void Save_NGRF(void)

   445

{

   446

	GRFConfig *c;

   447

	int index = 0;

   448

   449

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

   450

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

   451

		SlSetArrayIndex(index++);

   452

		SlObject(c, _grfconfig_desc);

   453

	}

   454

}

   455

   456

   457

static void Load_NGRF(void)

   458

{

   459

	GRFConfig *first = NULL;

   460

	GRFConfig **last = &first;

   461

   462

	while (SlIterateArray() != -1) {

   463

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

   464

		SlObject(c, _grfconfig_desc);

   465

   466

		/* Append our configuration to the list */

   467

		*last = c;

   468

		last = &c->next;

   469

	}

   470

   471

	/* Append static NewGRF configuration */

   472

	CopyGRFConfigList(last, _grfconfig_static);

   473

   474

	ClearGRFConfigList(&_grfconfig);

   475

	_grfconfig = first;

   476

	AppendStaticGRFConfigs(&_grfconfig);

   477

}

   478

   479

extern const ChunkHandler _newgrf_chunk_handlers[] = {

   480

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

   481

};

   482

   483