// Copyright (c) Hercules Dev Team, licensed under GNU GPL. // See the LICENSE file // Portions Copyright (c) Athena Dev Teams #include "../common/cbasetypes.h" #include "../common/des.h" #include "../common/malloc.h" #include "../common/showmsg.h" #include "../common/strlib.h" #include "../common/utils.h" #include "../common/nullpo.h" #include "grfio.h" #include #include #include #include #include //---------------------------- // file entry table struct //---------------------------- typedef struct _FILELIST { int srclen; ///< compressed size int srclen_aligned; int declen; ///< original size int srcpos; ///< position of entry in grf int next; ///< index of next filelist entry with same hash (-1: end of entry chain) char type; char fn[128-4*5]; ///< file name char *fnd; ///< if the file was cloned, contains name of original file int8 gentry; ///< read grf file select } FILELIST; #define FILELIST_TYPE_FILE 0x01 // entry is a file #define FILELIST_TYPE_ENCRYPT_HEADER 0x04 // encryption mode 1 (header DES only) #define FILELIST_TYPE_ENCRYPT_MIXED 0x02 // encryption mode 0 (header DES + periodic DES/shuffle) //gentry ... > 0 : data read from a grf file (gentry_table[gentry-1]) //gentry ... 0 : data read from a local file (data directory) //gentry ... < 0 : entry "-(gentry)" is marked for a local file check // - if local file exists, gentry will be set to 0 (thus using the local file) // - if local file doesn't exist, sign is inverted (thus using the original file inside a grf) // (NOTE: this case is only used once (during startup) and only if GRFIO_LOCAL is enabled) // (NOTE: probably meant to be used to override grf contents by files in the data directory) //#define GRFIO_LOCAL // stores info about every loaded file FILELIST* filelist = NULL; int filelist_entrys = 0; int filelist_maxentry = 0; // stores grf file names char** gentry_table = NULL; int gentry_entrys = 0; int gentry_maxentry = 0; // the path to the data directory char data_dir[1024] = ""; // little endian char array to uint conversion static unsigned int getlong(unsigned char* p) { return (p[0] << 0 | p[1] << 8 | p[2] << 16 | p[3] << 24); } static void NibbleSwap(unsigned char* src, int len) { while( len > 0 ) { *src = (*src >> 4) | (*src << 4); ++src; --len; } } /// Substitutes some specific values for others, leaves rest intact. Obfuscation. /// NOTE: Operation is symmetric (calling it twice gives back the original input). static uint8_t grf_substitution(uint8_t in) { uint8_t out; switch( in ) { case 0x00: out = 0x2B; break; case 0x2B: out = 0x00; break; case 0x6C: out = 0x80; break; case 0x01: out = 0x68; break; case 0x68: out = 0x01; break; case 0x48: out = 0x77; break; case 0x60: out = 0xFF; break; case 0x77: out = 0x48; break; case 0xB9: out = 0xC0; break; case 0xC0: out = 0xB9; break; case 0xFE: out = 0xEB; break; case 0xEB: out = 0xFE; break; case 0x80: out = 0x6C; break; case 0xFF: out = 0x60; break; default: out = in; break; } return out; } /* this is not used anywhere, is it ok to delete? */ //static void grf_shuffle_enc(BIT64* src) { // BIT64 out; // // out.b[0] = src->b[3]; // out.b[1] = src->b[4]; // out.b[2] = src->b[5]; // out.b[3] = src->b[0]; // out.b[4] = src->b[1]; // out.b[5] = src->b[6]; // out.b[6] = src->b[2]; // out.b[7] = grf_substitution(src->b[7]); // // *src = out; //} static void grf_shuffle_dec(BIT64* src) { BIT64 out; out.b[0] = src->b[3]; out.b[1] = src->b[4]; out.b[2] = src->b[6]; out.b[3] = src->b[0]; out.b[4] = src->b[1]; out.b[5] = src->b[2]; out.b[6] = src->b[5]; out.b[7] = grf_substitution(src->b[7]); *src = out; } static void grf_decode_header(unsigned char* buf, size_t len) { BIT64* p = (BIT64*)buf; size_t nblocks = len / sizeof(BIT64); size_t i; // first 20 blocks are all des-encrypted for( i = 0; i < 20 && i < nblocks; ++i ) des_decrypt_block(&p[i]); // the rest is plaintext, done. } static void grf_decode_full(unsigned char* buf, size_t len, int cycle) { BIT64* p = (BIT64*)buf; size_t nblocks = len / sizeof(BIT64); int dcycle, scycle; size_t i, j; // first 20 blocks are all des-encrypted for( i = 0; i < 20 && i < nblocks; ++i ) des_decrypt_block(&p[i]); // after that only one of every 'dcycle' blocks is des-encrypted dcycle = cycle; // and one of every 'scycle' plaintext blocks is shuffled (starting from the 0th but skipping the 0th) scycle = 7; // so decrypt/de-shuffle periodically j = (size_t)-1; // 0, adjusted to fit the ++j step for( i = 20; i < nblocks; ++i ) { if( i % dcycle == 0 ) {// decrypt block des_decrypt_block(&p[i]); continue; } ++j; if( j % scycle == 0 && j != 0 ) {// de-shuffle block grf_shuffle_dec(&p[i]); continue; } // plaintext, do nothing. } } /// Decodes grf data. /// @param buf data to decode (in-place) /// @param len length of the data /// @param entry_type flags associated with the data /// @param entry_len true (unaligned) length of the data static void grf_decode(unsigned char* buf, size_t len, char entry_type, int entry_len) { if( entry_type & FILELIST_TYPE_ENCRYPT_MIXED ) {// fully encrypted int digits; int cycle; int i; // compute number of digits of the entry length digits = 1; for( i = 10; i <= entry_len; i *= 10 ) ++digits; // choose size of gap between two encrypted blocks // digits: 0 1 2 3 4 5 6 7 8 9 ... // cycle: 1 1 1 4 5 14 15 22 23 24 ... cycle = ( digits < 3 ) ? 1 : ( digits < 5 ) ? digits + 1 : ( digits < 7 ) ? digits + 9 : digits + 15; grf_decode_full(buf, len, cycle); } else if( entry_type & FILELIST_TYPE_ENCRYPT_HEADER ) {// header encrypted grf_decode_header(buf, len); } else {// plaintext ; } } /****************************************************** *** Zlib Subroutines *** ******************************************************/ /// zlib crc32 unsigned long grfio_crc32(const unsigned char* buf, unsigned int len) { return crc32(crc32(0L, Z_NULL, 0), buf, len); } /// zlib uncompress int decode_zip(void* dest, unsigned long* destLen, const void* source, unsigned long sourceLen) { return uncompress((Bytef*)dest, destLen, (const Bytef*)source, sourceLen); } /// zlib compress int encode_zip(void* dest, unsigned long* destLen, const void* source, unsigned long sourceLen) { if( *destLen == 0 ) /* [Ind/Hercules] */ *destLen = compressBound(sourceLen); if( dest == NULL ) { /* [Ind/Hercules] */ CREATE(dest, unsigned char, *destLen); } return compress((Bytef*)dest, destLen, (const Bytef*)source, sourceLen); } /*********************************************************** *** File List Subroutines *** ***********************************************************/ // file list hash table int filelist_hash[256]; // initializes the table that holds the first elements of all hash chains static void hashinit(void) { int i; for (i = 0; i < 256; i++) filelist_hash[i] = -1; } // hashes a filename string into a number from {0..255} static int filehash(const char* fname) { unsigned int hash = 0; while(*fname) { hash = (hash<<1) + (hash>>7)*9 + TOLOWER(*fname); fname++; } return hash & 255; } // finds a FILELIST entry with the specified file name static FILELIST* filelist_find(const char* fname) { int hash, index; if (!filelist) return NULL; hash = filelist_hash[filehash(fname)]; for (index = hash; index != -1; index = filelist[index].next) if(!strcmpi(filelist[index].fn, fname)) break; return (index >= 0) ? &filelist[index] : NULL; } // returns the original file name char* grfio_find_file(const char* fname) { FILELIST *flist = filelist_find(fname); if (!flist) return NULL; return (!flist->fnd ? flist->fn : flist->fnd); } // adds a FILELIST entry into the list of loaded files static FILELIST* filelist_add(FILELIST* entry) { int hash; nullpo_ret(entry); #ifdef __clang_analyzer__ // Make clang's static analyzer shut up about a possible NULL pointer in &filelist[filelist_entrys] nullpo_ret(&filelist[filelist_entrys]); #endif // __clang_analyzer__ #define FILELIST_ADDS 1024 // number increment of file lists ` if (filelist_entrys >= filelist_maxentry) { filelist = (FILELIST *)aRealloc(filelist, (filelist_maxentry + FILELIST_ADDS) * sizeof(FILELIST)); memset(filelist + filelist_maxentry, '\0', FILELIST_ADDS * sizeof(FILELIST)); filelist_maxentry += FILELIST_ADDS; } #undef FILELIST_ADDS memcpy(&filelist[filelist_entrys], entry, sizeof(FILELIST)); hash = filehash(entry->fn); filelist[filelist_entrys].next = filelist_hash[hash]; filelist_hash[hash] = filelist_entrys; filelist_entrys++; return &filelist[filelist_entrys - 1]; } // adds a new FILELIST entry or overwrites an existing one static FILELIST* filelist_modify(FILELIST* entry) { FILELIST* fentry = filelist_find(entry->fn); if (fentry != NULL) { int tmp = fentry->next; memcpy(fentry, entry, sizeof(FILELIST)); fentry->next = tmp; } else { fentry = filelist_add(entry); } return fentry; } // shrinks the file list array if too long static void filelist_compact(void) { if (filelist == NULL) return; if (filelist_entrys < filelist_maxentry) { filelist = (FILELIST *)aRealloc(filelist, filelist_entrys * sizeof(FILELIST)); filelist_maxentry = filelist_entrys; } } /*********************************************************** *** Grfio Subroutines *** ***********************************************************/ /// Combines are resource path with the data folder location to create local resource path. static void grfio_localpath_create(char* buffer, size_t size, const char* filename) { unsigned int i; size_t len; len = strlen(data_dir); if( data_dir[0] == '\0' || data_dir[len-1] == '/' || data_dir[len-1] == '\\' ) { safesnprintf(buffer, size, "%s%s", data_dir, filename); } else { safesnprintf(buffer, size, "%s/%s", data_dir, filename); } // normalize path for( i = 0; buffer[i] != '\0'; ++i ) if( buffer[i] == '\\' ) buffer[i] = '/'; } /// Reads a file into a newly allocated buffer (from grf or data directory). void* grfio_reads(const char* fname, int* size) { unsigned char* buf2 = NULL; FILELIST* entry = filelist_find(fname); if( entry == NULL || entry->gentry <= 0 ) {// LocalFileCheck char lfname[256]; FILE* in; grfio_localpath_create(lfname, sizeof(lfname), ( entry && entry->fnd ) ? entry->fnd : fname); in = fopen(lfname, "rb"); if( in != NULL ) { int declen; fseek(in,0,SEEK_END); declen = (int)ftell(in); fseek(in,0,SEEK_SET); buf2 = (unsigned char *)aMalloc(declen+1); // +1 for resnametable zero-termination if(fread(buf2, 1, declen, in) != (size_t)declen) ShowError("An error occured in fread grfio_reads, fname=%s \n",fname); fclose(in); if( size ) *size = declen; } else { if (entry != NULL && entry->gentry < 0) { entry->gentry = -entry->gentry; // local file checked } else { ShowError("grfio_reads: %s not found (local file: %s)\n", fname, lfname); return NULL; } } } if( entry != NULL && entry->gentry > 0 ) {// Archive[GRF] File Read char* grfname = gentry_table[entry->gentry - 1]; FILE* in = fopen(grfname, "rb"); if( in != NULL ) { int fsize = entry->srclen_aligned; unsigned char *buf = (unsigned char *)aMalloc(fsize); fseek(in, entry->srcpos, 0); if(fread(buf, 1, fsize, in) != (size_t)fsize) ShowError("An error occured in fread in grfio_reads, grfname=%s\n",grfname); fclose(in); buf2 = (unsigned char *)aMalloc(entry->declen+1); // +1 for resnametable zero-termination if( entry->type & FILELIST_TYPE_FILE ) {// file uLongf len; grf_decode(buf, fsize, entry->type, entry->srclen); len = entry->declen; decode_zip(buf2, &len, buf, entry->srclen); if (len != (uLong)entry->declen) { ShowError("decode_zip size mismatch err: %d != %d\n", (int)len, entry->declen); aFree(buf); aFree(buf2); return NULL; } } else {// directory? memcpy(buf2, buf, entry->declen); } if( size ) *size = entry->declen; aFree(buf); } else { ShowError("grfio_reads: %s not found (GRF file: %s)\n", fname, grfname); return NULL; } } return buf2; } /// Decodes encrypted filename from a version 01xx grf index. static char* decode_filename(unsigned char* buf, int len) { int lop; for(lop=0;lop> 8; if( grf_version == 0x01 ) {// ****** Grf version 01xx ****** long list_size; list_size = grf_size - ftell(fp); grf_filelist = (unsigned char *) aMalloc(list_size); if(fread(grf_filelist,1,list_size,fp) != (size_t)list_size) { ShowError("Couldn't read all grf_filelist element of %s \n", grfname); } fclose(fp); entrys = getlong(grf_header+0x26) - getlong(grf_header+0x22) - 7; // Get an entry for( entry = 0, ofs = 0; entry < entrys; ++entry ) { FILELIST aentry; int ofs2 = ofs+getlong(grf_filelist+ofs)+4; unsigned char type = grf_filelist[ofs2+12]; if( type & FILELIST_TYPE_FILE ) { char* fname = decode_filename(grf_filelist+ofs+6, grf_filelist[ofs]-6); int srclen = getlong(grf_filelist+ofs2+0) - getlong(grf_filelist+ofs2+8) - 715; if( strlen(fname) > sizeof(aentry.fn) - 1 ) { ShowFatalError("GRF file name %s is too long\n", fname); aFree(grf_filelist); exit(EXIT_FAILURE); } type |= ( isFullEncrypt(fname) ) ? FILELIST_TYPE_ENCRYPT_MIXED : FILELIST_TYPE_ENCRYPT_HEADER; aentry.srclen = srclen; aentry.srclen_aligned = getlong(grf_filelist+ofs2+4)-37579; aentry.declen = getlong(grf_filelist+ofs2+8); aentry.srcpos = getlong(grf_filelist+ofs2+13)+0x2e; aentry.type = type; safestrncpy(aentry.fn, fname, sizeof(aentry.fn)); aentry.fnd = NULL; #ifdef GRFIO_LOCAL aentry.gentry = -(gentry+1); // As Flag for making it a negative number carrying out the first time LocalFileCheck #else aentry.gentry = (char)(gentry+1); // With no first time LocalFileCheck #endif filelist_modify(&aentry); } ofs = ofs2 + 17; } aFree(grf_filelist); } else if( grf_version == 0x02 ) {// ****** Grf version 02xx ****** unsigned char eheader[8]; unsigned char *rBuf; uLongf rSize, eSize; if(fread(eheader,1,8,fp) != 8) ShowError("An error occured in fread while reading eheader buffer\n"); rSize = getlong(eheader); // Read Size eSize = getlong(eheader+4); // Extend Size if( (long)rSize > grf_size-ftell(fp) ) { fclose(fp); ShowError("Illegal data format: GRF compress entry size\n"); return 4; } rBuf = (unsigned char *)aMalloc(rSize); // Get a Read Size grf_filelist = (unsigned char *)aMalloc(eSize); // Get a Extend Size if(fread(rBuf,1,rSize,fp) != rSize) ShowError("An error occured in fread \n"); fclose(fp); decode_zip(grf_filelist, &eSize, rBuf, rSize); // Decode function aFree(rBuf); entrys = getlong(grf_header+0x26) - 7; // Get an entry for( entry = 0, ofs = 0; entry < entrys; ++entry ) { FILELIST aentry; char* fname = (char*)(grf_filelist+ofs); int ofs2 = ofs + (int)strlen(fname)+1; int type = grf_filelist[ofs2+12]; if( strlen(fname) > sizeof(aentry.fn)-1 ) { ShowFatalError("GRF file name %s is too long\n", fname); aFree(grf_filelist); exit(EXIT_FAILURE); } if( type & FILELIST_TYPE_FILE ) {// file aentry.srclen = getlong(grf_filelist+ofs2+0); aentry.srclen_aligned = getlong(grf_filelist+ofs2+4); aentry.declen = getlong(grf_filelist+ofs2+8); aentry.srcpos = getlong(grf_filelist+ofs2+13)+0x2e; aentry.type = (char)type; safestrncpy(aentry.fn, fname, sizeof(aentry.fn)); aentry.fnd = NULL; #ifdef GRFIO_LOCAL aentry.gentry = -(gentry+1); // As Flag for making it a negative number carrying out the first time LocalFileCheck #else aentry.gentry = (char)(gentry+1); // With no first time LocalFileCheck #endif filelist_modify(&aentry); } ofs = ofs2 + 17; } aFree(grf_filelist); } else {// ****** Grf Other version ****** fclose(fp); ShowError("GRF version %04x not supported\n",getlong(grf_header+0x2a)); return 4; } filelist_compact(); // Unnecessary area release of filelist return 0; // 0:no error } static bool grfio_parse_restable_row(const char* row) { char w1[256], w2[256]; char src[256], dst[256]; char local[256]; FILELIST* entry; if( sscanf(row, "%[^#\r\n]#%[^#\r\n]#", w1, w2) != 2 ) return false; if( strstr(w2, ".gat") == NULL && strstr(w2, ".rsw") == NULL ) return false; // we only need the maps' GAT and RSW files sprintf(src, "data\\%s", w1); sprintf(dst, "data\\%s", w2); entry = filelist_find(dst); if( entry != NULL ) {// alias for GRF resource FILELIST fentry; memcpy(&fentry, entry, sizeof(FILELIST)); safestrncpy(fentry.fn, src, sizeof(fentry.fn)); fentry.fnd = aStrdup(dst); filelist_modify(&fentry); return true; } grfio_localpath_create(local, sizeof(local), dst); if( exists(local) ) {// alias for local resource FILELIST fentry; memset(&fentry, 0, sizeof(fentry)); safestrncpy(fentry.fn, src, sizeof(fentry.fn)); fentry.fnd = aStrdup(dst); filelist_modify(&fentry); return true; } return false; } /// Grfio Resource file check. static void grfio_resourcecheck(void) { char restable[256]; char *buf; int size; FILE* fp; int i = 0; // read resnametable from data directory and return if successful grfio_localpath_create(restable, sizeof(restable), "data\\resnametable.txt"); fp = fopen(restable, "rb"); if( fp != NULL ) { char line[256]; while( fgets(line, sizeof(line), fp) ) { if( grfio_parse_restable_row(line) ) ++i; } fclose(fp); ShowStatus("Done reading '"CL_WHITE"%d"CL_RESET"' entries in '"CL_WHITE"%s"CL_RESET"'.\n", i, "resnametable.txt"); return; // we're done here! } // read resnametable from loaded GRF's, only if it cannot be loaded from the data directory buf = (char *)grfio_reads("data\\resnametable.txt", &size); if( buf != NULL ) { char *ptr; buf[size] = '\0'; ptr = buf; while( ptr - buf < size ) { if( grfio_parse_restable_row(ptr) ) ++i; ptr = strchr(ptr, '\n'); if( ptr == NULL ) break; ptr++; } aFree(buf); ShowStatus("Done reading '"CL_WHITE"%d"CL_RESET"' entries in '"CL_WHITE"%s"CL_RESET"'.\n", i, "data\\resnametable.txt"); return; } } /// Reads a grf file and adds it to the list. static int grfio_add(const char* fname) { if( gentry_entrys >= gentry_maxentry ) { #define GENTRY_ADDS 4 // The number increment of gentry_table entries gentry_maxentry += GENTRY_ADDS; gentry_table = (char**)aRealloc(gentry_table, gentry_maxentry * sizeof(char*)); memset(gentry_table + (gentry_maxentry - GENTRY_ADDS), 0, sizeof(char*) * GENTRY_ADDS); } gentry_table[gentry_entrys++] = aStrdup(fname); return grfio_entryread(fname, gentry_entrys - 1); } /// Finalizes grfio. void grfio_final(void) { if (filelist != NULL) { int i; for (i = 0; i < filelist_entrys; i++) if (filelist[i].fnd != NULL) aFree(filelist[i].fnd); aFree(filelist); filelist = NULL; } filelist_entrys = filelist_maxentry = 0; if (gentry_table != NULL) { int i; for (i = 0; i < gentry_entrys; i++) if (gentry_table[i] != NULL) aFree(gentry_table[i]); aFree(gentry_table); gentry_table = NULL; } gentry_entrys = gentry_maxentry = 0; } /// Initializes grfio. void grfio_init(const char* fname) { FILE* data_conf; int grf_num = 0; hashinit(); // hash table initialization data_conf = fopen(fname, "r"); if( data_conf != NULL ) { char line[1024]; while( fgets(line, sizeof(line), data_conf) ) { char w1[1024], w2[1024]; if( line[0] == '/' && line[1] == '/' ) continue; // skip comments if( sscanf(line, "%[^:]: %[^\r\n]", w1, w2) != 2 ) continue; // skip unrecognized lines // Entry table reading if( strcmp(w1, "grf") == 0 ) // GRF file { if( grfio_add(w2) == 0 ) ++grf_num; } else if( strcmp(w1,"data_dir") == 0 ) // Data directory { safestrncpy(data_dir, w2, sizeof(data_dir)); } } fclose(data_conf); ShowStatus("Done reading '"CL_WHITE"%s"CL_RESET"'.\n", fname); } if( grf_num == 0 ) ShowInfo("No GRF loaded, using default data directory\n"); // Unneccessary area release of filelist filelist_compact(); // Resource check grfio_resourcecheck(); }