(svn r7348) -Feature: Initial support for saving NewGRF settings with savegames. Back up your savegames...
parent
dc8992a677
commit
bd66cc5756
@ -0,0 +1,294 @@
|
||||
/* $Id$ */
|
||||
|
||||
#include "stdafx.h"
|
||||
#include "openttd.h"
|
||||
#include "functions.h"
|
||||
#include "macros.h"
|
||||
#include "debug.h"
|
||||
#include "variables.h"
|
||||
#include "saveload.h"
|
||||
#include "md5.h"
|
||||
#include "newgrf.h"
|
||||
#include "newgrf_config.h"
|
||||
|
||||
#include "fileio.h"
|
||||
#include "fios.h"
|
||||
#include <sys/types.h>
|
||||
#include <sys/stat.h>
|
||||
|
||||
#ifdef WIN32
|
||||
# include <io.h>
|
||||
#else
|
||||
# include <unistd.h>
|
||||
# include <dirent.h>
|
||||
#endif /* WIN32 */
|
||||
|
||||
|
||||
GRFConfig *_all_grfs;
|
||||
GRFConfig *_grfconfig;
|
||||
GRFConfig *_grfconfig_newgame;
|
||||
|
||||
|
||||
/* Calculate the MD5 Sum for a GRF */
|
||||
static bool CalcGRFMD5Sum(GRFConfig *config)
|
||||
{
|
||||
FILE *f;
|
||||
char filename[MAX_PATH];
|
||||
md5_state_t md5state;
|
||||
md5_byte_t buffer[1024];
|
||||
size_t len;
|
||||
|
||||
/* open the file */
|
||||
snprintf(filename, lengthof(filename), "%s%s", _path.data_dir, config->filename);
|
||||
f = fopen(filename, "rb");
|
||||
if (f == NULL) return false;
|
||||
|
||||
/* calculate md5sum */
|
||||
md5_init(&md5state);
|
||||
while ((len = fread(buffer, 1, sizeof(buffer), f)) != 0) {
|
||||
md5_append(&md5state, buffer, len);
|
||||
}
|
||||
md5_finish(&md5state, config->md5sum);
|
||||
|
||||
fclose(f);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/* Find the GRFID and calculate the md5sum */
|
||||
bool FillGRFDetails(GRFConfig *config)
|
||||
{
|
||||
if (!FioCheckFileExists(config->filename)) {
|
||||
SETBIT(config->flags, GCF_NOT_FOUND);
|
||||
return false;
|
||||
}
|
||||
|
||||
/* Find and load the Action 8 information */
|
||||
/* 62 is the last file slot before sample.cat.
|
||||
* Should perhaps be some "don't care" value */
|
||||
LoadNewGRFFile(config, 62, GLS_FILESCAN);
|
||||
|
||||
/* Skip if the grfid is 0 (not read) or 0xFFFFFFFF (ttdp system grf) */
|
||||
if (config->grfid == 0 || config->grfid == 0xFFFFFFFF) return false;
|
||||
|
||||
return CalcGRFMD5Sum(config);
|
||||
}
|
||||
|
||||
|
||||
/* Clear a GRF Config list */
|
||||
void ClearGRFConfigList(GRFConfig *config)
|
||||
{
|
||||
GRFConfig *c, *next;
|
||||
for (c = config; c != NULL; c = next) {
|
||||
next = c->next;
|
||||
free(c->filename);
|
||||
free(c->name);
|
||||
free(c->info);
|
||||
free(c);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* Copy a GRF Config list */
|
||||
static void CopyGRFConfigList(GRFConfig **dst, GRFConfig *src)
|
||||
{
|
||||
GRFConfig *c;
|
||||
|
||||
for (; src != NULL; src = src->next) {
|
||||
c = calloc(1, sizeof(*c));
|
||||
*c = *src;
|
||||
c->filename = strdup(src->filename);
|
||||
if (src->name != NULL) c->name = strdup(src->name);
|
||||
if (src->info != NULL) c->info = strdup(src->info);
|
||||
|
||||
*dst = c;
|
||||
dst = &c->next;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* Reset the current GRF Config to either blank or newgame settings */
|
||||
void ResetGRFConfig(bool defaults)
|
||||
{
|
||||
ClearGRFConfigList(_grfconfig);
|
||||
_grfconfig = NULL;
|
||||
if (defaults) CopyGRFConfigList(&_grfconfig, _grfconfig_newgame);
|
||||
}
|
||||
|
||||
|
||||
/* Check if all GRFs in the GRF Config can be loaded */
|
||||
bool IsGoodGRFConfigList(void)
|
||||
{
|
||||
bool res = true;
|
||||
GRFConfig *c;
|
||||
|
||||
for (c = _grfconfig; c != NULL; c = c->next) {
|
||||
const GRFConfig *f = FindGRFConfig(c->grfid, c->md5sum);
|
||||
if (f == NULL) {
|
||||
char buf[512], *p = buf;
|
||||
uint i;
|
||||
|
||||
p += snprintf(p, lastof(buf) - p, "Couldn't find NewGRF %08X (%s) checksum ", BSWAP32(c->grfid), c->filename);
|
||||
for (i = 0; i < lengthof(c->md5sum); i++) {
|
||||
p += snprintf(p, lastof(buf) - p, "%02X", c->md5sum[i]);
|
||||
}
|
||||
ShowInfo(buf);
|
||||
|
||||
res = false;
|
||||
} else {
|
||||
DEBUG(grf, 1) ("[GRF] Loading GRF %X from %s", BSWAP32(c->grfid), f->filename);
|
||||
c->filename = strdup(f->filename);
|
||||
c->name = strdup(f->name);
|
||||
c->info = strdup(f->info);
|
||||
}
|
||||
}
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
|
||||
extern bool FiosIsValidFile(const char *path, const struct dirent *ent, struct stat *sb);
|
||||
|
||||
/* Scan a path for NewGRFs */
|
||||
static uint ScanPath(const char *path)
|
||||
{
|
||||
uint num = 0;
|
||||
struct stat sb;
|
||||
struct dirent *dirent;
|
||||
DIR *dir;
|
||||
GRFConfig *c;
|
||||
|
||||
if ((dir = opendir(path)) == NULL) return 0;
|
||||
|
||||
while ((dirent = readdir(dir)) != NULL) {
|
||||
const char *d_name = FS2OTTD(dirent->d_name);
|
||||
char filename[MAX_PATH];
|
||||
|
||||
if (!FiosIsValidFile(path, dirent, &sb)) continue;
|
||||
|
||||
snprintf(filename, lengthof(filename), "%s" PATHSEP "%s", path, d_name);
|
||||
|
||||
if (sb.st_mode & S_IFDIR) {
|
||||
/* Directory */
|
||||
if (strcmp(d_name, ".") == 0 || strcmp(d_name, "..") == 0) continue;
|
||||
num += ScanPath(filename);
|
||||
} else if (sb.st_mode & S_IFREG) {
|
||||
/* File */
|
||||
char *ext = strrchr(filename, '.');
|
||||
char *file = strchr(filename, PATHSEPCHAR) + 1; // Crop base path
|
||||
|
||||
/* If no extension or extension isn't .grf, skip the file */
|
||||
if (ext == NULL) continue;
|
||||
if (strcasecmp(ext, ".grf") != 0) continue;
|
||||
|
||||
c = calloc(1, sizeof(*c));
|
||||
c->filename = strdup(file);
|
||||
|
||||
if (FillGRFDetails(c)) {
|
||||
if (_all_grfs == NULL) {
|
||||
_all_grfs = c;
|
||||
} else {
|
||||
/* Insert file into list at a position determined by its
|
||||
* name, so the list is sorted as we go along */
|
||||
GRFConfig **pd, *d;
|
||||
for (pd = &_all_grfs; (d = *pd) != NULL; pd = &d->next) {
|
||||
if (strcasecmp(c->name, d->name) <= 0) break;
|
||||
}
|
||||
c->next = d;
|
||||
*pd = c;
|
||||
}
|
||||
|
||||
num++;
|
||||
} else {
|
||||
/* File couldn't be opened, or is either not a NewGRF or is a
|
||||
* 'system' NewGRF, so forget about it. */
|
||||
free(c->filename);
|
||||
free(c->name);
|
||||
free(c->info);
|
||||
free(c);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
closedir(dir);
|
||||
|
||||
return num;
|
||||
}
|
||||
|
||||
|
||||
/* Scan for all NewGRFs */
|
||||
void ScanNewGRFFiles(void)
|
||||
{
|
||||
uint num;
|
||||
|
||||
ClearGRFConfigList(_all_grfs);
|
||||
_all_grfs = NULL;
|
||||
|
||||
DEBUG(grf, 1) ("[GRF] Scanning for NewGRFs");
|
||||
num = ScanPath(_path.data_dir);
|
||||
DEBUG(grf, 1) ("[GRF] Scan complete, found %d files", num);
|
||||
}
|
||||
|
||||
|
||||
/* Find a NewGRF in the scanned list */
|
||||
const GRFConfig *FindGRFConfig(uint32 grfid, uint8 *md5sum)
|
||||
{
|
||||
GRFConfig *c;
|
||||
static const uint8 blanksum[sizeof(c->md5sum)] = { 0 };
|
||||
|
||||
for (c = _all_grfs; c != NULL; c = c->next) {
|
||||
if (c->grfid == grfid) {
|
||||
if (memcmp(blanksum, c->md5sum, sizeof(c->md5sum)) == 0) CalcGRFMD5Sum(c);
|
||||
if (memcmp(md5sum, c->md5sum, sizeof(c->md5sum)) == 0) return c;
|
||||
}
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
static const SaveLoad _grfconfig_desc[] = {
|
||||
SLE_STR(GRFConfig, filename, SLE_STR, 0x40),
|
||||
SLE_VAR(GRFConfig, grfid, SLE_UINT32),
|
||||
SLE_ARR(GRFConfig, md5sum, SLE_UINT8, 16),
|
||||
SLE_ARR(GRFConfig, param, SLE_UINT32, 0x80),
|
||||
SLE_VAR(GRFConfig, num_params, SLE_UINT8),
|
||||
SLE_END()
|
||||
};
|
||||
|
||||
|
||||
static void Save_NGRF(void)
|
||||
{
|
||||
GRFConfig *c;
|
||||
int index = 0;
|
||||
|
||||
for (c = _grfconfig; c != NULL; c = c->next) {
|
||||
SlSetArrayIndex(index++);
|
||||
SlObject(c, _grfconfig_desc);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static void Load_NGRF(void)
|
||||
{
|
||||
GRFConfig *first = NULL;
|
||||
GRFConfig **last = &first;
|
||||
|
||||
while (SlIterateArray() != -1) {
|
||||
GRFConfig *c = calloc(1, sizeof(*c));
|
||||
SlObject(c, _grfconfig_desc);
|
||||
|
||||
/* Append our configuration to the list */
|
||||
*last = c;
|
||||
last = &c->next;
|
||||
}
|
||||
|
||||
ClearGRFConfigList(_grfconfig);
|
||||
_grfconfig = first;
|
||||
}
|
||||
|
||||
const ChunkHandler _newgrf_chunk_handlers[] = {
|
||||
{ 'NGRF', Save_NGRF, Load_NGRF, CH_ARRAY | CH_LAST }
|
||||
};
|
||||
|
@ -0,0 +1,43 @@
|
||||
/* $Id$ */
|
||||
|
||||
#ifndef NEWGRF_CONFIG_H
|
||||
#define NEWGRF_CONFIG_H
|
||||
|
||||
/* GRF config bit flags */
|
||||
enum {
|
||||
GCF_DISABLED,
|
||||
GCF_NOT_FOUND,
|
||||
GCF_ACTIVATED,
|
||||
};
|
||||
|
||||
typedef struct GRFConfig {
|
||||
char *filename;
|
||||
char *name;
|
||||
char *info;
|
||||
uint32 grfid;
|
||||
|
||||
uint8 flags;
|
||||
uint8 md5sum[16];
|
||||
uint32 param[0x80];
|
||||
uint8 num_params;
|
||||
|
||||
struct GRFConfig *next;
|
||||
} GRFConfig;
|
||||
|
||||
/* First item in list of all scanned NewGRFs */
|
||||
extern GRFConfig *_all_grfs;
|
||||
|
||||
/* First item in list of current GRF set up */
|
||||
extern GRFConfig *_grfconfig;
|
||||
|
||||
/* First item in list of default GRF set up */
|
||||
extern GRFConfig *_grfconfig_newgame;
|
||||
|
||||
void ScanNewGRFFiles(void);
|
||||
const GRFConfig *FindGRFConfig(uint32 grfid, uint8 *md5sum);
|
||||
void ClearGRFConfigList(GRFConfig *config);
|
||||
void ResetGRFConfig(bool defaults);
|
||||
bool IsGoodGRFConfigList(void);
|
||||
bool FillGRFDetails(GRFConfig *config);
|
||||
|
||||
#endif /* NEWGRF_CONFIG_H */
|
Loading…
Reference in New Issue