X-Git-Url: http://de.git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=fs.c;h=0782cf52bdb26ca8bba15ce4ebc3da9ace1f4f5c;hp=b7b74d92f54415775661954c7da8d969ee0123a5;hb=66e2a20b4a20d03de1098a3c76186cb0ce316f21;hpb=62bc56e9c2d45afe69ba3f1ebb87f40d5753eeab diff --git a/fs.c b/fs.c index b7b74d92..0782cf52 100644 --- a/fs.c +++ b/fs.c @@ -30,6 +30,7 @@ #ifdef WIN32 # include # include +# include #else # include # include @@ -37,6 +38,7 @@ #endif #include "fs.h" +#include "wad.h" // Win32 requires us to add O_BINARY, but the other OSes don't have it #ifndef O_BINARY @@ -48,8 +50,23 @@ # define O_NONBLOCK 0 #endif +// largefile support for Win32 +#ifdef WIN32 +# define lseek _lseeki64 +#endif -/* +#if _MSC_VER >= 1400 +// suppress deprecated warnings +# include +# include +# define read _read +# define write _write +# define close _close +# define unlink _unlink +# define dup _dup +#endif + +/** \page fs File System All of Quake's data access is through a hierchal file system, but the contents of the file system can be transparently merged from several sources. @@ -94,8 +111,23 @@ CONSTANTS #define MAX_WBITS 15 #define Z_OK 0 #define Z_STREAM_END 1 +#define Z_STREAM_ERROR (-2) +#define Z_DATA_ERROR (-3) +#define Z_MEM_ERROR (-4) +#define Z_BUF_ERROR (-5) #define ZLIB_VERSION "1.2.3" +#define Z_BINARY 0 +#define Z_DEFLATED 8 +#define Z_MEMLEVEL_DEFAULT 8 + +#define Z_NULL 0 +#define Z_DEFAULT_COMPRESSION (-1) +#define Z_NO_FLUSH 0 +#define Z_SYNC_FLUSH 2 +#define Z_FULL_FLUSH 3 +#define Z_FINISH 4 + // Uncomment the following line if the zlib DLL you have still uses // the 1.1.x series calling convention on Win32 (WINAPI) //#define ZLIB_USES_WINAPI @@ -109,62 +141,66 @@ TYPES ============================================================================= */ -// Zlib stream (from zlib.h) -// Warning: some pointers we don't use directly have -// been cast to "void*" for a matter of simplicity +/*! Zlib stream (from zlib.h) + * \warning: some pointers we don't use directly have + * been cast to "void*" for a matter of simplicity + */ typedef struct { - unsigned char *next_in; // next input byte - unsigned int avail_in; // number of bytes available at next_in - unsigned long total_in; // total nb of input bytes read so far + unsigned char *next_in; ///< next input byte + unsigned int avail_in; ///< number of bytes available at next_in + unsigned long total_in; ///< total nb of input bytes read so far - unsigned char *next_out; // next output byte should be put there - unsigned int avail_out; // remaining free space at next_out - unsigned long total_out; // total nb of bytes output so far + unsigned char *next_out; ///< next output byte should be put there + unsigned int avail_out; ///< remaining free space at next_out + unsigned long total_out; ///< total nb of bytes output so far - char *msg; // last error message, NULL if no error - void *state; // not visible by applications + char *msg; ///< last error message, NULL if no error + void *state; ///< not visible by applications - void *zalloc; // used to allocate the internal state - void *zfree; // used to free the internal state - void *opaque; // private data object passed to zalloc and zfree + void *zalloc; ///< used to allocate the internal state + void *zfree; ///< used to free the internal state + void *opaque; ///< private data object passed to zalloc and zfree - int data_type; // best guess about the data type: ascii or binary - unsigned long adler; // adler32 value of the uncompressed data - unsigned long reserved; // reserved for future use + int data_type; ///< best guess about the data type: ascii or binary + unsigned long adler; ///< adler32 value of the uncompressed data + unsigned long reserved; ///< reserved for future use } z_stream; -// inside a package (PAK or PK3) +/// inside a package (PAK or PK3) #define QFILE_FLAG_PACKED (1 << 0) -// file is compressed using the deflate algorithm (PK3 only) +/// file is compressed using the deflate algorithm (PK3 only) #define QFILE_FLAG_DEFLATED (1 << 1) +/// file is actually already loaded data +#define QFILE_FLAG_DATA (1 << 2) #define FILE_BUFF_SIZE 2048 typedef struct { z_stream zstream; - size_t comp_length; // length of the compressed file - size_t in_ind, in_len; // input buffer current index and length - size_t in_position; // position in the compressed file + size_t comp_length; ///< length of the compressed file + size_t in_ind, in_len; ///< input buffer current index and length + size_t in_position; ///< position in the compressed file unsigned char input [FILE_BUFF_SIZE]; } ztoolkit_t; struct qfile_s { int flags; - int handle; // file descriptor - fs_offset_t real_length; // uncompressed file size (for files opened in "read" mode) - fs_offset_t position; // current position in the file - fs_offset_t offset; // offset into the package (0 if external file) - int ungetc; // single stored character from ungetc, cleared to EOF when read + int handle; ///< file descriptor + fs_offset_t real_length; ///< uncompressed file size (for files opened in "read" mode) + fs_offset_t position; ///< current position in the file + fs_offset_t offset; ///< offset into the package (0 if external file) + int ungetc; ///< single stored character from ungetc, cleared to EOF when read // Contents buffer - fs_offset_t buff_ind, buff_len; // buffer current index and length + fs_offset_t buff_ind, buff_len; ///< buffer current index and length unsigned char buff [FILE_BUFF_SIZE]; - // For zipped files - ztoolkit_t* ztk; + ztoolkit_t* ztk; ///< For zipped files. + + const unsigned char *data; ///< For data files. }; @@ -176,11 +212,11 @@ typedef struct pk3_endOfCentralDir_s { unsigned int signature; unsigned short disknum; - unsigned short cdir_disknum; // number of the disk with the start of the central directory - unsigned short localentries; // number of entries in the central directory on this disk - unsigned short nbentries; // total number of entries in the central directory on this disk - unsigned int cdir_size; // size of the central directory - unsigned int cdir_offset; // with respect to the starting disk number + unsigned short cdir_disknum; ///< number of the disk with the start of the central directory + unsigned short localentries; ///< number of entries in the central directory on this disk + unsigned short nbentries; ///< total number of entries in the central directory on this disk + unsigned int cdir_size; ///< size of the central directory + unsigned int cdir_offset; ///< with respect to the starting disk number unsigned short comment_size; } pk3_endOfCentralDir_t; @@ -200,33 +236,37 @@ typedef struct dpackheader_s } dpackheader_t; -// Packages in memory -// the offset in packfile_t is the true contents offset +/*! \name Packages in memory + * @{ + */ +/// the offset in packfile_t is the true contents offset #define PACKFILE_FLAG_TRUEOFFS (1 << 0) -// file compressed using the deflate algorithm +/// file compressed using the deflate algorithm #define PACKFILE_FLAG_DEFLATED (1 << 1) +/// file is a symbolic link +#define PACKFILE_FLAG_SYMLINK (1 << 2) typedef struct packfile_s { char name [MAX_QPATH]; int flags; fs_offset_t offset; - fs_offset_t packsize; // size in the package - fs_offset_t realsize; // real file size (uncompressed) + fs_offset_t packsize; ///< size in the package + fs_offset_t realsize; ///< real file size (uncompressed) } packfile_t; typedef struct pack_s { char filename [MAX_OSPATH]; + char shortname [MAX_QPATH]; int handle; - int ignorecase; // PK3 ignores case + int ignorecase; ///< PK3 ignores case int numfiles; packfile_t *files; - struct pack_s *next; } pack_t; +//@} - -// Search paths for files (including packages) +/// Search paths for files (including packages) typedef struct searchpath_s { // only one of filename / pack will be used @@ -246,8 +286,8 @@ FUNCTION PROTOTYPES void FS_Dir_f(void); void FS_Ls_f(void); +void FS_Which_f(void); -static const char *FS_FileExtension (const char *in); static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet); static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack, fs_offset_t offset, fs_offset_t packsize, @@ -264,18 +304,26 @@ VARIABLES mempool_t *fs_mempool; -pack_t *packlist = NULL; - searchpath_t *fs_searchpaths = NULL; +const char *const fs_checkgamedir_missing = "missing"; #define MAX_FILES_IN_PACK 65536 +char fs_userdir[MAX_OSPATH]; char fs_gamedir[MAX_OSPATH]; char fs_basedir[MAX_OSPATH]; -qboolean fs_modified; // set true if using non-id files +// list of active game directories (empty if not running a mod) +int fs_numgamedirs = 0; +char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH]; + +// list of all gamedirs with modinfo.txt +gamedir_t *fs_all_gamedirs = NULL; +int fs_all_gamedirs_count = 0; -cvar_t scr_screenshot_name = {0, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running)"}; +cvar_t scr_screenshot_name = {CVAR_NORESETTODEFAULTS, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"}; +cvar_t fs_empty_files_in_pack_mark_deletions = {0, "fs_empty_files_in_pack_mark_deletions", "0", "if enabled, empty files in a pak/pk3 count as not existing but cancel the search in further packs, effectively allowing patch pak/pk3 files to 'delete' files"}; +cvar_t cvar_fs_gamedir = {CVAR_READONLY | CVAR_NORESETTODEFAULTS, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"}; /* @@ -297,9 +345,16 @@ static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush); static int (ZEXPORT *qz_inflateEnd) (z_stream* strm); static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size); static int (ZEXPORT *qz_inflateReset) (z_stream* strm); +static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size); +static int (ZEXPORT *qz_deflateEnd) (z_stream* strm); +static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush); #define qz_inflateInit2(strm, windowBits) \ qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) +#define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ + qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream)) + +// qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream)) static dllfunction_t zlibfuncs[] = { @@ -307,12 +362,24 @@ static dllfunction_t zlibfuncs[] = {"inflateEnd", (void **) &qz_inflateEnd}, {"inflateInit2_", (void **) &qz_inflateInit2_}, {"inflateReset", (void **) &qz_inflateReset}, + {"deflateInit2_", (void **) &qz_deflateInit2_}, + {"deflateEnd", (void **) &qz_deflateEnd}, + {"deflate", (void **) &qz_deflate}, {NULL, NULL} }; -// Handle for Zlib DLL +/// Handle for Zlib DLL static dllhandle_t zlib_dll = NULL; +#ifdef WIN32 +static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPTSTR pszPath); +static dllfunction_t shfolderfuncs[] = +{ + {"SHGetFolderPathA", (void **) &qSHGetFolderPath}, + {NULL, NULL} +}; +static dllhandle_t shfolder_dll = NULL; +#endif /* ==================== @@ -361,16 +428,21 @@ qboolean PK3_OpenLibrary (void) return true; // Load the DLL - if (! Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs)) - { - Con_Printf ("Compressed files support disabled\n"); - return false; - } - - Con_Printf ("Compressed files support enabled\n"); - return true; + return Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs); } +/* +==================== +FS_HasZlib + +See if zlib is available +==================== +*/ +qboolean FS_HasZlib(void) +{ + PK3_OpenLibrary(); // to be safe + return (zlib_dll != 0); +} /* ==================== @@ -451,7 +523,11 @@ int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd) // Load the central directory in memory central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size); lseek (pack->handle, eocd->cdir_offset, SEEK_SET); - read (pack->handle, central_dir, eocd->cdir_size); + if(read (pack->handle, central_dir, eocd->cdir_size) != (ssize_t) eocd->cdir_size) + { + Mem_Free (central_dir); + return -1; + } // Extract the files properties // The parsing is done "by hand" because some fields have variable sizes and @@ -483,9 +559,16 @@ int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd) // Check encryption, compression, and attributes // 1st uint8 : general purpose bit flag // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?)) + // + // LordHavoc: bit 3 would be a problem if we were scanning the archive + // but is not a problem in the central directory where the values are + // always real. + // + // bit 3 seems to always be set by the standard Mac OSX zip maker + // // 2nd uint8 : external file attributes // Check bits 3 (file is a directory) and 5 (file is a volume (?)) - if ((ptr[8] & 0x29) == 0 && (ptr[38] & 0x18) == 0) + if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0) { // Still enough bytes for the name? if (remaining < namesize || namesize >= (int)sizeof (*pack->files)) @@ -513,6 +596,18 @@ int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd) offset = BuffLittleLong (&ptr[42]); packsize = BuffLittleLong (&ptr[20]); realsize = BuffLittleLong (&ptr[24]); + + switch(ptr[5]) // C_VERSION_MADE_BY_1 + { + case 3: // UNIX_ + case 2: // VMS_ + case 16: // BEOS_ + if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000) + // can't use S_ISLNK here, as this has to compile on non-UNIX too + flags |= PACKFILE_FLAG_SYMLINK; + break; + } + FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags); } } @@ -546,7 +641,11 @@ pack_t *FS_LoadPackPK3 (const char *packfile) pack_t *pack; int real_nb_files; +#if _MSC_VER >= 1400 + _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE); +#else packhandle = open (packfile, O_RDONLY | O_BINARY); +#endif if (packhandle < 0) return NULL; @@ -583,8 +682,6 @@ pack_t *FS_LoadPackPK3 (const char *packfile) pack->handle = packhandle; pack->numfiles = eocd.nbentries; pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t)); - pack->next = packlist; - packlist = pack; real_nb_files = PK3_BuildFileList (pack, &eocd); if (real_nb_files < 0) @@ -699,7 +796,7 @@ static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack, ============ FS_CreatePath -Only used for FS_Open. +Only used for FS_OpenRealFile. ============ */ void FS_CreatePath (char *path) @@ -744,13 +841,12 @@ void FS_Path_f (void) /* ================= FS_LoadPackPAK - -Takes an explicit (not game tree related) path to a pak file. - -Loads the header and directory, adding the files at the beginning -of the list so they override previous pack files. ================= */ +/*! Takes an explicit (not game tree related) path to a pak file. + *Loads the header and directory, adding the files at the beginning + *of the list so they override previous pack files. + */ pack_t *FS_LoadPackPAK (const char *packfile) { dpackheader_t header; @@ -759,10 +855,19 @@ pack_t *FS_LoadPackPAK (const char *packfile) pack_t *pack; dpackfile_t *info; +#if _MSC_VER >= 1400 + _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE); +#else packhandle = open (packfile, O_RDONLY | O_BINARY); +#endif if (packhandle < 0) return NULL; - read (packhandle, (void *)&header, sizeof(header)); + if(read (packhandle, (void *)&header, sizeof(header)) != sizeof(header)) + { + Con_Printf ("%s is not a packfile\n", packfile); + close(packhandle); + return NULL; + } if (memcmp(header.id, "PACK", 4)) { Con_Printf ("%s is not a packfile\n", packfile); @@ -804,8 +909,6 @@ pack_t *FS_LoadPackPAK (const char *packfile) pack->handle = packhandle; pack->numfiles = 0; pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t)); - pack->next = packlist; - packlist = pack; // parse the directory for (i = 0;i < numpackfiles;i++) @@ -825,18 +928,19 @@ pack_t *FS_LoadPackPAK (const char *packfile) /* ================ FS_AddPack_Fullpath - -Adds the given pack to the search path. -The pack type is autodetected by the file extension. - -Returns true if the file was successfully added to the -search path or if it was already included. - -If keep_plain_dirs is set, the pack will be added AFTER the first sequence of -plain directories. ================ */ -static qboolean FS_AddPack_Fullpath(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs) +/*! Adds the given pack to the search path. + * The pack type is autodetected by the file extension. + * + * Returns true if the file was successfully added to the + * search path or if it was already included. + * + * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of + * plain directories. + * + */ +static qboolean FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qboolean *already_loaded, qboolean keep_plain_dirs) { searchpath_t *search; pack_t *pak = NULL; @@ -864,6 +968,8 @@ static qboolean FS_AddPack_Fullpath(const char *pakfile, qboolean *already_loade if (pak) { + strlcpy(pak->shortname, shortname, sizeof(pak->shortname)); + //Con_DPrintf(" Registered pack with short name %s\n", shortname); if(keep_plain_dirs) { // find the first item whose next one is a pack or NULL @@ -919,17 +1025,17 @@ static qboolean FS_AddPack_Fullpath(const char *pakfile, qboolean *already_loade /* ================ FS_AddPack - -Adds the given pack to the search path and searches for it in the game path. -The pack type is autodetected by the file extension. - -Returns true if the file was successfully added to the -search path or if it was already included. - -If keep_plain_dirs is set, the pack will be added AFTER the first sequence of -plain directories. ================ */ +/*! Adds the given pack to the search path and searches for it in the game path. + * The pack type is autodetected by the file extension. + * + * Returns true if the file was successfully added to the + * search path or if it was already included. + * + * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of + * plain directories. + */ qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs) { char fullpath[MAX_QPATH]; @@ -949,7 +1055,7 @@ qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile); - return FS_AddPack_Fullpath(fullpath, already_loaded, keep_plain_dirs); + return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs); } @@ -963,34 +1069,35 @@ then loads and adds pak1.pak pak2.pak ... */ void FS_AddGameDirectory (const char *dir) { - stringlist_t *list, *current; + int i; + stringlist_t list; searchpath_t *search; - char pakfile[MAX_OSPATH]; strlcpy (fs_gamedir, dir, sizeof (fs_gamedir)); - list = listdirectory(dir); + stringlistinit(&list); + listdirectory(&list, "", dir); + stringlistsort(&list); // add any PAK package in the directory - for (current = list;current;current = current->next) + for (i = 0;i < list.numstrings;i++) { - if (!strcasecmp(FS_FileExtension(current->text), "pak")) + if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak")) { - dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, current->text); - FS_AddPack_Fullpath(pakfile, NULL, false); + FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false); } } - // add any PK3 package in the director - for (current = list;current;current = current->next) + // add any PK3 package in the directory + for (i = 0;i < list.numstrings;i++) { - if (!strcasecmp(FS_FileExtension(current->text), "pk3")) + if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3")) { - dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, current->text); - FS_AddPack_Fullpath(pakfile, NULL, false); + FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false); } } - freedirectory(list); + + stringlistfreecontents(&list); // Add the directory to the search path // (unpacked files have the priority over packed files) @@ -1008,19 +1115,11 @@ FS_AddGameHierarchy */ void FS_AddGameHierarchy (const char *dir) { -#ifndef WIN32 - const char *homedir; -#endif - // Add the common game directory FS_AddGameDirectory (va("%s%s/", fs_basedir, dir)); -#ifndef WIN32 - // Add the personal game directory - homedir = getenv ("HOME"); - if (homedir != NULL && homedir[0] != '\0') - FS_AddGameDirectory (va("%s/.%s/%s/", homedir, gameuserdirname, dir)); -#endif + if (*fs_userdir) + FS_AddGameDirectory(va("%s%s/", fs_userdir, dir)); } @@ -1029,7 +1128,7 @@ void FS_AddGameHierarchy (const char *dir) FS_FileExtension ============ */ -static const char *FS_FileExtension (const char *in) +const char *FS_FileExtension (const char *in) { const char *separator, *backslash, *colon, *dot; @@ -1050,119 +1149,114 @@ static const char *FS_FileExtension (const char *in) /* -================ -FS_Init -================ +============ +FS_FileWithoutPath +============ */ -void FS_Init (void) +const char *FS_FileWithoutPath (const char *in) { - int i; - searchpath_t *search; - - fs_mempool = Mem_AllocPool("file management", 0, NULL); + const char *separator, *backslash, *colon; - strlcpy(fs_gamedir, "", sizeof(fs_gamedir)); + separator = strrchr(in, '/'); + backslash = strrchr(in, '\\'); + if (!separator || separator < backslash) + separator = backslash; + colon = strrchr(in, ':'); + if (!separator || separator < colon) + separator = colon; + return separator ? separator + 1 : in; +} -// If the base directory is explicitly defined by the compilation process -#ifdef DP_FS_BASEDIR - strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir)); -#else - strlcpy(fs_basedir, "", sizeof(fs_basedir)); -#ifdef MACOSX - // FIXME: is there a better way to find the directory outside the .app? - if (strstr(com_argv[0], ".app/")) +/* +================ +FS_ClearSearchPath +================ +*/ +void FS_ClearSearchPath (void) +{ + // unload all packs and directory information, close all pack files + // (if a qfile is still reading a pack it won't be harmed because it used + // dup() to get its own handle already) + while (fs_searchpaths) { - char *split; - - split = strstr(com_argv[0], ".app/"); - while (split > com_argv[0] && *split != '/') - split--; - strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir)); - fs_basedir[split - com_argv[0]] = 0; + searchpath_t *search = fs_searchpaths; + fs_searchpaths = search->next; + if (search->pack) + { + // close the file + close(search->pack->handle); + // free any memory associated with it + if (search->pack->files) + Mem_Free(search->pack->files); + Mem_Free(search->pack); + } + Mem_Free(search); } -#endif -#endif +} - PK3_OpenLibrary (); - // -basedir - // Overrides the system supplied base directory (under GAMENAME) -// COMMANDLINEOPTION: Filesystem: -basedir chooses what base directory the game data is in, inside this there should be a data directory for the game (for example id1) - i = COM_CheckParm ("-basedir"); - if (i && i < com_argc-1) - { - strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir)); - i = (int)strlen (fs_basedir); - if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/')) - fs_basedir[i-1] = 0; - } +/* +================ +FS_Rescan +================ +*/ +void FS_Rescan (void) +{ + int i; + qboolean fs_modified = false; + char gamedirbuf[MAX_INPUTLINE]; - // add a path separator to the end of the basedir if it lacks one - if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\') - strlcat(fs_basedir, "/", sizeof(fs_basedir)); + FS_ClearSearchPath(); + + // add the game-specific paths + // gamedirname1 (typically id1) + FS_AddGameHierarchy (gamedirname1); + // update the com_modname (used for server info) + strlcpy(com_modname, gamedirname1, sizeof(com_modname)); - // -path [] ... - // Fully specifies the exact search path, overriding the generated one -// COMMANDLINEOPTION: Filesystem: -path specifies the full search path manually, overriding the generated one, example: -path c:\quake\id1 c:\quake\pak0.pak c:\quake\pak1.pak (not recommended) - i = COM_CheckParm ("-path"); - if (i) + // add the game-specific path, if any + // (only used for mission packs and the like, which should set fs_modified) + if (gamedirname2) { fs_modified = true; - while (++i < com_argc) - { - if (!com_argv[i] || com_argv[i][0] == '+' || com_argv[i][0] == '-') - break; - - if(!FS_AddPack_Fullpath(com_argv[i], NULL, false)) - { - search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t)); - strlcpy (search->filename, com_argv[i], sizeof (search->filename)); - search->next = fs_searchpaths; - fs_searchpaths = search; - } - } + FS_AddGameHierarchy (gamedirname2); } - else - { - // add the game-specific paths - // gamedirname1 (typically id1) - FS_AddGameHierarchy (gamedirname1); - - // add the game-specific path, if any - if (gamedirname2) - { - fs_modified = true; - FS_AddGameHierarchy (gamedirname2); - } - // set the com_modname (reported in server info) - strlcpy(com_modname, gamedirname1, sizeof(com_modname)); + // -game + // Adds basedir/gamedir as an override game + // LordHavoc: now supports multiple -game directories + // set the com_modname (reported in server info) + *gamedirbuf = 0; + for (i = 0;i < fs_numgamedirs;i++) + { + fs_modified = true; + FS_AddGameHierarchy (fs_gamedirs[i]); + // update the com_modname (used server info) + strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname)); + if(i) + strlcat(gamedirbuf, va(" %s", fs_gamedirs[i]), sizeof(gamedirbuf)); + else + strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf)); + } + Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it - // -game - // Adds basedir/gamedir as an override game - // LordHavoc: now supports multiple -game directories - for (i = 1;i < com_argc;i++) - { - if (!com_argv[i]) - continue; - if (!strcmp (com_argv[i], "-game") && i < com_argc-1) - { - i++; - fs_modified = true; - FS_AddGameHierarchy (com_argv[i]); - // update the com_modname - strlcpy (com_modname, com_argv[i], sizeof (com_modname)); - } - } + // set the default screenshot name to either the mod name or the + // gamemode screenshot name + if (strcmp(com_modname, gamedirname1)) + Cvar_SetQuick (&scr_screenshot_name, com_modname); + else + Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname); + + if((i = COM_CheckParm("-modname")) && i < com_argc - 1) + strlcpy(com_modname, com_argv[i+1], sizeof(com_modname)); - // If "-condebug" is in the command line, remove the previous log file - if (COM_CheckParm ("-condebug") != 0) - unlink (va("%s/qconsole.log", fs_gamedir)); - } + // If "-condebug" is in the command line, remove the previous log file + if (COM_CheckParm ("-condebug") != 0) + unlink (va("%s/qconsole.log", fs_gamedir)); // look for the pop.lmp file and set registered to true if it is found - if (gamemode == GAME_NORMAL && !FS_FileExists("gfx/pop.lmp")) + if ((gamemode == GAME_NORMAL || gamemode == GAME_HIPNOTIC || gamemode == GAME_ROGUE) && !FS_FileExists("gfx/pop.lmp")) { if (fs_modified) Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n"); @@ -1176,121 +1270,538 @@ void FS_Init (void) Con_Print("Playing registered version.\n"); } - // set the default screenshot name to either the mod name or the - // gamemode screenshot name - if (fs_modified) - Cvar_SetQuick (&scr_screenshot_name, com_modname); - else - Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname); + // unload all wads so that future queries will return the new data + W_UnloadAll(); } -void FS_Init_Commands(void) +void FS_Rescan_f(void) { - Cvar_RegisterVariable (&scr_screenshot_name); - - Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)"); - Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line"); - Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line"); + FS_Rescan(); } /* ================ -FS_Shutdown +FS_ChangeGameDirs ================ */ -void FS_Shutdown (void) +extern void Host_SaveConfig (void); +extern void Host_LoadConfig_f (void); +qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing) { - Mem_FreePool (&fs_mempool); -} - -/* -==================== -FS_SysOpen + int i; + const char *p; -Internal function used to create a qfile_t and open the relevant non-packed file on disk -==================== -*/ -static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking) -{ - qfile_t* file; - int mod, opt; - unsigned int ind; + if (fs_numgamedirs == numgamedirs) + { + for (i = 0;i < numgamedirs;i++) + if (strcasecmp(fs_gamedirs[i], gamedirs[i])) + break; + if (i == numgamedirs) + return true; // already using this set of gamedirs, do nothing + } - // Parse the mode string - switch (mode[0]) + if (numgamedirs > MAX_GAMEDIRS) { - case 'r': - mod = O_RDONLY; - opt = 0; - break; - case 'w': - mod = O_WRONLY; - opt = O_CREAT | O_TRUNC; - break; - case 'a': - mod = O_WRONLY; - opt = O_CREAT | O_APPEND; - break; - default: - Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode); - return NULL; + if (complain) + Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS); + return false; // too many gamedirs } - for (ind = 1; mode[ind] != '\0'; ind++) + + for (i = 0;i < numgamedirs;i++) { - switch (mode[ind]) + // if string is nasty, reject it + p = FS_CheckGameDir(gamedirs[i]); + if(!p) { - case '+': - mod = O_RDWR; - break; - case 'b': - opt |= O_BINARY; - break; - default: - Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n", - filepath, mode, mode[ind]); + if (complain) + Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]); + return false; // nasty gamedirs + } + if(p == fs_checkgamedir_missing && failmissing) + { + if (complain) + Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]); + return false; // missing gamedirs } } - if (nonblocking) - opt |= O_NONBLOCK; + Host_SaveConfig(); - file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file)); - memset (file, 0, sizeof (*file)); - file->ungetc = EOF; + fs_numgamedirs = numgamedirs; + for (i = 0;i < fs_numgamedirs;i++) + strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i])); - file->handle = open (filepath, mod | opt, 0666); - if (file->handle < 0) - { - Mem_Free (file); - return NULL; - } + // reinitialize filesystem to detect the new paks + FS_Rescan(); - file->real_length = lseek (file->handle, 0, SEEK_END); + // exec the new config + Host_LoadConfig_f(); - // For files opened in append mode, we start at the end of the file - if (mod & O_APPEND) - file->position = file->real_length; - else - lseek (file->handle, 0, SEEK_SET); + // unload all sounds so they will be reloaded from the new files as needed + S_UnloadAllSounds_f(); - return file; -} + // reinitialize renderer (this reloads hud/console background/etc) + R_Modules_Restart(); + return true; +} /* -=========== -FS_OpenPackedFile - -Open a packed file using its package file descriptor -=========== +================ +FS_GameDir_f +================ */ -qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind) +void FS_GameDir_f (void) { - packfile_t *pfile; - int dup_handle; - qfile_t* file; + int i; + int numgamedirs; + char gamedirs[MAX_GAMEDIRS][MAX_QPATH]; - pfile = &pack->files[pack_ind]; + if (Cmd_Argc() < 2) + { + Con_Printf("gamedirs active:"); + for (i = 0;i < fs_numgamedirs;i++) + Con_Printf(" %s", fs_gamedirs[i]); + Con_Printf("\n"); + return; + } + + numgamedirs = Cmd_Argc() - 1; + if (numgamedirs > MAX_GAMEDIRS) + { + Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS); + return; + } + + for (i = 0;i < numgamedirs;i++) + strlcpy(gamedirs[i], Cmd_Argv(i+1), sizeof(gamedirs[i])); + + if ((cls.state == ca_connected && !cls.demoplayback) || sv.active) + { + // actually, changing during game would work fine, but would be stupid + Con_Printf("Can not change gamedir while client is connected or server is running!\n"); + return; + } + + // halt demo playback to close the file + CL_Disconnect(); + + FS_ChangeGameDirs(numgamedirs, gamedirs, true, true); +} + +static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking); +static const char *FS_SysCheckGameDir(const char *gamedir) +{ + static char buf[8192]; + qboolean success; + qfile_t *f; + stringlist_t list; + fs_offset_t n; + + stringlistinit(&list); + listdirectory(&list, gamedir, ""); + success = list.numstrings > 0; + stringlistfreecontents(&list); + + if(success) + { + f = FS_SysOpen(va("%smodinfo.txt", gamedir), "r", false); + if(f) + { + n = FS_Read (f, buf, sizeof(buf) - 1); + if(n >= 0) + buf[n] = 0; + else + *buf = 0; + FS_Close(f); + } + else + *buf = 0; + return buf; + } + + return NULL; +} + +/* +================ +FS_CheckGameDir +================ +*/ +const char *FS_CheckGameDir(const char *gamedir) +{ + const char *ret; + + if (FS_CheckNastyPath(gamedir, true)) + return NULL; + + ret = FS_SysCheckGameDir(va("%s%s/", fs_userdir, gamedir)); + if(ret) + { + if(!*ret) + { + // get description from basedir + ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir)); + if(ret) + return ret; + return ""; + } + return ret; + } + + ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir)); + if(ret) + return ret; + + return fs_checkgamedir_missing; +} + +static void FS_ListGameDirs() +{ + stringlist_t list, list2; + int i, j; + const char *info; + + fs_all_gamedirs_count = 0; + if(fs_all_gamedirs) + Mem_Free(fs_all_gamedirs); + + stringlistinit(&list); + listdirectory(&list, va("%s/", fs_basedir), ""); + listdirectory(&list, va("%s/", fs_userdir), ""); + stringlistsort(&list); + + stringlistinit(&list2); + for(i = 0; i < list.numstrings; ++i) + { + if(i) + if(!strcmp(list.strings[i-1], list.strings[i])) + continue; + info = FS_CheckGameDir(list.strings[i]); + if(!info) + continue; + if(info == fs_checkgamedir_missing) + continue; + if(!*info) + continue; + stringlistappend(&list2, list.strings[i]); + } + stringlistfreecontents(&list); + + fs_all_gamedirs = Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs)); + for(i = 0; i < list2.numstrings; ++i) + { + info = FS_CheckGameDir(list2.strings[i]); + // all this cannot happen any more, but better be safe than sorry + if(!info) + continue; + if(info == fs_checkgamedir_missing) + continue; + if(!*info) + continue; + strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[j].name)); + strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[j].description)); + ++fs_all_gamedirs_count; + } +} + +/* +================ +FS_Init +================ +*/ +void FS_Init (void) +{ + const char *p; + int i; +#ifdef WIN32 + TCHAR mydocsdir[MAX_PATH + 1]; +#if _MSC_VER >= 1400 + size_t homedirlen; +#endif +#endif + char *homedir; + +#ifdef WIN32 + const char* dllnames [] = + { + "shfolder.dll", // IE 4, or Win NT and higher + NULL + }; + Sys_LoadLibrary(dllnames, &shfolder_dll, shfolderfuncs); + // don't care for the result; if it fails, %USERPROFILE% will be used instead +#endif + + fs_mempool = Mem_AllocPool("file management", 0, NULL); + + // Add the personal game directory + if((i = COM_CheckParm("-userdir")) && i < com_argc - 1) + { + dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", com_argv[i+1]); + } + else if(COM_CheckParm("-nohome")) + { + *fs_userdir = 0; + } + else + { +#ifdef WIN32 + if(qSHGetFolderPath && (qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)) + { + dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Games/%s/", mydocsdir, gameuserdirname); + Con_DPrintf("Obtained personal directory %s from SHGetFolderPath\n", fs_userdir); + } + else + { + // use the environment +#if _MSC_VER >= 1400 + _dupenv_s (&homedir, &homedirlen, "USERPROFILE"); +#else + homedir = getenv("USERPROFILE"); +#endif + + if(homedir) + { + dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Documents/My Games/%s/", homedir, gameuserdirname); +#if _MSC_VER >= 1400 + free(homedir); +#endif + Con_DPrintf("Obtained personal directory %s from environment\n", fs_userdir); + } + } + + if(!*fs_userdir) + Con_DPrintf("Could not obtain home directory; not supporting -mygames\n"); +#else + homedir = getenv ("HOME"); + if(homedir) + dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/.%s/", homedir, gameuserdirname); + + if(!*fs_userdir) + Con_DPrintf("Could not obtain home directory; assuming -nohome\n"); +#endif + +#ifdef WIN32 + if(!COM_CheckParm("-mygames")) + { +#if _MSC_VER >= 1400 + int fd; + _sopen_s(&fd, va("%s%s/config.cfg", fs_basedir, gamedirname1), O_WRONLY | O_CREAT, _SH_DENYNO, _S_IREAD | _S_IWRITE); // note: no O_TRUNC here! +#else + int fd = open (va("%s%s/config.cfg", fs_basedir, gamedirname1), O_WRONLY | O_CREAT, 0666); // note: no O_TRUNC here! +#endif + if(fd >= 0) + { + close(fd); + *fs_userdir = 0; // we have write access to the game dir, so let's use it + } + } +#endif + } + + strlcpy(fs_gamedir, "", sizeof(fs_gamedir)); + +// If the base directory is explicitly defined by the compilation process +#ifdef DP_FS_BASEDIR + strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir)); +#else + *fs_basedir = 0; + +#ifdef MACOSX + // FIXME: is there a better way to find the directory outside the .app? + if (strstr(com_argv[0], ".app/")) + { + char *split; + + split = strstr(com_argv[0], ".app/"); + while (split > com_argv[0] && *split != '/') + split--; + strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir)); + fs_basedir[split - com_argv[0]] = 0; + } +#endif +#endif + + PK3_OpenLibrary (); + + // -basedir + // Overrides the system supplied base directory (under GAMENAME) +// COMMANDLINEOPTION: Filesystem: -basedir chooses what base directory the game data is in, inside this there should be a data directory for the game (for example id1) + i = COM_CheckParm ("-basedir"); + if (i && i < com_argc-1) + { + strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir)); + i = (int)strlen (fs_basedir); + if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/')) + fs_basedir[i-1] = 0; + } + + // add a path separator to the end of the basedir if it lacks one + if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\') + strlcat(fs_basedir, "/", sizeof(fs_basedir)); + + FS_ListGameDirs(); + + p = FS_CheckGameDir(gamedirname1); + if(!p || p == fs_checkgamedir_missing) + Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1); + + if(gamedirname2) + { + p = FS_CheckGameDir(gamedirname2); + if(!p || p == fs_checkgamedir_missing) + Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2); + } + + // -game + // Adds basedir/gamedir as an override game + // LordHavoc: now supports multiple -game directories + for (i = 1;i < com_argc && fs_numgamedirs < MAX_GAMEDIRS;i++) + { + if (!com_argv[i]) + continue; + if (!strcmp (com_argv[i], "-game") && i < com_argc-1) + { + i++; + p = FS_CheckGameDir(com_argv[i]); + if(!p) + Sys_Error("Nasty -game name rejected: %s", com_argv[i]); + if(p == fs_checkgamedir_missing) + Con_Printf("WARNING: -game %s%s/ not found!\n", fs_basedir, com_argv[i]); + // add the gamedir to the list of active gamedirs + strlcpy (fs_gamedirs[fs_numgamedirs], com_argv[i], sizeof(fs_gamedirs[fs_numgamedirs])); + fs_numgamedirs++; + } + } + + // generate the searchpath + FS_Rescan(); +} + +void FS_Init_Commands(void) +{ + Cvar_RegisterVariable (&scr_screenshot_name); + Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions); + Cvar_RegisterVariable (&cvar_fs_gamedir); + + Cmd_AddCommand ("gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)"); + Cmd_AddCommand ("fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes"); + Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)"); + Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line"); + Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line"); + Cmd_AddCommand ("which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from"); +} + +/* +================ +FS_Shutdown +================ +*/ +void FS_Shutdown (void) +{ + // close all pack files and such + // (hopefully there aren't any other open files, but they'll be cleaned up + // by the OS anyway) + FS_ClearSearchPath(); + Mem_FreePool (&fs_mempool); + +#ifdef WIN32 + Sys_UnloadLibrary (&shfolder_dll); +#endif +} + +/* +==================== +FS_SysOpen + +Internal function used to create a qfile_t and open the relevant non-packed file on disk +==================== +*/ +static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking) +{ + qfile_t* file; + int mod, opt; + unsigned int ind; + + // Parse the mode string + switch (mode[0]) + { + case 'r': + mod = O_RDONLY; + opt = 0; + break; + case 'w': + mod = O_WRONLY; + opt = O_CREAT | O_TRUNC; + break; + case 'a': + mod = O_WRONLY; + opt = O_CREAT | O_APPEND; + break; + default: + Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode); + return NULL; + } + for (ind = 1; mode[ind] != '\0'; ind++) + { + switch (mode[ind]) + { + case '+': + mod = O_RDWR; + break; + case 'b': + opt |= O_BINARY; + break; + default: + Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n", + filepath, mode, mode[ind]); + } + } + + if (nonblocking) + opt |= O_NONBLOCK; + + file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file)); + memset (file, 0, sizeof (*file)); + file->ungetc = EOF; + +#if _MSC_VER >= 1400 + _sopen_s(&file->handle, filepath, mod | opt, _SH_DENYNO, _S_IREAD | _S_IWRITE); +#else + file->handle = open (filepath, mod | opt, 0666); +#endif + if (file->handle < 0) + { + Mem_Free (file); + return NULL; + } + + file->real_length = lseek (file->handle, 0, SEEK_END); + + // For files opened in append mode, we start at the end of the file + if (mod & O_APPEND) + file->position = file->real_length; + else + lseek (file->handle, 0, SEEK_SET); + + return file; +} + + +/* +=========== +FS_OpenPackedFile + +Open a packed file using its package file descriptor +=========== +*/ +qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind) +{ + packfile_t *pfile; + int dup_handle; + qfile_t* file; + + pfile = &pack->files[pack_ind]; // If we don't have the true offset, get it now if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS)) @@ -1311,7 +1822,7 @@ qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind) if (lseek (pack->handle, pfile->offset, SEEK_SET) == -1) { Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n", - pfile->name, pack->filename, pfile->offset); + pfile->name, pack->filename, (int) pfile->offset); return NULL; } @@ -1382,8 +1893,12 @@ Return true if the path should be rejected due to one of the following: or are just not a good idea for a mod to be using. ==================== */ -int FS_CheckNastyPath (const char *path) +int FS_CheckNastyPath (const char *path, qboolean isgamedir) { + // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless + if (!path[0]) + return 2; + // Windows: don't allow \ in filenames (windows-only), period. // (on Windows \ is a directory separator, but / is also supported) if (strstr(path, "\\")) @@ -1400,14 +1915,34 @@ int FS_CheckNastyPath (const char *path) if (strstr(path, "//")) return 1; // non-portable attempt to go to parent directory - // all: don't allow going to current directory (./) or parent directory (../ or /../) - if (strstr(path, "./")) + // all: don't allow going to parent directory (../ or /../) + if (strstr(path, "..")) return 2; // attempt to go outside the game directory // Windows and UNIXes: don't allow absolute paths if (path[0] == '/') return 2; // attempt to go outside the game directory + // all: don't allow . characters before the last slash (it should only be used in filenames, not path elements), this catches all imaginable cases of ./, ../, .../, etc + if (strchr(path, '.')) + { + if (isgamedir) + { + // gamedir is entirely path elements, so simply forbid . entirely + return 2; + } + if (strchr(path, '.') < strrchr(path, '/')) + return 2; // possible attempt to go outside the game directory + } + + // all: forbid trailing slash on gamedir + if (isgamedir && path[strlen(path)-1] == '/') + return 2; + + // all: forbid leading dot on any filename for any reason + if (strstr(path, "/.")) + return 2; // attempt to go outside the game directory + // after all these checks we're pretty sure it's a / separated filename // and won't do much if any harm return false; @@ -1454,6 +1989,17 @@ static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet) // Found it if (!diff) { + if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0) + { + // yes, but the first one is empty so we treat it as not being there + if (!quiet && developer.integer >= 10) + Con_Printf("FS_FindFile: %s is marked as deleted\n", name); + + if (index != NULL) + *index = -1; + return NULL; + } + if (!quiet && developer.integer >= 10) Con_Printf("FS_FindFile: %s in %s\n", pak->files[middle].name, pak->filename); @@ -1502,7 +2048,7 @@ FS_OpenReadFile Look for a file in the search paths and open it in read-only mode =========== */ -qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking) +qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking, int symlinkLevels) { searchpath_t *search; int pack_ind; @@ -1521,7 +2067,81 @@ qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonbloc return FS_SysOpen (path, "rb", nonblocking); } - // So, we found it in a package... + // So, we found it in a package... + + // Is it a PK3 symlink? + // TODO also handle directory symlinks by parsing the whole structure... + // but heck, file symlinks are good enough for now + if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK) + { + if(symlinkLevels <= 0) + { + Con_Printf("symlink: %s: too many levels of symbolic links\n", filename); + return NULL; + } + else + { + char linkbuf[MAX_QPATH]; + fs_offset_t count; + qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind); + const char *mergeslash; + char *mergestart; + + if(!linkfile) + return NULL; + count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1); + FS_Close(linkfile); + if(count < 0) + return NULL; + linkbuf[count] = 0; + + // Now combine the paths... + mergeslash = strrchr(filename, '/'); + mergestart = linkbuf; + if(!mergeslash) + mergeslash = filename; + while(!strncmp(mergestart, "../", 3)) + { + mergestart += 3; + while(mergeslash > filename) + { + --mergeslash; + if(*mergeslash == '/') + break; + } + } + // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended + if(mergeslash == filename) + { + // Either mergeslash == filename, then we just replace the name (done below) + } + else + { + // Or, we append the name after mergeslash; + // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first + int spaceNeeded = mergeslash - filename + 1; + int spaceRemoved = mergestart - linkbuf; + if(count - spaceRemoved + spaceNeeded >= MAX_QPATH) + { + Con_DPrintf("symlink: too long path rejected\n"); + return NULL; + } + memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved); + memcpy(linkbuf, filename, spaceNeeded); + linkbuf[count - spaceRemoved + spaceNeeded] = 0; + mergestart = linkbuf; + } + if (!quiet && developer_loading.integer) + Con_DPrintf("symlink: %s -> %s\n", filename, mergestart); + if(FS_CheckNastyPath (mergestart, false)) + { + Con_DPrintf("symlink: nasty path %s rejected\n", mergestart); + return NULL; + } + return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1); + } + } + return FS_OpenPackedFile (search->pack, pack_ind); } @@ -1536,38 +2156,70 @@ MAIN PUBLIC FUNCTIONS /* ==================== -FS_Open +FS_OpenRealFile -Open a file. The syntax is the same as fopen +Open a file in the userpath. The syntax is the same as fopen +Used for savegame scanning in menu, and all file writing. ==================== */ -qfile_t* FS_Open (const char* filepath, const char* mode, qboolean quiet, qboolean nonblocking) +qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet) { - if (FS_CheckNastyPath(filepath)) + char real_path [MAX_OSPATH]; + + if (FS_CheckNastyPath(filepath, false)) { - Con_Printf("FS_Open(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false"); + Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false"); return NULL; } - // If the file is opened in "write", "append", or "read/write" mode + dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); + + // If the file is opened in "write", "append", or "read/write" mode, + // create directories up to the file. if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+')) - { - char real_path [MAX_OSPATH]; + FS_CreatePath (real_path); + return FS_SysOpen (real_path, mode, false); +} - // Open the file on disk directly - dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); - // Create directories up to the file - FS_CreatePath (real_path); +/* +==================== +FS_OpenVirtualFile - return FS_SysOpen (real_path, mode, nonblocking); +Open a file. The syntax is the same as fopen +==================== +*/ +qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet) +{ + if (FS_CheckNastyPath(filepath, false)) + { + Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false"); + return NULL; } - // Else, we look at the various search paths and open the file in read-only mode - else - return FS_OpenReadFile (filepath, quiet, nonblocking); + + return FS_OpenReadFile (filepath, quiet, false, 16); } +/* +==================== +FS_FileFromData + +Open a file. The syntax is the same as fopen +==================== +*/ +qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet) +{ + qfile_t* file; + file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file)); + memset (file, 0, sizeof (*file)); + file->flags = QFILE_FLAG_DATA; + file->ungetc = EOF; + file->real_length = size; + file->data = data; + return file; +} + /* ==================== FS_Close @@ -1577,6 +2229,12 @@ Close a file */ int FS_Close (qfile_t* file) { + if(file->flags & QFILE_FLAG_DATA) + { + Mem_Free(file); + return 0; + } + if (close (file->handle)) return EOF; @@ -1647,16 +2305,26 @@ fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize) else done = 0; + if(file->flags & QFILE_FLAG_DATA) + { + size_t left = file->real_length - file->position; + if(buffersize > left) + buffersize = left; + memcpy(buffer, file->data + file->position, buffersize); + file->position += buffersize; + return buffersize; + } + // First, we copy as many bytes as we can from "buff" if (file->buff_ind < file->buff_len) { count = file->buff_len - file->buff_ind; + count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize; + done += count; + memcpy (buffer, &file->buff[file->buff_ind], count); + file->buff_ind += count; - done += ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize; - memcpy (buffer, &file->buff[file->buff_ind], done); - file->buff_ind += done; - - buffersize -= done; + buffersize -= count; if (buffersize == 0) return done; } @@ -1868,7 +2536,7 @@ Get the next character of a file */ int FS_Getc (qfile_t* file) { - char c; + unsigned char c; if (FS_Read (file, &c, 1) != 1) return EOF; @@ -1925,9 +2593,15 @@ int FS_Seek (qfile_t* file, fs_offset_t offset, int whence) default: return -1; } - if (offset < 0 || offset > (long) file->real_length) + if (offset < 0 || offset > file->real_length) return -1; + if(file->flags & QFILE_FLAG_DATA) + { + file->position = offset; + return 0; + } + // If we have the data in our read buffer, we don't need to actually seek if (file->position - file->buff_len <= offset && offset <= file->position) { @@ -2003,6 +2677,19 @@ fs_offset_t FS_Tell (qfile_t* file) } +/* +==================== +FS_FileSize + +Give the total size of a file +==================== +*/ +fs_offset_t FS_FileSize (qfile_t* file) +{ + return file->real_length; +} + + /* ==================== FS_Purge @@ -2032,14 +2719,23 @@ unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, f unsigned char *buf = NULL; fs_offset_t filesize = 0; - file = FS_Open (path, "rb", quiet, false); + file = FS_OpenVirtualFile(path, quiet); if (file) { filesize = file->real_length; + if(filesize < 0) + { + Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false"); + FS_Close(file); + return NULL; + } + buf = (unsigned char *)Mem_Alloc (pool, filesize + 1); buf[filesize] = '\0'; FS_Read (file, buf, filesize); FS_Close (file); + if (developer_loadfile.integer) + Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize); } if (filesizepointer) @@ -2059,14 +2755,14 @@ qboolean FS_WriteFile (const char *filename, void *data, fs_offset_t len) { qfile_t *file; - file = FS_Open (filename, "wb", false, false); + file = FS_OpenRealFile(filename, "wb", false); if (!file) { Con_Printf("FS_WriteFile: failed on %s\n", filename); return false; } - Con_DPrintf("FS_WriteFile: %s\n", filename); + Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)len); FS_Write (file, data, len); FS_Close (file); return true; @@ -2135,6 +2831,30 @@ void FS_DefaultExtension (char *path, const char *extension, size_t size_path) } +/* +================== +FS_FileType + +Look for a file in the packages and in the filesystem +================== +*/ +int FS_FileType (const char *filename) +{ + searchpath_t *search; + char fullpath[MAX_QPATH]; + + search = FS_FindFile (filename, NULL, true); + if(!search) + return FS_FILETYPE_NONE; + + if(search->pack) + return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later + + dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename); + return FS_SysFileType(fullpath); +} + + /* ================== FS_FileExists @@ -2155,28 +2875,41 @@ FS_SysFileExists Look for a file in the filesystem only ================== */ -qboolean FS_SysFileExists (const char *path) +int FS_SysFileType (const char *path) { #if WIN32 - int desc; +// Sajt - some older sdks are missing this define +# ifndef INVALID_FILE_ATTRIBUTES +# define INVALID_FILE_ATTRIBUTES ((DWORD)-1) +# endif - // TODO: use another function instead, to avoid opening the file - desc = open (path, O_RDONLY | O_BINARY); - if (desc < 0) - return false; + DWORD result = GetFileAttributes(path); - close (desc); - return true; + if(result == INVALID_FILE_ATTRIBUTES) + return FS_FILETYPE_NONE; + + if(result & FILE_ATTRIBUTE_DIRECTORY) + return FS_FILETYPE_DIRECTORY; + + return FS_FILETYPE_FILE; #else struct stat buf; if (stat (path,&buf) == -1) - return false; + return FS_FILETYPE_NONE; - return true; + if(S_ISDIR(buf.st_mode)) + return FS_FILETYPE_DIRECTORY; + + return FS_FILETYPE_FILE; #endif } +qboolean FS_SysFileExists (const char *path) +{ + return FS_SysFileType (path) != FS_FILETYPE_NONE; +} + void FS_mkdir (const char *path) { #if WIN32 @@ -2198,11 +2931,11 @@ fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet) fssearch_t *search; searchpath_t *searchpath; pack_t *pak; - int i, basepathlength, numfiles, numchars; - stringlist_t *dir, *dirfile, *liststart, *listcurrent, *listtemp; + int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex; + stringlist_t resultlist; + stringlist_t dirlist; const char *slash, *backslash, *colon, *separator; char *basepath; - char netpath[MAX_OSPATH]; char temp[MAX_OSPATH]; for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++) @@ -2214,10 +2947,9 @@ fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet) return NULL; } + stringlistinit(&resultlist); + stringlistinit(&dirlist); search = NULL; - liststart = NULL; - listcurrent = NULL; - listtemp = NULL; slash = strrchr(pattern, '/'); backslash = strrchr(pattern, '\\'); colon = strrchr(pattern, ':'); @@ -2244,16 +2976,14 @@ fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet) { if (matchpattern(temp, (char *)pattern, true)) { - for (listtemp = liststart;listtemp;listtemp = listtemp->next) - if (!strcmp(listtemp->text, temp)) + for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++) + if (!strcmp(resultlist.strings[resultlistindex], temp)) break; - if (listtemp == NULL) + if (resultlistindex == resultlist.numstrings) { - listcurrent = stringlistappend(listcurrent, temp); - if (liststart == NULL) - liststart = listcurrent; - if (!quiet) - Con_DPrintf("SearchPackFile: %s : %s\n", pak->filename, temp); + stringlistappend(&resultlist, temp); + if (!quiet && developer_loading.integer) + Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp); } } // strip off one path element at a time until empty @@ -2274,61 +3004,121 @@ fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet) } else { - // get a directory listing and look at each name - dpsnprintf(netpath, sizeof (netpath), "%s%s", searchpath->filename, basepath); - if ((dir = listdirectory(netpath))) + stringlist_t matchedSet, foundSet; + const char *start = pattern; + + stringlistinit(&matchedSet); + stringlistinit(&foundSet); + // add a first entry to the set + stringlistappend(&matchedSet, ""); + // iterate through pattern's path + while (*start) { - for (dirfile = dir;dirfile;dirfile = dirfile->next) + const char *asterisk, *wildcard, *nextseparator, *prevseparator; + char subpath[MAX_OSPATH]; + char subpattern[MAX_OSPATH]; + + // find the next wildcard + wildcard = strchr(start, '?'); + asterisk = strchr(start, '*'); + if (asterisk && (!wildcard || asterisk < wildcard)) { - dpsnprintf(temp, sizeof(temp), "%s%s", basepath, dirfile->text); - if (matchpattern(temp, (char *)pattern, true)) + wildcard = asterisk; + } + + if (wildcard) + { + nextseparator = strchr( wildcard, '/' ); + } + else + { + nextseparator = NULL; + } + + if( !nextseparator ) { + nextseparator = start + strlen( start ); + } + + // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string) + // copy everything up except nextseperator + strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1))); + // find the last '/' before the wildcard + prevseparator = strrchr( subpattern, '/' ); + if (!prevseparator) + prevseparator = subpattern; + else + prevseparator++; + // copy everything from start to the previous including the '/' (before the wildcard) + // everything up to start is already included in the path of matchedSet's entries + strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1))); + + // for each entry in matchedSet try to open the subdirectories specified in subpath + for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) { + strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) ); + strlcat( temp, subpath, sizeof(temp) ); + listdirectory( &foundSet, searchpath->filename, temp ); + } + if( dirlistindex == 0 ) { + break; + } + // reset the current result set + stringlistfreecontents( &matchedSet ); + // match against the pattern + for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) { + const char *direntry = foundSet.strings[ dirlistindex ]; + if (matchpattern(direntry, subpattern, true)) { + stringlistappend( &matchedSet, direntry ); + } + } + stringlistfreecontents( &foundSet ); + + start = nextseparator; + } + + for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++) + { + const char *temp = matchedSet.strings[dirlistindex]; + if (matchpattern(temp, (char *)pattern, true)) + { + for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++) + if (!strcmp(resultlist.strings[resultlistindex], temp)) + break; + if (resultlistindex == resultlist.numstrings) { - for (listtemp = liststart;listtemp;listtemp = listtemp->next) - if (!strcmp(listtemp->text, temp)) - break; - if (listtemp == NULL) - { - listcurrent = stringlistappend(listcurrent, temp); - if (liststart == NULL) - liststart = listcurrent; - if (!quiet) - Con_DPrintf("SearchDirFile: %s\n", temp); - } + stringlistappend(&resultlist, temp); + if (!quiet && developer_loading.integer) + Con_Printf("SearchDirFile: %s\n", temp); } } - freedirectory(dir); } + stringlistfreecontents( &matchedSet ); } } - if (liststart) + if (resultlist.numstrings) { - liststart = stringlistsort(liststart); - numfiles = 0; + stringlistsort(&resultlist); + numfiles = resultlist.numstrings; numchars = 0; - for (listtemp = liststart;listtemp;listtemp = listtemp->next) - { - numfiles++; - numchars += (int)strlen(listtemp->text) + 1; - } + for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++) + numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1; search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *)); search->filenames = (char **)((char *)search + sizeof(fssearch_t)); search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *)); search->numfilenames = (int)numfiles; numfiles = 0; numchars = 0; - for (listtemp = liststart;listtemp;listtemp = listtemp->next) + for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++) { size_t textlen; search->filenames[numfiles] = search->filenamesbuffer + numchars; - textlen = strlen(listtemp->text) + 1; - memcpy(search->filenames[numfiles], listtemp->text, textlen); + textlen = strlen(resultlist.strings[resultlistindex]) + 1; + memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen); numfiles++; numchars += (int)textlen; } - if (liststart) - stringlistfree(liststart); } + stringlistfreecontents(&resultlist); Mem_Free(basepath); return search; @@ -2434,12 +3224,288 @@ void FS_Ls_f(void) FS_ListDirectoryCmd("ls", false); } +void FS_Which_f(void) +{ + const char *filename; + int index; + searchpath_t *sp; + if (Cmd_Argc() != 2) + { + Con_Printf("usage:\n%s \n", Cmd_Argv(0)); + return; + } + filename = Cmd_Argv(1); + sp = FS_FindFile(filename, &index, true); + if (!sp) { + Con_Printf("%s isn't anywhere\n", filename); + return; + } + if (sp->pack) + Con_Printf("%s is in package %s\n", filename, sp->pack->shortname); + else + Con_Printf("%s is file %s%s\n", filename, sp->filename, filename); +} + + const char *FS_WhichPack(const char *filename) { int index; searchpath_t *sp = FS_FindFile(filename, &index, true); if(sp && sp->pack) - return sp->pack->filename; + return sp->pack->shortname; else return 0; } + +/* +==================== +FS_IsRegisteredQuakePack + +Look for a proof of purchase file file in the requested package + +If it is found, this file should NOT be downloaded. +==================== +*/ +qboolean FS_IsRegisteredQuakePack(const char *name) +{ + searchpath_t *search; + pack_t *pak; + + // search through the path, one element at a time + for (search = fs_searchpaths;search;search = search->next) + { + if (search->pack && !strcasecmp(FS_FileWithoutPath(search->filename), name)) + { + int (*strcmp_funct) (const char* str1, const char* str2); + int left, right, middle; + + pak = search->pack; + strcmp_funct = pak->ignorecase ? strcasecmp : strcmp; + + // Look for the file (binary search) + left = 0; + right = pak->numfiles - 1; + while (left <= right) + { + int diff; + + middle = (left + right) / 2; + diff = !strcmp_funct (pak->files[middle].name, "gfx/pop.lmp"); + + // Found it + if (!diff) + return true; + + // If we're too far in the list + if (diff > 0) + right = middle - 1; + else + left = middle + 1; + } + + // we found the requested pack but it is not registered quake + return false; + } + } + + return false; +} + +int FS_CRCFile(const char *filename, size_t *filesizepointer) +{ + int crc = -1; + unsigned char *filedata; + fs_offset_t filesize; + if (filesizepointer) + *filesizepointer = 0; + if (!filename || !*filename) + return crc; + filedata = FS_LoadFile(filename, tempmempool, true, &filesize); + if (filedata) + { + if (filesizepointer) + *filesizepointer = filesize; + crc = CRC_Block(filedata, filesize); + Mem_Free(filedata); + } + return crc; +} + +unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool) +{ + z_stream strm; + unsigned char *out = NULL; + unsigned char *tmp; + + memset(&strm, 0, sizeof(strm)); + strm.zalloc = Z_NULL; + strm.zfree = Z_NULL; + strm.opaque = Z_NULL; + + if(level < 0) + level = Z_DEFAULT_COMPRESSION; + + if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK) + { + Con_Printf("FS_Deflate: deflate init error!\n"); + return NULL; + } + + strm.next_in = (unsigned char*)data; + strm.avail_in = size; + + tmp = (unsigned char *) Mem_Alloc(tempmempool, size); + if(!tmp) + { + Con_Printf("FS_Deflate: not enough memory in tempmempool!\n"); + qz_deflateEnd(&strm); + return NULL; + } + + strm.next_out = tmp; + strm.avail_out = size; + + if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END) + { + Con_Printf("FS_Deflate: deflate failed!\n"); + qz_deflateEnd(&strm); + Mem_Free(tmp); + return NULL; + } + + if(qz_deflateEnd(&strm) != Z_OK) + { + Con_Printf("FS_Deflate: deflateEnd failed\n"); + Mem_Free(tmp); + return NULL; + } + + if(strm.total_out >= size) + { + Con_Printf("FS_Deflate: deflate is useless on this data!\n"); + Mem_Free(tmp); + return NULL; + } + + out = (unsigned char *) Mem_Alloc(mempool, strm.total_out); + if(!out) + { + Con_Printf("FS_Deflate: not enough memory in target mempool!\n"); + Mem_Free(tmp); + return NULL; + } + + if(deflated_size) + *deflated_size = (size_t)strm.total_out; + + memcpy(out, tmp, strm.total_out); + Mem_Free(tmp); + + return out; +} + +static void AssertBufsize(sizebuf_t *buf, int length) +{ + if(buf->cursize + length > buf->maxsize) + { + int oldsize = buf->maxsize; + unsigned char *olddata; + olddata = buf->data; + buf->maxsize += length; + buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize); + if(olddata) + { + memcpy(buf->data, olddata, oldsize); + Mem_Free(olddata); + } + } +} + +unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool) +{ + int ret; + z_stream strm; + unsigned char *out = NULL; + unsigned char tmp[2048]; + unsigned int have; + sizebuf_t outbuf; + + memset(&outbuf, 0, sizeof(outbuf)); + outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp)); + outbuf.maxsize = sizeof(tmp); + + memset(&strm, 0, sizeof(strm)); + strm.zalloc = Z_NULL; + strm.zfree = Z_NULL; + strm.opaque = Z_NULL; + + if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK) + { + Con_Printf("FS_Inflate: inflate init error!\n"); + Mem_Free(outbuf.data); + return NULL; + } + + strm.next_in = (unsigned char*)data; + strm.avail_in = size; + + do + { + strm.next_out = tmp; + strm.avail_out = sizeof(tmp); + ret = qz_inflate(&strm, Z_NO_FLUSH); + // it either returns Z_OK on progress, Z_STREAM_END on end + // or an error code + switch(ret) + { + case Z_STREAM_END: + case Z_OK: + break; + + case Z_STREAM_ERROR: + Con_Print("FS_Inflate: stream error!\n"); + break; + case Z_DATA_ERROR: + Con_Print("FS_Inflate: data error!\n"); + break; + case Z_MEM_ERROR: + Con_Print("FS_Inflate: mem error!\n"); + break; + case Z_BUF_ERROR: + Con_Print("FS_Inflate: buf error!\n"); + break; + default: + Con_Print("FS_Inflate: unknown error!\n"); + break; + + } + if(ret != Z_OK && ret != Z_STREAM_END) + { + Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in); + Mem_Free(outbuf.data); + qz_inflateEnd(&strm); + return NULL; + } + have = sizeof(tmp) - strm.avail_out; + AssertBufsize(&outbuf, max(have, sizeof(tmp))); + SZ_Write(&outbuf, tmp, have); + } while(ret != Z_STREAM_END); + + qz_inflateEnd(&strm); + + out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize); + if(!out) + { + Con_Printf("FS_Inflate: not enough memory in target mempool!\n"); + Mem_Free(outbuf.data); + return NULL; + } + + memcpy(out, outbuf.data, outbuf.cursize); + Mem_Free(outbuf.data); + + if(inflated_size) + *inflated_size = (size_t)outbuf.cursize; + + return out; +}