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, is_static ? GLS_SAFETYSCAN : GLS_FILESCAN);

    74

    75

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

    76

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

    77

    78

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

    79

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

    80

    81

	return CalcGRFMD5Sum(config);

    82

}

    83

    84

    85

void ClearGRFConfig(GRFConfig **config)

    86

{

    87

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

    88

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

    89

		free((*config)->filename);

    90

		free((*config)->name);

    91

		free((*config)->info);

    92

	}

    93

	free(*config);

    94

	*config = NULL;

    95

}

    96

    97

    98

/* Clear a GRF Config list */

    99

void ClearGRFConfigList(GRFConfig **config)

   100

{

   101

	GRFConfig *c, *next;

   102

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

   103

		next = c->next;

   104

		ClearGRFConfig(&c);

   105

	}

   106

	*config = NULL;

   107

}

   108

   109

   110

/** Copy a GRF Config list

   111

 * @param dst pointer to destination list

   112

 * @param srt pointer to source list values

   113

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

   114

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

   115

{

   116

	GRFConfig *c;

   117

   118

	/* Clear destination as it will be overwritten */

   119

	ClearGRFConfigList(dst);

   120

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

   121

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

   122

		*c = *src;

   126

   127

		*dst = c;

   128

		dst = &c->next;

   129

	}

   130

   131

	return dst;

   132

}

   133

   134

   135

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

   136

void ResetGRFConfig(bool defaults)

   137

{

   138

	GRFConfig **c = &_grfconfig;

   139

   140

	if (defaults) c = CopyGRFConfigList(c, _grfconfig_newgame);

   141

	CopyGRFConfigList(c, _grfconfig_static);

   142

}

   143

   144

   145

/* Check if all GRFs in the GRF Config can be loaded */

   146

bool IsGoodGRFConfigList(void)

   147

{

   148

	bool res = true;

   149

	GRFConfig *c;

   150

   151

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

   152

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

   153

		if (f == NULL) {

   154

			char buf[512], *p = buf;

   155

			uint i;

   156

   157

			p += snprintf(p, lastof(buf) - p, "Couldn't find NewGRF %08X (%s) checksum ", BSWAP32(c->grfid), c->filename);

   158

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

   159

				p += snprintf(p, lastof(buf) - p, "%02X", c->md5sum[i]);

   160

			}

   161

			ShowInfo(buf);

   162

   163

			res = false;

   164

		} else {

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

				free(c->filename);

   173

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

   174

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

   175

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

   176

			}

   177

		}

   178

	}

   179

   180

	return res;

   181

}

   182

   183

   184

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

   185

   186

/* Scan a path for NewGRFs */

   187

static uint ScanPath(const char *path)

   188

{

   189

	uint num = 0;

   190

	struct stat sb;

   191

	struct dirent *dirent;

   192

	DIR *dir;

   193

	GRFConfig *c;

   194

   195

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

   196

   197

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

   198

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

   199

		char filename[MAX_PATH];

   200

   201

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

   202

   203

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

   204

   205

		if (sb.st_mode & S_IFDIR) {

   206

			/* Directory */

   207

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

   208

			num += ScanPath(filename);

   209

		} else if (sb.st_mode & S_IFREG) {

   210

			/* File */

   211

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

   212

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

   213

   214

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

   215

			if (ext == NULL) continue;

   216

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

   217

   218

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

   219

			c->filename = strdup(file);

   220

   221

			if (FillGRFDetails(c, false)) {

   222

				if (_all_grfs == NULL) {

   223

					_all_grfs = c;

   224

				} else {

   225

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

   226

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

   227

					GRFConfig **pd, *d;

   228

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

   229

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

   230

					}

   231

					c->next = d;

   232

					*pd = c;

   233

				}

   234

   235

				num++;

   236

			} else {

   237

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

   238

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

   239

				free(c->filename);

   240

				free(c->name);

   241

				free(c->info);

   242

				free(c);

   243

			}

   244

		}

   245

	}

   246

   247

	closedir(dir);

   248

   249

	return num;

   250

}

   251

   252

   253

/* Scan for all NewGRFs */

   254

void ScanNewGRFFiles(void)

   255

{

   256

	uint num;

   257

   258

	ClearGRFConfigList(&_all_grfs);

   259

   260

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

   261

	num = ScanPath(_paths.data_dir);

   262

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

   263

}

   264

   265

   266

/* Find a NewGRF in the scanned list */

   267

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

   268

{

   269

	GRFConfig *c;

   270

	static const uint8 blanksum[sizeof(c->md5sum)] = { 0 };

   271

   272

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

   273

		if (c->grfid == grfid) {

   274

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

   275

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

   276

		}

   277

	}

   278

   279

	return NULL;

   280

}

   281

   282

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

   283

typedef struct UnknownGRF UnknownGRF;

   284

struct UnknownGRF {

   285

	UnknownGRF *next;

   286

	uint32 grfid;

   287

	uint8  md5sum[16];

   288

	char   name[NETWORK_GRF_NAME_LENGTH];

   289

};

   290

   291

/**

   292

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

   293

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

   294

 *

   295

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

   296

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

   297

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

   298

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

   299

 *

   300

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

   301

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

   302

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

   303

 *               exist in the fake list of GRFConfigs.

   304

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

   305

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

   306

 *         freed by the caller.

   307

 */

   308

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

   309

{

   310

	UnknownGRF *grf;

   311

	static UnknownGRF *unknown_grfs = NULL;

   312

   313

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

   314

		if (grf->grfid == grfid) {

   315

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

   316

		}

   317

	}

   318

   319

	if (!create) return NULL;

   320

   321

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

   322

	grf->grfid = grfid;

   323

	grf->next  = unknown_grfs;

   324

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

   325

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

   326

   327

	unknown_grfs = grf;

   328

	return grf->name;

   329

}

   330

   331

   332

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

   333

GRFConfig *GetGRFConfig(uint32 grfid)

   334

{

   335

	GRFConfig *c;

   336

   337

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

   338

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

   339

	}

   340

   341

	return NULL;

   342

}

   343

   344

   345

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

   346

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

   347

{

   348

	uint i;

   349

   350

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

   351

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

   352

   353

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

   354

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

   355

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

   356

	}

   357

	return dst;

   358

}

   359

   360

   361

static const SaveLoad _grfconfig_desc[] = {

   362

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

   363

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   364

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   365

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

   366

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   367

	SLE_END()

   368

};

   369

   370

   371

static void Save_NGRF(void)

   372

{

   373

	GRFConfig *c;

   374

	int index = 0;

   375

   376

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

   377

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

   378

		SlSetArrayIndex(index++);

   379

		SlObject(c, _grfconfig_desc);

   380

	}

   381

}

   382

   383

   384

static void Load_NGRF(void)

   385

{

   386

	GRFConfig *first = NULL;

   387

	GRFConfig **last = &first;

   388

   389

	while (SlIterateArray() != -1) {

   390

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

   391

		SlObject(c, _grfconfig_desc);

   392

   393

		/* Append our configuration to the list */

   394

		*last = c;

   395

		last = &c->next;

   396

	}

   397

   398

	/* Append static NewGRF configuration */

   399

	CopyGRFConfigList(last, _grfconfig_static);

   400

   401

	ClearGRFConfigList(&_grfconfig);

   402

	_grfconfig = first;

   403

}

   404

   405

const ChunkHandler _newgrf_chunk_handlers[] = {

   406

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

   407

};

   408