config update

This commit is contained in:
CrazyRedMachine 2024-06-08 01:00:37 +02:00
parent 02b193bfab
commit 28d58fe172
10 changed files with 440 additions and 124 deletions

0
dist/popnhax/_update vendored Normal file
View File

View File

@ -12,6 +12,7 @@ libs_popnhax := \
srcpp_popnhax := \
dllmain.cc \
config.cc \
loader.cc \
SearchFile.cc \
translation.cc \

242
popnhax/config.cc Normal file
View File

@ -0,0 +1,242 @@
#include <windows.h>
#include <io.h>
#include "util/crc32.h"
#include "util/log.h"
#include "config.h"
#define F_OK 0
static char *get_opt_filename(const char *xml_filename){
char *opt_filename = strdup(xml_filename);
if ( opt_filename != NULL )
strcpy(opt_filename+strlen(opt_filename)-3, "opt");
return opt_filename;
}
//works for .opt and .xml
static char *get_option(FILE *handle, char *option_name){
if (handle == NULL || option_name == NULL)
return NULL;
rewind(handle);
char line[256];
while (fgets(line, 256, handle))
{
char *ptr = strchr(line, '<');
if ( ptr == NULL )
continue;
if ( strncmp(option_name, ptr+1, strlen(option_name)) == 0
&& (*(ptr+1+strlen(option_name)) == ' ') ) //filter out common prefixes
{
rewind(handle);
return strdup(line);
}
}
return NULL;
}
//check .xml crc-32 and compare to .opt entry
static bool config_check_crc(const char *filepath){
//retrieve xml crc
uint32_t xmlcrc = 0;
long charcnt = 0;
if ( crc32file(filepath, &xmlcrc, &charcnt) == false )
{
LOG("popnhax: config update: cannot compute %s CRC-32\n", filepath);
return false;
}
LOG("popnhax: config update: %s CRC-32 is %08X\n", filepath, xmlcrc);
//retrieve opt crc
uint32_t optcrc = 0;
char *opt_filename = get_opt_filename(filepath);
FILE *opt = fopen(opt_filename, "r");
if (opt == NULL)
{
LOG("popnhax: config update: opt file not found.\n");
return false;
}
char line[256];
fgets(line, 256, opt); //disclaimer line
fgets(line, 256, opt); //CRC line
sscanf(line, "<!-- %08X -->\n", &optcrc);
fclose(opt);
LOG("popnhax: config update: %s reference CRC is %08X (matching: %s)\n", opt_filename, optcrc, optcrc==xmlcrc? "true":"false");
free(opt_filename);
return (optcrc==xmlcrc);
}
static char *get_option_name(char *line)
{
if ( line == NULL )
return NULL;
char *ptr = line;
while ( *ptr == ' ' || *ptr == '\t' )
ptr++;
if ( *ptr != '<' )
return NULL;
if ( *(++ptr) == '!' )
return NULL;
if ( strchr(ptr, ' ') == NULL )
return NULL;
size_t opt_len = strchr(ptr, ' ') - ptr;
char *option_name = (char*)malloc(opt_len+1);
strncpy(option_name, ptr, opt_len);
option_name[opt_len] = '\0';
return option_name;
}
//check if _update file is present
static bool config_need_update()
{
return (access("_update", F_OK) == 0);
}
//for every entry in .opt, overwrite xml value
static bool config_update_xml(const char *xml_filename)
{
char *opt_filename = get_opt_filename(xml_filename);
FILE *opt = fopen(opt_filename, "r");
if ( opt == NULL )
{
LOG("popnhax: config_update_xml: cannot open opt file\n");
free(opt_filename);
return true; //not a problem if it doesn't exist
}
FILE *xml = fopen(xml_filename, "r");
if ( xml == NULL )
{
LOG("popnhax: config_update_xml: cannot open xml file\n");
return false;
}
FILE *update = fopen("update.xml.tmp", "w");
if ( update == NULL )
{
LOG("popnhax: config_update_xml: create update.xml.tmp\n");
return false;
}
// read each line from xml and copy to update unless opt has a value in which case copy from opt instead
char line[256];
while (fgets(line, 256, xml))
{
char *option_name = get_option_name(line);
char *option_line = get_option(opt, option_name); //will return NULL if option_name is NULL
if (option_line == NULL)
{
//not an option line, copy to dest
fprintf(update, "%s", line);
if (option_name)
free(option_name);
continue;
}
// opt file has an entry for it, take that one
fprintf(update, "%s", option_line);
free(option_line);
free(option_name);
}
fclose(xml);
fclose(opt);
fclose(update);
free(opt_filename);
if ( remove(xml_filename) == -1 )
{
LOG("popnhax: config_update_xml: cannot remove %s (%d)\n", xml_filename, errno);
return false;
}
if ( rename("update.xml.tmp",xml_filename) == -1 )
{
LOG("popnhax: config_update_xml: cannot rename update.xml.tmp (%d)\n", errno);
return false;
}
return true;
}
//regen .opt file (comprised of disclaimer, crc, and all options from xml)
static bool config_make_opt(const char *xml_filename){
uint32_t crc = 0;
long charcnt = 0;
if ( crc32file(xml_filename, &crc, &charcnt) == false )
{
LOG("Cannot compute %s CRC-32\n", xml_filename);
return false;
}
FILE *xml = fopen(xml_filename, "r");
if ( xml == NULL )
{
LOG("popnhax: config update: cannot open config xml file\n");
return false;
}
char *opt_filename = get_opt_filename(xml_filename);
FILE *opt = fopen(opt_filename, "w");
free(opt_filename);
if ( opt == NULL )
{
LOG("popnhax: config update: cannot create config opt file\n");
free(opt_filename);
fclose(xml);
return false;
}
fprintf(opt, "<!-- GENERATED BY POPNHAX. DO NOT EDIT THIS FILE -->\n");
fprintf(opt, "<!-- %08X -->\n", crc);
char line[256];
while (fgets(line, 256, xml))
{
char *ptr = line;
while ( *ptr == ' ' || *ptr == '\t' )
ptr++;
if ( *ptr != '<' )
continue;
if ( *(ptr+1) == '!' )
continue;
fprintf(opt, "%s", line);
}
fclose(opt);
fclose(xml);
return true;
}
// take care of updating .xml/.opt files if needed
bool config_process(const char *xml_filepath){
// look for _update marker file
if ( config_need_update() )
{
//update xml with values from opt
LOG("popnhax: config update: popnhax update detected. Updating xml with your previous settings\n");
config_update_xml(xml_filepath);
remove("_update");
} else if ( config_check_crc(xml_filepath) ) {
LOG("popnhax: config update: nothing to do.\n");
return true;
}
// regen opt from xml file
LOG("popnhax: config update: xml has changed. Regenerating opt file\n");
bool res = config_make_opt(xml_filepath);
return res;
}

View File

@ -34,8 +34,6 @@ struct popnhax_config {
bool local_favorites;
bool patch_db;
bool disable_expansions;
bool disable_redirection;
bool disable_multiboot;
bool patch_xml_auto;
bool ignore_music_limit;
@ -48,16 +46,12 @@ struct popnhax_config {
int8_t beam_brightness;
bool fps_uncap;
bool disable_translation;
bool translation_debug;
bool enhanced_polling;
uint8_t debounce;
bool enhanced_polling_stats;
int8_t enhanced_polling_priority;
uint8_t hispeed_auto;
uint16_t hispeed_default_bpm;
uint8_t survival_gauge;
bool survival_iidx;
bool survival_spicy;
int8_t base_offset;
char custom_category_title[16];
char custom_category_format[64];
@ -68,6 +62,16 @@ struct popnhax_config {
bool high_framerate;
bool high_framerate_limiter;
uint16_t high_framerate_fps;
/* removed/hidden */
bool disable_expansions;
bool disable_redirection;
uint8_t survival_gauge;
bool survival_iidx;
bool survival_spicy;
bool translation_debug;
};
bool config_process(const char *filepath); // take care of updating .xml/.opt files if needed
#endif

View File

@ -36,7 +36,7 @@
#define PROGRAM_VERSION "1.12.dev"
const char *g_game_dll_fn = NULL;
const char *g_config_fn = NULL;
char *g_config_fn = NULL;
FILE *g_log_fp = NULL;
@ -7837,10 +7837,18 @@ BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserv
LOG("popnhax: config file: %s\n",g_config_fn);
if ( !config_process(g_config_fn) )
{
LOG("FATAL ERROR: Could not pre-process config file\n");
exit(0);
}
strcpy(g_config_fn+strlen(g_config_fn)-3, "opt");
if (!_load_config(g_config_fn, &config, config_psmap))
{
LOG("FATAL ERROR: Could not parse %s\n", g_config_fn);
return FALSE;
exit(0);
}
config.game_version = game_version;

View File

@ -1,8 +1,8 @@
libs += util
srcpp_util := \
fuzzy_search.cc \
bst.cc \
search.cc \
cmdline.cc \
patch.cc \
crc32.cc \

160
util/crc32.cc Normal file
View File

@ -0,0 +1,160 @@
/* Crc - 32 BIT ANSI X3.66 CRC checksum files */
#include <stdio.h>
#include "crc32.h"
/**********************************************************************\
|* Demonstration program to compute the 32-bit CRC used as the frame *|
|* check sequence in ADCCP (ANSI X3.66, also known as FIPS PUB 71 *|
|* and FED-STD-1003, the U.S. versions of CCITT's X.25 link-level *|
|* protocol). The 32-bit FCS was added via the Federal Register, *|
|* 1 June 1982, p.23798. I presume but don't know for certain that *|
|* this polynomial is or will be included in CCITT V.41, which *|
|* defines the 16-bit CRC (often called CRC-CCITT) polynomial. FIPS *|
|* PUB 78 says that the 32-bit FCS reduces otherwise undetected *|
|* errors by a factor of 10^-5 over 16-bit FCS. *|
\**********************************************************************/
/* Need an unsigned type capable of holding 32 bits; */
typedef uint32_t UNS_32_BITS;
/* Copyright (C) 1986 Gary S. Brown. You may use this program, or
code or tables extracted from it, as desired without restriction.*/
/* First, the polynomial itself and its table of feedback terms. The */
/* polynomial is */
/* X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X^1+X^0 */
/* Note that we take it "backwards" and put the highest-order term in */
/* the lowest-order bit. The X^32 term is "implied"; the LSB is the */
/* X^31 term, etc. The X^0 term (usually shown as "+1") results in */
/* the MSB being 1. */
/* Note that the usual hardware shift register implementation, which */
/* is what we're using (we're merely optimizing it by doing eight-bit */
/* chunks at a time) shifts bits into the lowest-order term. In our */
/* implementation, that means shifting towards the right. Why do we */
/* do it this way? Because the calculated CRC must be transmitted in */
/* order from highest-order term to lowest-order term. UARTs transmit */
/* characters in order from LSB to MSB. By storing the CRC this way, */
/* we hand it to the UART in the order low-byte to high-byte; the UART */
/* sends each low-bit to hight-bit; and the result is transmission bit */
/* by bit from highest- to lowest-order term without requiring any bit */
/* shuffling on our part. Reception works similarly. */
/* The feedback terms table consists of 256, 32-bit entries. Notes: */
/* */
/* 1. The table can be generated at runtime if desired; code to do so */
/* is shown later. It might not be obvious, but the feedback */
/* terms simply represent the results of eight shift/xor opera- */
/* tions for all combinations of data and CRC register values. */
/* */
/* 2. The CRC accumulation logic is the same for all CRC polynomials, */
/* be they sixteen or thirty-two bits wide. You simply choose the */
/* appropriate table. Alternatively, because the table can be */
/* generated at runtime, you can start by generating the table for */
/* the polynomial in question and use exactly the same "updcrc", */
/* if your application needn't simultaneously handle two CRC */
/* polynomials. (Note, however, that XMODEM is strange.) */
/* */
/* 3. For 16-bit CRCs, the table entries need be only 16 bits wide; */
/* of course, 32-bit entries work OK if the high 16 bits are zero. */
/* */
/* 4. The values must be right-shifted by eight bits by the "updcrc" */
/* logic; the shift must be unsigned (bring in zeroes). On some */
/* hardware you could probably optimize the shift in assembler by */
/* using byte-swap instructions. */
static UNS_32_BITS crc_32_tab[] = { /* CRC polynomial 0xedb88320 */
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
};
uint32_t updateCRC32(unsigned char ch, uint32_t crc)
{
return UPDC32(ch, crc);
}
bool crc32file(const char *name, uint32_t *crc, long *charcnt)
{
register FILE *fin;
register uint32_t oldcrc32;
register int c;
oldcrc32 = 0xFFFFFFFF; *charcnt = 0;
if ((fin=fopen(name, "r"))==NULL)
{
perror(name);
return false;
}
while ((c=getc(fin))!=EOF)
{
++*charcnt;
oldcrc32 = UPDC32(c, oldcrc32);
}
if (ferror(fin))
{
perror(name);
*charcnt = -1;
}
fclose(fin);
*crc = oldcrc32 = ~oldcrc32;
return true;
}
uint32_t crc32buf(char *buf, size_t len)
{
register uint32_t oldcrc32;
oldcrc32 = 0xFFFFFFFF;
for ( ; len; --len, ++buf)
{
oldcrc32 = UPDC32(*buf, oldcrc32);
}
return ~oldcrc32;
}

16
util/crc32.h Normal file
View File

@ -0,0 +1,16 @@
/* taken from https://github.com/panzi/CRC-and-checksum-functions/ */
#ifndef __CRC32_H__
#define __CRC32_H__
#include <stdlib.h> /* For size_t */
#include <stdint.h> /* For uint8_t, uint16_t, uint32_t */
#include <stdbool.h> /* For bool, true, false */
#define UPDC32(octet,crc) (crc_32_tab[((crc)\
^ ((uint8_t)octet)) & 0xff] ^ ((crc) >> 8))
uint32_t updateCRC32(unsigned char ch, uint32_t crc);
bool crc32file(const char *name, uint32_t *crc, long *charcnt);
uint32_t crc32buf(char *buf, size_t len);
#endif

View File

@ -1,62 +0,0 @@
#include <memory.h>
#include <stdint.h>
#include "util/fuzzy_search.h"
int find_block_core(char *haystack, size_t haystack_size, fuzzy_search_task *needle,
size_t orig_offset, int dir) {
size_t offset = orig_offset;
haystack_size += orig_offset;
while (offset + 1 < haystack_size) {
size_t offset_temp = offset;
int found = 1;
if (needle->count <= 0) {
found = 0;
}
for (int i = 0; i < needle->count; i++) {
int subfound = -1;
if (needle->blocks[i].type == 1) {
offset_temp += needle->blocks[i].length;
continue;
}
for (int j = 0; j < needle->blocks[i].count; j++) {
if (haystack + offset_temp + needle->blocks[i].data[j].length <
haystack + haystack_size &&
memcmp(haystack + offset_temp, needle->blocks[i].data[j].block,
needle->blocks[i].data[j].length) == 0) {
subfound = j;
break;
}
}
if (subfound == -1) {
found = 0;
break;
}
offset_temp += needle->blocks[i].data[subfound].length;
}
if (found == 1) {
return offset;
} else {
offset += dir;
}
}
return -1;
}
int find_block(char *haystack, size_t haystack_size, fuzzy_search_task *needle,
size_t orig_offset) {
return find_block_core(haystack, haystack_size, needle, orig_offset, 1);
}
int find_block_back(char *haystack, size_t haystack_size, fuzzy_search_task *needle,
size_t orig_offset) {
return find_block_core(haystack, haystack_size, needle, orig_offset, -1);
}

View File

@ -1,53 +0,0 @@
#ifndef __FUZZY_SEARCH_H__
#define __FUZZY_SEARCH_H__
#include <stddef.h>
#define FUZZY_START(task, _count) \
{ \
task.count = _count; \
task.blocks = (fuzzy_search_block *)calloc(task.count, sizeof(fuzzy_search_block)); \
}
#define FUZZY_CODE(task, id, code, len) \
{ \
task.blocks[id].count = 1; \
task.blocks[id].data[0].type = 0; \
task.blocks[id].data[0].length = len; \
task.blocks[id].data[0].block = \
(char *)calloc(task.blocks[id].data[0].length, sizeof(char)); \
memcpy(task.blocks[id].data[0].block, code, task.blocks[id].data[0].length); \
}
#define FUZZY_WILDCARD(task, id, len) \
{ \
task.blocks[id].count = 1; \
task.blocks[id].type = 1; \
task.blocks[id].length = len; \
task.blocks[id].data[0].length = len; \
}
#define FUZZY_SIZE(task, id) (task.blocks[id].data[0].length)
typedef struct fuzzy_search_block_data {
int type;
int length;
char *block;
} fuzzy_search_block_data;
typedef struct fuzzy_search_block {
int type;
int length;
int count;
fuzzy_search_block_data data[0x10];
} fuzzy_search_block;
typedef struct fuzzy_search_task {
int count;
fuzzy_search_block *blocks;
} fuzzy_search_task;
int find_block(char *haystack, size_t haystack_size, fuzzy_search_task *needle, size_t offset);
int find_block_back(char *haystack, size_t haystack_size, fuzzy_search_task *needle, size_t offset);
#endif