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)
49 #include "filematch.h"
64 // =============================================================================
67 static GSList* g_unzFiles;
68 static GSList* g_pakFiles;
69 static char g_strDirs[VFS_MAXDIRS][PATH_MAX + 1];
71 char g_strForbiddenDirs[VFS_MAXDIRS][PATH_MAX + 1];
72 int g_numForbiddenDirs = 0;
73 static gboolean g_bUsePak = TRUE;
75 // =============================================================================
78 static void vfsAddSlash( char *str ){
79 int n = strlen( str );
81 if ( str[n - 1] != '\\' && str[n - 1] != '/' ) {
87 static void vfsFixDOSName( char *src ){
101 //!\todo Define globally or use heap-allocated string.
104 static void vfsInitPakFile( const char *filename ){
110 uf = unzOpen( filename );
115 g_unzFiles = g_slist_append( g_unzFiles, uf );
117 err = unzGetGlobalInfo( uf,&gi );
118 if ( err != UNZ_OK ) {
121 unzGoToFirstFile( uf );
123 for ( i = 0; i < gi.number_entry; i++ )
125 char filename_inzip[NAME_MAX];
126 char *filename_lower;
127 unz_file_info file_info;
130 err = unzGetCurrentFileInfo( uf, &file_info, filename_inzip, sizeof( filename_inzip ), NULL, 0, NULL, 0 );
131 if ( err != UNZ_OK ) {
135 err = unzGetFilePos( uf, &pos );
136 if ( err != UNZ_OK ) {
140 file = (VFS_PAKFILE*)safe_malloc( sizeof( VFS_PAKFILE ) );
141 g_pakFiles = g_slist_append( g_pakFiles, file );
143 vfsFixDOSName( filename_inzip );
144 //-1 null terminated string
145 filename_lower = g_ascii_strdown( filename_inzip, -1 );
147 file->name = strdup( filename_lower );
148 file->size = file_info.uncompressed_size;
152 if ( ( i + 1 ) < gi.number_entry ) {
153 err = unzGoToNextFile( uf );
154 if ( err != UNZ_OK ) {
158 g_free( filename_lower );
162 // =============================================================================
165 // reads all pak files from a dir
166 void vfsInitDirectory( const char *path ){
167 char filename[PATH_MAX];
172 for ( j = 0; j < g_numForbiddenDirs; ++j )
174 char* dbuf = g_strdup( path );
175 if ( *dbuf && dbuf[strlen( dbuf ) - 1] == '/' ) {
176 dbuf[strlen( dbuf ) - 1] = 0;
178 const char *p = strrchr( dbuf, '/' );
179 p = ( p ? ( p + 1 ) : dbuf );
180 if ( matchpattern( p, g_strForbiddenDirs[j], TRUE ) ) {
186 if ( j < g_numForbiddenDirs ) {
190 if ( g_numDirs == VFS_MAXDIRS ) {
191 Sys_FPrintf( SYS_WRN, "WARNING: too many VFS directories, can't init %s\n", path );
195 Sys_Printf( "VFS Init: %s\n", path );
197 strncpy( g_strDirs[g_numDirs], path, PATH_MAX );
198 g_strDirs[g_numDirs][PATH_MAX] = 0;
199 vfsFixDOSName( g_strDirs[g_numDirs] );
200 vfsAddSlash( g_strDirs[g_numDirs] );
204 dir = g_dir_open( path, 0, NULL );
209 const char* name = g_dir_read_name( dir );
210 if ( name == NULL ) {
214 for ( j = 0; j < g_numForbiddenDirs; ++j )
216 const char *p = strrchr( name, '/' );
217 p = ( p ? ( p + 1 ) : name );
218 if ( matchpattern( p, g_strForbiddenDirs[j], TRUE ) ) {
222 if ( j < g_numForbiddenDirs ) {
226 dirlist = g_strdup( name );
229 char *ext = strrchr( dirlist, '.' );
231 if ( ext != NULL && ( !Q_stricmp( ext, ".pk3dir" ) || !Q_stricmp( ext, ".dpkdir" ) ) ) {
232 if ( g_numDirs == VFS_MAXDIRS ) {
236 snprintf( g_strDirs[g_numDirs], PATH_MAX, "%s/%s", path, name );
237 g_strDirs[g_numDirs][PATH_MAX-1] = '\0';
238 vfsFixDOSName( g_strDirs[g_numDirs] );
239 vfsAddSlash( g_strDirs[g_numDirs] );
243 if ( ext == NULL || ( Q_stricmp( ext, ".pk3" ) != 0 && Q_stricmp( ext, ".dpk" ) != 0 ) ) {
249 sprintf( filename, "%s/%s", path, dirlist );
250 vfsInitPakFile( filename );
259 // frees all memory that we allocated
263 unzClose( (unzFile)g_unzFiles->data );
264 g_unzFiles = g_slist_remove( g_unzFiles, g_unzFiles->data );
269 VFS_PAKFILE* file = (VFS_PAKFILE*)g_pakFiles->data;
272 g_pakFiles = g_slist_remove( g_pakFiles, file );
276 // return the number of files that match
277 int vfsGetFileCount( const char *filename ){
279 char fixed[NAME_MAX], tmp[NAME_MAX];
283 strcpy( fixed, filename );
284 vfsFixDOSName( fixed );
285 lower = g_ascii_strdown( fixed, -1 );
287 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
289 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
291 if ( strcmp( file->name, lower ) == 0 ) {
296 for ( i = 0; i < g_numDirs; i++ )
298 strcpy( tmp, g_strDirs[i] );
299 strcat( tmp, lower );
300 if ( access( tmp, R_OK ) == 0 ) {
308 static qboolean isSymlink(const unz_file_info64 *fileInfo) {
309 // see https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/stat.h
310 // redefine so it works outside of Unices
311 const unsigned long Q3MAP_S_IFMT = 00170000;
312 const unsigned long Q3MAP_S_IFLNK = 0120000;
313 // see https://trac.edgewall.org/attachment/ticket/8919/ZipDownload.patch
314 const unsigned long PKZIP_EXTERNAL_ATTR_FILE_TYPE_SHIFT = 16;
316 unsigned long attr = fileInfo->external_fa >> PKZIP_EXTERNAL_ATTR_FILE_TYPE_SHIFT;
317 return (attr & Q3MAP_S_IFMT) == Q3MAP_S_IFLNK;
320 // The zip format has a maximum filename size of 64K
321 static const int MAX_FILENAME_BUF = 65537;
323 /* The symlink implementation is ported from Dæmon engine implementation by slipher which was a complete rewrite of one illwieckz did on Dæmon by taking inspiration from Darkplaces engine.
327 - https://github.com/DaemonEngine/Daemon/blob/master/src/common/FileSystem.cpp
328 - https://gitlab.com/xonotic/darkplaces/-/blob/div0-stable/fs.c
330 Some words by slipher:
332 > Symlinks are a bad feature which you should not use. Therefore, the implementation is as
333 > slow as possible with a full iteration of the archive performed for each symlink.
335 > The symlink path `relative` must be relative to the symlink's location.
336 > Only supports paths consisting of "../" 0 or more times, followed by non-magical path components.
338 void resolveSymlinkPath( const char* base, const char* relative, char* resolved ){
340 base = g_path_get_dirname( base );
342 while( g_str_has_prefix( relative, "../" ) )
344 if ( base[0] == '\0' )
346 Sys_FPrintf( SYS_WRN, "Error while reading symbolic link: \"%s\": no such directory\n", base );
351 base = g_path_get_dirname( base );
355 snprintf( resolved, MAX_FILENAME_BUF, "%s/%s", base, relative);
358 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
359 int vfsLoadFile( const char *filename, void **bufferptr, int index ){
361 char tmp[NAME_MAX], fixed[NAME_MAX];
365 // filename is a full path
370 f = fopen( filename, "rb" );
375 fseek( f, 0, SEEK_END );
379 *bufferptr = safe_malloc( len + 1 );
380 if ( *bufferptr == NULL ) {
385 if ( fread( *bufferptr, 1, len, f ) != (size_t) len ) {
391 // we need to end the buffer with a 0
392 ( (char*) ( *bufferptr ) )[len] = 0;
398 strncpy( fixed, filename, sizeof( fixed ) );
399 vfsFixDOSName( fixed );
400 lower = g_ascii_strdown( fixed, -1 );
402 for ( i = 0; i < g_numDirs; i++ )
404 strcpy( tmp, g_strDirs[i] );
405 strcat( tmp, filename );
406 if ( access( tmp, R_OK ) == 0 ) {
407 if ( count == index ) {
411 f = fopen( tmp, "rb" );
416 fseek( f, 0, SEEK_END );
420 *bufferptr = safe_malloc( len + 1 );
421 if ( *bufferptr == NULL ) {
426 if ( fread( *bufferptr, 1, len, f ) != (size_t) len ) {
432 // we need to end the buffer with a 0
433 ( (char*) ( *bufferptr ) )[len] = 0;
442 // Do not resolve more than 5 recursive symbolic links to
443 // prevent circular symbolic links.
444 int max_symlink_depth = 5;
447 for ( lst = g_pakFiles; lst != NULL; lst = g_slist_next( lst ) )
449 VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
451 if ( strcmp( file->name, lower ) != 0 ) {
455 if ( count == index ) {
457 if ( unzGoToFilePos( file->zipfile, &file->zippos ) != UNZ_OK ) {
460 if ( unzOpenCurrentFile( file->zipfile ) != UNZ_OK ) {
464 unz_file_info64 fileInfo;
465 if ( unzGetCurrentFileInfo64( file->zipfile, &fileInfo, filename, sizeof(filename), NULL, 0, NULL, 0 ) != UNZ_OK ) {
469 *bufferptr = safe_malloc( file->size + 1 );
470 // we need to end the buffer with a 0
471 ( (char*) ( *bufferptr ) )[file->size] = 0;
473 i = unzReadCurrentFile( file->zipfile, *bufferptr, file->size );
474 unzCloseCurrentFile( file->zipfile );
476 if ( isSymlink( &fileInfo ) ) {
477 Sys_FPrintf( SYS_VRB, "Found symbolic link: \"%s\"\n", filename );
479 if ( max_symlink_depth == 0 ) {
480 Sys_FPrintf( SYS_WRN, "Maximum symbolic link depth reached\n" );
487 const char* relative = (const char*) *bufferptr;
488 char resolved[MAX_FILENAME_BUF];
490 resolveSymlinkPath( file->name, relative, resolved );
492 Sys_FPrintf( SYS_VRB, "Resolved symbolic link: \"%s\"\n", resolved );
495 strncpy( fixed, resolved, sizeof( fixed ) );
496 vfsFixDOSName( fixed );
497 lower = g_ascii_strdown( fixed, -1 );
499 // slow as possible full iteration of the archive
500 goto openSymlinkTarget;