2 Copyright (c) 2001, Loki software, inc.
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
8 Redistributions of source code must retain the above copyright notice, this list
9 of conditions and the following disclaimer.
11 Redistributions in binary form must reproduce the above copyright notice, this
12 list of conditions and the following disclaimer in the documentation and/or
13 other materials provided with the distribution.
15 Neither the name of Loki software nor the names of its contributors may be used
16 to endorse or promote products derived from this software without specific prior
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
23 DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 // - Directories should be searched in the following order: ~/.q3a/baseq3,
35 // install dir (/usr/local/games/quake3/baseq3) and cd_path (/mnt/cdrom/baseq3).
37 // - Pak files are searched first inside the directories.
38 // - Case insensitive.
39 // - Unix-style slashes (/) (windows is backwards .. everyone knows that)
41 // Leonardo Zide (leo@lokigames.com)
47 #if defined ( __linux__ ) || defined ( __APPLE__ )
54 #define S_ISDIR( mode ) ( mode & _S_IFDIR )
57 // TTimo: String functions
58 // see http://www.qeradiant.com/faq/index.cgi?file=175
73 unsigned long filenumber;
77 // =============================================================================
80 static GSList* g_wadFiles;
81 static GSList* g_pakFiles;
82 static char g_strDirs[VFS_MAXDIRS][PATH_MAX];
85 // =============================================================================
88 static void vfsAddSlash( char *str ){
89 int n = strlen( str );
91 if ( str[n - 1] != '\\' && str[n - 1] != '/' ) {
97 static void vfsFixDOSName( char *src ){
104 if ( *src == '\\' ) {
111 //FIXME: STUPID short filenames.. get RID of it asap
112 // copied verbatim from qe3.cpp
113 int vfsBuildShortPathName( const char* pPath, char* pBuffer, int nBufferLen ){
116 int nResult = GetFullPathName( pPath, nBufferLen, pBuffer, &pFile );
117 nResult = GetShortPathName( pPath, pBuffer, nBufferLen );
118 if ( nResult == 0 ) {
119 strcpy( pBuffer, pPath ); // Use long filename
124 #if defined ( __linux__ ) || defined ( __APPLE__ )
126 // remove /../ from directories
127 const char *scr = pPath; char *dst = pBuffer;
128 for ( int i = 0; ( i < nBufferLen ) && ( *scr != 0 ); i++ )
130 if ( *scr == '/' && *( scr + 1 ) == '.' && *( scr + 2 ) == '.' ) {
132 while ( dst != pBuffer && *( --dst ) != '/' )
144 return strlen( pBuffer );
148 static void vfsInitPakFile( const char *filename ){
153 char wadname[NAME_MAX];
155 wf = wadOpen( filename );
157 g_FuncTable.m_pfnSysFPrintf( SYS_WRN, " failed to init wad file %s\n", filename );
160 g_FuncTable.m_pfnSysPrintf( " wad file: %s\n", filename );
162 for ( i = strlen( filename ) - 1 ; i >= 0 && filename[i] != '\\' && filename[i] != '/' ; i-- )
163 wadnameptr = (char *)filename + i;
165 strcpy( wadname,wadnameptr );
166 wadname[strlen( wadname ) - 4] = 0; // ditch the .wad so everthing looks nice!
168 g_wadFiles = g_slist_append( g_wadFiles, wf ); // store the wadfile handle
170 wadGoToFirstFile( wf );
172 for ( i = 0; i < wf->lpHeader->numlumps; i++ )
174 char filename_inwad[NAME_MAX];
175 char filename_inwadfixed[NAME_MAX];
176 unsigned long filesize;
179 err = wadGetCurrentFileInfo( wf, filename_inwad, sizeof( filename_inwad ) - 5, &filesize ); // -5 for extension + null terminator
184 file = (VFS_PAKFILE*)g_malloc( sizeof( VFS_PAKFILE ) );
185 g_pakFiles = g_slist_append( g_pakFiles, file );
187 vfsFixDOSName( filename_inwad );
188 g_strdown( filename_inwad );
190 // texturenames in wad files don't have an extensions or paths, so we must add them!
191 if ( wf->lpLump->type == WAD2_TYPE_MIP ) {
192 sprintf( filename_inwadfixed,"textures/%s/%s.mip",wadname,filename_inwad );
195 sprintf( filename_inwadfixed,"textures/%s/%s.hlw",wadname,filename_inwad );
198 //g_FuncTable.m_pfnSysFPrintf(SYS_WRN, " scanned %s\\%s\n", filename,filename_inwad);
200 file->name = g_strdup( filename_inwadfixed );
201 file->size = filesize;
202 file->filenumber = wf->currentfile;
204 memcpy( &file->wadlump, wf->lpLump, sizeof( WAD3_LUMP ) );
206 err = wadGoToNextFile( wf );
213 static GSList* vfsGetListInternal( const char *refdir, const char *ext, bool directories ){
214 GSList *lst, *lst_aux, *files = NULL;
215 char dirname[NAME_MAX], extension[NAME_MAX], filename[NAME_MAX];
216 char basedir[NAME_MAX];
222 if ( refdir != NULL ) {
223 strcpy( dirname, refdir );
224 g_strdown( dirname );
225 vfsFixDOSName( dirname );
226 vfsAddSlash( dirname );
231 dirlen = strlen( dirname );
234 strcpy( extension, ext );
239 g_strdown( extension );
241 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
243 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
244 gboolean found = FALSE;
247 // check that the file name begins with dirname
248 for ( i = 0; ( *ptr && i < dirlen ); i++, ptr++ )
249 if ( *ptr != dirname[i] ) {
258 char *sep = strchr( ptr, '/' );
265 // check for duplicates
266 for ( lst_aux = files; lst_aux; lst_aux = g_slist_next( lst_aux ) )
267 if ( strncmp( (char*)lst_aux->data, ptr, i ) == 0 ) {
273 char *name = g_strndup( ptr, i + 1 );
275 files = g_slist_append( files, name );
281 char *ptr_ext = strrchr( ptr, '.' );
282 if ( ( ext != NULL ) && ( ( ptr_ext == NULL ) || ( strcmp( ptr_ext + 1, extension ) != 0 ) ) ) {
286 // check for duplicates
287 for ( lst_aux = files; lst_aux; lst_aux = g_slist_next( lst_aux ) )
288 if ( strcmp( (char*)lst_aux->data, ptr ) == 0 ) {
294 files = g_slist_append( files, g_strdup( ptr ) );
299 for ( i = 0; i < g_numDirs; i++ )
301 strcpy( basedir, g_strDirs[i] );
302 strcat( basedir, dirname );
304 GDir* dir = g_dir_open( basedir, 0, NULL );
309 const char* name = g_dir_read_name( dir );
310 if ( name == NULL ) {
314 if ( directories && ( name[0] == '.' ) ) {
318 sprintf( filename, "%s%s", basedir, name );
319 stat( filename, &st );
321 if ( ( S_ISDIR( st.st_mode ) != 0 ) != directories ) {
325 gboolean found = FALSE;
327 char* direntry = g_strdup( name );
329 g_strdown( direntry );
331 char *ptr_ext = strrchr( direntry, '.' );
334 || ( ext != NULL && ptr_ext != NULL && ptr_ext[0] != '\0' && strcmp( ptr_ext + 1, extension ) == 0 ) ) {
336 // check for duplicates
337 for ( lst_aux = files; lst_aux; lst_aux = g_slist_next( lst_aux ) )
338 if ( strcmp( (char*)lst_aux->data, direntry ) == 0 ) {
344 files = g_slist_append( files, g_strdup( direntry ) );
357 // =============================================================================
360 // reads all pak files from a dir
361 void vfsInitDirectory( const char *path ){
362 char filename[PATH_MAX];
364 if ( g_numDirs == ( VFS_MAXDIRS - 1 ) ) {
368 strcpy( g_strDirs[g_numDirs], path );
369 vfsFixDOSName( g_strDirs[g_numDirs] );
370 vfsAddSlash( g_strDirs[g_numDirs] );
373 // if (g_PrefsDlg.m_bPAK)
374 // TODO: can't read prefs from a module, bah..
376 GDir* dir = g_dir_open( path, 0, NULL );
378 g_FuncTable.m_pfnSysPrintf( "vfs directory: %s\n", path );
381 const char* name = g_dir_read_name( dir );
382 if ( name == NULL ) {
386 const char *ext = strrchr( name, '.' );
387 if ( ( ext == NULL ) || ( strcmp( ext, ".wad" ) != 0 ) ) {
391 sprintf( filename, "%s/%s", path, name );
392 vfsInitPakFile( filename );
397 g_FuncTable.m_pfnSysFPrintf( SYS_WRN, "vfs directory not found: %s\n", path );
402 // frees all memory that we allocated
403 // FIXME TTimo this should be improved so that we can shutdown and restart the VFS without exiting Radiant?
404 // (for instance when modifying the project settings)
408 wadCleanup( (wadFile_t *)g_wadFiles->data );
409 g_wadFiles = g_slist_remove( g_wadFiles, g_wadFiles->data );
412 // avoid dangling pointer operation (makes BC hangry)
413 GSList *cur = g_pakFiles;
418 VFS_PAKFILE* file = (VFS_PAKFILE*)cur->data;
419 g_free( file->name );
421 next = g_slist_remove( cur, file );
426 void vfsFreeFile( void *p ){
430 GSList* vfsGetFileList( const char *dir, const char *ext ){
431 return vfsGetListInternal( dir, ext, false );
434 GSList* vfsGetDirList( const char *dir ){
435 return vfsGetListInternal( dir, NULL, true );
438 void vfsClearFileDirList( GSList **lst ){
441 g_free( ( *lst )->data );
442 *lst = g_slist_remove( *lst, ( *lst )->data );
446 // return the number of files that match
447 int vfsGetFileCount( const char *filename, int flag ){
449 char fixed[NAME_MAX], tmp[NAME_MAX];
452 strcpy( fixed, filename );
453 vfsFixDOSName( fixed );
456 if ( !flag || ( flag & VFS_SEARCH_PAK ) ) {
457 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
459 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
461 if ( strcmp( file->name, fixed ) == 0 ) {
467 if ( !flag || ( flag & VFS_SEARCH_DIR ) ) {
468 for ( i = 0; i < g_numDirs; i++ )
470 strcpy( tmp, g_strDirs[i] );
471 strcat( tmp, fixed );
472 if ( access( tmp, R_OK ) == 0 ) {
481 // open a full path file
482 int vfsLoadFullPathFile( const char *filename, void **bufferptr ){
486 f = fopen( filename, "rb" );
491 fseek( f, 0, SEEK_END );
495 *bufferptr = g_malloc( len + 1 );
496 if ( *bufferptr == NULL ) {
500 fread( *bufferptr, 1, len, f );
503 // we need to end the buffer with a 0
504 ( (char*) ( *bufferptr ) )[len] = 0;
509 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
510 int vfsLoadFile( const char *filename, void **bufferptr, int index ){
512 char tmp[NAME_MAX], fixed[NAME_MAX];
516 strcpy( fixed, filename );
517 vfsFixDOSName( fixed );
520 for ( i = 0; i < g_numDirs; i++ )
522 strcpy( tmp, g_strDirs[i] );
523 strcat( tmp, filename );
524 if ( access( tmp, R_OK ) == 0 ) {
525 if ( count == index ) {
526 return vfsLoadFullPathFile( tmp,bufferptr );
531 f = fopen (tmp, "rb");
535 fseek (f, 0, SEEK_END);
539 *bufferptr = g_malloc (len+1);
540 if (*bufferptr == NULL)
543 fread (*bufferptr, 1, len, f);
546 // we need to end the buffer with a 0
547 ((char*) (*bufferptr))[len] = 0;
558 // Textures in HalfLife wads don't have paths, but in the list of files
559 // we store the actual full paths of the files and what WAD they're in.
560 // so what we have to do is strip the paths and just compare filenames.
562 // Hydra: well, we did do this, but now we don't, as the map loader now
563 // fills in the correct paths for each texture.
571 for (i = strlen(fixed)-1 ; i >= 0 && fixed[i] != '\\' && fixed[i] != '/' ; i --)
572 fixedptr = (char *)fixed + i;
574 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
576 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
580 searchname = file->name;
581 for (i = strlen(file->name)-1 ; i >= 0 && file->name[i] != '\\' && file->name[i] != '/' ; i --)
582 searchname = (char *)file->name + i;
583 if (strcmp (searchname, fixedptr) != 0)
587 if ( strcmp( file->name, fixed ) != 0 ) {
591 if ( count == index ) {
592 // Useful for debugging
593 //Sys_Printf("VFSWAD: reading from %s\n",file->wadfile->wadfilename);
595 if ( wadOpenCurrentFileByNum( file->wadfile, file->filenumber ) != 1 ) {
599 *bufferptr = g_malloc( file->size + 1 );
600 // we need to end the buffer with a 0
601 ( (char*) ( *bufferptr ) )[file->size] = 0;
603 i = wadReadCurrentFile( file->wadfile, (char *)*bufferptr, file->size );
604 wadCloseCurrentFile( file->wadfile );
624 char* vfsExtractRelativePath( const char *in ){
627 char check[PATH_MAX];
628 static char out[PATH_MAX];
632 Sys_Printf( "vfsExtractRelativePath: %s\n", in );
636 vfsCleanFileName( l_in );
639 Sys_Printf( "cleaned path: %s\n", l_in );
642 for ( i = 0; i < g_numDirs; i++ )
644 strcpy( check,g_strDirs[i] );
645 vfsCleanFileName( check );
647 Sys_Printf( "Matching against %s\n", check );
650 // try to find a match
651 if ( strstr( l_in, check ) ) {
652 strcpy( out,l_in + strlen( check ) + 1 );
658 Sys_Printf( "vfsExtractRelativePath: success\n" );
663 Sys_Printf( "vfsExtractRelativePath: failed\n" );
668 // removed CString usage
669 void vfsCleanFileName( char *in ){
671 vfsBuildShortPathName( in, str, PATH_MAX );
673 vfsFixDOSName( str );
674 int n = strlen( str );
675 if ( str[n - 1] == '/' ) {
681 // HYDRA: this now searches VFS/PAK files in addition to the filesystem
682 // if FLAG is unspecified then ONLY dirs are searched.
683 // PAK's are searched before DIRs to mimic engine behaviour
684 // index is ignored when searching PAK files.
686 char* vfsGetFullPath( const char *in, int index, int flag ){
688 static char out[PATH_MAX];
692 if ( flag & VFS_SEARCH_PAK ) {
693 char fixed[NAME_MAX];
697 vfsFixDOSName( fixed );
700 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
702 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
705 lastptr = file->name;
707 while ( ( ptr = strchr( lastptr,'/' ) ) != NULL )
710 if ( strcmp( lastptr, fixed ) == 0 ) {
711 strncpy( out,file->name,PATH_MAX );
718 if ( !flag || ( flag & VFS_SEARCH_DIR ) ) {
719 for ( i = 0; i < g_numDirs; i++ )
721 strcpy( tmp, g_strDirs[i] );
723 if ( access( tmp, R_OK ) == 0 ) {
724 if ( count == index ) {
735 // TODO TTimo on linux the base prompt is ~/.q3a/<fs_game>
736 // given the file dialog, we could push the strFSBasePath and ~/.q3a into the directory shortcuts
737 // FIXME TTimo is this really a VFS functionality?
738 // actually .. this should be the decision of the core isn't it?
739 // or .. add an API so that the base prompt can be set during VFS init
740 const char* vfsBasePromptPath(){
742 static const char* path = "C:";
744 static const char* path = "/";