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

   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

   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

   193

   194

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

   195

void ResetGRFConfig(bool defaults)

   196

{

   197

	GRFConfig **c = &_grfconfig;

   198

   199

	if (defaults) {

   200

		c = CopyGRFConfigList(c, _grfconfig_newgame);

   201

	} else {

   202

		ClearGRFConfigList(c);

   203

	}

   204

   205

	AppendStaticGRFConfigs(&_grfconfig);

   206

}

   207

   208

   209

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

   210

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

   211

 * <ul>

   212

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

   213

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

   214

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

   215

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

   216

 * </ul> */

   217

GCF_Flags IsGoodGRFConfigList(void)

   218

{

   219

	GCF_Flags res = GCF_ACTIVATED;

   220

   221

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

   222

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

   223

		if (f == NULL) {

   224

			char buf[256];

   225

   226

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

   227

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

   228

			f = FindGRFConfig(c->grfid);

   229

			if (f != NULL) {

   230

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

   231

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

   232

				SETBIT(c->flags, GCF_COMPATIBLE);

   233

   234

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

   235

				if (res != GCF_NOT_FOUND) res = GCF_COMPATIBLE;

   236

				goto compatible_grf;

   237

			}

   238

   239

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

   240

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

   241

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

   242

   243

			SETBIT(c->flags, GCF_NOT_FOUND);

   244

			res = GCF_NOT_FOUND;

   245

		} else {

   246

compatible_grf:

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

				free(c->filename);

   255

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

   256

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

   257

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

   258

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

   259

			}

   260

		}

   261

	}

   262

   263

	return res;

   264

}

   265

   266

   267

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

   268

   269

/* Scan a path for NewGRFs */

   270

static uint ScanPath(const char *path)

   271

{

   272

	uint num = 0;

   273

	struct stat sb;

   274

	struct dirent *dirent;

   275

	DIR *dir;

   276

   277

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

   278

   279

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

   280

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

   281

		char filename[MAX_PATH];

   282

   283

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

   284

   285

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

   286

   287

		if (sb.st_mode & S_IFDIR) {

   288

			/* Directory */

   289

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

   290

			num += ScanPath(filename);

   291

		} else if (sb.st_mode & S_IFREG) {

   292

			/* File */

   293

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

   294

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

   295

   296

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

   297

			if (ext == NULL) continue;

   298

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

   299

   300

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

   301

			c->filename = strdup(file);

   302

   303

			if (FillGRFDetails(c, false)) {

   304

				if (_all_grfs == NULL) {

   305

					_all_grfs = c;

   306

				} else {

   307

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

   308

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

   309

					GRFConfig **pd, *d;

   310

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

   311

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

   312

					}

   313

					c->next = d;

   314

					*pd = c;

   315

				}

   316

   317

				num++;

   318

			} else {

   319

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

   320

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

   321

				free(c->filename);

   322

				free(c->name);

   323

				free(c->info);

   324

				free(c);

   325

			}

   326

		}

   327

	}

   328

   329

	closedir(dir);

   330

   331

	return num;

   332

}

   333

   334

   335

/* Scan for all NewGRFs */

   336

void ScanNewGRFFiles(void)

   337

{

   338

	uint num;

   339

   340

	ClearGRFConfigList(&_all_grfs);

   341

   342

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

   343

	num = ScanPath(_paths.data_dir);

   344

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

   345

}

   346

   347

   348

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

   349

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

   350

{

   351

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

   352

		if (c->grfid == grfid) {

   353

			if (md5sum == NULL) return c;

   354

   355

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

   356

		}

   357

	}

   358

   359

	return NULL;

   360

}

   361

   362

#ifdef ENABLE_NETWORK

   363

   364

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

   365

typedef struct UnknownGRF UnknownGRF;

   366

struct UnknownGRF : public GRFIdentifier {

   367

	UnknownGRF *next;

   368

	char   name[NETWORK_GRF_NAME_LENGTH];

   369

};

   370

   371

/**

   372

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

   373

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

   374

 *

   375

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

   376

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

   377

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

   378

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

   379

 *

   380

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

   381

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

   382

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

   383

 *               exist in the fake list of GRFConfigs.

   384

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

   385

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

   386

 *         freed by the caller.

   387

 */

   388

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

   389

{

   390

	UnknownGRF *grf;

   391

	static UnknownGRF *unknown_grfs = NULL;

   392

   393

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

   394

		if (grf->grfid == grfid) {

   395

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

   396

		}

   397

	}

   398

   399

	if (!create) return NULL;

   400

   401

	grf = CallocT<UnknownGRF>(1);

   402

	grf->grfid = grfid;

   403

	grf->next  = unknown_grfs;

   404

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

   405

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

   406

   407

	unknown_grfs = grf;

   408

	return grf->name;

   409

}

   410

   411

#endif /* ENABLE_NETWORK */

   412

   413

   414

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

   415

GRFConfig *GetGRFConfig(uint32 grfid)

   416

{

   417

	GRFConfig *c;

   418

   419

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

   420

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

   421

	}

   422

   423

	return NULL;

   424

}

   425

   426

   427

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

   428

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

   429

{

   430

	uint i;

   431

   432

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

   433

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

   434

   435

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

   436

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

   437

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

   438

	}

   439

	return dst;

   440

}

   441

   442

   443

static const SaveLoad _grfconfig_desc[] = {

   444

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

   445

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   446

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   447

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

   448

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   449

	SLE_END()

   450

};

   451

   452

   453

static void Save_NGRF(void)

   454

{

   455

	GRFConfig *c;

   456

	int index = 0;

   457

   458

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

   459

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

   460

		SlSetArrayIndex(index++);

   461

		SlObject(c, _grfconfig_desc);

   462

	}

   463

}

   464

   465

   466

static void Load_NGRF(void)

   467

{

   469

	while (SlIterateArray() != -1) {

   470

		SlObject(c, _grfconfig_desc);

   472

	}

   474

   475

	/* Append static NewGRF configuration */

   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