This repository has been archived on 2022-06-27. You can view files and clone it, but cannot push or open issues or pull requests.
Xash3DArchive/launch/filesystem.c

4278 lines
113 KiB
C

//=======================================================================
// Copyright XashXT Group 2007 ©
// filesystem.c - game filesystem based on DP fs
//=======================================================================
#include "launch.h"
#include "qfiles_ref.h"
#include "filesystem.h"
#include "byteorder.h"
#include "library.h"
#include "mathlib.h"
#define ZIP_END_CDIR_SIZE 22
#define ZIP_CDIR_CHUNK_BASE_SIZE 46
#define ZIP_LOCAL_CHUNK_BASE_SIZE 30
#define FILE_FLAG_PACKED (1<<0) // inside a package (PAK or PK3)
#define FILE_FLAG_CRYPTED (1<<1) // file is crypted (PAK2)
#define FILE_FLAG_DEFLATED (1<<2) // (PK3 only)
#define PACKFILE_FLAG_TRUEOFFS (1<<0) // the offset in packfile_t is the true contents offset
#define PACKFILE_FLAG_DEFLATED (1<<1) // file compressed using the deflate algorithm
#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
byte input [FILE_BUFF_SIZE];
} ztoolkit_t;
typedef struct stringlist_s
{
// maxstrings changes as needed, causing reallocation of strings[] array
int maxstrings;
int numstrings;
char **strings;
} stringlist_t;
typedef struct wadtype_s
{
char *ext;
char type;
} wadtype_t;
typedef struct file_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
time_t filetime; // pak, wad or real filetime
// Contents buffer
fs_offset_t buff_ind, buff_len; // buffer current index and length
byte buff [FILE_BUFF_SIZE];
ztoolkit_t* ztk; // For zipped files
};
typedef struct vfile_s
{
byte *buff;
file_t *handle;
int mode;
bool compress;
fs_offset_t buffsize;
fs_offset_t length;
fs_offset_t offset;
};
typedef struct wfile_s
{
char filename [MAX_SYSPATH];
int infotableofs;
byte *mempool; // W_ReadLump temp buffers
int numlumps;
int mode;
file_t *file;
dlumpinfo_t *lumps;
time_t filetime;
};
typedef struct packfile_s
{
char name[128];
int flags;
fs_offset_t offset;
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_SYSPATH];
int handle;
int numfiles;
packfile_t *files;
time_t filetime; // common for all packed files
} pack_t;
typedef struct searchpath_s
{
char filename[MAX_SYSPATH];
pack_t *pack;
wfile_t *wad;
int flags;
struct searchpath_s *next;
} searchpath_t;
byte *fs_mempool;
searchpath_t *fs_searchpaths = NULL;
searchpath_t fs_directpath; // static direct path
static void FS_InitMemory( void );
const char *FS_FileExtension( const char *in );
static searchpath_t *FS_FindFile( const char *name, int *index, bool quiet, bool gamedironly );
static dlumpinfo_t *W_FindLump( wfile_t *wad, const char *name, const char matchtype );
static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack, fs_offset_t offset, fs_offset_t packsize, fs_offset_t realsize, int flags);
static byte *W_LoadFile( const char *path, fs_offset_t *filesizeptr );
static bool FS_SysFileExists( const char *path );
static long FS_SysFileTime( const char *filename );
static char W_TypeFromExt( const char *lumpname );
static const char *W_ExtFromType( char lumptype );
char sys_rootdir[MAX_SYSPATH]; // system root
char fs_rootdir[MAX_SYSPATH]; // engine root directory
char fs_basedir[MAX_SYSPATH]; // base directory of game
char fs_gamedir[MAX_SYSPATH]; // game current directory
char gs_basedir[MAX_SYSPATH]; // initial dir before loading gameinfo.txt (used for compilers too)
char gs_mapname[64]; // used for compilers only
// command ilne parms
int fs_argc;
char *fs_argv[MAX_NUM_ARGVS];
bool fs_ext_path = false; // attempt to read\write from ./ or ../ pathes
bool fs_use_wads = false; // some utilities needs this
cvar_t *fs_defaultdir;
cvar_t *fs_wadsupport;
sysinfo_t SI;
/*
=============================================================================
PRIVATE FUNCTIONS - PK3 HANDLING
=============================================================================
*/
/*
====================
PK3_GetEndOfCentralDir
Extract the end of the central directory from a PK3 package
====================
*/
bool PK3_GetEndOfCentralDir (const char *packfile, int packhandle, dpak3file_t *eocd)
{
fs_offset_t filesize, maxsize;
byte *buffer, *ptr;
int ind;
// Get the package size
filesize = lseek (packhandle, 0, SEEK_END);
if (filesize < ZIP_END_CDIR_SIZE) return false;
// Load the end of the file in memory
if (filesize < (word)0xffff + ZIP_END_CDIR_SIZE)
maxsize = filesize;
else maxsize = (word)0xffff + ZIP_END_CDIR_SIZE;
buffer = (byte *)Mem_Alloc( fs_mempool, maxsize );
lseek (packhandle, filesize - maxsize, SEEK_SET);
if(read(packhandle, buffer, maxsize) != (fs_offset_t)maxsize)
{
Mem_Free(buffer);
return false;
}
// Look for the end of central dir signature around the end of the file
maxsize -= ZIP_END_CDIR_SIZE;
ptr = &buffer[maxsize];
ind = 0;
while(BuffLittleLong(ptr) != IDPK3ENDHEADER)
{
if (ind == maxsize)
{
Mem_Free (buffer);
return false;
}
ind++;
ptr--;
}
Mem_Copy (eocd, ptr, ZIP_END_CDIR_SIZE);
eocd->ident = LittleLong (eocd->ident);
eocd->disknum = LittleShort (eocd->disknum);
eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
eocd->localentries = LittleShort (eocd->localentries);
eocd->nbentries = LittleShort (eocd->nbentries);
eocd->cdir_size = LittleLong (eocd->cdir_size);
eocd->cdir_offset = LittleLong (eocd->cdir_offset);
eocd->comment_size = LittleShort (eocd->comment_size);
Mem_Free (buffer);
return true;
}
/*
====================
PK3_BuildFileList
Extract the file list from a PK3 file
====================
*/
int PK3_BuildFileList (pack_t *pack, const dpak3file_t *eocd)
{
byte *central_dir, *ptr;
uint ind;
fs_offset_t remaining;
// Load the central directory in memory
central_dir = (byte *)Mem_Alloc( fs_mempool, eocd->cdir_size );
lseek( pack->handle, eocd->cdir_offset, SEEK_SET );
read( pack->handle, central_dir, eocd->cdir_size );
// Extract the files properties
// The parsing is done "by hand" because some fields have variable sizes and
// the constant part isn't 4-bytes aligned, which makes the use of structs difficult
remaining = eocd->cdir_size;
pack->numfiles = 0;
ptr = central_dir;
for (ind = 0; ind < eocd->nbentries; ind++)
{
fs_offset_t namesize, count;
// Checking the remaining size
if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
{
Mem_Free (central_dir);
return -1;
}
remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
// Check header
if (BuffLittleLong (ptr) != IDPK3CDRHEADER)
{
Mem_Free (central_dir);
return -1;
}
namesize = BuffLittleShort(&ptr[28]); // filename length
// 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 (?))
// 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)
{
// Still enough bytes for the name?
if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
{
Mem_Free(central_dir);
return -1;
}
// WinZip doesn't use the "directory" attribute, so we need to check the name directly
if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
{
char filename [sizeof (pack->files[0].name)];
fs_offset_t offset, packsize, realsize;
int flags;
// Extract the name (strip it if necessary)
namesize = min(namesize, (int)sizeof (filename) - 1);
Mem_Copy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
filename[namesize] = '\0';
if (BuffLittleShort (&ptr[10]))
flags = PACKFILE_FLAG_DEFLATED;
else flags = 0;
offset = BuffLittleLong (&ptr[42]);
packsize = BuffLittleLong (&ptr[20]);
realsize = BuffLittleLong (&ptr[24]);
FS_AddFileToPack(filename, pack, offset, packsize, realsize, flags);
}
}
// Skip the name, additionnal field, and comment
// 1er uint16 : extra field length
// 2eme uint16 : file comment length
count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
remaining -= count;
}
// If the package is empty, central_dir is NULL here
if (central_dir != NULL) Mem_Free (central_dir);
return pack->numfiles;
}
/*
====================
FS_LoadPackPK3
Create a package entry associated with a PK3 file
====================
*/
pack_t *FS_LoadPackPK3( const char *packfile )
{
int packhandle;
int real_nb_files;
dpak3file_t eocd;
pack_t *pack;
packhandle = open( packfile, O_RDONLY|O_BINARY );
if( packhandle < 0 ) return NULL;
if( !PK3_GetEndOfCentralDir( packfile, packhandle, &eocd ))
{
MsgDev( D_NOTE, "%s is not a PK3 file\n", packfile );
close( packhandle );
return NULL;
}
// multi-volume ZIP archives are NOT allowed
if( eocd.disknum != 0 || eocd.cdir_disknum != 0 )
{
MsgDev( D_NOTE, "%s is a multi-volume ZIP archive. Ignored.\n", packfile );
close( packhandle );
return NULL;
}
// Create a package structure in memory
pack = (pack_t *)Mem_Alloc( fs_mempool, sizeof( pack_t ));
com.strncpy( pack->filename, packfile, sizeof( pack->filename ));
pack->handle = packhandle;
pack->numfiles = eocd.nbentries;
pack->files = (packfile_t *)Mem_Alloc( fs_mempool, eocd.nbentries * sizeof( packfile_t ));
pack->filetime = FS_SysFileTime( packfile );
real_nb_files = PK3_BuildFileList( pack, &eocd );
if( real_nb_files < 0 )
{
MsgDev( D_ERROR, "%s is not a valid PK3 file\n", packfile );
close( pack->handle );
Mem_Free( pack );
return NULL;
}
MsgDev( D_LOAD, "Adding packfile %s (%i files)\n", packfile, real_nb_files );
return pack;
}
/*
====================
PK3_GetTrueFileOffset
Find where the true file data offset is
====================
*/
bool PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
{
byte buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
fs_offset_t count;
// already found?
if (pfile->flags & PACKFILE_FLAG_TRUEOFFS) return true;
// Load the local file description
lseek (pack->handle, pfile->offset, SEEK_SET);
count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffLittleLong (buffer) != IDPACKV3HEADER)
{
Msg("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
return false;
}
// Skip name and extra field
pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
return true;
}
/*
=============================================================================
FILEMATCH COMMON SYSTEM
=============================================================================
*/
int matchpattern(const char *in, const char *pattern, bool caseinsensitive)
{
int c1, c2;
while( *pattern )
{
switch( *pattern )
{
case 0: return 1; // end of pattern
case '?': // match any single character
if( *in == 0 || *in == '/' || *in == '\\' || *in == ':' )
return 0; // no match
in++;
pattern++;
break;
case '*': // match anything until following string
if( !*in ) return 1; // match
pattern++;
while( *in )
{
if( *in == '/' || *in == '\\' || *in == ':' )
break;
// see if pattern matches at this offset
if( matchpattern( in, pattern, caseinsensitive ))
return 1;
// nope, advance to next offset
in++;
}
break;
default:
if( *in != *pattern )
{
if( !caseinsensitive )
return 0; // no match
c1 = *in;
if( c1 >= 'A' && c1 <= 'Z' )
c1 += 'a' - 'A';
c2 = *pattern;
if( c2 >= 'A' && c2 <= 'Z' )
c2 += 'a' - 'A';
if( c1 != c2) return 0; // no match
}
in++;
pattern++;
break;
}
}
if( *in ) return 0; // reached end of pattern but not end of input
return 1; // success
}
void stringlistinit( stringlist_t *list )
{
Mem_Set( list, 0, sizeof( *list ));
}
void stringlistfreecontents(stringlist_t *list)
{
int i;
for (i = 0;i < list->numstrings;i++)
{
if (list->strings[i]) Mem_Free(list->strings[i]);
list->strings[i] = NULL;
}
list->numstrings = 0;
list->maxstrings = 0;
if (list->strings) Mem_Free(list->strings);
}
void stringlistappend( stringlist_t *list, char *text )
{
size_t textlen;
char **oldstrings;
if (list->numstrings >= list->maxstrings)
{
oldstrings = list->strings;
list->maxstrings += 4096;
list->strings = Mem_Alloc(fs_mempool, list->maxstrings * sizeof(*list->strings));
if (list->numstrings) Mem_Copy(list->strings, oldstrings, list->numstrings * sizeof(*list->strings));
if (oldstrings) Mem_Free( oldstrings );
}
textlen = com.strlen( text ) + 1;
list->strings[list->numstrings] = Mem_Alloc( fs_mempool, textlen );
Mem_Copy( list->strings[list->numstrings], text, textlen );
list->numstrings++;
}
void stringlistsort( stringlist_t *list )
{
int i, j;
char *temp;
// this is a selection sort (finds the best entry for each slot)
for( i = 0; i < list->numstrings - 1; i++ )
{
for( j = i + 1; j < list->numstrings; j++ )
{
if( com.strcmp( list->strings[i], list->strings[j] ) > 0 )
{
temp = list->strings[i];
list->strings[i] = list->strings[j];
list->strings[j] = temp;
}
}
}
}
void listdirectory( stringlist_t *list, const char *path )
{
int i;
char pattern[4096], *c;
struct _finddata_t n_file;
long hFile;
com.strncpy( pattern, path, sizeof( pattern ));
com.strncat( pattern, "*", sizeof( pattern ));
// ask for the directory listing handle
hFile = _findfirst( pattern, &n_file );
if( hFile == -1 ) return;
// start a new chain with the the first name
stringlistappend( list, n_file.name );
// iterate through the directory
while( _findnext( hFile, &n_file ) == 0 )
stringlistappend( list, n_file.name );
_findclose( hFile );
// convert names to lowercase because windows doesn't care, but pattern matching code often does
for( i = 0; i < list->numstrings; i++ )
{
for( c = list->strings[i]; *c; c++ )
{
if( *c >= 'A' && *c <= 'Z' )
*c += 'a' - 'A';
}
}
}
/*
=============================================================================
OTHER PRIVATE FUNCTIONS
=============================================================================
*/
/*
====================
FS_AddFileToPack
Add a file to the list of files contained into a package
====================
*/
static packfile_t* FS_AddFileToPack(const char* name, pack_t* pack, fs_offset_t offset, fs_offset_t packsize, fs_offset_t realsize, int flags)
{
int left, right, middle;
packfile_t *pfile;
// look for the slot we should put that file into (binary search)
left = 0;
right = pack->numfiles - 1;
while( left <= right )
{
int diff;
middle = (left + right) / 2;
diff = com.stricmp( pack->files[middle].name, name );
// If we found the file, there's a problem
if( !diff ) MsgDev( D_NOTE, "Package %s contains the file %s several times\n", pack->filename, name );
// If we're too far in the list
if( diff > 0 ) right = middle - 1;
else left = middle + 1;
}
// We have to move the right of the list by one slot to free the one we need
pfile = &pack->files[left];
memmove( pfile + 1, pfile, (pack->numfiles - left) * sizeof( *pfile ));
pack->numfiles++;
com.strncpy( pfile->name, name, sizeof( pfile->name ));
pfile->offset = offset;
pfile->packsize = packsize;
pfile->realsize = realsize;
pfile->flags = flags;
return pfile;
}
/*
============
FS_CreatePath
Only used for FS_Open.
============
*/
void FS_CreatePath( char *path )
{
char *ofs, save;
for( ofs = path+1; *ofs; ofs++ )
{
if (*ofs == '/' || *ofs == '\\')
{
// create the directory
save = *ofs;
*ofs = 0;
_mkdir (path);
*ofs = save;
}
}
}
/*
============
FS_Path_f
debug info
============
*/
void FS_Path_f( void )
{
searchpath_t *s;
Msg( "Current search path:\n" );
for( s = fs_searchpaths; s; s = s->next )
{
if( s->pack ) Msg( "%s (%i files)\n", s->pack->filename, s->pack->numfiles );
else if( s->wad ) Msg( "%s (%i files)\n", s->wad->filename, s->wad->numlumps );
else Msg( "%s\n", s->filename );
}
}
/*
============
FS_ClearPath_f
only for debug targets
============
*/
void FS_ClearPaths_f( void )
{
FS_ClearSearchPath();
}
/*
============
FS_FileBase
Extracts the base name of a file (no path, no extension, assumes '/' as path separator)
============
*/
void _FS_FileBase( const char *in, char *out, bool kill_backwardslash )
{
int len, start, end;
len = com.strlen( in );
if( !len ) return;
// scan backward for '.'
end = len - 1;
while( end && in[end] != '.' && in[end] != '/' && in[end] != '\\' )
end--;
if( in[end] != '.' )
end = len-1; // no '.', copy to end
else end--; // found ',', copy to left of '.'
// scan backward for '/'
start = len - 1;
if( kill_backwardslash )
{
while( start >= 0 && in[start] != '/' && in[start] != '\\' )
start--;
if( start < 0 || ( in[start] != '/' && in[start] != '\\' ))
start = 0;
else start++;
}
else
{
// NOTE: some doomwads using backward slash as part of animation name
// e.g. vile\1, so ignore backward slash for wads
while ( start >= 0 && in[start] != '/' )
start--;
if ( start < 0 || in[start] != '/' )
start = 0;
else start++;
}
// length of new sting
len = end - start + 1;
// Copy partial string
com.strncpy( out, &in[start], len + 1 );
out[len] = 0;
}
void FS_FileBase( const char *in, char *out )
{
_FS_FileBase( in, out, true );
}
void W_FileBase( const char *in, char *out )
{
_FS_FileBase( in, out, false );
}
/*
=================
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.
=================
*/
pack_t *FS_LoadPackPAK( const char *packfile )
{
dpackheader_t header;
int i, numpackfiles;
int packhandle;
pack_t *pack;
dpackfile_t *info;
packhandle = open( packfile, O_RDONLY|O_BINARY );
if( packhandle < 0 ) return NULL;
read( packhandle, (void *)&header, sizeof( header ));
if( header.ident != IDPACKV1HEADER )
{
MsgDev( D_NOTE, "%s is not a packfile. Ignored.\n", packfile );
close( packhandle );
return NULL;
}
header.dirofs = LittleLong( header.dirofs );
header.dirlen = LittleLong( header.dirlen );
if( header.dirlen % sizeof( dpackfile_t ))
{
MsgDev( D_ERROR, "%s has an invalid directory size. Ignored.\n", packfile );
close( packhandle );
return NULL;
}
numpackfiles = header.dirlen / sizeof( dpackfile_t );
if( numpackfiles > MAX_FILES_IN_PACK )
{
MsgDev( D_ERROR, "%s has too many files ( %i ). Ignored.\n", packfile, numpackfiles );
close( packhandle );
return NULL;
}
info = (dpackfile_t *)Mem_Alloc( fs_mempool, sizeof( *info ) * numpackfiles );
lseek( packhandle, header.dirofs, SEEK_SET );
if( header.dirlen != read( packhandle, (void *)info, header.dirlen ))
{
MsgDev( D_NOTE, "%s is an incomplete PAK, not loading\n", packfile );
Mem_Free( info );
close( packhandle );
return NULL;
}
pack = (pack_t *)Mem_Alloc( fs_mempool, sizeof( pack_t ));
com.strncpy( pack->filename, packfile, sizeof( pack->filename ));
pack->handle = packhandle;
pack->numfiles = 0;
pack->files = (packfile_t *)Mem_Alloc( fs_mempool, numpackfiles * sizeof( packfile_t ));
pack->filetime = FS_SysFileTime( packfile );
// parse the directory
for( i = 0; i < numpackfiles; i++ )
{
fs_offset_t offset = LittleLong( info[i].filepos );
fs_offset_t size = LittleLong( info[i].filelen );
FS_AddFileToPack( info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS );
}
Mem_Free( info );
MsgDev( D_LOAD, "Adding packfile: %s (%i files)\n", packfile, numpackfiles );
return pack;
}
/*
=================
FS_LoadPackPK2
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_LoadPackPK2(const char *packfile)
{
dpackheader_t header;
int i, numpackfiles;
int packhandle;
pack_t *pack;
dpak2file_t *info;
packhandle = open (packfile, O_RDONLY | O_BINARY);
if (packhandle < 0) return NULL;
read (packhandle, (void *)&header, sizeof(header));
if(header.ident != IDPACKV2HEADER)
{
Msg("%s is not a packfile\n", packfile);
close(packhandle);
return NULL;
}
header.dirofs = LittleLong (header.dirofs);
header.dirlen = LittleLong (header.dirlen);
if (header.dirlen % sizeof(dpak2file_t))
{
Msg("%s has an invalid directory size\n", packfile);
close(packhandle);
return NULL;
}
numpackfiles = header.dirlen / sizeof(dpak2file_t);
if (numpackfiles > MAX_FILES_IN_PACK)
{
Msg("%s has %i files\n", packfile, numpackfiles);
close(packhandle);
return NULL;
}
info = (dpak2file_t *)Mem_Alloc( fs_mempool, sizeof(*info) * numpackfiles);
lseek (packhandle, header.dirofs, SEEK_SET);
if(header.dirlen != read(packhandle, (void *)info, header.dirlen))
{
Msg("%s is an incomplete PAK, not loading\n", packfile);
Mem_Free(info);
close(packhandle);
return NULL;
}
pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof( pack_t ));
com.strncpy( pack->filename, packfile, sizeof( pack->filename ));
pack->handle = packhandle;
pack->numfiles = 0;
pack->files = (packfile_t *)Mem_Alloc( fs_mempool, numpackfiles * sizeof( packfile_t ));
// parse the directory
for( i = 0; i < numpackfiles; i++ )
{
fs_offset_t offset = LittleLong( info[i].filepos );
fs_offset_t size = LittleLong( info[i].filelen );
FS_AddFileToPack( info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS );
}
Mem_Free( info );
MsgDev( D_LOAD, "Adding packfile %s (%i files)\n", packfile, numpackfiles );
return pack;
}
/*
================
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 bool FS_AddPack_Fullpath( const char *pakfile, bool *already_loaded, bool keep_plain_dirs, int flags )
{
searchpath_t *search;
pack_t *pak = NULL;
const char *ext = FS_FileExtension( pakfile );
for( search = fs_searchpaths; search; search = search->next )
{
if( search->pack && !com.stricmp( search->pack->filename, pakfile ))
{
if( already_loaded ) *already_loaded = true;
return true; // already loaded
}
}
if( already_loaded ) *already_loaded = false;
if( !com.stricmp( ext, "pak" )) pak = FS_LoadPackPAK( pakfile );
else if( !com.stricmp( ext, "pk2" )) pak = FS_LoadPackPK3( pakfile );
else if( !com.stricmp( ext, "pk3" )) pak = FS_LoadPackPK3( pakfile );
else MsgDev( D_ERROR, "\"%s\" does not have a pack extension\n", pakfile );
if( pak )
{
if( keep_plain_dirs )
{
// find the first item whose next one is a pack or NULL
searchpath_t *insertion_point = 0;
if( fs_searchpaths && !fs_searchpaths->pack )
{
insertion_point = fs_searchpaths;
while( 1 )
{
if( !insertion_point->next ) break;
if( insertion_point->next->pack ) break;
insertion_point = insertion_point->next;
}
}
// if insertion_point is NULL, this means that either there is no
// item in the list yet, or that the very first item is a pack. In
// that case, we want to insert at the beginning...
if( !insertion_point )
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->pack = pak;
search->next = fs_searchpaths;
search->flags |= flags;
fs_searchpaths = search;
}
else // otherwise we want to append directly after insertion_point.
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->pack = pak;
search->next = insertion_point->next;
search->flags |= flags;
insertion_point->next = search;
}
}
else
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->pack = pak;
search->next = fs_searchpaths;
search->flags |= flags;
fs_searchpaths = search;
}
return true;
}
else
{
MsgDev( D_ERROR, "FS_AddPack_Fullpath: unable to load pak \"%s\"\n", pakfile );
return false;
}
}
/*
====================
FS_AddWad_Fullpath
====================
*/
static bool FS_AddWad_Fullpath( const char *wadfile, bool *already_loaded, bool keep_plain_dirs )
{
searchpath_t *search;
wfile_t *wad = NULL;
const char *ext = FS_FileExtension( wadfile );
for( search = fs_searchpaths; search; search = search->next )
{
if( search->wad && !com.stricmp( search->wad->filename, wadfile ))
{
if( already_loaded ) *already_loaded = true;
return true; // already loaded
}
}
if( already_loaded ) *already_loaded = false;
if( !com.stricmp( ext, "wad" )) wad = W_Open( wadfile, "rb" );
else MsgDev( D_ERROR, "\"%s\" doesn't have a wad extension\n", wadfile );
if( wad )
{
if( keep_plain_dirs )
{
// find the first item whose next one is a wad or NULL
searchpath_t *insertion_point = NULL;
if( fs_searchpaths && !fs_searchpaths->wad )
{
insertion_point = fs_searchpaths;
while( 1 )
{
if( !insertion_point->next ) break;
if( insertion_point->next->wad ) break;
insertion_point = insertion_point->next;
}
}
// if insertion_point is NULL, this means that either there is no
// item in the list yet, or that the very first item is a wad. In
// that case, we want to insert at the beginning...
if( !insertion_point )
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->wad = wad;
search->next = fs_searchpaths;
fs_searchpaths = search;
}
else // otherwise we want to append directly after insertion_point.
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->wad = wad;
search->next = insertion_point->next;
insertion_point->next = search;
}
}
else
{
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
search->wad = wad;
search->next = fs_searchpaths;
fs_searchpaths = search;
}
MsgDev( D_LOAD, "Adding wadfile %s (%i files)\n", wadfile, wad->numlumps );
return true;
}
else
{
MsgDev( D_ERROR, "FS_AddWad_Fullpath: unable to load wad \"%s\"\n", wadfile );
return false;
}
}
/*
================
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.
================
*/
bool FS_AddPack( const char *pakfile, bool *already_loaded, bool keep_plain_dirs )
{
char fullpath[ MAX_STRING ];
searchpath_t *search;
int index;
if( already_loaded ) *already_loaded = false;
// then find the real name...
search = FS_FindFile( pakfile, &index, true, false );
if( !search || search->pack )
{
MsgDev( D_WARN, "FS_AddPack: could not find pak \"%s\"\n", pakfile );
return false;
}
com.sprintf( fullpath, "%s%s", search->filename, pakfile );
return FS_AddPack_Fullpath( fullpath, already_loaded, keep_plain_dirs, 0 );
}
/*
================
FS_AddGameDirectory
Sets fs_gamedir, adds the directory to the head of the path,
then loads and adds pak1.pak pak2.pak ...
================
*/
void FS_AddGameDirectory( const char *dir, int flags )
{
stringlist_t list;
searchpath_t *search;
string pakfile;
search_t *wads;
int i;
if(!( flags & FS_NOWRITE_PATH ))
com.strncpy( fs_gamedir, dir, sizeof( fs_gamedir ));
stringlistinit( &list );
listdirectory( &list, dir );
stringlistsort( &list );
// add any PAK package in the directory
for( i = 0; i < list.numstrings; i++ )
{
if( !com.stricmp( FS_FileExtension( list.strings[i] ), "pak" ))
{
com.sprintf( pakfile, "%s%s", dir, list.strings[i] );
FS_AddPack_Fullpath( pakfile, NULL, false, flags );
}
}
// add any PK2 package in the directory
for( i = 0; i < list.numstrings; i++ )
{
if( !com.stricmp( FS_FileExtension( list.strings[i]), "pk2" ))
{
com.sprintf( pakfile, "%s%s", dir, list.strings[i] );
FS_AddPack_Fullpath( pakfile, NULL, false, flags );
}
}
// add any PK3 package in the directory
for( i = 0; i < list.numstrings; i++ )
{
if( !com.stricmp( FS_FileExtension( list.strings[i] ), "pk3" ))
{
com.sprintf( pakfile, "%s%s", dir, list.strings[i] );
FS_AddPack_Fullpath( pakfile, NULL, false, flags );
}
}
// add the directory to the search path
// (unpacked files have the priority over packed files)
search = (searchpath_t *)Mem_Alloc( fs_mempool, sizeof( searchpath_t ));
com.strncpy( search->filename, dir, sizeof ( search->filename ));
search->next = fs_searchpaths;
search->flags = flags;
fs_searchpaths = search;
stringlistfreecontents( &list );
if( Sys.app_name == HOST_NORMAL || Sys.app_name == HOST_DEDICATED || Sys.app_name == HOST_BSPLIB )
{
// because we want first add gamedir wads
if(!( flags & FS_GAMEDIR_PATH )) return;
}
// use normal method because we want take access to wad files through pak or pk3 archives
wads = FS_Search( "*.wad", true );
for( i = 0; wads && i < wads->numfilenames; i++ )
FS_AddWad_Fullpath( wads->filenames[i], NULL, false );
if( wads ) Mem_Free( wads );
}
/*
================
FS_AddGameHierarchy
================
*/
void FS_AddGameHierarchy( const char *dir, int flags )
{
// Add the common game directory
if( dir && *dir ) FS_AddGameDirectory( va( "%s%s/", fs_basedir, dir ), flags );
}
/*
============
FS_FileExtension
============
*/
const char *FS_FileExtension( const char *in )
{
const char *separator, *backslash, *colon, *dot;
separator = com.strrchr( in, '/' );
backslash = com.strrchr( in, '\\' );
if( !separator || separator < backslash ) separator = backslash;
colon = com.strrchr( in, ':' );
if( !separator || separator < colon ) separator = colon;
dot = com.strrchr( in, '.' );
if( dot == NULL || (separator && (dot < separator)))
return "";
return dot + 1;
}
/*
============
FS_FileWithoutPath
============
*/
const char *FS_FileWithoutPath( const char *in )
{
const char *separator, *backslash, *colon;
separator = com.strrchr( in, '/' );
backslash = com.strrchr( in, '\\' );
if( !separator || separator < backslash ) separator = backslash;
colon = com.strrchr( in, ':' );
if( !separator || separator < colon ) separator = colon;
return separator ? separator + 1 : in;
}
/*
============
FS_ExtractFilePath
============
*/
void FS_ExtractFilePath( const char* const path, char* dest )
{
const char *src;
src = path + com.strlen( path ) - 1;
// back up until a \ or the start
while( src != path && !(*(src - 1) == '\\' || *(src - 1) == '/' ))
src--;
if( src != path )
{
Mem_Copy( dest, path, src - path );
dest[src - path - 1] = 0; // cutoff backslash
}
else com.strcpy( dest, "" ); // file without path
}
/*
================
FS_ClearSearchPath
================
*/
void FS_ClearSearchPath( void )
{
while( fs_searchpaths )
{
searchpath_t *search = fs_searchpaths;
if( search->flags & FS_STATIC_PATH )
{
// skip read-only pathes e.g. "bin"
if( search->next )
fs_searchpaths = search->next->next;
else break;
}
else fs_searchpaths = search->next;
if( search->pack )
{
if( search->pack->files )
Mem_Free( search->pack->files );
Mem_Free( search->pack );
}
if( search->wad )
{
W_Close( search->wad );
}
Mem_Free( search );
}
}
/*
====================
FS_CheckNastyPath
Return true if the path should be rejected due to one of the following:
1: path elements that are non-portable
2: path elements that would allow access to files outside the game directory,
or are just not a good idea for a mod to be using.
====================
*/
int FS_CheckNastyPath( const char *path, bool 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( com.strstr( path, "\\" ) && !fs_ext_path ) return 1; // non-portable
// Mac: don't allow Mac-only filenames - : is a directory separator
// instead of /, but we rely on / working already, so there's no reason to
// support a Mac-only path
// Amiga and Windows: : tries to go to root of drive
if( com.strstr( path, ":" ) && !fs_ext_path ) return 1; // non-portable attempt to go to root of drive
// Amiga: // is parent directory
if( com.strstr( path, "//" ) && !fs_ext_path ) return 1; // non-portable attempt to go to parent directory
// all: don't allow going to parent directory (../ or /../)
if( com.strstr( path, ".." ) && !fs_ext_path ) return 2; // attempt to go outside the game directory
// Windows and UNIXes: don't allow absolute paths
if( path[0] == '/' && !fs_ext_path ) 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( com.strchr( path, '.' ) && !fs_ext_path )
{
if( isgamedir ) return 2; // gamedir is entirely path elements, so simply forbid . entirely
if( com.strchr( path, '.' ) < com.strrchr( path, '/' )) return 2; // possible attempt to go outside the game directory
}
// all: forbid trailing slash on gamedir
if( isgamedir && !fs_ext_path && path[com.strlen( path )-1] == '/' ) return 2;
// all: forbid leading dot on any filename for any reason
if( com.strstr( path, "/." ) && !fs_ext_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;
}
/*
================
FS_Rescan
================
*/
void FS_Rescan( void )
{
MsgDev( D_NOTE, "FS_Rescan( %s )\n", SI.GameInfo->title );
FS_ClearSearchPath();
FS_AddGameHierarchy( SI.GameInfo->basedir, 0 );
FS_AddGameHierarchy( SI.GameInfo->gamedir, FS_GAMEDIR_PATH );
}
void FS_Rescan_f( void )
{
FS_Rescan();
}
void FS_CreatePathesList( void )
{
file_t *f;
// make simple pathes.rc
f = FS_Open( "pathes.rc", "w" );
if( !f ) return; // not fatal for us
FS_Printf (f, "//=======================================================================\n");
FS_Printf (f, "//\t\t\tCopyright XashXT Group %s ©\n", com.timestamp( TIME_YEAR_ONLY ));
FS_Printf (f, "//\t\t pathes.rc - executable associations\n");
FS_Printf (f, "//=======================================================================\n");
FS_Printf (f, "\n");
FS_Printf (f, "// executable name\t\tlinked basedir\n");
FS_Printf (f, "quake.exe\t\t\tid1\n" );
FS_Printf (f, "quake2.exe\t\tbaseq2\n" );
FS_Printf (f, "quake3.exe\t\tbaseq3\n" );
FS_Printf (f, "hl.exe\t\t\tvalve\n" );
FS_Close (f);
}
void FS_ApplyBaseDir( void )
{
script_t *script;
token_t tok;
if( Sys.app_state == SYS_RESTART ) return; // don't associate folder names - may be collisions
if( !FS_FileExists( "pathes.rc" )) FS_CreatePathesList();
script = PS_LoadScript( "pathes.rc", NULL, 0 );
if( !script ) return; // use standard methods
while( PS_ReadToken( script, SC_ALLOW_NEWLINES|SC_ALLOW_PATHNAMES, &tok ))
{
FS_StripExtension( tok.string ); // cutoff .exe if present
if( !com.stricmp( tok.string, gs_basedir ))
{
if( PS_ReadToken( script, SC_ALLOW_PATHNAMES, &tok ))
{
// install new basedir
com.strncpy( gs_basedir, tok.string, sizeof( gs_basedir ));
break;
}
else MsgDev( D_ERROR, "missing associated directory with %s.exe\n", gs_basedir );
}
else PS_SkipRestOfLine( script );
}
PS_FreeScript( script );
}
void FS_UpdateSysInfo( void )
{
com.strcpy( SI.username, Sys_GetCurrentUser());
SI.developer = Sys.developer;
SI.version = XASH_VERSION;
}
static bool FS_ParseVector( script_t *script, float *v, size_t size )
{
uint i;
token_t token;
bool bracket = false;
if( v == NULL || size == 0 )
return false;
Mem_Set( v, 0, sizeof( *v ) * size );
if( size == 1 )
return PS_GetFloat( script, 0, v );
if( !PS_ReadToken( script, false, &token ))
return false;
if( token.type == TT_PUNCTUATION && !com.stricmp( token.string, "(" ))
bracket = true;
else PS_SaveToken( script, &token ); // save token to right get it again
for( i = 0; i < size; i++ )
{
if( !PS_GetFloat( script, false, &v[i] ))
v[i] = 0; // because Com_ReadFloat may return 0 if parsing expression it's not a number
}
if( !bracket ) return true; // done
if( !PS_ReadToken( script, false, &token ))
return false;
if( token.type == TT_PUNCTUATION && !com.stricmp( token.string, ")" ))
return true;
return false;
}
void FS_CreateGameInfo( const char *filename )
{
char *buffer = Mem_Alloc( fs_mempool, MAX_SYSPATH );
// make simple gameinfo.txt
com.strncat( buffer, va("// generated by Xash3D\r\r\nbasedir\t\t\"%s\"\n", gs_basedir), MAX_SYSPATH ); // add new string
com.strncat( buffer, va("gamedir\t\t\"%s\"\n", gs_basedir ), MAX_SYSPATH);
com.strncat( buffer, va("title\t\t\"New Game\"\rversion\t\t\"%g\"\rviewmode\t\t\"firstperson\"\r", XASH_VERSION ), MAX_SYSPATH );
com.strncat( buffer, "gamemode\t\t\"default\"\r", MAX_SYSPATH );
com.strncat( buffer, "\nstartmap\t\t\"newmap\"\n\n", MAX_SYSPATH );
com.strncat( buffer, "\ngameHint\t\t\"Xash3D\"", MAX_SYSPATH );
com.strncat( buffer, "\nsp_spawn\t\t\"info_player_start\"", MAX_SYSPATH );
com.strncat( buffer, "\ndm_spawn\t\t\"info_player_deathmatch\"", MAX_SYSPATH );
com.strncat( buffer, "\nctf_spawn\t\t\"info_player_ctf\"", MAX_SYSPATH );
com.strncat( buffer, "\ncoop_spawn\t\"info_player_coop\"", MAX_SYSPATH );
com.strncat( buffer, "\nteam_spawn\t\"info_player_team\"", MAX_SYSPATH );
com.strncat( buffer, "\nhull0\t\t( 0 0 0 ) ( 0 0 0 )", MAX_SYSPATH );
com.strncat( buffer, "\nhull1\t\t( -16 -16 -36 ) ( 16 16 36 )", MAX_SYSPATH );
com.strncat( buffer, "\nhull2\t\t( -32 -32 -32 ) ( 32 32 32 )", MAX_SYSPATH );
com.strncat( buffer, "\nhull3\t\t( -16 -16 -18 ) ( 16 16 18 )", MAX_SYSPATH );
com.strncat( buffer, "\nviewheight0\t28", MAX_SYSPATH );
com.strncat( buffer, "\nviewheight1\t12", MAX_SYSPATH );
com.strncat( buffer, "\nmax_edicts\t1024", MAX_SYSPATH );
com.strncat( buffer, "\nurl_update\t\"\"", MAX_SYSPATH );
com.strncat( buffer, "\nurl_info\t\"\"", MAX_SYSPATH );
com.strncat( buffer, "\n\n\n", MAX_SYSPATH );
FS_WriteFile( filename, buffer, com.strlen( buffer ));
Mem_Free( buffer );
}
/*
================
FS_ParseGameInfo
================
*/
static bool FS_ParseGameInfo( const char *filename, gameinfo_t *GameInfo )
{
script_t *script = NULL;
string fs_path, filepath;
token_t token;
com.snprintf( filepath, sizeof( filepath ), "%s/gameinfo.txt", filename );
// force to create gameinfo for specified game if missing
if( !com.stricmp( gs_basedir, filename ) && !FS_FileExists( filepath ))
FS_CreateGameInfo( filepath );
if( !GameInfo ) return false; // no dest
script = PS_LoadScript( filepath, NULL, 0 );
if( !script ) return false;
// setup default values
com.strncpy( GameInfo->gamefolder, filename, MAX_STRING );
GameInfo->max_edicts = 1024; // default value if not specified
GameInfo->version = 1.0;
GameInfo->viewheight[0] = 28.0f;
GameInfo->viewheight[1] = 12.0f;
GameInfo->sp_inhibite_ents = false;
com.strncpy( GameInfo->gameHint, "Xash3D", MAX_STRING );
com.strncpy( GameInfo->sp_entity, "info_player_start", MAX_STRING );
com.strncpy( GameInfo->dm_entity, "info_player_deathmatch", MAX_STRING );
com.strncpy( GameInfo->ctf_entity, "info_player_ctf", MAX_STRING );
com.strncpy( GameInfo->coop_entity, "info_player_coop", MAX_STRING );
com.strncpy( GameInfo->team_entity, "info_player_team", MAX_STRING );
com.strncpy( GameInfo->startmap, "", MAX_STRING );
VectorSet( GameInfo->client_mins[0], 0, 0, 0 );
VectorSet( GameInfo->client_maxs[0], 0, 0, 0 );
VectorSet( GameInfo->client_mins[1], -16, -16, -36 );
VectorSet( GameInfo->client_maxs[1], 16, 16, 36 );
VectorSet( GameInfo->client_mins[2], -32, -32, -32 );
VectorSet( GameInfo->client_maxs[2], 32, 32, 32 );
VectorSet( GameInfo->client_mins[3], -16, -16, -18 );
VectorSet( GameInfo->client_maxs[3], 16, 16, 18 );
while( script )
{
if( !PS_ReadToken( script, SC_ALLOW_NEWLINES, &token ))
break;
if( !com.stricmp( token.string, "basedir" ))
{
PS_GetString( script, false, fs_path, MAX_STRING );
if( com.stricmp( fs_path, GameInfo->basedir ) || com.stricmp( fs_path, GameInfo->gamedir ))
com.strncpy( GameInfo->basedir, fs_path, MAX_STRING );
}
else if( !com.stricmp( token.string, "gamedir" ))
{
PS_GetString( script, false, fs_path, MAX_STRING );
if( com.stricmp( fs_path, GameInfo->basedir ) || com.stricmp( fs_path, GameInfo->gamedir ))
com.strncpy( GameInfo->gamedir, fs_path, MAX_STRING );
}
else if( !com.stricmp( token.string, "title" ))
{
PS_GetString( script, false, GameInfo->title, sizeof( GameInfo->title ));
}
else if( !com.stricmp( token.string, "gameHint" ))
{
PS_GetString( script, false, GameInfo->gameHint, sizeof( GameInfo->gameHint ));
}
else if( !com.stricmp( token.string, "sp_spawn" ))
{
PS_GetString( script, false, GameInfo->sp_entity, sizeof( GameInfo->sp_entity ));
}
else if( !com.stricmp( token.string, "dm_spawn" ))
{
PS_GetString( script, false, GameInfo->dm_entity, sizeof( GameInfo->dm_entity ));
}
else if( !com.stricmp( token.string, "ctf_spawn" ))
{
PS_GetString( script, false, GameInfo->ctf_entity, sizeof( GameInfo->ctf_entity ));
}
else if( !com.stricmp( token.string, "coop_spawn" ))
{
PS_GetString( script, false, GameInfo->coop_entity, sizeof( GameInfo->coop_entity ));
}
else if( !com.stricmp( token.string, "team_spawn" ))
{
PS_GetString( script, false, GameInfo->team_entity, sizeof( GameInfo->team_entity ));
}
else if( !com.stricmp( token.string, "startmap" ))
{
PS_GetString( script, false, GameInfo->startmap, sizeof( GameInfo->startmap ));
}
else if( !com.stricmp( token.string, "trainmap" ))
{
PS_GetString( script, false, GameInfo->trainmap, sizeof( GameInfo->trainmap ));
}
else if( !com.stricmp( token.string, "url_info" ))
{
PS_GetString( script, false, GameInfo->game_url, sizeof( GameInfo->game_url ));
}
else if( !com.stricmp( token.string, "url_update" ))
{
PS_GetString( script, false, GameInfo->update_url, sizeof( GameInfo->update_url ));
}
else if( !com.stricmp( token.string, "textures_path" ))
{
PS_GetString( script, false, GameInfo->texpath, sizeof( GameInfo->texpath ));
}
else if( !com.stricmp( token.string, "date" ))
{
PS_GetString( script, false, GameInfo->date, sizeof( GameInfo->date ));
}
else if( !com.stricmp( token.string, "type" ))
{
PS_GetString( script, false, GameInfo->type, sizeof( GameInfo->type ));
}
else if( !com.stricmp( token.string, "version" ))
{
PS_GetFloat( script, false, &GameInfo->version );
}
else if( !com.stricmp( token.string, "size" ))
{
PS_ReadToken( script, 0, &token );
GameInfo->size = com.atoi( token.string );
}
else if( !com.stricmp( token.string, "allow_inhibited_entities" ))
{
MsgDev( D_INFO, "GameInfo: Q1-like inhibite entities mode enabled\n" );
GameInfo->sp_inhibite_ents = true;
}
else if( !com.stricmp( token.string, "max_edicts" ))
{
PS_GetInteger( script, false, &GameInfo->max_edicts );
GameInfo->max_edicts = bound( 600, GameInfo->max_edicts, 32000 ); // reserve some edicts for tempents
}
else if( !com.stricmp( token.string, "viewmode" ))
{
PS_ReadToken( script, 0, &token );
if( !com.stricmp( token.string, "firstperson" ))
GameInfo->viewmode = 1;
else if( !com.stricmp( token.string, "thirdperson" ))
GameInfo->viewmode = 2;
}
else if( !com.stricmp( token.string, "gamemode" ))
{
PS_ReadToken( script, 0, &token );
if( !com.stricmp( token.string, "singleplayer_only" ))
GameInfo->gamemode = 1;
else if( !com.stricmp( token.string, "multiplayer_only" ))
GameInfo->gamemode = 2;
}
else if( !com.strnicmp( token.string, "hull", 4 ))
{
int hullNum = com.atoi( token.string + 4 );
if( hullNum < 0 || hullNum > 15 )
{
MsgDev( D_ERROR, "FS_ParseGameInfo: Invalid hull number %i. Ignored.\n", hullNum );
PS_SkipRestOfLine( script );
}
else
{
FS_ParseVector( script, GameInfo->client_mins[hullNum], 3 );
FS_ParseVector( script, GameInfo->client_maxs[hullNum], 3 );
}
}
else if( !com.strnicmp( token.string, "viewheight", 10 ))
{
int hullNum = com.atoi( token.string + 10 );
float value;
if( hullNum < 0 || hullNum > ( PM_MAXHULLS - 1 ))
{
MsgDev( D_ERROR, "FS_ParseGameInfo: Invalid hull number %i. Ignored.\n", hullNum );
PS_SkipRestOfLine( script );
}
else
{
if( PS_GetFloat( script, false, &value ))
GameInfo->viewheight[hullNum] = value;
}
}
}
PS_FreeScript( script );
return true;
}
/*
================
FS_LoadGameInfo
can be passed null arg
================
*/
void FS_LoadGameInfo( const char *rootfolder )
{
int i;
// lock uplevel of gamedir for read\write
fs_ext_path = false;
if( rootfolder ) com.strcpy( gs_basedir, rootfolder );
MsgDev( D_NOTE, "FS_LoadGameInfo( %s )\n", gs_basedir );
// clear any old pathes
FS_ClearSearchPath();
// validate gamedir
for( i = 0; i < SI.numgames; i++ )
{
if( !com.stricmp( SI.games[i]->gamefolder, gs_basedir ))
break;
}
if( i == SI.numgames )
Sys_Break( "Couldn't find game directory '%s'\n", gs_basedir );
SI.GameInfo = SI.games[i];
FS_Rescan(); // create new filesystem
}
/*
================
FS_Init
================
*/
void FS_Init( void )
{
stringlist_t dirs;
bool hasDefaultDir = false;
int i;
FS_InitMemory();
FS_AddGameDirectory( "bin/", FS_STATIC_PATH ); // execute system config
Cmd_AddCommand( "fs_rescan", FS_Rescan_f, "rescan filesystem search pathes" );
Cmd_AddCommand( "fs_path", FS_Path_f, "show filesystem search pathes" );
Cmd_AddCommand( "fs_clearpaths", FS_ClearPaths_f, "clear filesystem search pathes" );
fs_wadsupport = Cvar_Get( "fs_wadsupport", "0", CVAR_SYSTEMINFO, "enable wad-archive support" );
fs_defaultdir = Cvar_Get( "fs_defaultdir", "tmpQuArK", CVAR_SYSTEMINFO, "user-game default directory" );
Cbuf_ExecuteText( EXEC_NOW, "systemcfg\n" );
Cbuf_Execute(); // apply system cvars immediately
// ignore commandlineoption "-game" for other stuff
if( Sys.app_name == HOST_NORMAL || Sys.app_name == HOST_DEDICATED || Sys.app_name == HOST_BSPLIB )
{
stringlistinit( &dirs );
listdirectory( &dirs, "./" );
stringlistsort( &dirs );
SI.numgames = 0;
if( !FS_GetParmFromCmdLine( "-game", gs_basedir, sizeof( gs_basedir )))
{
if( Sys.app_name == HOST_BSPLIB )
com.strcpy( gs_basedir, fs_defaultdir->string );
else if( Sys_GetModuleName( gs_basedir, MAX_SYSPATH ));
else com.strcpy( gs_basedir, fs_defaultdir->string ); // default dir
FS_ApplyBaseDir(); // check for associated folders
}
// checked nasty path: "bin" it's a reserved word
if( FS_CheckNastyPath( gs_basedir, true ) || !com.stricmp( "bin", gs_basedir ))
{
MsgDev( D_ERROR, "FS_Init: invalid game directory \"%s\"\n", gs_basedir );
com.strcpy( gs_basedir, fs_defaultdir->string ); // default dir
}
// validate directories
for( i = 0; i < dirs.numstrings; i++ )
{
if( !com.stricmp( fs_defaultdir->string, dirs.strings[i] ))
hasDefaultDir = true;
if( !com.stricmp( gs_basedir, dirs.strings[i] ))
break;
}
if( i == dirs.numstrings )
{
MsgDev( D_INFO, "FS_Init: game directory \"%s\" not exist\n", gs_basedir );
if( hasDefaultDir ) com.strcpy( gs_basedir, fs_defaultdir->string ); // default dir
}
// build list of game directories here
FS_AddGameDirectory( "./", 0 );
for( i = 0; i < dirs.numstrings; i++ )
{
const char *ext = FS_FileExtension( dirs.strings[i] );
if( com.stricmp( ext, "" ) || (!com.stricmp( dirs.strings[i], ".." ) && !fs_ext_path))
continue;
if( !SI.games[SI.numgames] )
SI.games[SI.numgames] = (gameinfo_t *)Mem_Alloc( fs_mempool, sizeof( gameinfo_t ));
if( FS_ParseGameInfo( dirs.strings[i], SI.games[SI.numgames] ))
SI.numgames++; // added
}
stringlistfreecontents( &dirs );
}
// enable explicit wad support for some tools
switch( Sys.app_name )
{
case HOST_WADLIB:
case HOST_RIPPER:
case HOST_XIMAGE:
fs_use_wads = true;
break;
default:
fs_use_wads = false;
break;
}
FS_UpdateSysInfo();
MsgDev( D_INFO, "FS_Root: %s\n", sys_rootdir );
MsgDev( D_NOTE, "FS_Init: done\n" );
}
void FS_InitRootDir( char *path )
{
char szTemp[4096];
FS_InitMemory();
// just set cwd
GetModuleFileName( NULL, szTemp, MAX_SYSPATH );
FS_ExtractFilePath( szTemp, szTemp );
SetCurrentDirectory ( szTemp );
// use extended pathname
fs_ext_path = true;
FS_ClearSearchPath();
FS_AddGameHierarchy( path, FS_STATIC_PATH );
}
bool FS_GetParmFromCmdLine( char *parm, char *out, size_t size )
{
int argc = FS_CheckParm( parm );
if(!argc) return false;
if(!out) return false;
if(!fs_argv[argc + 1]) return false;
com.strncpy( out, fs_argv[argc+1], size );
return true;
}
void FS_AllowDirectPaths( bool enable )
{
fs_ext_path = enable;
}
/*
============
FS_WriteVariables
Appends lines containing "set variable value" for all variables
with the archive flag set to true.
============
*/
static void FS_WriteCvar( const char *name, const char *string, const char *desc, void *f )
{
if( !desc ) return; // ignore cvars without description (fantom variables)
FS_Printf( f, "setc %s \"%s\"\n", name, string );
}
void FS_WriteVariables( file_t *f )
{
Cvar_LookupVars( CVAR_SYSTEMINFO, NULL, f, FS_WriteCvar );
}
void FS_UpdateConfig( void )
{
file_t *f;
if( Sys.app_state == SYS_ERROR ) return;
// only normal and bsplib instance can change config.rc
if( Sys.app_name != HOST_NORMAL && Sys.app_name != HOST_BSPLIB ) return;
com.strncpy( fs_gamedir, "bin", sizeof( fs_gamedir )); // set write directory for system config
f = FS_Open( "config.rc", "w" );
if( f )
{
FS_Printf (f, "//=======================================================================\n");
FS_Printf (f, "//\t\t\tCopyright XashXT Group %s ©\n", com.timestamp( TIME_YEAR_ONLY ));
FS_Printf (f, "//\t\t config.rc - archive of system cvars\n");
FS_Printf (f, "//=======================================================================\n");
FS_WriteVariables( f );
FS_Close (f);
}
else MsgDev( D_ERROR, "can't update config.rc.\n" );
}
/*
================
FS_Shutdown
================
*/
void FS_Shutdown( void )
{
int i;
// release gamedirs
for( i = 0; i < SI.numgames; i++ )
if( SI.games[i] ) Mem_Free( SI.games[i] );
Mem_Set( &SI, 0, sizeof( SI ));
FS_ClearSearchPath(); // release all wad files too
FS_UpdateEnvironmentVariables(); // merge working directory
FS_UpdateConfig();
Mem_FreePool( &fs_mempool );
}
/*
====================
FS_SysFileTime
Internal function used to determine filetime
====================
*/
static long FS_SysFileTime( const char *filename )
{
struct stat buf;
if( stat( filename, &buf ) == -1 )
return -1;
return buf.st_mtime;
}
/*
====================
FS_SysOpen
Internal function used to create a file_t and open the relevant non-packed file on disk
====================
*/
static file_t* FS_SysOpen( const char* filepath, const char* mode )
{
file_t *file;
int mod, opt;
uint 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:
MsgDev( D_ERROR, "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:
MsgDev( D_ERROR, "FS_SysOpen: %s: unknown char in mode (%c)\n", filepath, mode, mode[ind] );
break;
}
}
file = (file_t *)Mem_Alloc( fs_mempool, sizeof( *file ));
file->filetime = FS_SysFileTime( filepath );
file->ungetc = EOF;
file->handle = open( filepath, mod|opt, 0666 );
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
===========
*/
file_t *FS_OpenPackedFile( pack_t *pack, int pack_ind )
{
packfile_t *pfile;
int dup_handle;
file_t *file;
pfile = &pack->files[pack_ind];
// if we don't have the true offset, get it now
if( !( pfile->flags & PACKFILE_FLAG_TRUEOFFS ))
if( !PK3_GetTrueFileOffset( pfile, pack ))
return NULL;
if( lseek( pack->handle, pfile->offset, SEEK_SET ) == -1 )
{
Msg( "FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n", pfile->name, pack->filename, pfile->offset );
return NULL;
}
dup_handle = dup( pack->handle );
if( dup_handle < 0 )
{
Msg( "FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename );
return NULL;
}
file = (file_t *)Mem_Alloc( fs_mempool, sizeof( *file ));
Mem_Set( file, 0, sizeof( *file ));
file->handle = dup_handle;
file->flags = FILE_FLAG_PACKED;
file->real_length = pfile->realsize;
file->offset = pfile->offset;
file->position = 0;
file->ungetc = EOF;
if( pfile->flags & PACKFILE_FLAG_DEFLATED )
{
ztoolkit_t *ztk;
file->flags |= FILE_FLAG_DEFLATED;
// We need some more variables
ztk = (ztoolkit_t *)Mem_Alloc( fs_mempool, sizeof( *ztk ));
ztk->comp_length = pfile->packsize;
// Initialize zlib stream
ztk->zstream.next_in = ztk->input;
ztk->zstream.avail_in = 0;
if( inflateInit2( &ztk->zstream, -MAX_WBITS ) != Z_OK )
{
Msg( "FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name );
close( dup_handle );
Mem_Free( file );
return NULL;
}
ztk->zstream.next_out = file->buff;
ztk->zstream.avail_out = sizeof( file->buff );
file->ztk = ztk;
}
return file;
}
/*
==================
FS_SysFileExists
Look for a file in the filesystem only
==================
*/
bool FS_SysFileExists( const char *path )
{
int desc;
desc = open( path, O_RDONLY|O_BINARY );
if( desc < 0 ) return false;
close( desc );
return true;
}
/*
====================
FS_FindFile
Look for a file in the packages and in the filesystem
Return the searchpath where the file was found (or NULL)
and the file index in the package if relevant
====================
*/
static searchpath_t *FS_FindFile( const char *name, int* index, bool quiet, bool gamedironly )
{
searchpath_t *search;
char *pEnvPath;
pack_t *pak;
// search through the path, one element at a time
for( search = fs_searchpaths; search; search = search->next )
{
if( gamedironly & !( search->flags & FS_GAMEDIR_PATH ))
continue;
// is the element a pak file?
if( search->pack )
{
int left, right, middle;
pak = search->pack;
// look for the file (binary search)
left = 0;
right = pak->numfiles - 1;
while( left <= right )
{
int diff;
middle = (left + right) / 2;
diff = com.stricmp( pak->files[middle].name, name );
// Found it
if( !diff )
{
if( !quiet ) MsgDev( D_INFO, "FS_FindFile: %s in %s\n", pak->files[middle].name, pak->filename );
if( index ) *index = middle;
return search;
}
// if we're too far in the list
if( diff > 0 )
right = middle - 1;
else left = middle + 1;
}
}
else if( search->wad )
{
dlumpinfo_t *lump;
char type = W_TypeFromExt( name );
bool anywadname = true;
string wadname, wadfolder;
string shortname;
// quick reject by filetype
if( type == TYPE_NONE ) continue;
FS_ExtractFilePath( name, wadname );
wadfolder[0] = '\0';
if( com.strlen( wadname ))
{
FS_FileBase( wadname, wadname );
com.strncpy( wadfolder, wadname, sizeof( wadfolder ));
FS_DefaultExtension( wadname, ".wad" );
anywadname = false;
}
// quick reject by wadname
if( !anywadname && com.stricmp( wadname, search->wad->filename ))
continue;
// NOTE: we can't using long names for wad,
// because we using original wad names[16];
W_FileBase( name, shortname );
// can't using binary search: wad lumps never sorting by alphabetical
lump = W_FindLump( search->wad, shortname, type );
if( lump )
{
if( !quiet ) MsgDev( D_INFO, "FS_FindFile: %s in %s\n", lump->name, search->wad->filename );
if( index ) *index = lump - search->wad->lumps;
return search;
}
}
else
{
char netpath[MAX_SYSPATH];
com.sprintf( netpath, "%s%s", search->filename, name );
if( FS_SysFileExists( netpath ))
{
if( !quiet ) MsgDev( D_INFO, "FS_FindFile: %s\n", netpath );
if( index != NULL ) *index = -1;
return search;
}
}
}
if( fs_ext_path && ( pEnvPath = getenv( "Path" )))
{
char netpath[MAX_SYSPATH];
// clear searchpath
search = &fs_directpath;
Mem_Set( search, 0, sizeof( searchpath_t ));
// search for environment path
while( pEnvPath )
{
char *end = com.strchr( pEnvPath, ';' );
if( !end ) break;
com.strncpy( search->filename, pEnvPath, (end - pEnvPath) + 1 );
com.strcat( search->filename, "\\" );
com.snprintf( netpath, MAX_SYSPATH, "%s%s", search->filename, name );
if( FS_SysFileExists( netpath ))
{
if( !quiet ) MsgDev( D_INFO, "FS_FindFile: %s\n", netpath );
if( index != NULL ) *index = -1;
return search;
}
pEnvPath += (end - pEnvPath) + 1; // move pointer
}
}
if( !quiet ) MsgDev( D_WARN, "FS_FindFile: can't find %s\n", name );
if( index != NULL ) *index = -1;
return NULL;
}
/*
===========
FS_OpenReadFile
Look for a file in the search paths and open it in read-only mode
===========
*/
file_t *FS_OpenReadFile( const char *filename, const char *mode, bool quiet )
{
searchpath_t *search;
bool gamedironly = false;
int pack_ind;
if( filename[0] == '' )
{
filename++;
gamedironly = true;
}
search = FS_FindFile( filename, &pack_ind, quiet, gamedironly );
// not found?
if( search == NULL )
return NULL;
if( search->pack )
return FS_OpenPackedFile( search->pack, pack_ind );
else if( search->wad )
return NULL; // let W_LoadFile get lump correctly
else if( pack_ind < 0 )
{
// found in the filesystem?
char path [MAX_SYSPATH];
com.sprintf( path, "%s%s", search->filename, filename );
return FS_SysOpen( path, mode );
}
return NULL;
}
/*
=============================================================================
MAIN PUBLIC FUNCTIONS
=============================================================================
*/
/*
====================
FS_Open
Open a file. The syntax is the same as fopen
====================
*/
file_t* _FS_Open( const char* filepath, const char* mode, bool quiet )
{
if( FS_CheckNastyPath( filepath, false ))
{
MsgDev( D_NOTE, "FS_Open: (\"%s\", \"%s\"): nasty filename rejected\n", filepath, mode );
return NULL;
}
// if the file is opened in "write", "append", or "read/write" mode
if( mode[0] == 'w' || mode[0] == 'a' || com.strchr( mode, '+' ))
{
char real_path[MAX_SYSPATH];
// open the file on disk directly
com.sprintf( real_path, "%s/%s", fs_gamedir, filepath );
FS_CreatePath( real_path );// Create directories up to the file
return FS_SysOpen( real_path, mode );
}
// else, we look at the various search paths and open the file in read-only mode
return FS_OpenReadFile( filepath, mode, quiet );
}
file_t* FS_Open( const char* filepath, const char* mode )
{
return _FS_Open( filepath, mode, true );
}
/*
====================
FS_Close
Close a file
====================
*/
int FS_Close( file_t* file )
{
if( close( file->handle ))
return EOF;
if( file->ztk )
{
inflateEnd( &file->ztk->zstream );
Mem_Free( file->ztk );
}
Mem_Free( file );
return 0;
}
/*
====================
FS_Write
Write "datasize" bytes into a file
====================
*/
fs_offset_t FS_Write( file_t* file, const void* data, size_t datasize )
{
fs_offset_t result;
if( !file ) return 0;
// if necessary, seek to the exact file position we're supposed to be
if( file->buff_ind != file->buff_len )
lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
// Purge cached data
FS_Purge (file);
// Write the buffer and update the position
result = write (file->handle, data, (fs_offset_t)datasize);
file->position = lseek (file->handle, 0, SEEK_CUR);
if (file->real_length < file->position)
file->real_length = file->position;
if( result < 0 ) return 0;
return result;
}
/*
====================
FS_Read
Read up to "buffersize" bytes from a file
====================
*/
fs_offset_t FS_Read (file_t* file, void* buffer, size_t buffersize)
{
fs_offset_t count, done;
// nothing to copy
if (buffersize == 0) return 1;
// Get rid of the ungetc character
if (file->ungetc != EOF)
{
((char*)buffer)[0] = file->ungetc;
buffersize--;
file->ungetc = EOF;
done = 1;
}
else done = 0;
// 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;
done += ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
Mem_Copy (buffer, &file->buff[file->buff_ind], done);
file->buff_ind += done;
buffersize -= done;
if (buffersize == 0) return done;
}
// NOTE: at this point, the read buffer is always empty
// If the file isn't compressed
if (! (file->flags & FILE_FLAG_DEFLATED))
{
fs_offset_t nb;
// We must take care to not read after the end of the file
count = file->real_length - file->position;
// If we have a lot of data to get, put them directly into "buffer"
if (buffersize > sizeof (file->buff) / 2)
{
if (count > (fs_offset_t)buffersize)
count = (fs_offset_t)buffersize;
lseek (file->handle, file->offset + file->position, SEEK_SET);
nb = read (file->handle, &((unsigned char*)buffer)[done], count);
if (nb > 0)
{
done += nb;
file->position += nb;
// Purge cached data
FS_Purge (file);
}
}
else
{
if (count > (fs_offset_t)sizeof (file->buff))
count = (fs_offset_t)sizeof (file->buff);
lseek (file->handle, file->offset + file->position, SEEK_SET);
nb = read (file->handle, file->buff, count);
if (nb > 0)
{
file->buff_len = nb;
file->position += nb;
// Copy the requested data in "buffer" (as much as we can)
count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
Mem_Copy (&((unsigned char*)buffer)[done], file->buff, count);
file->buff_ind = count;
done += count;
}
}
return done;
}
// If the file is compressed, it's more complicated...
// We cycle through a few operations until we have read enough data
while (buffersize > 0)
{
ztoolkit_t *ztk = file->ztk;
int error;
// NOTE: at this point, the read buffer is always empty
// If "input" is also empty, we need to refill it
if (ztk->in_ind == ztk->in_len)
{
// If we are at the end of the file
if (file->position == file->real_length)
return done;
count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
if (count > (fs_offset_t)sizeof (ztk->input))
count = (fs_offset_t)sizeof (ztk->input);
lseek (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
if (read (file->handle, ztk->input, count) != count)
{
Msg("FS_Read: unexpected end of file\n");
break;
}
ztk->in_ind = 0;
ztk->in_len = count;
ztk->in_position += count;
}
ztk->zstream.next_in = &ztk->input[ztk->in_ind];
ztk->zstream.avail_in = (uint)(ztk->in_len - ztk->in_ind);
// Now that we are sure we have compressed data available, we need to determine
// if it's better to inflate it in "file->buff" or directly in "buffer"
// Inflate the data in "file->buff"
if (buffersize < sizeof (file->buff) / 2)
{
ztk->zstream.next_out = file->buff;
ztk->zstream.avail_out = sizeof (file->buff);
error = inflate (&ztk->zstream, Z_SYNC_FLUSH);
if (error != Z_OK && error != Z_STREAM_END)
{
Msg("FS_Read: Can't inflate file: %s\n", ztk->zstream.msg );
break;
}
ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
file->position += file->buff_len;
// Copy the requested data in "buffer" (as much as we can)
count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
Mem_Copy (&((unsigned char*)buffer)[done], file->buff, count);
file->buff_ind = count;
}
else // Else, we inflate directly in "buffer"
{
ztk->zstream.next_out = &((unsigned char*)buffer)[done];
ztk->zstream.avail_out = (unsigned int)buffersize;
error = inflate (&ztk->zstream, Z_SYNC_FLUSH);
if (error != Z_OK && error != Z_STREAM_END)
{
Msg("FS_Read: Can't inflate file: %s\n", ztk->zstream.msg);
break;
}
ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
// How much data did it inflate?
count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
file->position += count;
// Purge cached data
FS_Purge (file);
}
done += count;
buffersize -= count;
}
return done;
}
/*
====================
FS_Print
Print a string into a file
====================
*/
int FS_Print( file_t* file, const char *msg )
{
return FS_Write( file, msg, com.strlen( msg ));
}
/*
====================
FS_Printf
Print a string into a file
====================
*/
int FS_Printf(file_t* file, const char* format, ...)
{
int result;
va_list args;
va_start (args, format);
result = FS_VPrintf (file, format, args);
va_end (args);
return result;
}
/*
====================
FS_VPrintf
Print a string into a file
====================
*/
int FS_VPrintf( file_t* file, const char* format, va_list ap )
{
int len;
fs_offset_t buff_size = MAX_MSGLEN;
char *tempbuff;
if( !file ) return 0;
while( 1 )
{
tempbuff = (char *)Mem_Alloc( fs_mempool, buff_size );
len = com.vsprintf( tempbuff, format, ap );
if( len >= 0 && len < buff_size ) break;
Mem_Free( tempbuff );
buff_size *= 2;
}
len = write( file->handle, tempbuff, len );
Mem_Free( tempbuff );
return len;
}
/*
====================
FS_Getc
Get the next character of a file
====================
*/
int FS_Getc( file_t* file )
{
char c;
if (FS_Read (file, &c, 1) != 1)
return EOF;
return c;
}
/*
====================
FS_UnGetc
Put a character back into the read buffer (only supports one character!)
====================
*/
int FS_UnGetc( file_t* file, byte c )
{
// If there's already a character waiting to be read
if (file->ungetc != EOF)
return EOF;
file->ungetc = c;
return c;
}
int FS_Gets( file_t* file, byte *string, size_t bufsize )
{
int c, end = 0;
while( 1 )
{
c = FS_Getc( file );
if( c == '\r' || c == '\n' || c < 0 )
break;
if( end < bufsize - 1 )
string[end++] = c;
}
string[end] = 0;
// remove \n following \r
if( c == '\r' )
{
c = FS_Getc( file );
if( c != '\n' ) FS_UnGetc( file, (byte)c );
}
return c;
}
/*
====================
FS_Seek
Move the position index in a file
====================
*/
int FS_Seek (file_t* file, fs_offset_t offset, int whence)
{
ztoolkit_t *ztk;
unsigned char* buffer;
fs_offset_t buffersize;
// Compute the file offset
switch (whence)
{
case SEEK_CUR:
offset += file->position - file->buff_len + file->buff_ind;
break;
case SEEK_SET:
break;
case SEEK_END:
offset += file->real_length;
break;
default:
return -1;
}
if (offset < 0 || offset > (long)file->real_length) return -1;
// 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)
{
file->buff_ind = offset + file->buff_len - file->position;
return 0;
}
// Purge cached data
FS_Purge (file);
// Unpacked or uncompressed files can seek directly
if (! (file->flags & FILE_FLAG_DEFLATED))
{
if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
return -1;
file->position = offset;
return 0;
}
// Seeking in compressed files is more a hack than anything else,
// but we need to support it, so here we go.
ztk = file->ztk;
// If we have to go back in the file, we need to restart from the beginning
if (offset <= file->position)
{
ztk->in_ind = 0;
ztk->in_len = 0;
ztk->in_position = 0;
file->position = 0;
lseek (file->handle, file->offset, SEEK_SET);
// Reset the Zlib stream
ztk->zstream.next_in = ztk->input;
ztk->zstream.avail_in = 0;
inflateReset (&ztk->zstream);
}
// We need a big buffer to force inflating into it directly
buffersize = 2 * sizeof (file->buff);
buffer = (byte *)Mem_Alloc( fs_mempool, buffersize );
// Skip all data until we reach the requested offset
while (offset > file->position)
{
fs_offset_t diff = offset - file->position;
fs_offset_t count, len;
count = (diff > buffersize) ? buffersize : diff;
len = FS_Read (file, buffer, count);
if (len != count)
{
Mem_Free (buffer);
return -1;
}
}
Mem_Free (buffer);
return 0;
}
/*
====================
FS_Tell
Give the current position in a file
====================
*/
fs_offset_t FS_Tell( file_t* file )
{
if( !file ) return 0;
return file->position - file->buff_len + file->buff_ind;
}
/*
====================
FS_Eof
indicates at reached end of file
====================
*/
bool FS_Eof( file_t* file )
{
if( !file ) return true;
return (file->position == file->real_length) ? true : false;
}
/*
====================
FS_Purge
Erases any buffered input or output data
====================
*/
void FS_Purge( file_t* file )
{
file->buff_len = 0;
file->buff_ind = 0;
file->ungetc = EOF;
}
/*
============
FS_LoadFile
Filename are relative to the xash directory.
Always appends a 0 byte.
============
*/
byte *FS_LoadFile( const char *path, fs_offset_t *filesizeptr )
{
file_t *file;
byte *buf = NULL;
fs_offset_t filesize = 0;
const char *ext = FS_FileExtension( path );
file = _FS_Open( path, "rb", true );
if( file )
{
filesize = file->real_length;
buf = (byte *)Mem_Alloc( fs_mempool, filesize + 1 );
buf[filesize] = '\0';
FS_Read( file, buf, filesize );
FS_Close( file );
}
else buf = W_LoadFile( path, &filesize );
if( filesizeptr ) *filesizeptr = filesize;
return buf;
}
/*
============
FS_WriteFile
The filename will be prefixed by the current game directory
============
*/
bool FS_WriteFile( const char *filename, const void *data, fs_offset_t len )
{
file_t *file;
file = _FS_Open( filename, "wb", false );
if (!file)
{
MsgDev( D_ERROR, "FS_WriteFile: failed on %s\n", filename);
return false;
}
FS_Write (file, data, len);
FS_Close (file);
return true;
}
/*
=============================================================================
OTHERS PUBLIC FUNCTIONS
=============================================================================
*/
/*
============
FS_StripExtension
============
*/
void FS_StripExtension (char *path)
{
size_t length;
length = com.strlen( path ) - 1;
while( length > 0 && path[length] != '.' )
{
length--;
if( path[length] == '/' || path[length] == '\\' || path[length] == ':' )
return; // no extension
}
if( length ) path[length] = 0;
}
/*
==================
FS_DefaultExtension
==================
*/
void FS_DefaultExtension( char *path, const char *extension )
{
const char *src;
// if path doesn't have a .EXT, append extension
// (extension should include the .)
src = path + com.strlen( path ) - 1;
while (*src != '/' && src != path)
{
// it has an extension
if (*src == '.') return;
src--;
}
com.strcat( path, extension );
}
/*
==================
FS_FileExists
Look for a file in the packages and in the filesystem
==================
*/
bool FS_FileExists( const char *filename )
{
bool gamedironly = false;
if( filename[0] == '' )
{
filename++;
gamedironly = true;
}
if( FS_FindFile( filename, NULL, true, gamedironly ))
return true;
return false;
}
/*
==================
FS_FindLibrary
search for library, assume index is valid
only for internal use
==================
*/
dll_user_t *FS_FindLibrary( const char *dllname, bool directpath )
{
string dllpath;
searchpath_t *search;
dll_user_t *hInst;
int index;
// check for bad exports
if( !dllname || !*dllname )
return NULL;
fs_ext_path = directpath;
if( !directpath )
com.snprintf( dllpath, sizeof( dllpath ), "bin/%s", dllname );
else com.strncpy( dllpath, dllname, sizeof( dllpath ));
FS_DefaultExtension( dllpath, ".dll" ); // trying to apply if forget
search = FS_FindFile( dllpath, &index, true, false );
if( !search )
{
fs_ext_path = false;
if( directpath ) return NULL; // direct paths fails here
// trying check also 'bin' folder for indirect paths
com.strncpy( dllpath, dllname, sizeof( dllpath ));
search = FS_FindFile( dllpath, &index, true, false );
if( !search ) return NULL; // unable to find
}
// all done, create dll_user_t struct
hInst = Mem_Alloc( Sys.basepool, sizeof( dll_user_t ));
// save dllname for debug purposes
com.strncpy( hInst->dllName, dllname, sizeof( hInst->dllName ));
// shortPath is used for LibraryLoadSymbols only
com.strncpy( hInst->shortPath, dllpath, sizeof( hInst->shortPath ));
if( index < 0 )
{
com.snprintf( hInst->fullPath, sizeof( hInst->fullPath ), "%s%s", search->filename, dllpath );
hInst->custom_loader = false; // we can loading from disk and use normal debugging
}
else
{
com.strncpy( hInst->fullPath, dllpath, sizeof( hInst->fullPath ));
hInst->custom_loader = true; // loading from pack or wad - for release, debug don't working
}
fs_ext_path = false; // always reset direct paths
return hInst;
}
/*
==================
FS_FileSize
return size of file in bytes
==================
*/
fs_offset_t FS_FileSize (const char *filename)
{
file_t *fp;
int length = 0;
fp = _FS_Open( filename, "rb", true );
if( fp )
{
// it exists
FS_Seek( fp, 0, SEEK_END );
length = FS_Tell( fp );
FS_Close( fp );
}
return length;
}
/*
==================
FS_FileTime
return time of creation file in seconds
==================
*/
fs_offset_t FS_FileTime( const char *filename )
{
searchpath_t *search;
int pack_ind;
search = FS_FindFile( filename, &pack_ind, true, false );
if( !search ) return -1; // doesn't exist
if( search->pack ) // grab pack filetime
return search->pack->filetime;
else if( search->wad ) // grab wad filetime
return search->wad->filetime;
else if( pack_ind < 0 )
{
// found in the filesystem?
char path [MAX_SYSPATH];
com.sprintf( path, "%s%s", search->filename, filename );
return FS_SysFileTime( path );
}
return -1; // doesn't exist
}
/*
==================
FS_Rename
rename specified file from gamefolder
==================
*/
bool FS_Rename( const char *oldname, const char *newname )
{
char oldpath[MAX_SYSPATH], newpath[MAX_SYSPATH];
bool iRet;
if( !oldname || !newname || !*oldname || !*newname )
return false;
com_snprintf( oldpath, sizeof( oldpath ), "%s/%s", fs_gamedir, oldname );
com_snprintf( newpath, sizeof( newpath ), "%s/%s", fs_gamedir, newname );
iRet = rename( oldpath, newpath );
return iRet;
}
/*
==================
FS_Delete
delete specified file from gamefolder
==================
*/
bool FS_Delete( const char *path )
{
char real_path[MAX_SYSPATH];
bool iRet;
if( !path || !*path )
return false;
com_snprintf( real_path, sizeof( real_path ), "%s/%s", fs_gamedir, path );
iRet = remove( real_path );
return iRet;
}
/*
===========
FS_Search
Allocate and fill a search structure with information on matching filenames.
===========
*/
static search_t *_FS_Search( const char *pattern, int caseinsensitive, int quiet )
{
search_t *search = NULL;
searchpath_t *searchpath;
pack_t *pak;
wfile_t *wad;
bool gamedironly = false;
int i, basepathlength, numfiles, numchars;
int resultlistindex, dirlistindex;
const char *slash, *backslash, *colon, *separator;
string netpath, temp;
stringlist_t resultlist;
stringlist_t dirlist;
char *basepath;
for( i = 0; pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\'; i++ );
if( i > 0 )
{
MsgDev( D_INFO, "FS_Search: don't use punctuation at the beginning of a search pattern!\n");
return NULL;
}
if( pattern[0] == '' )
{
gamedironly = true;
pattern++; // ignore this symbol
}
stringlistinit( &resultlist );
stringlistinit( &dirlist );
slash = com.strrchr( pattern, '/' );
backslash = com.strrchr( pattern, '\\' );
colon = com.strrchr( pattern, ':' );
separator = max( slash, backslash );
separator = max( separator, colon );
basepathlength = separator ? (separator + 1 - pattern) : 0;
basepath = Mem_Alloc( fs_mempool, basepathlength + 1 );
if( basepathlength ) Mem_Copy( basepath, pattern, basepathlength );
basepath[basepathlength] = 0;
// search through the path, one element at a time
for( searchpath = fs_searchpaths; searchpath; searchpath = searchpath->next )
{
if( gamedironly && !( searchpath->flags & FS_GAMEDIR_PATH ))
continue;
// is the element a pak file?
if( searchpath->pack )
{
// look through all the pak file elements
pak = searchpath->pack;
for( i = 0; i < pak->numfiles; i++ )
{
com.strncpy( temp, pak->files[i].name, sizeof( temp ));
while( temp[0] )
{
if( matchpattern( temp, (char *)pattern, true ))
{
for( resultlistindex = 0; resultlistindex < resultlist.numstrings; resultlistindex++ )
{
if( !com.strcmp( resultlist.strings[resultlistindex], temp ))
break;
}
if( resultlistindex == resultlist.numstrings )
{
stringlistappend( &resultlist, temp );
if( !quiet ) MsgDev( D_INFO, "SearchPackFile: %s : %s\n", pak->filename, temp );
}
}
// strip off one path element at a time until empty
// this way directories are added to the listing if they match the pattern
slash = com.strrchr( temp, '/' );
backslash = com.strrchr( temp, '\\' );
colon = com.strrchr( temp, ':' );
separator = temp;
if( separator < slash )
separator = slash;
if( separator < backslash )
separator = backslash;
if( separator < colon )
separator = colon;
*((char *)separator) = 0;
}
}
}
else if( searchpath->wad )
{
string wadpattern, wadname, temp2;
char type = W_TypeFromExt( pattern );
bool anywadname = true;
string wadfolder;
// quick reject by filetype
if( type == TYPE_NONE ) continue;
FS_ExtractFilePath( pattern, wadname );
FS_FileBase( pattern, wadpattern );
wadfolder[0] = '\0';
if( com.strlen( wadname ))
{
FS_FileBase( wadname, wadname );
com.strncpy( wadfolder, wadname, sizeof( wadfolder ));
FS_DefaultExtension( wadname, ".wad" );
anywadname = false;
}
// quick reject by wadname
if( !anywadname && com.stricmp( wadname, searchpath->wad->filename ))
continue;
// look through all the wad file elements
wad = searchpath->wad;
for( i = 0; i < wad->numlumps; i++ )
{
// if type not matching, we already no chance ...
if( type != TYPE_ANY && wad->lumps[i].type != type )
continue;
com.strncpy( temp, wad->lumps[i].name, sizeof( temp ));
while( temp[0] )
{
if( matchpattern( temp, wadpattern, true ))
{
for( resultlistindex = 0; resultlistindex < resultlist.numstrings; resultlistindex++ )
{
if( !com.strcmp( resultlist.strings[resultlistindex], temp ))
break;
}
if( resultlistindex == resultlist.numstrings )
{
// build path: wadname/lumpname.ext
com.snprintf( temp2, sizeof(temp2), "%s/%s", wadfolder, temp );
FS_DefaultExtension( temp2, va(".%s", W_ExtFromType( wad->lumps[i].type ))); // make ext
stringlistappend( &resultlist, temp2 );
if( !quiet ) MsgDev( D_INFO, "SearchWadFile: %s : %s\n", wad->filename, temp2 );
}
}
// strip off one path element at a time until empty
// this way directories are added to the listing if they match the pattern
slash = com.strrchr( temp, '/' );
backslash = com.strrchr( temp, '\\' );
colon = com.strrchr( temp, ':' );
separator = temp;
if( separator < slash )
separator = slash;
if( separator < backslash )
separator = backslash;
if( separator < colon )
separator = colon;
*((char *)separator) = 0;
}
}
}
else
{
// get a directory listing and look at each name
com.sprintf( netpath, "%s%s", searchpath->filename, basepath );
stringlistinit( &dirlist );
listdirectory( &dirlist, netpath );
for( dirlistindex = 0; dirlistindex < dirlist.numstrings; dirlistindex++ )
{
com.sprintf( temp, "%s%s", basepath, dirlist.strings[dirlistindex] );
if( matchpattern( temp, (char *)pattern, true ))
{
for( resultlistindex = 0; resultlistindex < resultlist.numstrings; resultlistindex++ )
{
if( !com.strcmp( resultlist.strings[resultlistindex], temp ))
break;
}
if( resultlistindex == resultlist.numstrings )
{
stringlistappend( &resultlist, temp );
if( !quiet ) MsgDev( D_INFO, "SearchDirFile: %s\n", temp );
}
}
}
stringlistfreecontents( &dirlist );
}
}
if( resultlist.numstrings )
{
stringlistsort( &resultlist );
numfiles = resultlist.numstrings;
numchars = 0;
for( resultlistindex = 0; resultlistindex < resultlist.numstrings; resultlistindex++ )
numchars += (int)com.strlen( resultlist.strings[resultlistindex]) + 1;
search = Mem_Alloc( fs_mempool, sizeof(search_t) + numchars + numfiles * sizeof( char * ));
search->filenames = (char **)((char *)search + sizeof(search_t));
search->filenamesbuffer = (char *)((char *)search + sizeof(search_t) + numfiles * sizeof( char * ));
search->numfilenames = (int)numfiles;
numfiles = 0;
numchars = 0;
for( resultlistindex = 0; resultlistindex < resultlist.numstrings; resultlistindex++ )
{
size_t textlen;
search->filenames[numfiles] = search->filenamesbuffer + numchars;
textlen = com.strlen(resultlist.strings[resultlistindex]) + 1;
Mem_Copy( search->filenames[numfiles], resultlist.strings[resultlistindex], textlen );
numfiles++;
numchars += (int)textlen;
}
}
stringlistfreecontents( &resultlist );
Mem_Free( basepath );
return search;
}
search_t *FS_Search(const char *pattern, int caseinsensitive )
{
return _FS_Search( pattern, caseinsensitive, true );
}
void FS_Mem_FreeSearch( search_t *search )
{
Mem_Free( search );
}
void FS_InitMemory( void )
{
fs_mempool = Mem_AllocPool( "Filesystem Pool" );
// add a path separator to the end of the basedir if it lacks one
if( fs_basedir[0] && fs_basedir[com.strlen(fs_basedir) - 1] != '/' && fs_basedir[com.strlen(fs_basedir) - 1] != '\\' )
com.strncat( fs_basedir, "/", sizeof( fs_basedir ));
fs_searchpaths = NULL;
}
/*
================
FS_CheckParm
Returns the position (1 to argc-1) in the program's argument list
where the given parameter apears, or 0 if not present
================
*/
int FS_CheckParm( const char *parm )
{
int i;
for( i = 1; i < fs_argc; i++ )
{
// NEXTSTEP sometimes clears appkit vars.
if( !fs_argv[i] ) continue;
if( !com.stricmp( parm, fs_argv[i] )) return i;
}
return 0;
}
void FS_GetBaseDir( char *pszBuffer, char *out )
{
char basedir[ MAX_SYSPATH ];
char szBuffer[ MAX_SYSPATH ];
int j;
char *pBuffer = NULL;
com.strcpy( szBuffer, pszBuffer );
pBuffer = com.strrchr( szBuffer,'\\' );
if ( pBuffer ) *(pBuffer+1) = '\0';
com.strcpy( basedir, szBuffer );
j = com.strlen( basedir );
if( j > 0 )
{
if(( basedir[ j-1 ] == '\\' ) || ( basedir[ j-1 ] == '/' ))
basedir[ j-1 ] = 0;
}
com.strcpy( out, basedir );
}
void FS_ReadEnvironmentVariables( char *pPath )
{
// get basepath from registry
REG_GetValue( HKEY_LOCAL_MACHINE, "System\\CurrentControlSet\\Control\\Session Manager\\Environment", "Xash3D", pPath );
}
void FS_SaveEnvironmentVariables( char *pPath )
{
// save new path
REG_SetValue( HKEY_LOCAL_MACHINE, "System\\CurrentControlSet\\Control\\Session Manager\\Environment", "Xash3D", pPath );
SendMessageTimeout( HWND_BROADCAST, WM_SETTINGCHANGE, 0, 0, SMTO_NORMAL, 10, NULL); // system update message
}
static void FS_BuildPath( char *pPath, char *pOut )
{
// set working directory
SetCurrentDirectory ( pPath );
com.sprintf( pOut, "%s\\bin\\launch.dll", pPath );
}
void FS_UpdateEnvironmentVariables( void )
{
char szTemp[4096];
char szPath[MAX_SYSPATH]; // test path
// NOTE: we want set "real" work directory
// defined in environment variables, but in some reasons
// we need make some additional checks before set current dir
// get variable from registry and current directory
FS_ReadEnvironmentVariables( szTemp );
GetCurrentDirectory( MAX_SYSPATH, sys_rootdir );
// if both values is math - no run additional tests
if( com.stricmp( sys_rootdir, szTemp ))
{
// Step1: path from registry have higher priority than current working directory
// because user can execute launcher from random place or from a bat-file
// so, set current working directory as path from registry and test it
FS_BuildPath( szTemp, szPath );
if( !FS_SysFileExists( szPath )) // Step2: engine root dir has been moved to other place?
{
FS_BuildPath( sys_rootdir, szPath );
if( !FS_SysFileExists( szPath )) // Step3: directly execute from bin directory?
{
// Step4: create last test for bin directory
FS_GetBaseDir( sys_rootdir, szTemp );
FS_BuildPath( szTemp, szPath );
if( !FS_SysFileExists( szPath ))
{
// big bada-boom: engine was moved and launcher was running from other place
// step5: so, path form registry is invalid, current path is no valid
Sys_Break( "Invalid root directory!\n\rPlease re-install Xash3D\n" );
}
else FS_SaveEnvironmentVariables( szTemp ); // update registry
}
else FS_SaveEnvironmentVariables( sys_rootdir );
}
}
}
/*
=============================================================================
VIRTUAL FILE SYSTEM - WRITE DATA INTO MEMORY
=============================================================================
*/
vfile_t *VFS_Create( const byte *buffer, size_t buffsize)
{
vfile_t *file = (vfile_t *)Mem_Alloc( fs_mempool, sizeof (*file));
file->length = file->buffsize = buffsize;
file->buff = Mem_Alloc(fs_mempool, (file->buffsize));
file->offset = 0;
file->mode = O_RDONLY;
Mem_Copy( file->buff, buffer, buffsize );
return file;
}
vfile_t *VFS_Open(file_t *handle, const char* mode)
{
vfile_t *file = (vfile_t *)Mem_Alloc (fs_mempool, sizeof (vfile_t));
// If the file is opened in "write", "append", or "read/write" mode
if (mode[0] == 'w')
{
file->compress = (mode[1] == 'z') ? true : false;
file->handle = handle;
file->buffsize = (64 * 1024); // will be resized if need
file->buff = Mem_Alloc(fs_mempool, (file->buffsize));
file->length = 0;
file->offset = 0;
file->mode = O_WRONLY;
}
else if (mode[0] == 'r')
{
int curpos, endpos;
file->compress = false;
file->handle = handle;
curpos = FS_Tell(file->handle);
FS_Seek(file->handle, 0, SEEK_END);
endpos = FS_Tell(file->handle);
FS_Seek(file->handle, curpos, SEEK_SET);
file->buffsize = endpos - curpos;
file->buff = Mem_Alloc(fs_mempool, (file->buffsize));
FS_Read(file->handle, file->buff, file->buffsize);
file->length = file->buffsize;
file->offset = 0;
file->mode = O_RDONLY;
}
else
{
Mem_Free( file );
MsgDev( D_ERROR, "VFS_Open: unsupported mode %s\n", mode );
return NULL;
}
return file;
}
fs_offset_t VFS_Read( vfile_t* file, void* buffer, size_t buffersize)
{
fs_offset_t read_size = 0;
if ( buffersize == 0 ) return 1;
if (!file) return 0;
// check for enough room
if(file->offset >= file->length)
{
return 0; //hit EOF
}
if(file->offset + buffersize <= file->length)
{
Mem_Copy( buffer, file->buff + file->offset, buffersize );
file->offset += buffersize;
read_size = buffersize;
}
else
{
int reduced_size = file->length - file->offset;
Mem_Copy( buffer, file->buff + file->offset, reduced_size );
file->offset += reduced_size;
read_size = reduced_size;
MsgDev( D_NOTE, "VFS_Read: vfs buffer is out\n");
}
return read_size;
}
fs_offset_t VFS_Write( vfile_t *file, const void *buf, size_t size )
{
if(!file) return -1;
if (file->offset + size >= file->buffsize)
{
int newsize = file->offset + size + (64 * 1024);
if (file->buffsize < newsize)
{
// reallocate buffer now
file->buff = Mem_Realloc( fs_mempool, file->buff, newsize );
file->buffsize = newsize; // merge buffsize
}
}
// write into buffer
Mem_Copy( file->buff + file->offset, (byte *)buf, size );
file->offset += size;
if( file->offset > file->length )
file->length = file->offset;
return file->length;
}
byte *VFS_GetBuffer( vfile_t *file )
{
if( !file ) return NULL;
return file->buff;
}
/*
====================
VFS_Print
Print a string into a file
====================
*/
int VFS_Print( vfile_t* file, const char *msg )
{
return (int)VFS_Write( file, msg, com.strlen( msg ));
}
/*
====================
VFS_VPrintf
Print a string into a buffer
====================
*/
int VFS_VPrintf(vfile_t* file, const char* format, va_list ap)
{
int len;
fs_offset_t buff_size = MAX_MSGLEN;
char *tempbuff;
while( 1 )
{
tempbuff = (char *)Mem_Alloc( fs_mempool, buff_size );
len = com.vsprintf( tempbuff, format, ap );
if( len >= 0 && len < buff_size ) break;
Mem_Free( tempbuff );
buff_size *= 2;
}
len = VFS_Write( file, tempbuff, len );
Mem_Free( tempbuff );
return len;
}
/*
====================
VFS_Printf
Print a string into a buffer
====================
*/
int VFS_Printf(vfile_t* file, const char* format, ...)
{
int result;
va_list args;
va_start(args, format);
result = VFS_VPrintf(file, format, args);
va_end (args);
return result;
}
fs_offset_t VFS_Tell (vfile_t* file)
{
if (!file) return -1;
return file->offset;
}
bool VFS_Eof( vfile_t* file)
{
if (!file) return true;
return (file->offset == file->length) ? true : false;
}
/*
====================
VFS_Getc
Get the next character of a file
====================
*/
int VFS_Getc( vfile_t *file )
{
char c;
if(!VFS_Read( file, &c, 1 ))
return EOF;
return c;
}
int VFS_Gets( vfile_t* file, byte *string, size_t bufsize )
{
int c, end = 0;
while( 1 )
{
c = VFS_Getc( file );
if (c == '\r' || c == '\n' || c < 0)
break;
if (end < bufsize - 1) string[end++] = c;
}
string[end] = 0;
// remove \n following \r
if (c == '\r')
{
c = VFS_Getc( file );
if (c != '\n') VFS_Seek( file, -1, SEEK_CUR ); // rewind
}
MsgDev(D_INFO, "VFS_Gets: %s\n", string);
return c;
}
int VFS_Seek( vfile_t *file, fs_offset_t offset, int whence )
{
if (!file) return -1;
// Compute the file offset
switch (whence)
{
case SEEK_CUR:
offset += file->offset;
break;
case SEEK_SET:
break;
case SEEK_END:
offset += file->length;
break;
default:
return -1;
}
if (offset < 0 || offset > (long)file->length) return -1;
file->offset = offset;
return 0;
}
bool VFS_Unpack( void* compbuf, size_t compsize, void **dst, size_t size )
{
char *buf = *dst;
z_stream strm = {compbuf, compsize, 0, buf, size, 0, NULL, NULL, NULL, NULL, NULL, 0, 0, 0 };
inflateInit( &strm );
if( Z_STREAM_END != inflate( &strm, Z_FINISH )) // decompress it in one go.
{
if( !com.strlen( strm.msg )) MsgDev( D_NOTE, "VFS_Unpack: failed block decompression\n" );
else MsgDev( D_NOTE, "VFS_Unpack: failed block decompression: %s\n", strm.msg );
return false;
}
inflateEnd( &strm );
return true;
}
file_t *VFS_Close( vfile_t *file )
{
file_t *handle;
char out[8192]; // chunk size
z_stream strm = {file->buff, file->length, 0, out, sizeof(out), 0, NULL, NULL, NULL, NULL, NULL, 0, 0, 0 };
if(!file) return NULL;
if(file->mode == O_WRONLY)
{
if( file->compress ) // deflate before writing
{
deflateInit( &strm, 9 ); // Z_BEST_COMPRESSION
while(deflate(&strm, Z_FINISH) == Z_OK)
{
FS_Write( file->handle, out, sizeof(out) - strm.avail_out);
strm.next_out = out;
strm.avail_out = sizeof(out);
}
FS_Write( file->handle, out, sizeof(out) - strm.avail_out );
deflateEnd( &strm );
}
else if( file->handle )
FS_Write(file->handle, file->buff, (file->length + 3) & ~3); // align
}
handle = file->handle; // keep real handle
if( file->buff ) Mem_Free( file->buff );
Mem_Free( file ); // himself
return handle;
}
/*
=============================================================================
WADSYSTEM PRIVATE COMMON FUNCTIONS
=============================================================================
*/
// associate extension with wad type
static const wadtype_t wad_types[] =
{
{ "flp", TYPE_FLMP }, // doom1 menu picture
{ "snd", TYPE_SND }, // doom1 sound
{ "mus", TYPE_MUS }, // doom1 .mus format
{ "skn", TYPE_SKIN }, // doom1 sprite model
{ "flt", TYPE_FLAT }, // doom1 wall texture
{ "pal", TYPE_QPAL }, // palette
{ "lmp", TYPE_QPIC }, // quake1, hl pic
{ "fnt", TYPE_QFONT }, // hl qfonts
{ "mip", TYPE_MIPTEX}, // hl/q1 mip
{ "raw", TYPE_RAW }, // signed raw data
{ "wav", TYPE_SOUND }, // wav sounds (hl2)
{ "txt", TYPE_SCRIPT}, // any script file
{ NULL, TYPE_NONE }
};
static char W_TypeFromExt( const char *lumpname )
{
const char *ext = FS_FileExtension( lumpname );
const wadtype_t *type;
// we not known about filetype, so match only by filename
if( !com.strcmp( ext, "*" ) || !com.strcmp( ext, "" ))
return TYPE_ANY;
for( type = wad_types; type->ext; type++ )
{
if(!com.stricmp( ext, type->ext ))
return type->type;
}
return TYPE_NONE;
}
static const char *W_ExtFromType( char lumptype )
{
const wadtype_t *type;
// we not known aboyt filetype, so match only by filename
if( lumptype == TYPE_NONE || lumptype == TYPE_ANY )
return "";
for( type = wad_types; type->ext; type++ )
{
if( lumptype == type->type )
return type->ext;
}
return "";
}
static dlumpinfo_t *W_FindLump( wfile_t *wad, const char *name, const char matchtype )
{
int i;
if( !wad || !wad->lumps || matchtype == TYPE_NONE )
return NULL;
// serach trough current wad
for( i = 0; i < wad->numlumps; i++)
{
// filtering lumps by type first
if( matchtype == TYPE_ANY || matchtype == wad->lumps[i].type )
{
if( !com.stricmp( name, wad->lumps[i].name ))
return &wad->lumps[i]; // found
}
}
return NULL;
}
static void W_CleanupName( const char *dirtyname, char *cleanname )
{
string tempname;
if( !dirtyname || !cleanname ) return;
cleanname[0] = '\0'; // clear output
FS_FileBase( dirtyname, tempname );
if( com.strlen( tempname ) > WAD3_NAMELEN )
{
// windows style cutoff long names
// FIXME: probably can make duplicate names
tempname[14] = '~';
tempname[15] = '1';
}
tempname[16] = '\0'; // cutoff all other ...
com.strncpy( cleanname, tempname, 16 );
// .. and turn big letters
com.strupr( cleanname, cleanname );
}
static bool W_ConvertIWADLumps( wfile_t *wad )
{
dlumpfile_t *doomlumps;
bool flat_images = false; // doom1 wall texture marker
bool skin_images = false; // doom1 skin image ( sprite model ) marker
bool flmp_images = false; // doom1 menu image marker
size_t lat_size; // LAT - LumpAllocationTable
int i, k;
// nothing to convert ?
if( !wad ) return false;
lat_size = wad->numlumps * sizeof( dlumpfile_t );
doomlumps = (dlumpfile_t *)Mem_Alloc( wad->mempool, lat_size );
if( FS_Read( wad->file, doomlumps, lat_size ) != lat_size )
{
MsgDev( D_ERROR, "W_ConvertIWADLumps: %s has corrupted lump allocation table\n", wad->filename );
Mem_Free( doomlumps );
W_Close( wad );
return false;
}
// convert doom1 format into WAD3 lump format
for( i = 0; i < wad->numlumps; i++ )
{
// W_Open will be swap lump later
wad->lumps[i].filepos = doomlumps[i].filepos;
wad->lumps[i].size = wad->lumps[i].disksize = doomlumps[i].size;
com.strnlwr( doomlumps[i].name, wad->lumps[i].name, 9 );
wad->lumps[i].compression = CMP_NONE;
wad->lumps[i].type = TYPE_NONE;
// check for backslash issues
k = com.strlen( com_strchr( wad->lumps[i].name, '\\' ));
if( k ) wad->lumps[i].name[com.strlen( wad->lumps[i].name )-k] = '#'; // vile1.spr issues
// textures begin
if( !com.stricmp( "S_START", wad->lumps[i].name ))
{
skin_images = true;
continue; // skip identifier
}
else if( !com.stricmp( "P_START", wad->lumps[i].name ))
{
flat_images = true;
continue; // skip identifier
}
else if( !com.stricmp( "P1_START", wad->lumps[i].name ))
{
flat_images = true;
continue; // skip identifier
}
else if( !com.stricmp( "P2_START", wad->lumps[i].name ))
{
flat_images = true;
continue; // skip identifier
}
else if( !com.stricmp( "P3_START", wad->lumps[i].name ))
{
// only doom2 uses this name
flat_images = true;
continue; // skip identifier
}
else if( !com.strnicmp( "WI", wad->lumps[i].name, 2 )) flmp_images = true;
else if( !com.strnicmp( "ST", wad->lumps[i].name, 2 )) flmp_images = true;
else if( !com.strnicmp( "M_", wad->lumps[i].name, 2 )) flmp_images = true;
else if( !com.strnicmp( "END", wad->lumps[i].name, 3 )) flmp_images = true;
else if( !com.strnicmp( "HELP", wad->lumps[i].name, 4 )) flmp_images = true;
else if( !com.strnicmp( "CREDIT", wad->lumps[i].name, 6 )) flmp_images = true;
else if( !com.strnicmp( "TITLEPIC", wad->lumps[i].name, 8 )) flmp_images = true;
else if( !com.strnicmp( "VICTORY", wad->lumps[i].name, 7 )) flmp_images = true;
else if( !com.strnicmp( "PFUB", wad->lumps[i].name, 4 )) flmp_images = true;
else if( !com.stricmp( "P_END", wad->lumps[i].name )) flat_images = false;
else if( !com.stricmp( "P1_END", wad->lumps[i].name )) flat_images = false;
else if( !com.stricmp( "P2_END", wad->lumps[i].name )) flat_images = false;
else if( !com.stricmp("P3_END", wad->lumps[i].name )) flat_images = false;
else if( !com.stricmp( "S_END", wad->lumps[i].name )) skin_images = false;
else flmp_images = false;
// setup lumptypes for doomwads
if( flmp_images ) wad->lumps[i].type = TYPE_FLMP; // mark as menu pic
if( flat_images ) wad->lumps[i].type = TYPE_FLAT; // mark as texture
if( skin_images ) wad->lumps[i].type = TYPE_SKIN; // mark as skin (sprite model)
if(!com.strnicmp( wad->lumps[i].name, "D_", 2 )) wad->lumps[i].type = TYPE_MUS;
if(!com.strnicmp( wad->lumps[i].name, "DS", 2 )) wad->lumps[i].type = TYPE_SND;
// remove invalid resources
if(!com.strnicmp( wad->lumps[i].name, "ENDOOM", 6 )) wad->lumps[i].type = TYPE_NONE;
if(!com.strnicmp( wad->lumps[i].name, "STEP1", 5 )) wad->lumps[i].type = TYPE_NONE;
if(!com.strnicmp( wad->lumps[i].name, "STEP2", 5 )) wad->lumps[i].type = TYPE_NONE;
}
Mem_Free( doomlumps ); // no need anymore
return true;
}
static bool W_ReadLumpTable( wfile_t *wad )
{
size_t lat_size;
int i, k;
// nothing to convert ?
if( !wad ) return false;
lat_size = wad->numlumps * sizeof( dlumpinfo_t );
if( FS_Read( wad->file, wad->lumps, lat_size ) != lat_size )
{
MsgDev( D_ERROR, "W_ReadLumpTable: %s has corrupted lump allocation table\n", wad->filename );
W_Close( wad );
return false;
}
// swap everything
for( i = 0; i < wad->numlumps; i++ )
{
wad->lumps[i].filepos = LittleLong( wad->lumps[i].filepos );
wad->lumps[i].disksize = LittleLong( wad->lumps[i].disksize );
wad->lumps[i].size = LittleLong( wad->lumps[i].size );
// cleanup lumpname
com.strnlwr( wad->lumps[i].name, wad->lumps[i].name, sizeof(wad->lumps[i].name));
// check for '*' symbol issues
k = com.strlen( com.strrchr( wad->lumps[i].name, '*' ));
if( k ) wad->lumps[i].name[com.strlen(wad->lumps[i].name)-k] = '!'; // quake1 issues
// convert all qmip types to miptex
if( wad->lumps[i].type == TYPE_QMIP ) wad->lumps[i].type = TYPE_MIPTEX;
// check for Quake 'conchars' issues (only lmp loader supposed to read this lame pic)
if( !com.stricmp( wad->lumps[i].name, "conchars" ) && wad->lumps[i].type == TYPE_QMIP )
wad->lumps[i].type = TYPE_QPIC;
}
return true;
}
byte *W_ReadLump( wfile_t *wad, dlumpinfo_t *lump, size_t *lumpsizeptr )
{
byte *buf, *cbuf;
size_t size = 0;
// assume error
if( lumpsizeptr ) *lumpsizeptr = 0;
// no wads loaded
if( !wad || !lump ) return NULL;
if( FS_Seek( wad->file, lump->filepos, SEEK_SET ))
{
MsgDev( D_ERROR, "W_ReadLump: %s is corrupted\n", lump->name );
return NULL;
}
switch( lump->compression )
{
case CMP_NONE:
buf = (byte *)Mem_Alloc( wad->mempool, lump->disksize );
size = FS_Read( wad->file, buf, lump->disksize );
if( size < lump->disksize )
{
MsgDev( D_WARN, "W_ReadLump: %s is probably corrupted\n", lump->name );
Mem_Free( buf );
return NULL;
}
break;
case CMP_LZSS:
// never used by Id Software or Valve ?
MsgDev(D_WARN, "W_ReadLump: lump %s have unsupported compression type\n", lump->name );
return NULL;
case CMP_ZLIB:
cbuf = (byte *)Mem_Alloc( wad->mempool, lump->disksize );
size = FS_Read( wad->file, cbuf, lump->disksize );
buf = (byte *)Mem_Alloc( wad->mempool, lump->size );
if(!VFS_Unpack( cbuf, size, &buf, lump->size ))
{
MsgDev( D_WARN, "W_ReadLump: %s is probably corrupted\n", lump->name );
Mem_Free( cbuf );
Mem_Free( buf );
return NULL;
}
Mem_Free( cbuf ); // no reason to keep this data
break;
}
if( lumpsizeptr ) *lumpsizeptr = lump->size;
return buf;
}
bool W_WriteLump( wfile_t *wad, dlumpinfo_t *lump, const void* data, size_t datasize, char cmp )
{
size_t ofs;
vfile_t *h;
if( !wad || !lump ) return false;
if( !data || !datasize )
{
MsgDev( D_WARN, "W_WriteLump: ignore blank lump %s - nothing to save\n", lump->name );
return false;
}
switch(( int )cmp)
{
case CMP_LZSS:
// never used by Id Software or Valve ?
MsgDev( D_WARN, "W_SaveLump: lump %s can't be saved with comptype LZSS\n", lump->name );
return false;
case CMP_ZLIB:
h = VFS_Open( wad->file, "wz" );
lump->size = datasize; // realsize
VFS_Write( h, data, datasize );
wad->file = VFS_Close( h ); // go back to real filesystem
ofs = FS_Tell( wad->file ); // ofs - info->filepos returns compressed size
lump->disksize = LittleLong( ofs - lump->filepos );
return true;
default: // CMP_NONE method
lump->size = lump->disksize = LittleLong( datasize );
FS_Write( wad->file, data, datasize ); // just write file
return true;
}
}
/*
=============================================================================
WADSYSTEM PUBLIC BASE FUNCTIONS
=============================================================================
*/
int W_Check( const char *filename )
{
file_t *testwad;
dwadinfo_t header;
int numlumps;
int infotableofs;
testwad = FS_Open( filename, "rb" );
if( !testwad ) return 0; // just not exist
if( FS_Read( testwad, &header, sizeof(dwadinfo_t)) != sizeof(dwadinfo_t))
{
// corrupted or not wad
FS_Close( testwad );
return -1; // too small file
}
switch( header.ident )
{
case IDIWADHEADER:
case IDPWADHEADER:
case IDWAD2HEADER:
case IDWAD3HEADER: break;
default:
FS_Close( testwad );
return -2; // invalid id
}
numlumps = LittleLong( header.numlumps );
if( numlumps < 0 || numlumps > MAX_FILES_IN_WAD )
{
// invalid lump number
FS_Close( testwad );
return -3; // invalid lumpcount
}
infotableofs = LittleLong( header.infotableofs );
if( FS_Seek( testwad, infotableofs, SEEK_SET ))
{
// corrupted or not wad
FS_Close( testwad );
return -4; // invalid lumptable
}
// all check is done
FS_Close( testwad );
return 1; // valid
}
wfile_t *W_Open( const char *filename, const char *mode )
{
dwadinfo_t header;
wfile_t *wad = (wfile_t *)Mem_Alloc( fs_mempool, sizeof( wfile_t ));
if( mode[0] == 'a' ) wad->file = FS_Open( filename, "r+b" );
else if( mode[0] == 'w' ) wad->file = FS_Open( filename, "wb" );
else if( mode[0] == 'r' ) wad->file = FS_Open( filename, "rb" );
if( !wad->file )
{
W_Close( wad );
MsgDev( D_ERROR, "W_Open: couldn't open %s\n", filename );
return NULL;
}
// copy wad name
com.strncpy( wad->filename, filename, sizeof( wad->filename ));
wad->mempool = Mem_AllocPool( filename );
wad->filetime = wad->file->filetime;
// if the file is opened in "write", "append", or "read/write" mode
if( mode[0] == 'w' )
{
dwadinfo_t hdr;
wad->numlumps = 0; // blank wad
wad->lumps = NULL; //
wad->mode = O_WRONLY;
// save space for header
hdr.ident = IDWAD3HEADER;
hdr.numlumps = LittleLong( wad->numlumps );
hdr.infotableofs = LittleLong(sizeof( dwadinfo_t ));
FS_Write( wad->file, &hdr, sizeof( hdr ));
FS_Print( wad->file, "Generated by Xash WadLib. " );
wad->infotableofs = FS_Tell( wad->file );
}
else if( mode[0] == 'r' || mode[0] == 'a' )
{
if( mode[0] == 'a' )
{
FS_Seek( wad->file, 0, SEEK_SET );
wad->mode = O_APPEND;
}
if( FS_Read( wad->file, &header, sizeof( dwadinfo_t )) != sizeof( dwadinfo_t ))
{
MsgDev( D_ERROR, "W_Open: %s can't read header\n", filename );
W_Close( wad );
return NULL;
}
switch( header.ident )
{
case IDIWADHEADER:
case IDPWADHEADER:
case IDWAD2HEADER:
if( wad->mode == O_APPEND )
{
MsgDev( D_WARN, "W_Open: %s is readonly\n", filename, mode );
wad->mode = O_RDONLY; // set read-only mode
}
break;
case IDWAD3HEADER:
break; // WAD3 allow r\w mode
default:
MsgDev( D_ERROR, "W_Open: %s unknown wadtype\n", filename );
W_Close( wad );
return NULL;
}
wad->numlumps = LittleLong( header.numlumps );
if( wad->numlumps >= MAX_FILES_IN_WAD && wad->mode == O_APPEND )
{
MsgDev( D_WARN, "W_Open: %s is full (%i lumps)\n", wad->numlumps );
wad->mode = O_RDONLY; // set read-only mode
}
wad->infotableofs = LittleLong( header.infotableofs ); // save infotableofs position
if( FS_Seek( wad->file, wad->infotableofs, SEEK_SET ))
{
MsgDev( D_ERROR, "W_Open: %s can't find lump allocation table\n", filename );
W_Close( wad );
return NULL;
}
// NOTE: lumps table can be reallocated for O_APPEND mode
wad->lumps = Mem_Alloc( wad->mempool, wad->numlumps * sizeof( dlumpinfo_t ));
if( wad->mode == O_APPEND )
{
size_t lat_size = wad->numlumps * sizeof( dlumpinfo_t );
if( FS_Read( wad->file, wad->lumps, lat_size ) != lat_size )
{
MsgDev( D_ERROR, "W_ReadLumpTable: %s has corrupted lump allocation table\n", wad->filename );
W_Close( wad );
return NULL;
}
// if we are in append mode - we need started from infotableofs poisition
// overwrite lumptable as well, we have her copy in wad->lumps
FS_Seek( wad->file, wad->infotableofs, SEEK_SET );
}
else
{
// setup lump allocation table
switch( header.ident )
{
case IDIWADHEADER:
case IDPWADHEADER:
if(!W_ConvertIWADLumps( wad ))
return NULL;
break;
case IDWAD2HEADER:
case IDWAD3HEADER:
if(!W_ReadLumpTable( wad ))
return NULL;
break;
}
}
}
// and leaves the file open
return wad;
}
void W_Close( wfile_t *wad )
{
fs_offset_t ofs;
if( !wad ) return;
if( wad->file && ( wad->mode == O_APPEND || wad->mode == O_WRONLY ))
{
dwadinfo_t hdr;
// write the lumpingo
ofs = FS_Tell( wad->file );
FS_Write( wad->file, wad->lumps, wad->numlumps * sizeof( dlumpinfo_t ));
// write the header
hdr.ident = IDWAD3HEADER;
hdr.numlumps = LittleLong( wad->numlumps );
hdr.infotableofs = LittleLong( ofs );
FS_Seek( wad->file, 0, SEEK_SET );
FS_Write( wad->file, &hdr, sizeof( hdr ));
}
Mem_FreePool( &wad->mempool );
if( wad->file ) FS_Close( wad->file );
Mem_Free( wad ); // free himself
}
fs_offset_t W_SaveLump( wfile_t *wad, const char *lump, const void* data, size_t datasize, char type, char cmp )
{
size_t lat_size;
dlumpinfo_t *info;
int i;
if( !wad || !lump ) return -1;
if( !data || !datasize )
{
MsgDev( D_WARN, "W_SaveLump: ignore blank lump %s - nothing to save\n", lump );
return -1;
}
if( wad->mode == O_RDONLY )
{
MsgDev( D_ERROR, "W_SaveLump: %s opened in readonly mode\n", wad->filename );
return -1;
}
if( wad->numlumps >= MAX_FILES_IN_WAD )
{
MsgDev( D_ERROR, "W_SaveLump: %s is full\n", wad->filename );
return -1;
}
if( W_FindLump( wad, lump, type ))
{
// don't make mirror lumps
MsgDev( D_ERROR, "W_SaveLump: %s already exist\n", lump );
return -1;
}
lat_size = sizeof( dlumpinfo_t ) * (wad->numlumps + 1);
// reallocate lumptable
wad->lumps = Mem_Realloc( wad->mempool, wad->lumps, lat_size );
info = wad->lumps + wad->numlumps;
// write header
W_CleanupName( lump, info->name );
info->filepos = LittleLong( FS_Tell( wad->file ));
info->compression = cmp;
info->type = type;
i = FS_Tell( wad->file );
if(!W_WriteLump( wad, info, data, datasize, cmp ))
return -1;
MsgDev( D_NOTE, "W_SaveLump: %s, size %d\n", info->name, info->disksize );
return wad->numlumps++;
}
byte *W_LoadLump( wfile_t *wad, const char *lumpname, size_t *lumpsizeptr, const char type )
{
dlumpinfo_t *lump;
// assume error
if( lumpsizeptr ) *lumpsizeptr = 0;
if( !wad ) return NULL;
lump = W_FindLump( wad, lumpname, type );
return W_ReadLump( wad, lump, lumpsizeptr );
}
/*
=============================================================================
FILESYSTEM IMPLEMENTATION
=============================================================================
*/
static byte *W_LoadFile( const char *path, fs_offset_t *lumpsizeptr )
{
searchpath_t *search;
int index;
search = FS_FindFile( path, &index, true, false );
if( search && search->wad )
return W_ReadLump( search->wad, &search->wad->lumps[index], lumpsizeptr );
return NULL;
}