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_data.h"

    13

#include "newgrf.h"

    14

#include "newgrf_config.h"

    15

    16

#include "fileio.h"

    17

#include "fios.h"

    18

#include <sys/types.h>

    19

#include <sys/stat.h>

    20

    21

#ifdef WIN32

    22

# include <io.h>

    23

#else

    24

# include <unistd.h>

    25

# include <dirent.h>

    26

#endif /* WIN32 */

    27

    28

    29

GRFConfig *_all_grfs;

    30

GRFConfig *_grfconfig;

    31

GRFConfig *_grfconfig_newgame;

    32

GRFConfig *_grfconfig_static;

    33

    34

    35

/* Calculate the MD5 Sum for a GRF */

    36

static bool CalcGRFMD5Sum(GRFConfig *config)

    37

{

    38

	FILE *f;

    39

	char filename[MAX_PATH];

    40

	md5_state_t md5state;

    41

	md5_byte_t buffer[1024];

    42

	size_t len;

    43

    44

	/* open the file */

    45

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

    46

	f = fopen(filename, "rb");

    47

	if (f == NULL) return false;

    48

    49

	/* calculate md5sum */

    50

	md5_init(&md5state);

    51

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

    52

		md5_append(&md5state, buffer, len);

    53

	}

    54

	md5_finish(&md5state, config->md5sum);

    55

    56

	fclose(f);

    57

    58

	return true;

    59

}

    60

    61

    62

/* Find the GRFID and calculate the md5sum */

    63

bool FillGRFDetails(GRFConfig *config, bool is_static)

    64

{

    65

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

    66

		SETBIT(config->flags, GCF_NOT_FOUND);

    67

		return false;

    68

	}

    69

    70

	/* Find and load the Action 8 information */

    71

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

    72

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

    73

	LoadNewGRFFile(config, 62, GLS_FILESCAN);

    74

    75

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

    76

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

    77

    78

	if (is_static) {

    79

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

    80

		LoadNewGRFFile(config, 62, GLS_SAFETYSCAN);

    81

    82

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

    83

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

    84

	}

    85

    86

	return CalcGRFMD5Sum(config);

    87

}

    88

    89

    90

void ClearGRFConfig(GRFConfig **config)

    91

{

    92

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

    93

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

    94

		free((*config)->filename);

    95

		free((*config)->name);

    96

		free((*config)->info);

    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 srt 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

	GRFConfig *c;

   122

   123

	/* Clear destination as it will be overwritten */

   124

	ClearGRFConfigList(dst);

   125

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

   126

		c = calloc(1, sizeof(*c));

   127

		*c = *src;

   128

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

   129

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

   130

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

   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

   184

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

   185

void ResetGRFConfig(bool defaults)

   186

{

   187

	GRFConfig **c = &_grfconfig;

   188

   189

	if (defaults) {

   190

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   191

	} else {

   192

		ClearGRFConfigList(c);

   193

	}

   194

   195

	AppendStaticGRFConfigs(&_grfconfig);

   196

}

   197

   198

   199

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

   200

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

   201

 * <ul>

   202

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

   203

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

   204

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

   205

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

   206

 * </ul> */

   207

GCF_Flags IsGoodGRFConfigList(void)

   208

{

   209

	GCF_Flags res = GCF_ACTIVATED;

   210

	GRFConfig *c;

   211

   212

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

   213

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

   214

		if (f == NULL) {

   215

			char buf[256];

   216

   217

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

   218

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

   219

			f = FindGRFConfig(c->grfid, NULL);

   220

			if (f != NULL) {

   221

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

   222

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

   223

				SETBIT(c->flags, GCF_COMPATIBLE);

   224

   225

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

   226

				if (res != GCF_NOT_FOUND) res = GCF_COMPATIBLE;

   227

				goto compatible_grf;

   228

			}

   229

   230

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

   231

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

   232

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

   233

   234

			SETBIT(c->flags, GCF_NOT_FOUND);

   235

			res = GCF_NOT_FOUND;

   236

		} else {

   237

compatible_grf:

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

				free(c->filename);

   246

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

   247

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

   248

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

   249

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

   250

			}

   251

		}

   252

	}

   253

   254

	return res;

   255

}

   256

   257

   258

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

   259

   260

/* Scan a path for NewGRFs */

   261

static uint ScanPath(const char *path)

   262

{

   263

	uint num = 0;

   264

	struct stat sb;

   265

	struct dirent *dirent;

   266

	DIR *dir;

   267

	GRFConfig *c;

   268

   269

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

   270

   271

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

   272

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

   273

		char filename[MAX_PATH];

   274

   275

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

   276

   277

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

   278

   279

		if (sb.st_mode & S_IFDIR) {

   280

			/* Directory */

   281

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

   282

			num += ScanPath(filename);

   283

		} else if (sb.st_mode & S_IFREG) {

   284

			/* File */

   285

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

   286

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

   287

   288

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

   289

			if (ext == NULL) continue;

   290

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

   291

   292

			c = calloc(1, sizeof(*c));

   293

			c->filename = strdup(file);

   294

   295

			if (FillGRFDetails(c, false)) {

   296

				if (_all_grfs == NULL) {

   297

					_all_grfs = c;

   298

				} else {

   299

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

   300

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

   301

					GRFConfig **pd, *d;

   302

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

   303

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

   304

					}

   305

					c->next = d;

   306

					*pd = c;

   307

				}

   308

   309

				num++;

   310

			} else {

   311

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

   312

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

   313

				free(c->filename);

   314

				free(c->name);

   315

				free(c->info);

   316

				free(c);

   317

			}

   318

		}

   319

	}

   320

   321

	closedir(dir);

   322

   323

	return num;

   324

}

   325

   326

   327

/* Scan for all NewGRFs */

   328

void ScanNewGRFFiles(void)

   329

{

   330

	uint num;

   331

   332

	ClearGRFConfigList(&_all_grfs);

   333

   334

	DEBUG(grf, 1) ("[GRF] Scanning for NewGRFs");

   335

	num = ScanPath(_paths.data_dir);

   336

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

   337

}

   338

   339

   340

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

   341

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

   342

{

   343

	const GRFConfig *c;

   344

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

   345

		if (c->grfid == grfid) {

   346

			if (md5sum == NULL) return c;

   347

   348

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

   349

		}

   350

	}

   351

   352

	return NULL;

   353

}

   354

   355

#ifdef ENABLE_NETWORK

   356

   357

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

   358

typedef struct UnknownGRF UnknownGRF;

   359

struct UnknownGRF {

   360

	UnknownGRF *next;

   361

	uint32 grfid;

   362

	uint8  md5sum[16];

   363

	char   name[NETWORK_GRF_NAME_LENGTH];

   364

};

   365

   366

/**

   367

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

   368

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

   369

 *

   370

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

   371

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

   372

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

   373

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

   374

 *

   375

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

   376

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

   377

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

   378

 *               exist in the fake list of GRFConfigs.

   379

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

   380

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

   381

 *         freed by the caller.

   382

 */

   383

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

   384

{

   385

	UnknownGRF *grf;

   386

	static UnknownGRF *unknown_grfs = NULL;

   387

   388

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

   389

		if (grf->grfid == grfid) {

   390

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

   391

		}

   392

	}

   393

   394

	if (!create) return NULL;

   395

   396

	grf = calloc(1, sizeof(*grf));

   397

	grf->grfid = grfid;

   398

	grf->next  = unknown_grfs;

   399

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

   400

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

   401

   402

	unknown_grfs = grf;

   403

	return grf->name;

   404

}

   405

   406

#endif /* ENABLE_NETWORK */

   407

   408

   409

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

   410

GRFConfig *GetGRFConfig(uint32 grfid)

   411

{

   412

	GRFConfig *c;

   413

   414

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

   415

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

   416

	}

   417

   418

	return NULL;

   419

}

   420

   421

   422

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

   423

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

   424

{

   425

	uint i;

   426

   427

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

   428

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

   429

   430

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

   431

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

   432

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

   433

	}

   434

	return dst;

   435

}

   436

   437

   438

static const SaveLoad _grfconfig_desc[] = {

   439

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

   440

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   441

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   442

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

   443

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   444

	SLE_END()

   445

};

   446

   447

   448

static void Save_NGRF(void)

   449

{

   450

	GRFConfig *c;

   451

	int index = 0;

   452

   453

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

   454

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

   455

		SlSetArrayIndex(index++);

   456

		SlObject(c, _grfconfig_desc);

   457

	}

   458

}

   459

   460

   461

static void Load_NGRF(void)

   462

{

   463

	GRFConfig *first = NULL;

   464

	GRFConfig **last = &first;

   465

   466

	while (SlIterateArray() != -1) {

   467

		GRFConfig *c = calloc(1, sizeof(*c));

   468

		SlObject(c, _grfconfig_desc);

   469

   470

		/* Append our configuration to the list */

   471

		*last = c;

   472

		last = &c->next;

   473

	}

   474

   475

	/* Append static NewGRF configuration */

   476

	CopyGRFConfigList(last, _grfconfig_static);

   477

   478

	ClearGRFConfigList(&_grfconfig);

   479

	_grfconfig = first;

   480

	AppendStaticGRFConfigs(&_grfconfig);

   481

}

   482

   483

const ChunkHandler _newgrf_chunk_handlers[] = {

   484

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

   485

};

   486