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

    13

#include "newgrf_config.h"

    14

    15

#include "fileio.h"

    16

#include "fios.h"

    17

#include <sys/types.h>

    18

#include <sys/stat.h>

    19

    20

#ifdef WIN32

    21

# include <io.h>

    22

#else

    23

# include <unistd.h>

    24

# include <dirent.h>

    25

#endif /* WIN32 */

    26

    27

    28

GRFConfig *_all_grfs;

    29

GRFConfig *_grfconfig;

    30

GRFConfig *_grfconfig_newgame;

    31

GRFConfig *_grfconfig_static;

    32

    33

    34

/* Calculate the MD5 Sum for a GRF */

    35

static bool CalcGRFMD5Sum(GRFConfig *config)

    36

{

    37

	FILE *f;

    38

	char filename[MAX_PATH];

    39

	md5_state_t md5state;

    40

	md5_byte_t buffer[1024];

    41

	size_t len;

    42

    43

	/* open the file */

    44

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

    45

	f = fopen(filename, "rb");

    46

	if (f == NULL) return false;

    47

    48

	/* calculate md5sum */

    49

	md5_init(&md5state);

    50

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

    51

		md5_append(&md5state, buffer, len);

    52

	}

    53

	md5_finish(&md5state, config->md5sum);

    54

    55

	fclose(f);

    56

    57

	return true;

    58

}

    59

    60

    61

/* Find the GRFID and calculate the md5sum */

    62

bool FillGRFDetails(GRFConfig *config, bool is_static)

    63

{

    64

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

    65

		SETBIT(config->flags, GCF_NOT_FOUND);

    66

		return false;

    67

	}

    68

    69

	/* Find and load the Action 8 information */

    70

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

    71

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

    72

	LoadNewGRFFile(config, 62, is_static ? GLS_SAFETYSCAN : GLS_FILESCAN);

    73

    74

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

    75

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

    76

    77

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

    78

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

    79

    80

	return CalcGRFMD5Sum(config);

    81

}

    82

    83

    84

void ClearGRFConfig(GRFConfig *config)

    85

{

    86

	free(config->filename);

    87

	free(config->name);

    88

	free(config->info);

    89

	free(config);

    90

}

    91

    92

    93

/* Clear a GRF Config list */

    94

void ClearGRFConfigList(GRFConfig *config)

    95

{

    96

	GRFConfig *c, *next;

    97

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

    98

		next = c->next;

    99

		ClearGRFConfig(c);

   100

	}

   101

}

   102

   103

   104

/* Copy a GRF Config list */

   105

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

   106

{

   107

	GRFConfig *c;

   108

   109

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

   110

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

   111

		*c = *src;

   112

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

   113

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

   114

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

   115

   116

		*dst = c;

   117

		dst = &c->next;

   118

	}

   119

   120

	return dst;

   121

}

   122

   123

   124

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

   125

void ResetGRFConfig(bool defaults)

   126

{

   127

	GRFConfig **c = &_grfconfig;

   128

   129

	ClearGRFConfigList(_grfconfig);

   130

	_grfconfig = NULL;

   131

   132

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

   133

	CopyGRFConfigList(c, _grfconfig_static);

   134

}

   135

   136

   137

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

   138

bool IsGoodGRFConfigList(void)

   139

{

   140

	bool res = true;

   141

	GRFConfig *c;

   142

   143

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

   144

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

   145

		if (f == NULL) {

   146

			char buf[512], *p = buf;

   147

			uint i;

   148

   149

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

   150

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

   151

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

   152

			}

   153

			ShowInfo(buf);

   154

   155

			res = false;

   156

		} else {

   157

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

   158

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

   159

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

   160

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

   161

		}

   162

	}

   163

   164

	return res;

   165

}

   166

   167

   168

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

   169

   170

/* Scan a path for NewGRFs */

   171

static uint ScanPath(const char *path)

   172

{

   173

	uint num = 0;

   174

	struct stat sb;

   175

	struct dirent *dirent;

   176

	DIR *dir;

   177

	GRFConfig *c;

   178

   179

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

   180

   181

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

   182

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

   183

		char filename[MAX_PATH];

   184

   185

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

   186

   187

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

   188

   189

		if (sb.st_mode & S_IFDIR) {

   190

			/* Directory */

   191

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

   192

			num += ScanPath(filename);

   193

		} else if (sb.st_mode & S_IFREG) {

   194

			/* File */

   195

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

   196

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

   197

   198

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

   199

			if (ext == NULL) continue;

   200

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

   201

   202

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

   203

			c->filename = strdup(file);

   204

   205

			if (FillGRFDetails(c, false)) {

   206

				if (_all_grfs == NULL) {

   207

					_all_grfs = c;

   208

				} else {

   209

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

   210

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

   211

					GRFConfig **pd, *d;

   212

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

   213

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

   214

					}

   215

					c->next = d;

   216

					*pd = c;

   217

				}

   218

   219

				num++;

   220

			} else {

   221

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

   222

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

   223

				free(c->filename);

   224

				free(c->name);

   225

				free(c->info);

   226

				free(c);

   227

			}

   228

		}

   229

	}

   230

   231

	closedir(dir);

   232

   233

	return num;

   234

}

   235

   236

   237

/* Scan for all NewGRFs */

   238

void ScanNewGRFFiles(void)

   239

{

   240

	uint num;

   241

   242

	ClearGRFConfigList(_all_grfs);

   243

	_all_grfs = NULL;

   244

   245

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

   246

	num = ScanPath(_paths.data_dir);

   247

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

   248

}

   249

   250

   251

/* Find a NewGRF in the scanned list */

   252

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

   253

{

   254

	GRFConfig *c;

   255

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

   256

   257

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

   258

		if (c->grfid == grfid) {

   259

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

   260

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

   261

		}

   262

	}

   263

   264

	return NULL;

   265

}

   266

   267

   268

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

   269

const GRFConfig *GetGRFConfig(uint32 grfid)

   270

{

   271

	GRFConfig *c;

   272

   273

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

   274

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

   275

	}

   276

   277

	return NULL;

   278

}

   279

   280

   281

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

   282

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

   283

{

   284

	uint i;

   285

   286

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

   287

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

   288

   289

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

   290

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

   291

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

   292

	}

   293

	return dst;

   294

}

   295

   296

   297

static const SaveLoad _grfconfig_desc[] = {

   298

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

   299

	SLE_VAR(GRFConfig, grfid,      SLE_UINT32),

   300

	SLE_ARR(GRFConfig, md5sum,     SLE_UINT8, 16),

   301

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

   302

	SLE_VAR(GRFConfig, num_params, SLE_UINT8),

   303

	SLE_END()

   304

};

   305

   306

   307

static void Save_NGRF(void)

   308

{

   309

	GRFConfig *c;

   310

	int index = 0;

   311

   312

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

   313

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

   314

		SlSetArrayIndex(index++);

   315

		SlObject(c, _grfconfig_desc);

   316

	}

   317

}

   318

   319

   320

static void Load_NGRF(void)

   321

{

   322

	GRFConfig *first = NULL;

   323

	GRFConfig **last = &first;

   324

   325

	while (SlIterateArray() != -1) {

   326

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

   327

		SlObject(c, _grfconfig_desc);

   328

   329

		/* Append our configuration to the list */

   330

		*last = c;

   331

		last = &c->next;

   332

	}

   333

   334

	/* Append static NewGRF configuration */

   335

	CopyGRFConfigList(last, _grfconfig_static);

   336

   337

	ClearGRFConfigList(_grfconfig);

   338

	_grfconfig = first;

   339

}

   340

   341

const ChunkHandler _newgrf_chunk_handlers[] = {

   342

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

   343

};

   344