4 Copyright (C) 2003-2006 Mathieu Olivier
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 as published by the Free Software Foundation; either version 2
9 of the License, or (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 See the GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to:
20 Free Software Foundation, Inc.
21 59 Temple Place - Suite 330
22 Boston, MA 02111-1307, USA
32 # include <sys/stat.h>
36 # include <sys/stat.h>
43 // include SDL for IPHONEOS code
56 // Win32 requires us to add O_BINARY, but the other OSes don't have it
61 // In case the system doesn't support the O_NONBLOCK flag
66 // largefile support for Win32
69 # define lseek _lseeki64
72 // suppress deprecated warnings
77 # define unlink _unlink
83 typedef SDL_RWops *filedesc_t;
84 # define FILEDESC_INVALID NULL
85 # define FILEDESC_ISVALID(fd) ((fd) != NULL)
86 # define FILEDESC_READ(fd,buf,count) ((fs_offset_t)SDL_RWread(fd, buf, 1, count))
87 # define FILEDESC_WRITE(fd,buf,count) ((fs_offset_t)SDL_RWwrite(fd, buf, 1, count))
88 # define FILEDESC_CLOSE SDL_RWclose
89 # define FILEDESC_SEEK SDL_RWseek
90 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
91 filedesc_t new_fd = SDL_RWFromFile(filename, "rb");
92 if (SDL_RWseek(new_fd, SDL_RWseek(fd, 0, RW_SEEK_CUR), RW_SEEK_SET) < 0) {
98 # define unlink(name) Con_DPrintf("Sorry, no unlink support when trying to unlink %s.\n", (name))
100 typedef int filedesc_t;
101 # define FILEDESC_INVALID -1
102 # define FILEDESC_ISVALID(fd) ((fd) != -1)
103 # define FILEDESC_READ read
104 # define FILEDESC_WRITE write
105 # define FILEDESC_CLOSE close
106 # define FILEDESC_SEEK lseek
107 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
113 /* This code seems to have originally been written with the assumption that
114 * read(..., n) returns n on success. This is not the case (refer to
115 * <https://pubs.opengroup.org/onlinepubs/9699919799/functions/read.html>).
123 Read exactly length bytes from fd into buf. If end of file is reached,
124 the number of bytes read is returned. If an error occurred, that error
125 is returned. Note that if an error is returned, any previously read
129 static fs_offset_t ReadAll(const filedesc_t fd, void *const buf, const size_t length)
131 char *const p = (char *)buf;
135 const fs_offset_t result = FILEDESC_READ(fd, p + cursor, length - cursor);
136 if (result < 0) // Error
138 if (result == 0) // EOF
141 } while (cursor < length);
149 Write exactly length bytes to fd from buf.
150 If an error occurred, that error is returned.
153 static fs_offset_t WriteAll(const filedesc_t fd, const void *const buf, const size_t length)
155 const char *const p = (const char *)buf;
159 const fs_offset_t result = FILEDESC_WRITE(fd, p + cursor, length - cursor);
160 if (result < 0) // Error
163 } while (cursor < length);
168 #define FILEDESC_READ ReadAll
169 #undef FILEDESC_WRITE
170 #define FILEDESC_WRITE WriteAll
172 /** \page fs File System
174 All of Quake's data access is through a hierchal file system, but the contents
175 of the file system can be transparently merged from several sources.
177 The "base directory" is the path to the directory holding the quake.exe and
178 all game directories. The sys_* files pass this to host_init in
179 quakeparms_t->basedir. This can be overridden with the "-basedir" command
180 line parm to allow code debugging in a different directory. The base
181 directory is only used during filesystem initialization.
183 The "game directory" is the first tree on the search path and directory that
184 all generated files (savegames, screenshots, demos, config files) will be
185 saved to. This can be overridden with the "-game" command line parameter.
186 The game directory can never be changed while quake is executing. This is a
187 precaution against having a malicious server instruct clients to write files
188 over areas they shouldn't.
194 =============================================================================
198 =============================================================================
201 // Magic numbers of a ZIP file (big-endian format)
202 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
203 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
204 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
206 // Other constants for ZIP files
207 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
208 #define ZIP_END_CDIR_SIZE 22
209 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
210 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
215 #define qz_inflate inflate
216 #define qz_inflateEnd inflateEnd
217 #define qz_inflateInit2_ inflateInit2_
218 #define qz_inflateReset inflateReset
219 #define qz_deflateInit2_ deflateInit2_
220 #define qz_deflateEnd deflateEnd
221 #define qz_deflate deflate
222 #define Z_MEMLEVEL_DEFAULT 8
225 // Zlib constants (from zlib.h)
226 #define Z_SYNC_FLUSH 2
229 #define Z_STREAM_END 1
230 #define Z_STREAM_ERROR (-2)
231 #define Z_DATA_ERROR (-3)
232 #define Z_MEM_ERROR (-4)
233 #define Z_BUF_ERROR (-5)
234 #define ZLIB_VERSION "1.2.3"
238 #define Z_MEMLEVEL_DEFAULT 8
241 #define Z_DEFAULT_COMPRESSION (-1)
243 #define Z_SYNC_FLUSH 2
244 #define Z_FULL_FLUSH 3
247 // Uncomment the following line if the zlib DLL you have still uses
248 // the 1.1.x series calling convention on Win32 (WINAPI)
249 //#define ZLIB_USES_WINAPI
253 =============================================================================
257 =============================================================================
260 /*! Zlib stream (from zlib.h)
261 * \warning: some pointers we don't use directly have
262 * been cast to "void*" for a matter of simplicity
266 unsigned char *next_in; ///< next input byte
267 unsigned int avail_in; ///< number of bytes available at next_in
268 unsigned long total_in; ///< total nb of input bytes read so far
270 unsigned char *next_out; ///< next output byte should be put there
271 unsigned int avail_out; ///< remaining free space at next_out
272 unsigned long total_out; ///< total nb of bytes output so far
274 char *msg; ///< last error message, NULL if no error
275 void *state; ///< not visible by applications
277 void *zalloc; ///< used to allocate the internal state
278 void *zfree; ///< used to free the internal state
279 void *opaque; ///< private data object passed to zalloc and zfree
281 int data_type; ///< best guess about the data type: ascii or binary
282 unsigned long adler; ///< adler32 value of the uncompressed data
283 unsigned long reserved; ///< reserved for future use
288 /// inside a package (PAK or PK3)
289 #define QFILE_FLAG_PACKED (1 << 0)
290 /// file is compressed using the deflate algorithm (PK3 only)
291 #define QFILE_FLAG_DEFLATED (1 << 1)
292 /// file is actually already loaded data
293 #define QFILE_FLAG_DATA (1 << 2)
294 /// real file will be removed on close
295 #define QFILE_FLAG_REMOVE (1 << 3)
297 #define FILE_BUFF_SIZE 2048
301 size_t comp_length; ///< length of the compressed file
302 size_t in_ind, in_len; ///< input buffer current index and length
303 size_t in_position; ///< position in the compressed file
304 unsigned char input [FILE_BUFF_SIZE];
310 filedesc_t handle; ///< file descriptor
311 fs_offset_t real_length; ///< uncompressed file size (for files opened in "read" mode)
312 fs_offset_t position; ///< current position in the file
313 fs_offset_t offset; ///< offset into the package (0 if external file)
314 int ungetc; ///< single stored character from ungetc, cleared to EOF when read
317 fs_offset_t buff_ind, buff_len; ///< buffer current index and length
318 unsigned char buff [FILE_BUFF_SIZE];
320 ztoolkit_t* ztk; ///< For zipped files.
322 const unsigned char *data; ///< For data files.
324 const char *filename; ///< Kept around for QFILE_FLAG_REMOVE, unused otherwise
328 // ------ PK3 files on disk ------ //
330 // You can get the complete ZIP format description from PKWARE website
332 typedef struct pk3_endOfCentralDir_s
334 unsigned int signature;
335 unsigned short disknum;
336 unsigned short cdir_disknum; ///< number of the disk with the start of the central directory
337 unsigned short localentries; ///< number of entries in the central directory on this disk
338 unsigned short nbentries; ///< total number of entries in the central directory on this disk
339 unsigned int cdir_size; ///< size of the central directory
340 unsigned int cdir_offset; ///< with respect to the starting disk number
341 unsigned short comment_size;
342 fs_offset_t prepended_garbage;
343 } pk3_endOfCentralDir_t;
346 // ------ PAK files on disk ------ //
347 typedef struct dpackfile_s
350 int filepos, filelen;
353 typedef struct dpackheader_s
361 /*! \name Packages in memory
364 /// the offset in packfile_t is the true contents offset
365 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
366 /// file compressed using the deflate algorithm
367 #define PACKFILE_FLAG_DEFLATED (1 << 1)
368 /// file is a symbolic link
369 #define PACKFILE_FLAG_SYMLINK (1 << 2)
371 typedef struct packfile_s
373 char name [MAX_QPATH];
376 fs_offset_t packsize; ///< size in the package
377 fs_offset_t realsize; ///< real file size (uncompressed)
380 typedef struct pack_s
382 char filename [MAX_OSPATH];
383 char shortname [MAX_QPATH];
385 int ignorecase; ///< PK3 ignores case
393 /// Search paths for files (including packages)
394 typedef struct searchpath_s
396 // only one of filename / pack will be used
397 char filename[MAX_OSPATH];
399 struct searchpath_s *next;
404 =============================================================================
408 =============================================================================
411 void FS_Dir_f(cmd_state_t *cmd);
412 void FS_Ls_f(cmd_state_t *cmd);
413 void FS_Which_f(cmd_state_t *cmd);
415 static searchpath_t *FS_FindFile (const char *name, int* index, qbool quiet);
416 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
417 fs_offset_t offset, fs_offset_t packsize,
418 fs_offset_t realsize, int flags);
422 =============================================================================
426 =============================================================================
429 mempool_t *fs_mempool;
430 void *fs_mutex = NULL;
432 searchpath_t *fs_searchpaths = NULL;
433 const char *const fs_checkgamedir_missing = "missing";
435 #define MAX_FILES_IN_PACK 65536
437 char fs_userdir[MAX_OSPATH];
438 char fs_gamedir[MAX_OSPATH];
439 char fs_basedir[MAX_OSPATH];
440 static pack_t *fs_selfpack = NULL;
442 // list of active game directories (empty if not running a mod)
443 int fs_numgamedirs = 0;
444 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
446 // list of all gamedirs with modinfo.txt
447 gamedir_t *fs_all_gamedirs = NULL;
448 int fs_all_gamedirs_count = 0;
450 cvar_t scr_screenshot_name = {CF_CLIENT | CF_PERSISTENT, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
451 cvar_t fs_empty_files_in_pack_mark_deletions = {CF_CLIENT | CF_SERVER, "fs_empty_files_in_pack_mark_deletions", "0", "if enabled, empty files in a pak/pk3 count as not existing but cancel the search in further packs, effectively allowing patch pak/pk3 files to 'delete' files"};
452 cvar_t fs_unload_dlcache = {CF_CLIENT, "fs_unload_dlcache", "1", "if enabled, unload dlcache's loaded pak/pk3 files when changing server and/or map WARNING: disabling unloading can cause servers to override assets of other servers, \"memory leaking\" by dlcache assets never unloading and many more issues"};
453 cvar_t cvar_fs_gamedir = {CF_CLIENT | CF_SERVER | CF_READONLY | CF_PERSISTENT, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
457 =============================================================================
459 PRIVATE FUNCTIONS - PK3 HANDLING
461 =============================================================================
465 // Functions exported from zlib
466 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
467 # define ZEXPORT WINAPI
472 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
473 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
474 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
475 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
476 static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size);
477 static int (ZEXPORT *qz_deflateEnd) (z_stream* strm);
478 static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush);
481 #define qz_inflateInit2(strm, windowBits) \
482 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
483 #define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
484 qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream))
487 // qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
489 static dllfunction_t zlibfuncs[] =
491 {"inflate", (void **) &qz_inflate},
492 {"inflateEnd", (void **) &qz_inflateEnd},
493 {"inflateInit2_", (void **) &qz_inflateInit2_},
494 {"inflateReset", (void **) &qz_inflateReset},
495 {"deflateInit2_", (void **) &qz_deflateInit2_},
496 {"deflateEnd", (void **) &qz_deflateEnd},
497 {"deflate", (void **) &qz_deflate},
501 /// Handle for Zlib DLL
502 static dllhandle_t zlib_dll = NULL;
506 static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPWSTR pszPath);
507 static dllfunction_t shfolderfuncs[] =
509 {"SHGetFolderPathW", (void **) &qSHGetFolderPath},
512 static const char* shfolderdllnames [] =
514 "shfolder.dll", // IE 4, or Win NT and higher
517 static dllhandle_t shfolder_dll = NULL;
519 const GUID qFOLDERID_SavedGames = {0x4C5C32FF, 0xBB9D, 0x43b0, {0xB5, 0xB4, 0x2D, 0x72, 0xE5, 0x4E, 0xAA, 0xA4}};
520 #define qREFKNOWNFOLDERID const GUID *
521 #define qKF_FLAG_CREATE 0x8000
522 #define qKF_FLAG_NO_ALIAS 0x1000
523 static HRESULT (WINAPI *qSHGetKnownFolderPath) (qREFKNOWNFOLDERID rfid, DWORD dwFlags, HANDLE hToken, PWSTR *ppszPath);
524 static dllfunction_t shell32funcs[] =
526 {"SHGetKnownFolderPath", (void **) &qSHGetKnownFolderPath},
529 static const char* shell32dllnames [] =
531 "shell32.dll", // Vista and higher
534 static dllhandle_t shell32_dll = NULL;
536 static HRESULT (WINAPI *qCoInitializeEx)(LPVOID pvReserved, DWORD dwCoInit);
537 static void (WINAPI *qCoUninitialize)(void);
538 static void (WINAPI *qCoTaskMemFree)(LPVOID pv);
539 static dllfunction_t ole32funcs[] =
541 {"CoInitializeEx", (void **) &qCoInitializeEx},
542 {"CoUninitialize", (void **) &qCoUninitialize},
543 {"CoTaskMemFree", (void **) &qCoTaskMemFree},
546 static const char* ole32dllnames [] =
548 "ole32.dll", // 2000 and higher
551 static dllhandle_t ole32_dll = NULL;
561 static void PK3_CloseLibrary (void)
564 Sys_FreeLibrary (&zlib_dll);
573 Try to load the Zlib DLL
576 static qbool PK3_OpenLibrary (void)
581 const char* dllnames [] =
584 # ifdef ZLIB_USES_WINAPI
590 #elif defined(MACOSX)
604 return Sys_LoadDependency (dllnames, &zlib_dll, zlibfuncs);
612 See if zlib is available
615 qbool FS_HasZlib(void)
620 PK3_OpenLibrary(); // to be safe
621 return (zlib_dll != 0);
627 PK3_GetEndOfCentralDir
629 Extract the end of the central directory from a PK3 package
632 static qbool PK3_GetEndOfCentralDir (const char *packfile, filedesc_t packhandle, pk3_endOfCentralDir_t *eocd)
634 fs_offset_t filesize, maxsize;
635 unsigned char *buffer, *ptr;
638 // Get the package size
639 filesize = FILEDESC_SEEK (packhandle, 0, SEEK_END);
640 if (filesize < ZIP_END_CDIR_SIZE)
643 // Load the end of the file in memory
644 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
647 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
648 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
649 FILEDESC_SEEK (packhandle, filesize - maxsize, SEEK_SET);
650 if (FILEDESC_READ (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
656 // Look for the end of central dir signature around the end of the file
657 maxsize -= ZIP_END_CDIR_SIZE;
658 ptr = &buffer[maxsize];
660 while (BuffBigLong (ptr) != ZIP_END_HEADER)
672 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
673 eocd->signature = LittleLong (eocd->signature);
674 eocd->disknum = LittleShort (eocd->disknum);
675 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
676 eocd->localentries = LittleShort (eocd->localentries);
677 eocd->nbentries = LittleShort (eocd->nbentries);
678 eocd->cdir_size = LittleLong (eocd->cdir_size);
679 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
680 eocd->comment_size = LittleShort (eocd->comment_size);
681 eocd->prepended_garbage = filesize - (ind + ZIP_END_CDIR_SIZE) - eocd->cdir_offset - eocd->cdir_size; // this detects "SFX" zip files
682 eocd->cdir_offset += eocd->prepended_garbage;
687 eocd->cdir_size > filesize ||
688 eocd->cdir_offset >= filesize ||
689 eocd->cdir_offset + eocd->cdir_size > filesize
692 // Obviously invalid central directory.
704 Extract the file list from a PK3 file
707 static int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
709 unsigned char *central_dir, *ptr;
711 fs_offset_t remaining;
713 // Load the central directory in memory
714 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
715 if (FILEDESC_SEEK (pack->handle, eocd->cdir_offset, SEEK_SET) == -1)
717 Mem_Free (central_dir);
720 if(FILEDESC_READ (pack->handle, central_dir, eocd->cdir_size) != (fs_offset_t) eocd->cdir_size)
722 Mem_Free (central_dir);
726 // Extract the files properties
727 // The parsing is done "by hand" because some fields have variable sizes and
728 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
729 remaining = eocd->cdir_size;
732 for (ind = 0; ind < eocd->nbentries; ind++)
734 fs_offset_t namesize, count;
736 // Checking the remaining size
737 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
739 Mem_Free (central_dir);
742 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
745 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
747 Mem_Free (central_dir);
751 namesize = (unsigned short)BuffLittleShort (&ptr[28]); // filename length
753 // Check encryption, compression, and attributes
754 // 1st uint8 : general purpose bit flag
755 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
757 // LadyHavoc: bit 3 would be a problem if we were scanning the archive
758 // but is not a problem in the central directory where the values are
761 // bit 3 seems to always be set by the standard Mac OSX zip maker
763 // 2nd uint8 : external file attributes
764 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
765 if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0)
767 // Still enough bytes for the name?
768 if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
770 Mem_Free (central_dir);
774 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
775 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
777 char filename [sizeof (pack->files[0].name)];
778 fs_offset_t offset, packsize, realsize;
781 // Extract the name (strip it if necessary)
782 namesize = min(namesize, (int)sizeof (filename) - 1);
783 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
784 filename[namesize] = '\0';
786 if (BuffLittleShort (&ptr[10]))
787 flags = PACKFILE_FLAG_DEFLATED;
790 offset = (unsigned int)(BuffLittleLong (&ptr[42]) + eocd->prepended_garbage);
791 packsize = (unsigned int)BuffLittleLong (&ptr[20]);
792 realsize = (unsigned int)BuffLittleLong (&ptr[24]);
794 switch(ptr[5]) // C_VERSION_MADE_BY_1
799 if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000)
800 // can't use S_ISLNK here, as this has to compile on non-UNIX too
801 flags |= PACKFILE_FLAG_SYMLINK;
805 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
809 // Skip the name, additionnal field, and comment
810 // 1er uint16 : extra field length
811 // 2eme uint16 : file comment length
812 count = namesize + (unsigned short)BuffLittleShort (&ptr[30]) + (unsigned short)BuffLittleShort (&ptr[32]);
813 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
817 // If the package is empty, central_dir is NULL here
818 if (central_dir != NULL)
819 Mem_Free (central_dir);
820 return pack->numfiles;
828 Create a package entry associated with a PK3 file
831 static pack_t *FS_LoadPackPK3FromFD (const char *packfile, filedesc_t packhandle, qbool silent)
833 pk3_endOfCentralDir_t eocd;
837 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
840 Con_Printf ("%s is not a PK3 file\n", packfile);
841 FILEDESC_CLOSE(packhandle);
845 // Multi-volume ZIP archives are NOT allowed
846 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
848 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
849 FILEDESC_CLOSE(packhandle);
853 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
854 // since eocd.nbentries is an unsigned 16 bits integer
855 #if MAX_FILES_IN_PACK < 65535
856 if (eocd.nbentries > MAX_FILES_IN_PACK)
858 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
859 FILEDESC_CLOSE(packhandle);
864 // Create a package structure in memory
865 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
866 pack->ignorecase = true; // PK3 ignores case
867 dp_strlcpy (pack->filename, packfile, sizeof (pack->filename));
868 pack->handle = packhandle;
869 pack->numfiles = eocd.nbentries;
870 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
872 real_nb_files = PK3_BuildFileList (pack, &eocd);
873 if (real_nb_files < 0)
875 Con_Printf ("%s is not a valid PK3 file\n", packfile);
876 FILEDESC_CLOSE(pack->handle);
881 Con_DPrintf("Added packfile %s (%i files)\n", packfile, real_nb_files);
885 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qbool nonblocking);
886 static pack_t *FS_LoadPackPK3 (const char *packfile)
888 filedesc_t packhandle;
889 packhandle = FS_SysOpenFiledesc (packfile, "rb", false);
890 if (!FILEDESC_ISVALID(packhandle))
892 return FS_LoadPackPK3FromFD(packfile, packhandle, false);
898 PK3_GetTrueFileOffset
900 Find where the true file data offset is
903 static qbool PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
905 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
909 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
912 // Load the local file description
913 if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
915 Con_Printf ("Can't seek in package %s\n", pack->filename);
918 count = FILEDESC_READ (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
919 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
921 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
925 // Skip name and extra field
926 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
928 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
934 =============================================================================
936 OTHER PRIVATE FUNCTIONS
938 =============================================================================
946 Add a file to the list of files contained into a package
949 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
950 fs_offset_t offset, fs_offset_t packsize,
951 fs_offset_t realsize, int flags)
953 int (*strcmp_funct) (const char* str1, const char* str2);
954 int left, right, middle;
957 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
959 // Look for the slot we should put that file into (binary search)
961 right = pack->numfiles - 1;
962 while (left <= right)
966 middle = (left + right) / 2;
967 diff = strcmp_funct (pack->files[middle].name, name);
969 // If we found the file, there's a problem
971 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
973 // If we're too far in the list
980 // We have to move the right of the list by one slot to free the one we need
981 pfile = &pack->files[left];
982 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
985 dp_strlcpy (pfile->name, name, sizeof (pfile->name));
986 pfile->offset = offset;
987 pfile->packsize = packsize;
988 pfile->realsize = realsize;
989 pfile->flags = flags;
996 static inline int wstrlen(wchar *wstr)
999 while (wstr[len] != 0 && len < WSTRBUF)
1003 #define widen(str, wstr) fromwtf8(str, strlen(str), wstr, WSTRBUF)
1004 #define narrow(wstr, str) towtf8(wstr, wstrlen(wstr), str, WSTRBUF)
1007 static void FS_mkdir (const char *path)
1010 wchar pathw[WSTRBUF] = {0};
1012 if(Sys_CheckParm("-readonly"))
1017 if (_wmkdir (pathw) == -1)
1019 if (mkdir (path, 0777) == -1)
1022 // No logging for this. The only caller is FS_CreatePath (which
1023 // calls it in ways that will intentionally produce EEXIST),
1024 // and its own callers always use the directory afterwards and
1025 // thus will detect failure that way.
1033 Only used for FS_OpenRealFile.
1036 void FS_CreatePath (char *path)
1040 for (ofs = path+1 ; *ofs ; ofs++)
1042 if (*ofs == '/' || *ofs == '\\')
1044 // create the directory
1060 static void FS_Path_f(cmd_state_t *cmd)
1064 Con_Print("Current search path:\n");
1065 for (s=fs_searchpaths ; s ; s=s->next)
1070 Con_Printf("%sdir (virtual pack)\n", s->pack->filename);
1072 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
1075 Con_Printf("%s\n", s->filename);
1085 /*! Takes an explicit (not game tree related) path to a pak file.
1086 *Loads the header and directory, adding the files at the beginning
1087 *of the list so they override previous pack files.
1089 static pack_t *FS_LoadPackPAK (const char *packfile)
1091 dpackheader_t header;
1092 int i, numpackfiles;
1093 filedesc_t packhandle;
1097 packhandle = FS_SysOpenFiledesc(packfile, "rb", false);
1098 if (!FILEDESC_ISVALID(packhandle))
1100 if(FILEDESC_READ (packhandle, (void *)&header, sizeof(header)) != sizeof(header))
1102 Con_Printf ("%s is not a packfile\n", packfile);
1103 FILEDESC_CLOSE(packhandle);
1106 if (memcmp(header.id, "PACK", 4))
1108 Con_Printf ("%s is not a packfile\n", packfile);
1109 FILEDESC_CLOSE(packhandle);
1112 header.dirofs = LittleLong (header.dirofs);
1113 header.dirlen = LittleLong (header.dirlen);
1115 if (header.dirlen % sizeof(dpackfile_t))
1117 Con_Printf ("%s has an invalid directory size\n", packfile);
1118 FILEDESC_CLOSE(packhandle);
1122 numpackfiles = header.dirlen / sizeof(dpackfile_t);
1124 if (numpackfiles < 0 || numpackfiles > MAX_FILES_IN_PACK)
1126 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
1127 FILEDESC_CLOSE(packhandle);
1131 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
1132 FILEDESC_SEEK (packhandle, header.dirofs, SEEK_SET);
1133 if(header.dirlen != FILEDESC_READ (packhandle, (void *)info, header.dirlen))
1135 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
1137 FILEDESC_CLOSE(packhandle);
1141 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1142 pack->ignorecase = true; // PAK is sensitive in Quake1 but insensitive in Quake2
1143 dp_strlcpy (pack->filename, packfile, sizeof (pack->filename));
1144 pack->handle = packhandle;
1146 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
1148 // parse the directory
1149 for (i = 0;i < numpackfiles;i++)
1151 fs_offset_t offset = (unsigned int)LittleLong (info[i].filepos);
1152 fs_offset_t size = (unsigned int)LittleLong (info[i].filelen);
1154 // Ensure a zero terminated file name (required by format).
1155 info[i].name[sizeof(info[i].name) - 1] = 0;
1157 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
1162 Con_DPrintf("Added packfile %s (%i files)\n", packfile, numpackfiles);
1167 ====================
1170 Create a package entry associated with a directory file
1171 ====================
1173 static pack_t *FS_LoadPackVirtual (const char *dirname)
1176 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1178 pack->ignorecase = false;
1179 dp_strlcpy (pack->filename, dirname, sizeof(pack->filename));
1180 pack->handle = FILEDESC_INVALID;
1181 pack->numfiles = -1;
1183 Con_DPrintf("Added packfile %s (virtual pack)\n", dirname);
1192 /*! Adds the given pack to the search path.
1193 * The pack type is autodetected by the file extension.
1195 * Returns true if the file was successfully added to the
1196 * search path or if it was already included.
1198 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1199 * plain directories.
1202 static qbool FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qbool *already_loaded, qbool keep_plain_dirs, qbool dlcache)
1204 searchpath_t *search;
1206 const char *ext = FS_FileExtension(pakfile);
1209 for(search = fs_searchpaths; search; search = search->next)
1211 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
1214 *already_loaded = true;
1215 return true; // already loaded
1220 *already_loaded = false;
1222 if(!strcasecmp(ext, "pk3dir") || !strcasecmp(ext, "dpkdir"))
1223 pak = FS_LoadPackVirtual (pakfile);
1224 else if(!strcasecmp(ext, "pak"))
1225 pak = FS_LoadPackPAK (pakfile);
1226 else if(!strcasecmp(ext, "pk3") || !strcasecmp(ext, "dpk"))
1227 pak = FS_LoadPackPK3 (pakfile);
1228 else if(!strcasecmp(ext, "obb")) // android apk expansion
1229 pak = FS_LoadPackPK3 (pakfile);
1231 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
1235 dp_strlcpy(pak->shortname, shortname, sizeof(pak->shortname));
1237 //Con_DPrintf(" Registered pack with short name %s\n", shortname);
1240 // find the first item whose next one is a pack or NULL
1241 searchpath_t *insertion_point = 0;
1242 if(fs_searchpaths && !fs_searchpaths->pack)
1244 insertion_point = fs_searchpaths;
1247 if(!insertion_point->next)
1249 if(insertion_point->next->pack)
1251 insertion_point = insertion_point->next;
1254 // If insertion_point is NULL, this means that either there is no
1255 // item in the list yet, or that the very first item is a pack. In
1256 // that case, we want to insert at the beginning...
1257 if(!insertion_point)
1259 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1260 search->next = fs_searchpaths;
1261 fs_searchpaths = search;
1264 // otherwise we want to append directly after insertion_point.
1266 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1267 search->next = insertion_point->next;
1268 insertion_point->next = search;
1273 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1274 search->next = fs_searchpaths;
1275 fs_searchpaths = search;
1278 search->pack->dlcache = dlcache;
1281 dpsnprintf(search->filename, sizeof(search->filename), "%s/", pakfile);
1282 // if shortname ends with "pk3dir" or "dpkdir", strip that suffix to make it just "pk3" or "dpk"
1283 // same goes for the name inside the pack structure
1284 l = strlen(pak->shortname);
1286 if(!strcasecmp(pak->shortname + l - 7, ".pk3dir") || !strcasecmp(pak->shortname + l - 7, ".dpkdir"))
1287 pak->shortname[l - 3] = 0;
1288 l = strlen(pak->filename);
1290 if(!strcasecmp(pak->filename + l - 7, ".pk3dir") || !strcasecmp(pak->filename + l - 7, ".dpkdir"))
1291 pak->filename[l - 3] = 0;
1297 Con_Printf(CON_ERROR "unable to load pak \"%s\"\n", pakfile);
1308 /*! Adds the given pack to the search path and searches for it in the game path.
1309 * The pack type is autodetected by the file extension.
1311 * Returns true if the file was successfully added to the
1312 * search path or if it was already included.
1314 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1315 * plain directories.
1317 qbool FS_AddPack(const char *pakfile, qbool *already_loaded, qbool keep_plain_dirs, qbool dlcache)
1319 char fullpath[MAX_OSPATH];
1321 searchpath_t *search;
1324 *already_loaded = false;
1326 // then find the real name...
1327 search = FS_FindFile(pakfile, &index, true);
1328 if(!search || search->pack)
1330 Con_Printf("could not find pak \"%s\"\n", pakfile);
1334 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
1336 return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs, dlcache);
1344 Sets fs_gamedir, adds the directory to the head of the path,
1345 then loads and adds pak1.pak pak2.pak ...
1348 static void FS_AddGameDirectory (const char *dir, qbool set_fs_gamedir)
1352 searchpath_t *search;
1355 dp_strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
1357 stringlistinit(&list);
1358 listdirectory(&list, "", dir);
1359 stringlistsort(&list, false);
1361 // add any PAK package in the directory
1362 for (i = 0;i < list.numstrings;i++)
1364 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
1366 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false, false);
1370 // add any PK3 package in the directory
1371 for (i = 0;i < list.numstrings;i++)
1373 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3") || !strcasecmp(FS_FileExtension(list.strings[i]), "obb") || !strcasecmp(FS_FileExtension(list.strings[i]), "pk3dir")
1374 || !strcasecmp(FS_FileExtension(list.strings[i]), "dpk") || !strcasecmp(FS_FileExtension(list.strings[i]), "dpkdir"))
1376 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false, false);
1380 stringlistfreecontents(&list);
1382 // Add the directory to the search path
1383 // (unpacked files have the priority over packed files)
1384 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1385 dp_strlcpy (search->filename, dir, sizeof (search->filename));
1386 search->next = fs_searchpaths;
1387 fs_searchpaths = search;
1396 static void FS_AddGameHierarchy (const char *dir, qbool set_fs_gamedir)
1399 // Add the common game directory
1400 FS_AddGameDirectory (va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, dir), set_fs_gamedir);
1403 FS_AddGameDirectory(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, dir), set_fs_gamedir);
1412 const char *FS_FileExtension (const char *in)
1414 const char *separator, *backslash, *colon, *dot;
1416 dot = strrchr(in, '.');
1420 separator = strrchr(in, '/');
1421 backslash = strrchr(in, '\\');
1422 if (!separator || separator < backslash)
1423 separator = backslash;
1424 colon = strrchr(in, ':');
1425 if (!separator || separator < colon)
1428 if (separator && (dot < separator))
1440 const char *FS_FileWithoutPath (const char *in)
1442 const char *separator, *backslash, *colon;
1444 separator = strrchr(in, '/');
1445 backslash = strrchr(in, '\\');
1446 if (!separator || separator < backslash)
1447 separator = backslash;
1448 colon = strrchr(in, ':');
1449 if (!separator || separator < colon)
1451 return separator ? separator + 1 : in;
1460 static void FS_ClearSearchPath (void)
1462 // unload all packs and directory information, close all pack files
1463 // (if a qfile is still reading a pack it won't be harmed because it used
1464 // dup() to get its own handle already)
1465 while (fs_searchpaths)
1467 searchpath_t *search = fs_searchpaths;
1468 fs_searchpaths = search->next;
1469 if (search->pack && search->pack != fs_selfpack)
1471 if(!search->pack->vpack)
1474 FILEDESC_CLOSE(search->pack->handle);
1475 // free any memory associated with it
1476 if (search->pack->files)
1477 Mem_Free(search->pack->files);
1479 Mem_Free(search->pack);
1487 FS_UnloadPacks_dlcache
1489 Like FS_ClearSearchPath() but unloads only the packs loaded from dlcache
1490 so we don't need to use a full FS_Rescan() to prevent
1491 content from the previous server and/or map from interfering with the next
1494 void FS_UnloadPacks_dlcache(void)
1496 searchpath_t *search = fs_searchpaths, *searchprev = fs_searchpaths, *searchnext;
1498 if (!fs_unload_dlcache.integer)
1503 searchnext = search->next;
1504 if (search->pack && search->pack->dlcache)
1506 Con_DPrintf("Unloading pack: %s\n", search->pack->shortname);
1508 // remove it from the search path list
1509 if (search == fs_searchpaths)
1510 fs_searchpaths = search->next;
1512 searchprev->next = search->next;
1515 FILEDESC_CLOSE(search->pack->handle);
1516 // free any memory associated with it
1517 if (search->pack->files)
1518 Mem_Free(search->pack->files);
1519 Mem_Free(search->pack);
1523 searchprev = search;
1524 search = searchnext;
1528 static void FS_AddSelfPack(void)
1532 searchpath_t *search;
1533 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1534 search->next = fs_searchpaths;
1535 search->pack = fs_selfpack;
1536 fs_searchpaths = search;
1546 void FS_Rescan (void)
1549 qbool fs_modified = false;
1550 qbool reset = false;
1551 char gamedirbuf[MAX_INPUTLINE];
1556 FS_ClearSearchPath();
1558 // automatically activate gamemode for the gamedirs specified
1560 COM_ChangeGameTypeForGameDirs();
1562 // add the game-specific paths
1563 // gamedirname1 (typically id1)
1564 FS_AddGameHierarchy (gamedirname1, true);
1565 // update the com_modname (used for server info)
1566 if (gamedirname2 && gamedirname2[0])
1567 dp_strlcpy(com_modname, gamedirname2, sizeof(com_modname));
1569 dp_strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1571 // add the secondary game-specific path, if any
1572 // (only used for mission packs and the like, which should set fs_modified)
1573 if (gamedirname2 && gamedirname2[0])
1576 FS_AddGameHierarchy (gamedirname2, true);
1580 // Adds basedir/gamedir as an override game
1581 // LadyHavoc: now supports multiple -game directories
1582 // set the com_modname (reported in server info)
1583 // bones_was_here: does NOT set fs_gamedir in FS_AddGameHierarchy()
1584 // so that we still save files in the right place.
1586 for (i = 0;i < fs_numgamedirs;i++)
1589 FS_AddGameHierarchy (fs_gamedirs[i], false);
1590 // update the com_modname (used server info)
1591 dp_strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1593 dp_strlcat(gamedirbuf, va(vabuf, sizeof(vabuf), " %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1595 dp_strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1597 Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1599 // add back the selfpack as new first item
1602 if (cls.state != ca_dedicated)
1604 // set the default screenshot name to either the mod name or the
1605 // gamemode screenshot name
1606 if (strcmp(com_modname, gamedirname1))
1607 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1609 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1612 if((i = Sys_CheckParm("-modname")) && i < sys.argc - 1)
1613 dp_strlcpy(com_modname, sys.argv[i+1], sizeof(com_modname));
1615 // If "-condebug" is in the command line, remove the previous log file
1616 if (Sys_CheckParm ("-condebug") != 0)
1617 unlink (va(vabuf, sizeof(vabuf), "%s/qconsole.log", fs_gamedir));
1619 // look for the pop.lmp file and set registered to true if it is found
1620 if (FS_FileExists("gfx/pop.lmp"))
1621 Cvar_SetValueQuick(®istered, 1);
1627 if (!registered.integer)
1630 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1632 Con_Print("Playing shareware version.\n");
1635 Con_Print("Playing registered version.\n");
1637 case GAME_STEELSTORM:
1638 if (registered.integer)
1639 Con_Print("Playing registered version.\n");
1641 Con_Print("Playing shareware version.\n");
1647 // unload all wads so that future queries will return the new data
1651 static void FS_Rescan_f(cmd_state_t *cmd)
1661 extern qbool vid_opened;
1662 qbool FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qbool complain, qbool failmissing)
1667 if (fs_numgamedirs == numgamedirs)
1669 for (i = 0;i < numgamedirs;i++)
1670 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1672 if (i == numgamedirs)
1673 return true; // already using this set of gamedirs, do nothing
1676 if (numgamedirs > MAX_GAMEDIRS)
1679 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1680 return false; // too many gamedirs
1683 for (i = 0;i < numgamedirs;i++)
1685 // if string is nasty, reject it
1686 p = FS_CheckGameDir(gamedirs[i]);
1690 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1691 return false; // nasty gamedirs
1693 if(p == fs_checkgamedir_missing && failmissing)
1696 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1697 return false; // missing gamedirs
1701 Host_SaveConfig(CONFIGFILENAME);
1703 fs_numgamedirs = numgamedirs;
1704 for (i = 0;i < fs_numgamedirs;i++)
1705 dp_strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1707 // reinitialize filesystem to detect the new paks
1710 if (cls.demoplayback)
1716 // unload all sounds so they will be reloaded from the new files as needed
1717 S_UnloadAllSounds_f(cmd_local);
1719 // reset everything that can be and reload configs
1720 Cbuf_InsertText(cmd_local, "\nloadconfig\n");
1730 static void FS_GameDir_f(cmd_state_t *cmd)
1734 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1736 if (Cmd_Argc(cmd) < 2)
1738 Con_Printf("gamedirs active:");
1739 for (i = 0;i < fs_numgamedirs;i++)
1740 Con_Printf(" %s", fs_gamedirs[i]);
1745 numgamedirs = Cmd_Argc(cmd) - 1;
1746 if (numgamedirs > MAX_GAMEDIRS)
1748 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1752 for (i = 0;i < numgamedirs;i++)
1753 dp_strlcpy(gamedirs[i], Cmd_Argv(cmd, i+1), sizeof(gamedirs[i]));
1755 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1757 // actually, changing during game would work fine, but would be stupid
1758 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1762 // halt demo playback to close the file
1765 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1768 static const char *FS_SysCheckGameDir(const char *gamedir, char *buf, size_t buflength)
1776 stringlistinit(&list);
1777 listdirectory(&list, gamedir, "");
1778 success = list.numstrings > 0;
1779 stringlistfreecontents(&list);
1783 f = FS_SysOpen(va(vabuf, sizeof(vabuf), "%smodinfo.txt", gamedir), "r", false);
1786 n = FS_Read (f, buf, buflength - 1);
1806 const char *FS_CheckGameDir(const char *gamedir)
1809 static char buf[8192];
1812 if (FS_CheckNastyPath(gamedir, true))
1815 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, gamedir), buf, sizeof(buf));
1820 // get description from basedir
1821 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1829 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1833 return fs_checkgamedir_missing;
1836 static void FS_ListGameDirs(void)
1838 stringlist_t list, list2;
1843 fs_all_gamedirs_count = 0;
1845 Mem_Free(fs_all_gamedirs);
1847 stringlistinit(&list);
1848 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_basedir), "");
1849 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_userdir), "");
1850 stringlistsort(&list, false);
1852 stringlistinit(&list2);
1853 for(i = 0; i < list.numstrings; ++i)
1856 if(!strcmp(list.strings[i-1], list.strings[i]))
1858 info = FS_CheckGameDir(list.strings[i]);
1861 if(info == fs_checkgamedir_missing)
1865 stringlistappend(&list2, list.strings[i]);
1867 stringlistfreecontents(&list);
1869 fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1870 for(i = 0; i < list2.numstrings; ++i)
1872 info = FS_CheckGameDir(list2.strings[i]);
1873 // all this cannot happen any more, but better be safe than sorry
1876 if(info == fs_checkgamedir_missing)
1880 dp_strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[fs_all_gamedirs_count].name));
1881 dp_strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[fs_all_gamedirs_count].description));
1882 ++fs_all_gamedirs_count;
1888 #pragma comment(lib, "shell32.lib")
1893 static void COM_InsertFlags(const char *buf) {
1896 const char **new_argv;
1898 int args_left = 256;
1899 new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*sys.argv) * (sys.argc + args_left + 2));
1901 new_argv[0] = "dummy"; // Can't really happen.
1903 new_argv[0] = sys.argv[0];
1906 while(COM_ParseToken_Console(&p))
1908 size_t sz = strlen(com_token) + 1; // shut up clang
1911 q = (char *)Mem_Alloc(fs_mempool, sz);
1912 dp_strlcpy(q, com_token, sz);
1916 // Now: i <= args_left + 1.
1919 memcpy((char *)(&new_argv[i]), &sys.argv[1], sizeof(*sys.argv) * (sys.argc - 1));
1922 // Now: i <= args_left + (sys.argc || 1).
1924 sys.argv = new_argv;
1928 static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t userdirsize)
1930 #if defined(__IPHONEOS__)
1931 if (userdirmode == USERDIRMODE_HOME)
1933 // fs_basedir is "" by default, to utilize this you can simply add your gamedir to the Resources in xcode
1934 // fs_userdir stores configurations to the Documents folder of the app
1935 dp_strlcpy(userdir, "../Documents/", MAX_OSPATH);
1940 #elif defined(WIN32)
1941 char homedir[WSTRBUF];
1943 #if _MSC_VER >= 1400
1946 wchar_t mydocsdirw[WSTRBUF];
1947 char mydocsdir[WSTRBUF];
1948 wchar_t *savedgamesdirw;
1949 char savedgamesdir[WSTRBUF] = {0};
1958 case USERDIRMODE_NOHOME:
1959 dp_strlcpy(userdir, fs_basedir, userdirsize);
1961 case USERDIRMODE_MYGAMES:
1963 Sys_LoadDependency(shfolderdllnames, &shfolder_dll, shfolderfuncs);
1965 if (qSHGetFolderPath && qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdirw) == S_OK)
1967 narrow(mydocsdirw, mydocsdir);
1968 dpsnprintf(userdir, userdirsize, "%s/My Games/%s/", mydocsdir, gameuserdirname);
1971 #if _MSC_VER >= 1400
1972 _wdupenv_s(&homedirw, &homedirwlen, L"USERPROFILE");
1973 narrow(homedirw, homedir);
1976 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1981 homedirw = _wgetenv(L"USERPROFILE");
1982 narrow(homedirw, homedir);
1985 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1990 case USERDIRMODE_SAVEDGAMES:
1992 Sys_LoadDependency(shell32dllnames, &shell32_dll, shell32funcs);
1994 Sys_LoadDependency(ole32dllnames, &ole32_dll, ole32funcs);
1995 if (qSHGetKnownFolderPath && qCoInitializeEx && qCoTaskMemFree && qCoUninitialize)
1997 savedgamesdir[0] = 0;
1998 qCoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
2001 if (SHGetKnownFolderPath(FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
2003 if (SHGetKnownFolderPath(&FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
2006 if (qSHGetKnownFolderPath(&qFOLDERID_SavedGames, qKF_FLAG_CREATE | qKF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
2008 narrow(savedgamesdirw, savedgamesdir);
2009 qCoTaskMemFree(savedgamesdirw);
2012 if (savedgamesdir[0])
2014 dpsnprintf(userdir, userdirsize, "%s/%s/", savedgamesdir, gameuserdirname);
2029 case USERDIRMODE_NOHOME:
2030 dp_strlcpy(userdir, fs_basedir, userdirsize);
2032 case USERDIRMODE_HOME:
2033 homedir = getenv("HOME");
2036 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
2040 case USERDIRMODE_SAVEDGAMES:
2041 homedir = getenv("HOME");
2045 dpsnprintf(userdir, userdirsize, "%s/Library/Application Support/%s/", homedir, gameuserdirname);
2047 // the XDG say some files would need to go in:
2048 // XDG_CONFIG_HOME (or ~/.config/%s/)
2049 // XDG_DATA_HOME (or ~/.local/share/%s/)
2050 // XDG_CACHE_HOME (or ~/.cache/%s/)
2051 // and also search the following global locations if defined:
2052 // XDG_CONFIG_DIRS (normally /etc/xdg/%s/)
2053 // XDG_DATA_DIRS (normally /usr/share/%s/)
2054 // this would be too complicated...
2064 #if !defined(__IPHONEOS__)
2067 // historical behavior...
2068 if (userdirmode == USERDIRMODE_NOHOME && strcmp(gamedirname1, "id1"))
2069 return 0; // don't bother checking if the basedir folder is writable, it's annoying... unless it is Quake on Windows where NOHOME is the default preferred and we have to check for an error case
2072 // see if we can write to this path (note: won't create path)
2074 // no access() here, we must try to open the file for appending
2075 fd = FS_SysOpenFiledesc(va(vabuf, sizeof(vabuf), "%s%s/config.cfg", userdir, gamedirname1), "a", false);
2079 // on Unix, we don't need to ACTUALLY attempt to open the file
2080 if(access(va(vabuf, sizeof(vabuf), "%s%s/", userdir, gamedirname1), W_OK | X_OK) >= 0)
2087 return 1; // good choice - the path exists and is writable
2091 if (userdirmode == USERDIRMODE_NOHOME)
2092 return -1; // path usually already exists, we lack permissions
2094 return 0; // probably good - failed to write but maybe we need to create path
2099 void FS_Init_Commands(void)
2101 Cvar_RegisterVariable (&scr_screenshot_name);
2102 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
2103 Cvar_RegisterVariable (&fs_unload_dlcache);
2104 Cvar_RegisterVariable (&cvar_fs_gamedir);
2106 Cmd_AddCommand(CF_SHARED, "gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
2107 Cmd_AddCommand(CF_SHARED, "fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
2108 Cmd_AddCommand(CF_SHARED, "path", FS_Path_f, "print searchpath (game directories and archives)");
2109 Cmd_AddCommand(CF_SHARED, "dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
2110 Cmd_AddCommand(CF_SHARED, "ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
2111 Cmd_AddCommand(CF_SHARED, "which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
2114 static void FS_Init_Dir (void)
2124 // Overrides the system supplied base directory (under GAMENAME)
2125 // COMMANDLINEOPTION: Filesystem: -basedir <path> chooses what base directory the game data is in, inside this there should be a data directory for the game (for example id1)
2126 i = Sys_CheckParm ("-basedir");
2127 if (i && i < sys.argc-1)
2129 dp_strlcpy (fs_basedir, sys.argv[i+1], sizeof (fs_basedir));
2130 i = (int)strlen (fs_basedir);
2131 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
2132 fs_basedir[i-1] = 0;
2136 // If the base directory is explicitly defined by the compilation process
2137 #ifdef DP_FS_BASEDIR
2138 dp_strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
2139 #elif defined(__ANDROID__)
2140 dpsnprintf(fs_basedir, sizeof(fs_basedir), "/sdcard/%s/", gameuserdirname);
2141 #elif defined(MACOSX)
2142 // FIXME: is there a better way to find the directory outside the .app, without using Objective-C?
2143 if (strstr(sys.argv[0], ".app/"))
2146 dp_strlcpy(fs_basedir, sys.argv[0], sizeof(fs_basedir));
2147 split = strstr(fs_basedir, ".app/");
2150 struct stat statresult;
2152 // truncate to just after the .app/
2154 // see if gamedir exists in Resources
2155 if (stat(va(vabuf, sizeof(vabuf), "%s/Contents/Resources/%s", fs_basedir, gamedirname1), &statresult) == 0)
2157 // found gamedir inside Resources, use it
2158 dp_strlcat(fs_basedir, "Contents/Resources/", sizeof(fs_basedir));
2162 // no gamedir found in Resources, gamedir is probably
2163 // outside the .app, remove .app part of path
2164 while (split > fs_basedir && *split != '/')
2173 // make sure the appending of a path separator won't create an unterminated string
2174 memset(fs_basedir + sizeof(fs_basedir) - 2, 0, 2);
2175 // add a path separator to the end of the basedir if it lacks one
2176 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
2177 dp_strlcat(fs_basedir, "/", sizeof(fs_basedir));
2179 // Add the personal game directory
2180 if((i = Sys_CheckParm("-userdir")) && i < sys.argc - 1)
2181 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", sys.argv[i+1]);
2182 else if (Sys_CheckParm("-nohome"))
2183 *fs_userdir = 0; // user wants roaming installation, no userdir
2186 #ifdef DP_FS_USERDIR
2187 dp_strlcpy(fs_userdir, DP_FS_USERDIR, sizeof(fs_userdir));
2190 int highestuserdirmode = USERDIRMODE_COUNT - 1;
2191 int preferreduserdirmode = USERDIRMODE_COUNT - 1;
2192 int userdirstatus[USERDIRMODE_COUNT];
2194 // historical behavior...
2195 if (!strcmp(gamedirname1, "id1"))
2196 preferreduserdirmode = USERDIRMODE_NOHOME;
2198 // check what limitations the user wants to impose
2199 if (Sys_CheckParm("-home")) preferreduserdirmode = USERDIRMODE_HOME;
2200 if (Sys_CheckParm("-mygames")) preferreduserdirmode = USERDIRMODE_MYGAMES;
2201 if (Sys_CheckParm("-savedgames")) preferreduserdirmode = USERDIRMODE_SAVEDGAMES;
2202 // gather the status of the possible userdirs
2203 for (dirmode = 0;dirmode < USERDIRMODE_COUNT;dirmode++)
2205 userdirstatus[dirmode] = FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2206 if (userdirstatus[dirmode] == 1)
2207 Con_DPrintf("userdir %i = %s (writable)\n", dirmode, fs_userdir);
2208 else if (userdirstatus[dirmode] == 0)
2209 Con_DPrintf("userdir %i = %s (not writable or does not exist)\n", dirmode, fs_userdir);
2211 Con_DPrintf("userdir %i (not applicable)\n", dirmode);
2213 // some games may prefer writing to basedir, but if write fails we
2214 // have to search for a real userdir...
2215 if (preferreduserdirmode == 0 && userdirstatus[0] < 1)
2216 preferreduserdirmode = highestuserdirmode;
2217 // check for an existing userdir and continue using it if possible...
2218 for (dirmode = USERDIRMODE_COUNT - 1;dirmode > 0;dirmode--)
2219 if (userdirstatus[dirmode] == 1)
2221 // if no existing userdir found, make a new one...
2222 if (dirmode == 0 && preferreduserdirmode > 0)
2223 for (dirmode = preferreduserdirmode;dirmode > 0;dirmode--)
2224 if (userdirstatus[dirmode] >= 0)
2226 // and finally, we picked one...
2227 FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2228 Con_DPrintf("userdir %i is the winner\n", dirmode);
2232 // if userdir equal to basedir, clear it to avoid confusion later
2233 if (!strcmp(fs_basedir, fs_userdir))
2238 p = FS_CheckGameDir(gamedirname1);
2239 if(!p || p == fs_checkgamedir_missing)
2240 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
2244 p = FS_CheckGameDir(gamedirname2);
2245 if(!p || p == fs_checkgamedir_missing)
2246 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
2250 // Adds basedir/gamedir as an override game
2251 // LadyHavoc: now supports multiple -game directories
2252 for (i = 1;i < sys.argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
2256 if (!strcmp (sys.argv[i], "-game") && i < sys.argc-1)
2259 p = FS_CheckGameDir(sys.argv[i]);
2261 Con_Printf("WARNING: Nasty -game name rejected: %s\n", sys.argv[i]);
2262 if(p == fs_checkgamedir_missing)
2263 Con_Printf(CON_WARN "WARNING: -game %s%s/ not found!\n", fs_basedir, sys.argv[i]);
2264 // add the gamedir to the list of active gamedirs
2265 dp_strlcpy (fs_gamedirs[fs_numgamedirs], sys.argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
2270 // generate the searchpath
2273 if (Thread_HasThreads())
2274 fs_mutex = Thread_CreateMutex();
2282 void FS_Init_SelfPack (void)
2286 // Load darkplaces.opt from the FS.
2287 if (!Sys_CheckParm("-noopt"))
2289 buf = (char *) FS_SysLoadFile("darkplaces.opt", tempmempool, true, NULL);
2292 COM_InsertFlags(buf);
2298 // Provide the SelfPack.
2299 if (!Sys_CheckParm("-noselfpack") && sys.selffd >= 0)
2301 fs_selfpack = FS_LoadPackPK3FromFD(sys.argv[0], sys.selffd, true);
2305 if (!Sys_CheckParm("-noopt"))
2307 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
2310 COM_InsertFlags(buf);
2327 fs_mempool = Mem_AllocPool("file management", 0, NULL);
2333 // initialize the self-pack (must be before COM_InitGameType as it may add command line options)
2336 // detect gamemode from commandline options or executable name
2347 void FS_Shutdown (void)
2349 // close all pack files and such
2350 // (hopefully there aren't any other open files, but they'll be cleaned up
2351 // by the OS anyway)
2352 FS_ClearSearchPath();
2353 Mem_FreePool (&fs_mempool);
2354 PK3_CloseLibrary ();
2357 Sys_FreeLibrary (&shfolder_dll);
2358 Sys_FreeLibrary (&shell32_dll);
2359 Sys_FreeLibrary (&ole32_dll);
2363 Thread_DestroyMutex(fs_mutex);
2366 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qbool nonblocking)
2368 filedesc_t handle = FILEDESC_INVALID;
2371 qbool dolock = false;
2373 wchar filepathw[WSTRBUF] = {0};
2376 // Parse the mode string
2385 opt = O_CREAT | O_TRUNC;
2389 opt = O_CREAT | O_APPEND;
2392 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
2393 return FILEDESC_INVALID;
2395 for (ind = 1; mode[ind] != '\0'; ind++)
2409 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
2410 filepath, mode, mode[ind]);
2417 if(Sys_CheckParm("-readonly") && mod != O_RDONLY)
2418 return FILEDESC_INVALID;
2422 return FILEDESC_INVALID;
2423 handle = SDL_RWFromFile(filepath, mode);
2426 widen(filepath, filepathw);
2427 # if _MSC_VER >= 1400
2428 _wsopen_s(&handle, filepathw, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2430 handle = _wsopen (filepathw, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2433 handle = open (filepath, mod | opt, 0666);
2434 if(handle >= 0 && dolock)
2437 l.l_type = ((mod == O_RDONLY) ? F_RDLCK : F_WRLCK);
2438 l.l_whence = SEEK_SET;
2441 if(fcntl(handle, F_SETLK, &l) == -1)
2443 FILEDESC_CLOSE(handle);
2453 int FS_SysOpenFD(const char *filepath, const char *mode, qbool nonblocking)
2458 return FS_SysOpenFiledesc(filepath, mode, nonblocking);
2463 ====================
2466 Internal function used to create a qfile_t and open the relevant non-packed file on disk
2467 ====================
2469 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qbool nonblocking)
2473 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2475 file->handle = FS_SysOpenFiledesc(filepath, mode, nonblocking);
2476 if (!FILEDESC_ISVALID(file->handle))
2482 file->filename = Mem_strdup(fs_mempool, filepath);
2484 file->real_length = FILEDESC_SEEK (file->handle, 0, SEEK_END);
2486 // For files opened in append mode, we start at the end of the file
2488 file->position = file->real_length;
2490 FILEDESC_SEEK (file->handle, 0, SEEK_SET);
2500 Open a packed file using its package file descriptor
2503 static qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
2506 filedesc_t dup_handle;
2509 pfile = &pack->files[pack_ind];
2511 // If we don't have the true offset, get it now
2512 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
2513 if (!PK3_GetTrueFileOffset (pfile, pack))
2516 #ifndef LINK_TO_ZLIB
2517 // No Zlib DLL = no compressed files
2518 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2520 Con_Printf(CON_WARN "WARNING: can't open the compressed file %s\n"
2521 "You need the Zlib DLL to use compressed files\n",
2527 // LadyHavoc: FILEDESC_SEEK affects all duplicates of a handle so we do it before
2528 // the dup() call to avoid having to close the dup_handle on error here
2529 if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
2531 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %08x%08x)\n",
2532 pfile->name, pack->filename, (unsigned int)(pfile->offset >> 32), (unsigned int)(pfile->offset));
2536 dup_handle = FILEDESC_DUP (pack->filename, pack->handle);
2537 if (!FILEDESC_ISVALID(dup_handle))
2539 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2543 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2544 memset (file, 0, sizeof (*file));
2545 file->handle = dup_handle;
2546 file->flags = QFILE_FLAG_PACKED;
2547 file->real_length = pfile->realsize;
2548 file->offset = pfile->offset;
2552 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2556 file->flags |= QFILE_FLAG_DEFLATED;
2558 // We need some more variables
2559 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2561 ztk->comp_length = pfile->packsize;
2563 // Initialize zlib stream
2564 ztk->zstream.next_in = ztk->input;
2565 ztk->zstream.avail_in = 0;
2567 /* From Zlib's "unzip.c":
2569 * windowBits is passed < 0 to tell that there is no zlib header.
2570 * Note that in this case inflate *requires* an extra "dummy" byte
2571 * after the compressed stream in order to complete decompression and
2572 * return Z_STREAM_END.
2573 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2574 * size of both compressed and uncompressed data
2576 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2578 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2579 FILEDESC_CLOSE(dup_handle);
2584 ztk->zstream.next_out = file->buff;
2585 ztk->zstream.avail_out = sizeof (file->buff);
2594 ====================
2597 Return true if the path should be rejected due to one of the following:
2598 1: path elements that are non-portable
2599 2: path elements that would allow access to files outside the game directory,
2600 or are just not a good idea for a mod to be using.
2601 ====================
2603 int FS_CheckNastyPath (const char *path, qbool isgamedir)
2605 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2609 // Windows: don't allow \ in filenames (windows-only), period.
2610 // (on Windows \ is a directory separator, but / is also supported)
2611 if (strstr(path, "\\"))
2612 return 1; // non-portable
2614 // Mac: don't allow Mac-only filenames - : is a directory separator
2615 // instead of /, but we rely on / working already, so there's no reason to
2616 // support a Mac-only path
2617 // Amiga and Windows: : tries to go to root of drive
2618 if (strstr(path, ":"))
2619 return 1; // non-portable attempt to go to root of drive
2621 // Amiga: // is parent directory
2622 if (strstr(path, "//"))
2623 return 1; // non-portable attempt to go to parent directory
2625 // all: don't allow going to parent directory (../ or /../)
2626 if (strstr(path, ".."))
2627 return 2; // attempt to go outside the game directory
2629 // Windows and UNIXes: don't allow absolute paths
2631 return 2; // attempt to go outside the game directory
2633 // all: don't allow . character immediately before a slash, this catches all imaginable cases of ./, ../, .../, etc
2634 if (strstr(path, "./"))
2635 return 2; // possible attempt to go outside the game directory
2637 // all: forbid trailing slash on gamedir
2638 if (isgamedir && path[strlen(path)-1] == '/')
2641 // all: forbid leading dot on any filename for any reason
2642 if (strstr(path, "/."))
2643 return 2; // attempt to go outside the game directory
2645 // after all these checks we're pretty sure it's a / separated filename
2646 // and won't do much if any harm
2651 ====================
2654 Sanitize path (replace non-portable characters
2655 with portable ones in-place, etc)
2656 ====================
2658 void FS_SanitizePath(char *path)
2660 for (; *path; path++)
2666 ====================
2669 Look for a file in the packages and in the filesystem
2671 Return the searchpath where the file was found (or NULL)
2672 and the file index in the package if relevant
2673 ====================
2675 static searchpath_t *FS_FindFile (const char *name, int* index, qbool quiet)
2677 searchpath_t *search;
2680 // search through the path, one element at a time
2681 for (search = fs_searchpaths;search;search = search->next)
2683 // is the element a pak file?
2684 if (search->pack && !search->pack->vpack)
2686 int (*strcmp_funct) (const char* str1, const char* str2);
2687 int left, right, middle;
2690 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2692 // Look for the file (binary search)
2694 right = pak->numfiles - 1;
2695 while (left <= right)
2699 middle = (left + right) / 2;
2700 diff = strcmp_funct (pak->files[middle].name, name);
2705 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2707 // yes, but the first one is empty so we treat it as not being there
2708 if (!quiet && developer_extra.integer)
2709 Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2716 if (!quiet && developer_extra.integer)
2717 Con_DPrintf("FS_FindFile: %s in %s\n",
2718 pak->files[middle].name, pak->filename);
2725 // If we're too far in the list
2734 char netpath[MAX_OSPATH];
2735 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2736 if (FS_SysFileExists (netpath))
2738 if (!quiet && developer_extra.integer)
2739 Con_DPrintf("FS_FindFile: %s\n", netpath);
2748 if (!quiet && developer_extra.integer)
2749 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2761 Look for a file in the search paths and open it in read-only mode
2764 static qfile_t *FS_OpenReadFile (const char *filename, qbool quiet, qbool nonblocking, int symlinkLevels)
2766 searchpath_t *search;
2769 search = FS_FindFile (filename, &pack_ind, quiet);
2775 // Found in the filesystem?
2778 // this works with vpacks, so we are fine
2779 char path [MAX_OSPATH];
2780 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2781 return FS_SysOpen (path, "rb", nonblocking);
2784 // So, we found it in a package...
2786 // Is it a PK3 symlink?
2787 // TODO also handle directory symlinks by parsing the whole structure...
2788 // but heck, file symlinks are good enough for now
2789 if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2791 if(symlinkLevels <= 0)
2793 Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2798 char linkbuf[MAX_QPATH];
2800 qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2801 const char *mergeslash;
2806 count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2812 // Now combine the paths...
2813 mergeslash = strrchr(filename, '/');
2814 mergestart = linkbuf;
2816 mergeslash = filename;
2817 while(!strncmp(mergestart, "../", 3))
2820 while(mergeslash > filename)
2823 if(*mergeslash == '/')
2827 // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2828 if(mergeslash == filename)
2830 // Either mergeslash == filename, then we just replace the name (done below)
2834 // Or, we append the name after mergeslash;
2835 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2836 int spaceNeeded = mergeslash - filename + 1;
2837 int spaceRemoved = mergestart - linkbuf;
2838 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2840 Con_DPrintf("symlink: too long path rejected\n");
2843 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2844 memcpy(linkbuf, filename, spaceNeeded);
2845 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2846 mergestart = linkbuf;
2848 if (!quiet && developer_loading.integer)
2849 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2850 if(FS_CheckNastyPath (mergestart, false))
2852 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2855 return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2859 return FS_OpenPackedFile (search->pack, pack_ind);
2864 =============================================================================
2866 MAIN PUBLIC FUNCTIONS
2868 =============================================================================
2872 ====================
2875 Open a file in the userpath. The syntax is the same as fopen
2876 Used for savegame scanning in menu, and all file writing.
2877 ====================
2879 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qbool quiet)
2881 char real_path [MAX_OSPATH];
2883 if (FS_CheckNastyPath(filepath, false))
2885 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2889 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2891 // If the file is opened in "write", "append", or "read/write" mode,
2892 // create directories up to the file.
2893 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2894 FS_CreatePath (real_path);
2895 return FS_SysOpen (real_path, mode, false);
2900 ====================
2903 Open a file. The syntax is the same as fopen
2904 ====================
2906 qfile_t* FS_OpenVirtualFile (const char* filepath, qbool quiet)
2908 qfile_t *result = NULL;
2909 if (FS_CheckNastyPath(filepath, false))
2911 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2915 if (fs_mutex) Thread_LockMutex(fs_mutex);
2916 result = FS_OpenReadFile (filepath, quiet, false, 16);
2917 if (fs_mutex) Thread_UnlockMutex(fs_mutex);
2923 ====================
2926 Open a file. The syntax is the same as fopen
2927 ====================
2929 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qbool quiet)
2932 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2933 memset (file, 0, sizeof (*file));
2934 file->flags = QFILE_FLAG_DATA;
2936 file->real_length = size;
2942 ====================
2946 ====================
2948 int FS_Close (qfile_t* file)
2950 if(file->flags & QFILE_FLAG_DATA)
2956 if (FILEDESC_CLOSE (file->handle))
2961 if (file->flags & QFILE_FLAG_REMOVE)
2963 if (remove(file->filename) == -1)
2965 // No need to report this. If removing a just
2966 // written file failed, this most likely means
2967 // someone else deleted it first - which we
2972 Mem_Free((void *) file->filename);
2977 qz_inflateEnd (&file->ztk->zstream);
2978 Mem_Free (file->ztk);
2985 void FS_RemoveOnClose(qfile_t* file)
2987 file->flags |= QFILE_FLAG_REMOVE;
2991 ====================
2994 Write "datasize" bytes into a file
2995 ====================
2997 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2999 fs_offset_t written = 0;
3001 // If necessary, seek to the exact file position we're supposed to be
3002 if (file->buff_ind != file->buff_len)
3004 if (FILEDESC_SEEK (file->handle, file->buff_ind - file->buff_len, SEEK_CUR) == -1)
3006 Con_Printf(CON_WARN "WARNING: could not seek in %s.\n", file->filename);
3010 // Purge cached data
3013 // Write the buffer and update the position
3014 // LadyHavoc: to hush a warning about passing size_t to an unsigned int parameter on Win64 we do this as multiple writes if the size would be too big for an integer (we never write that big in one go, but it's a theory)
3015 while (written < (fs_offset_t)datasize)
3017 // figure out how much to write in one chunk
3018 fs_offset_t maxchunk = 1<<30; // 1 GiB
3019 int chunk = (int)min((fs_offset_t)datasize - written, maxchunk);
3020 int result = (int)FILEDESC_WRITE (file->handle, (const unsigned char *)data + written, chunk);
3021 // if at least some was written, add it to our accumulator
3024 // if the result is not what we expected, consider the write to be incomplete
3025 if (result != chunk)
3028 file->position = FILEDESC_SEEK (file->handle, 0, SEEK_CUR);
3029 if (file->real_length < file->position)
3030 file->real_length = file->position;
3032 // note that this will never be less than 0 even if the write failed
3038 ====================
3041 Read up to "buffersize" bytes from a file
3042 ====================
3044 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
3046 fs_offset_t count, done;
3048 if (buffersize == 0 || !buffer)
3051 // Get rid of the ungetc character
3052 if (file->ungetc != EOF)
3054 ((char*)buffer)[0] = file->ungetc;
3062 if(file->flags & QFILE_FLAG_DATA)
3064 size_t left = file->real_length - file->position;
3065 if(buffersize > left)
3067 memcpy(buffer, file->data + file->position, buffersize);
3068 file->position += buffersize;
3072 // First, we copy as many bytes as we can from "buff"
3073 if (file->buff_ind < file->buff_len)
3075 count = file->buff_len - file->buff_ind;
3076 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
3078 memcpy (buffer, &file->buff[file->buff_ind], count);
3079 file->buff_ind += count;
3081 buffersize -= count;
3082 if (buffersize == 0)
3086 // NOTE: at this point, the read buffer is always empty
3088 // If the file isn't compressed
3089 if (! (file->flags & QFILE_FLAG_DEFLATED))
3093 // We must take care to not read after the end of the file
3094 count = file->real_length - file->position;
3096 // If we have a lot of data to get, put them directly into "buffer"
3097 if (buffersize > sizeof (file->buff) / 2)
3099 if (count > (fs_offset_t)buffersize)
3100 count = (fs_offset_t)buffersize;
3101 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
3103 // Seek failed. When reading from a pipe, and
3104 // the caller never called FS_Seek, this still
3105 // works fine. So no reporting this error.
3107 nb = FILEDESC_READ (file->handle, &((unsigned char*)buffer)[done], count);
3111 file->position += nb;
3113 // Purge cached data
3119 if (count > (fs_offset_t)sizeof (file->buff))
3120 count = (fs_offset_t)sizeof (file->buff);
3121 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
3123 // Seek failed. When reading from a pipe, and
3124 // the caller never called FS_Seek, this still
3125 // works fine. So no reporting this error.
3127 nb = FILEDESC_READ (file->handle, file->buff, count);
3130 file->buff_len = nb;
3131 file->position += nb;
3133 // Copy the requested data in "buffer" (as much as we can)
3134 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3135 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3136 file->buff_ind = count;
3144 // If the file is compressed, it's more complicated...
3145 // We cycle through a few operations until we have read enough data
3146 while (buffersize > 0)
3148 ztoolkit_t *ztk = file->ztk;
3151 // NOTE: at this point, the read buffer is always empty
3153 // If "input" is also empty, we need to refill it
3154 if (ztk->in_ind == ztk->in_len)
3156 // If we are at the end of the file
3157 if (file->position == file->real_length)
3160 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
3161 if (count > (fs_offset_t)sizeof (ztk->input))
3162 count = (fs_offset_t)sizeof (ztk->input);
3163 FILEDESC_SEEK (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
3164 if (FILEDESC_READ (file->handle, ztk->input, count) != count)
3166 Con_Printf ("FS_Read: unexpected end of file\n");
3171 ztk->in_len = count;
3172 ztk->in_position += count;
3175 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
3176 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
3178 // Now that we are sure we have compressed data available, we need to determine
3179 // if it's better to inflate it in "file->buff" or directly in "buffer"
3181 // Inflate the data in "file->buff"
3182 if (buffersize < sizeof (file->buff) / 2)
3184 ztk->zstream.next_out = file->buff;
3185 ztk->zstream.avail_out = sizeof (file->buff);
3186 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3187 if (error != Z_OK && error != Z_STREAM_END)
3189 Con_Printf ("FS_Read: Can't inflate file\n");
3192 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3194 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
3195 file->position += file->buff_len;
3197 // Copy the requested data in "buffer" (as much as we can)
3198 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3199 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3200 file->buff_ind = count;
3203 // Else, we inflate directly in "buffer"
3206 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
3207 ztk->zstream.avail_out = (unsigned int)buffersize;
3208 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3209 if (error != Z_OK && error != Z_STREAM_END)
3211 Con_Printf ("FS_Read: Can't inflate file\n");
3214 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3216 // How much data did it inflate?
3217 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
3218 file->position += count;
3220 // Purge cached data
3225 buffersize -= count;
3233 ====================
3236 Print a string into a file
3237 ====================
3239 int FS_Print (qfile_t* file, const char *msg)
3241 return (int)FS_Write (file, msg, strlen (msg));
3245 ====================
3248 Print a string into a file
3249 ====================
3251 int FS_Printf(qfile_t* file, const char* format, ...)
3256 va_start (args, format);
3257 result = FS_VPrintf (file, format, args);
3265 ====================
3268 Print a string into a file
3269 ====================
3271 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
3274 fs_offset_t buff_size = MAX_INPUTLINE;
3279 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
3280 len = dpvsnprintf (tempbuff, buff_size, format, ap);
3281 if (len >= 0 && len < buff_size)
3283 Mem_Free (tempbuff);
3287 len = FILEDESC_WRITE (file->handle, tempbuff, len);
3288 Mem_Free (tempbuff);
3295 ====================
3298 Get the next character of a file
3299 ====================
3301 int FS_Getc (qfile_t* file)
3305 if (FS_Read (file, &c, 1) != 1)
3313 ====================
3316 Put a character back into the read buffer (only supports one character!)
3317 ====================
3319 int FS_UnGetc (qfile_t* file, unsigned char c)
3321 // If there's already a character waiting to be read
3322 if (file->ungetc != EOF)
3331 ====================
3334 Move the position index in a file
3335 ====================
3337 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
3340 unsigned char* buffer;
3341 fs_offset_t buffersize;
3343 // Compute the file offset
3347 offset += file->position - file->buff_len + file->buff_ind;
3354 offset += file->real_length;
3360 if (offset < 0 || offset > file->real_length)
3363 if(file->flags & QFILE_FLAG_DATA)
3365 file->position = offset;
3369 // If we have the data in our read buffer, we don't need to actually seek
3370 if (file->position - file->buff_len <= offset && offset <= file->position)
3372 file->buff_ind = offset + file->buff_len - file->position;
3376 // Purge cached data
3379 // Unpacked or uncompressed files can seek directly
3380 if (! (file->flags & QFILE_FLAG_DEFLATED))
3382 if (FILEDESC_SEEK (file->handle, file->offset + offset, SEEK_SET) == -1)
3384 file->position = offset;
3388 // Seeking in compressed files is more a hack than anything else,
3389 // but we need to support it, so here we go.
3392 // If we have to go back in the file, we need to restart from the beginning
3393 if (offset <= file->position)
3397 ztk->in_position = 0;
3399 if (FILEDESC_SEEK (file->handle, file->offset, SEEK_SET) == -1)
3400 Con_Printf("IMPOSSIBLE: couldn't seek in already opened pk3 file.\n");
3402 // Reset the Zlib stream
3403 ztk->zstream.next_in = ztk->input;
3404 ztk->zstream.avail_in = 0;
3405 qz_inflateReset (&ztk->zstream);
3408 // We need a big buffer to force inflating into it directly
3409 buffersize = 2 * sizeof (file->buff);
3410 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
3412 // Skip all data until we reach the requested offset
3413 while (offset > (file->position - file->buff_len + file->buff_ind))
3415 fs_offset_t diff = offset - (file->position - file->buff_len + file->buff_ind);
3416 fs_offset_t count, len;
3418 count = (diff > buffersize) ? buffersize : diff;
3419 len = FS_Read (file, buffer, count);
3433 ====================
3436 Give the current position in a file
3437 ====================
3439 fs_offset_t FS_Tell (qfile_t* file)
3441 return file->position - file->buff_len + file->buff_ind;
3446 ====================
3449 Give the total size of a file
3450 ====================
3452 fs_offset_t FS_FileSize (qfile_t* file)
3454 return file->real_length;
3459 ====================
3462 Erases any buffered input or output data
3463 ====================
3465 void FS_Purge (qfile_t* file)
3475 FS_LoadAndCloseQFile
3477 Loads full content of a qfile_t and closes it.
3478 Always appends a 0 byte.
3481 static unsigned char *FS_LoadAndCloseQFile (qfile_t *file, const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3483 unsigned char *buf = NULL;
3484 fs_offset_t filesize = 0;
3488 filesize = file->real_length;
3491 Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
3496 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
3497 buf[filesize] = '\0';
3498 FS_Read (file, buf, filesize);
3500 if (developer_loadfile.integer)
3501 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
3504 if (filesizepointer)
3505 *filesizepointer = filesize;
3514 Filename are relative to the quake directory.
3515 Always appends a 0 byte.
3518 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3520 qfile_t *file = FS_OpenVirtualFile(path, quiet);
3521 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3529 Filename are OS paths.
3530 Always appends a 0 byte.
3533 unsigned char *FS_SysLoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3535 qfile_t *file = FS_SysOpen(path, "rb", false);
3536 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3544 The filename will be prefixed by the current game directory
3547 qbool FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
3551 fs_offset_t lentotal;
3553 file = FS_OpenRealFile(filename, "wb", false);
3556 Con_Printf("FS_WriteFile: failed on %s\n", filename);
3561 for(i = 0; i < count; ++i)
3563 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
3564 for(i = 0; i < count; ++i)
3565 FS_Write (file, data[i], len[i]);
3570 qbool FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
3572 return FS_WriteFileInBlocks(filename, &data, &len, 1);
3577 =============================================================================
3579 OTHERS PUBLIC FUNCTIONS
3581 =============================================================================
3589 void FS_StripExtension (const char *in, char *out, size_t size_out)
3597 while ((currentchar = *in) && size_out > 1)
3599 if (currentchar == '.')
3601 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3603 *out++ = currentchar;
3619 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3623 // if path doesn't have a .EXT, append extension
3624 // (extension should include the .)
3625 src = path + strlen(path);
3627 while (*src != '/' && src != path)
3630 return; // it has an extension
3634 dp_strlcat (path, extension, size_path);
3642 Look for a file in the packages and in the filesystem
3645 int FS_FileType (const char *filename)
3647 searchpath_t *search;
3648 char fullpath[MAX_OSPATH];
3650 search = FS_FindFile (filename, NULL, true);
3652 return FS_FILETYPE_NONE;
3654 if(search->pack && !search->pack->vpack)
3655 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3657 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3658 return FS_SysFileType(fullpath);
3666 Look for a file in the packages and in the filesystem
3669 qbool FS_FileExists (const char *filename)
3671 return (FS_FindFile (filename, NULL, true) != NULL);
3679 Look for a file in the filesystem only
3682 int FS_SysFileType (const char *path)
3685 // Sajt - some older sdks are missing this define
3686 # ifndef INVALID_FILE_ATTRIBUTES
3687 # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3689 wchar pathw[WSTRBUF] = {0};
3692 result = GetFileAttributesW(pathw);
3694 if(result == INVALID_FILE_ATTRIBUTES)
3695 return FS_FILETYPE_NONE;
3697 if(result & FILE_ATTRIBUTE_DIRECTORY)
3698 return FS_FILETYPE_DIRECTORY;
3700 return FS_FILETYPE_FILE;
3704 if (stat (path,&buf) == -1)
3705 return FS_FILETYPE_NONE;
3708 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3710 if(S_ISDIR(buf.st_mode))
3711 return FS_FILETYPE_DIRECTORY;
3713 return FS_FILETYPE_FILE;
3717 qbool FS_SysFileExists (const char *path)
3719 return FS_SysFileType (path) != FS_FILETYPE_NONE;
3726 Allocate and fill a search structure with information on matching filenames.
3729 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet, const char *packfile)
3732 searchpath_t *searchpath;
3734 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3735 stringlist_t resultlist;
3736 stringlist_t dirlist;
3737 stringlist_t matchedSet, foundSet;
3738 const char *start, *slash, *backslash, *colon, *separator;
3741 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3746 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3750 stringlistinit(&resultlist);
3751 stringlistinit(&dirlist);
3753 slash = strrchr(pattern, '/');
3754 backslash = strrchr(pattern, '\\');
3755 colon = strrchr(pattern, ':');
3756 separator = max(slash, backslash);
3757 separator = max(separator, colon);
3758 basepathlength = separator ? (separator + 1 - pattern) : 0;
3759 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3761 memcpy(basepath, pattern, basepathlength);
3762 basepath[basepathlength] = 0;
3764 // search through the path, one element at a time
3765 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3767 // is the element a pak file?
3768 if (searchpath->pack && !searchpath->pack->vpack)
3770 // look through all the pak file elements
3771 pak = searchpath->pack;
3774 if(strcmp(packfile, pak->shortname))
3777 for (i = 0;i < pak->numfiles;i++)
3779 char temp[MAX_OSPATH];
3780 dp_strlcpy(temp, pak->files[i].name, sizeof(temp));
3783 if (matchpattern(temp, (char *)pattern, true))
3785 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3786 if (!strcmp(resultlist.strings[resultlistindex], temp))
3788 if (resultlistindex == resultlist.numstrings)
3790 stringlistappend(&resultlist, temp);
3791 if (!quiet && developer_loading.integer)
3792 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3795 // strip off one path element at a time until empty
3796 // this way directories are added to the listing if they match the pattern
3797 slash = strrchr(temp, '/');
3798 backslash = strrchr(temp, '\\');
3799 colon = strrchr(temp, ':');
3801 if (separator < slash)
3803 if (separator < backslash)
3804 separator = backslash;
3805 if (separator < colon)
3807 *((char *)separator) = 0;
3818 stringlistinit(&matchedSet);
3819 stringlistinit(&foundSet);
3820 // add a first entry to the set
3821 stringlistappend(&matchedSet, "");
3822 // iterate through pattern's path
3825 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3826 char subpath[MAX_OSPATH];
3827 char subpattern[MAX_OSPATH];
3829 // find the next wildcard
3830 wildcard = strchr(start, '?');
3831 asterisk = strchr(start, '*');
3832 if (asterisk && (!wildcard || asterisk < wildcard))
3834 wildcard = asterisk;
3839 nextseparator = strchr( wildcard, '/' );
3843 nextseparator = NULL;
3846 if( !nextseparator ) {
3847 nextseparator = start + strlen( start );
3850 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3851 // copy everything up except nextseperator
3852 dp_ustr2stp(subpattern, sizeof(subpattern), pattern, nextseparator - pattern);
3853 // find the last '/' before the wildcard
3854 prevseparator = strrchr( subpattern, '/' );
3856 prevseparator = subpattern;
3859 // copy everything from start to the previous including the '/' (before the wildcard)
3860 // everything up to start is already included in the path of matchedSet's entries
3861 dp_ustr2stp(subpath, sizeof(subpath), start, (prevseparator - subpattern) - (start - pattern));
3863 // for each entry in matchedSet try to open the subdirectories specified in subpath
3864 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3865 char temp[MAX_OSPATH];
3866 dp_strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3867 dp_strlcat( temp, subpath, sizeof(temp) );
3868 listdirectory( &foundSet, searchpath->filename, temp );
3870 if( dirlistindex == 0 ) {
3873 // reset the current result set
3874 stringlistfreecontents( &matchedSet );
3875 // match against the pattern
3876 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3877 const char *direntry = foundSet.strings[ dirlistindex ];
3878 if (matchpattern(direntry, subpattern, true)) {
3879 stringlistappend( &matchedSet, direntry );
3882 stringlistfreecontents( &foundSet );
3884 start = nextseparator;
3887 for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3889 const char *matchtemp = matchedSet.strings[dirlistindex];
3890 if (matchpattern(matchtemp, (char *)pattern, true))
3892 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3893 if (!strcmp(resultlist.strings[resultlistindex], matchtemp))
3895 if (resultlistindex == resultlist.numstrings)
3897 stringlistappend(&resultlist, matchtemp);
3898 if (!quiet && developer_loading.integer)
3899 Con_Printf("SearchDirFile: %s\n", matchtemp);
3903 stringlistfreecontents( &matchedSet );
3907 if (resultlist.numstrings)
3909 stringlistsort(&resultlist, true);
3910 numfiles = resultlist.numstrings;
3912 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3913 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3914 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3915 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3916 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3917 search->numfilenames = (int)numfiles;
3920 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3923 search->filenames[numfiles] = search->filenamesbuffer + numchars;
3924 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3925 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3927 numchars += (int)textlen;
3930 stringlistfreecontents(&resultlist);
3936 void FS_FreeSearch(fssearch_t *search)
3941 extern int con_linewidth;
3942 static int FS_ListDirectory(const char *pattern, int oneperline)
3951 char linebuf[MAX_INPUTLINE];
3953 search = FS_Search(pattern, true, true, NULL);
3956 numfiles = search->numfilenames;
3959 // FIXME: the names could be added to one column list and then
3960 // gradually shifted into the next column if they fit, and then the
3961 // next to make a compact variable width listing but it's a lot more
3963 // find width for columns
3965 for (i = 0;i < numfiles;i++)
3967 l = (int)strlen(search->filenames[i]);
3968 if (columnwidth < l)
3971 // count the spacing character
3973 // calculate number of columns
3974 numcolumns = con_linewidth / columnwidth;
3975 // don't bother with the column printing if it's only one column
3976 if (numcolumns >= 2)
3978 numlines = (numfiles + numcolumns - 1) / numcolumns;
3979 for (i = 0;i < numlines;i++)
3982 for (k = 0;k < numcolumns;k++)
3984 l = i * numcolumns + k;
3987 name = search->filenames[l];
3988 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3989 linebuf[linebufpos++] = name[j];
3990 // space out name unless it's the last on the line
3991 if (k + 1 < numcolumns && l + 1 < numfiles)
3992 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3993 linebuf[linebufpos++] = ' ';
3996 linebuf[linebufpos] = 0;
3997 Con_Printf("%s\n", linebuf);
4004 for (i = 0;i < numfiles;i++)
4005 Con_Printf("%s\n", search->filenames[i]);
4006 FS_FreeSearch(search);
4007 return (int)numfiles;
4010 static void FS_ListDirectoryCmd (cmd_state_t *cmd, const char* cmdname, int oneperline)
4012 const char *pattern;
4013 if (Cmd_Argc(cmd) >= 3)
4015 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
4018 if (Cmd_Argc(cmd) == 2)
4019 pattern = Cmd_Argv(cmd, 1);
4022 if (!FS_ListDirectory(pattern, oneperline))
4023 Con_Print("No files found.\n");
4026 void FS_Dir_f(cmd_state_t *cmd)
4028 FS_ListDirectoryCmd(cmd, "dir", true);
4031 void FS_Ls_f(cmd_state_t *cmd)
4033 FS_ListDirectoryCmd(cmd, "ls", false);
4036 void FS_Which_f(cmd_state_t *cmd)
4038 const char *filename;
4041 if (Cmd_Argc(cmd) != 2)
4043 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(cmd, 0));
4046 filename = Cmd_Argv(cmd, 1);
4047 sp = FS_FindFile(filename, &index, true);
4049 Con_Printf("%s isn't anywhere\n", filename);
4055 Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
4057 Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
4060 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
4064 const char *FS_WhichPack(const char *filename)
4067 searchpath_t *sp = FS_FindFile(filename, &index, true);
4069 return sp->pack->shortname;
4077 ====================
4078 FS_IsRegisteredQuakePack
4080 Look for a proof of purchase file file in the requested package
4082 If it is found, this file should NOT be downloaded.
4083 ====================
4085 qbool FS_IsRegisteredQuakePack(const char *name)
4087 searchpath_t *search;
4090 // search through the path, one element at a time
4091 for (search = fs_searchpaths;search;search = search->next)
4093 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
4094 // TODO do we want to support vpacks in here too?
4096 int (*strcmp_funct) (const char* str1, const char* str2);
4097 int left, right, middle;
4100 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
4102 // Look for the file (binary search)
4104 right = pak->numfiles - 1;
4105 while (left <= right)
4109 middle = (left + right) / 2;
4110 diff = strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
4116 // If we're too far in the list
4123 // we found the requested pack but it is not registered quake
4131 int FS_CRCFile(const char *filename, size_t *filesizepointer)
4134 unsigned char *filedata;
4135 fs_offset_t filesize;
4136 if (filesizepointer)
4137 *filesizepointer = 0;
4138 if (!filename || !*filename)
4140 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
4143 if (filesizepointer)
4144 *filesizepointer = filesize;
4145 crc = CRC_Block(filedata, filesize);
4151 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
4154 unsigned char *out = NULL;
4158 #ifndef LINK_TO_ZLIB
4163 memset(&strm, 0, sizeof(strm));
4164 strm.zalloc = Z_NULL;
4165 strm.zfree = Z_NULL;
4166 strm.opaque = Z_NULL;
4169 level = Z_DEFAULT_COMPRESSION;
4171 if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
4173 Con_Printf("FS_Deflate: deflate init error!\n");
4177 strm.next_in = (unsigned char*)data;
4178 strm.avail_in = (unsigned int)size;
4180 tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
4183 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
4184 qz_deflateEnd(&strm);
4188 strm.next_out = tmp;
4189 strm.avail_out = (unsigned int)size;
4191 if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
4193 Con_Printf("FS_Deflate: deflate failed!\n");
4194 qz_deflateEnd(&strm);
4199 if(qz_deflateEnd(&strm) != Z_OK)
4201 Con_Printf("FS_Deflate: deflateEnd failed\n");
4206 if(strm.total_out >= size)
4208 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
4213 out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
4216 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
4221 *deflated_size = (size_t)strm.total_out;
4223 memcpy(out, tmp, strm.total_out);
4229 static void AssertBufsize(sizebuf_t *buf, int length)
4231 if(buf->cursize + length > buf->maxsize)
4233 int oldsize = buf->maxsize;
4234 unsigned char *olddata;
4235 olddata = buf->data;
4236 buf->maxsize += length;
4237 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
4240 memcpy(buf->data, olddata, oldsize);
4246 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
4250 unsigned char *out = NULL;
4251 unsigned char tmp[2048];
4256 #ifndef LINK_TO_ZLIB
4261 memset(&outbuf, 0, sizeof(outbuf));
4262 outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
4263 outbuf.maxsize = sizeof(tmp);
4265 memset(&strm, 0, sizeof(strm));
4266 strm.zalloc = Z_NULL;
4267 strm.zfree = Z_NULL;
4268 strm.opaque = Z_NULL;
4270 if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
4272 Con_Printf("FS_Inflate: inflate init error!\n");
4273 Mem_Free(outbuf.data);
4277 strm.next_in = (unsigned char*)data;
4278 strm.avail_in = (unsigned int)size;
4282 strm.next_out = tmp;
4283 strm.avail_out = sizeof(tmp);
4284 ret = qz_inflate(&strm, Z_NO_FLUSH);
4285 // it either returns Z_OK on progress, Z_STREAM_END on end
4293 case Z_STREAM_ERROR:
4294 Con_Print("FS_Inflate: stream error!\n");
4297 Con_Print("FS_Inflate: data error!\n");
4300 Con_Print("FS_Inflate: mem error!\n");
4303 Con_Print("FS_Inflate: buf error!\n");
4306 Con_Print("FS_Inflate: unknown error!\n");
4310 if(ret != Z_OK && ret != Z_STREAM_END)
4312 Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
4313 Mem_Free(outbuf.data);
4314 qz_inflateEnd(&strm);
4317 have = sizeof(tmp) - strm.avail_out;
4318 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
4319 SZ_Write(&outbuf, tmp, have);
4320 } while(ret != Z_STREAM_END);
4322 qz_inflateEnd(&strm);
4324 out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
4327 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
4328 Mem_Free(outbuf.data);
4332 memcpy(out, outbuf.data, outbuf.cursize);
4333 Mem_Free(outbuf.data);
4335 *inflated_size = (size_t)outbuf.cursize;