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
52 // Win32 requires us to add O_BINARY, but the other OSes don't have it
57 // In case the system doesn't support the O_NONBLOCK flag
62 // largefile support for Win32
65 # define lseek _lseeki64
68 // suppress deprecated warnings
73 # define unlink _unlink
79 typedef SDL_RWops *filedesc_t;
80 # define FILEDESC_INVALID NULL
81 # define FILEDESC_ISVALID(fd) ((fd) != NULL)
82 # define FILEDESC_READ(fd,buf,count) ((fs_offset_t)SDL_RWread(fd, buf, 1, count))
83 # define FILEDESC_WRITE(fd,buf,count) ((fs_offset_t)SDL_RWwrite(fd, buf, 1, count))
84 # define FILEDESC_CLOSE SDL_RWclose
85 # define FILEDESC_SEEK SDL_RWseek
86 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
87 filedesc_t new_fd = SDL_RWFromFile(filename, "rb");
88 if (SDL_RWseek(new_fd, SDL_RWseek(fd, 0, RW_SEEK_CUR), RW_SEEK_SET) < 0) {
94 # define unlink(name) Con_DPrintf("Sorry, no unlink support when trying to unlink %s.\n", (name))
96 typedef int filedesc_t;
97 # define FILEDESC_INVALID -1
98 # define FILEDESC_ISVALID(fd) ((fd) != -1)
99 # define FILEDESC_READ read
100 # define FILEDESC_WRITE write
101 # define FILEDESC_CLOSE close
102 # define FILEDESC_SEEK lseek
103 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
108 /** \page fs File System
110 All of Quake's data access is through a hierchal file system, but the contents
111 of the file system can be transparently merged from several sources.
113 The "base directory" is the path to the directory holding the quake.exe and
114 all game directories. The sys_* files pass this to host_init in
115 quakeparms_t->basedir. This can be overridden with the "-basedir" command
116 line parm to allow code debugging in a different directory. The base
117 directory is only used during filesystem initialization.
119 The "game directory" is the first tree on the search path and directory that
120 all generated files (savegames, screenshots, demos, config files) will be
121 saved to. This can be overridden with the "-game" command line parameter.
122 The game directory can never be changed while quake is executing. This is a
123 precaution against having a malicious server instruct clients to write files
124 over areas they shouldn't.
130 =============================================================================
134 =============================================================================
137 // Magic numbers of a ZIP file (big-endian format)
138 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
139 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
140 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
142 // Other constants for ZIP files
143 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
144 #define ZIP_END_CDIR_SIZE 22
145 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
146 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
151 #define qz_inflate inflate
152 #define qz_inflateEnd inflateEnd
153 #define qz_inflateInit2_ inflateInit2_
154 #define qz_inflateReset inflateReset
155 #define qz_deflateInit2_ deflateInit2_
156 #define qz_deflateEnd deflateEnd
157 #define qz_deflate deflate
158 #define Z_MEMLEVEL_DEFAULT 8
161 // Zlib constants (from zlib.h)
162 #define Z_SYNC_FLUSH 2
165 #define Z_STREAM_END 1
166 #define Z_STREAM_ERROR (-2)
167 #define Z_DATA_ERROR (-3)
168 #define Z_MEM_ERROR (-4)
169 #define Z_BUF_ERROR (-5)
170 #define ZLIB_VERSION "1.2.3"
174 #define Z_MEMLEVEL_DEFAULT 8
177 #define Z_DEFAULT_COMPRESSION (-1)
179 #define Z_SYNC_FLUSH 2
180 #define Z_FULL_FLUSH 3
183 // Uncomment the following line if the zlib DLL you have still uses
184 // the 1.1.x series calling convention on Win32 (WINAPI)
185 //#define ZLIB_USES_WINAPI
189 =============================================================================
193 =============================================================================
196 /*! Zlib stream (from zlib.h)
197 * \warning: some pointers we don't use directly have
198 * been cast to "void*" for a matter of simplicity
202 unsigned char *next_in; ///< next input byte
203 unsigned int avail_in; ///< number of bytes available at next_in
204 unsigned long total_in; ///< total nb of input bytes read so far
206 unsigned char *next_out; ///< next output byte should be put there
207 unsigned int avail_out; ///< remaining free space at next_out
208 unsigned long total_out; ///< total nb of bytes output so far
210 char *msg; ///< last error message, NULL if no error
211 void *state; ///< not visible by applications
213 void *zalloc; ///< used to allocate the internal state
214 void *zfree; ///< used to free the internal state
215 void *opaque; ///< private data object passed to zalloc and zfree
217 int data_type; ///< best guess about the data type: ascii or binary
218 unsigned long adler; ///< adler32 value of the uncompressed data
219 unsigned long reserved; ///< reserved for future use
224 /// inside a package (PAK or PK3)
225 #define QFILE_FLAG_PACKED (1 << 0)
226 /// file is compressed using the deflate algorithm (PK3 only)
227 #define QFILE_FLAG_DEFLATED (1 << 1)
228 /// file is actually already loaded data
229 #define QFILE_FLAG_DATA (1 << 2)
230 /// real file will be removed on close
231 #define QFILE_FLAG_REMOVE (1 << 3)
233 #define FILE_BUFF_SIZE 2048
237 size_t comp_length; ///< length of the compressed file
238 size_t in_ind, in_len; ///< input buffer current index and length
239 size_t in_position; ///< position in the compressed file
240 unsigned char input [FILE_BUFF_SIZE];
246 filedesc_t handle; ///< file descriptor
247 fs_offset_t real_length; ///< uncompressed file size (for files opened in "read" mode)
248 fs_offset_t position; ///< current position in the file
249 fs_offset_t offset; ///< offset into the package (0 if external file)
250 int ungetc; ///< single stored character from ungetc, cleared to EOF when read
253 fs_offset_t buff_ind, buff_len; ///< buffer current index and length
254 unsigned char buff [FILE_BUFF_SIZE];
256 ztoolkit_t* ztk; ///< For zipped files.
258 const unsigned char *data; ///< For data files.
260 const char *filename; ///< Kept around for QFILE_FLAG_REMOVE, unused otherwise
264 // ------ PK3 files on disk ------ //
266 // You can get the complete ZIP format description from PKWARE website
268 typedef struct pk3_endOfCentralDir_s
270 unsigned int signature;
271 unsigned short disknum;
272 unsigned short cdir_disknum; ///< number of the disk with the start of the central directory
273 unsigned short localentries; ///< number of entries in the central directory on this disk
274 unsigned short nbentries; ///< total number of entries in the central directory on this disk
275 unsigned int cdir_size; ///< size of the central directory
276 unsigned int cdir_offset; ///< with respect to the starting disk number
277 unsigned short comment_size;
278 fs_offset_t prepended_garbage;
279 } pk3_endOfCentralDir_t;
282 // ------ PAK files on disk ------ //
283 typedef struct dpackfile_s
286 int filepos, filelen;
289 typedef struct dpackheader_s
297 /*! \name Packages in memory
300 /// the offset in packfile_t is the true contents offset
301 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
302 /// file compressed using the deflate algorithm
303 #define PACKFILE_FLAG_DEFLATED (1 << 1)
304 /// file is a symbolic link
305 #define PACKFILE_FLAG_SYMLINK (1 << 2)
307 typedef struct packfile_s
309 char name [MAX_QPATH];
312 fs_offset_t packsize; ///< size in the package
313 fs_offset_t realsize; ///< real file size (uncompressed)
316 typedef struct pack_s
318 char filename [MAX_OSPATH];
319 char shortname [MAX_QPATH];
321 int ignorecase; ///< PK3 ignores case
328 /// Search paths for files (including packages)
329 typedef struct searchpath_s
331 // only one of filename / pack will be used
332 char filename[MAX_OSPATH];
334 struct searchpath_s *next;
339 =============================================================================
343 =============================================================================
346 void FS_Dir_f(cmd_state_t *cmd);
347 void FS_Ls_f(cmd_state_t *cmd);
348 void FS_Which_f(cmd_state_t *cmd);
350 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet);
351 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
352 fs_offset_t offset, fs_offset_t packsize,
353 fs_offset_t realsize, int flags);
357 =============================================================================
361 =============================================================================
364 mempool_t *fs_mempool;
365 void *fs_mutex = NULL;
367 searchpath_t *fs_searchpaths = NULL;
368 const char *const fs_checkgamedir_missing = "missing";
370 #define MAX_FILES_IN_PACK 65536
372 char fs_userdir[MAX_OSPATH];
373 char fs_gamedir[MAX_OSPATH];
374 char fs_basedir[MAX_OSPATH];
375 static pack_t *fs_selfpack = NULL;
377 // list of active game directories (empty if not running a mod)
378 int fs_numgamedirs = 0;
379 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
381 // list of all gamedirs with modinfo.txt
382 gamedir_t *fs_all_gamedirs = NULL;
383 int fs_all_gamedirs_count = 0;
385 cvar_t scr_screenshot_name = {CVAR_CLIENT | CVAR_NORESETTODEFAULTS, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
386 cvar_t fs_empty_files_in_pack_mark_deletions = {CVAR_CLIENT | CVAR_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"};
387 cvar_t cvar_fs_gamedir = {CVAR_CLIENT | CVAR_SERVER | CVAR_READONLY | CVAR_NORESETTODEFAULTS, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
391 =============================================================================
393 PRIVATE FUNCTIONS - PK3 HANDLING
395 =============================================================================
399 // Functions exported from zlib
400 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
401 # define ZEXPORT WINAPI
406 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
407 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
408 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
409 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
410 static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size);
411 static int (ZEXPORT *qz_deflateEnd) (z_stream* strm);
412 static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush);
415 #define qz_inflateInit2(strm, windowBits) \
416 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
417 #define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
418 qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream))
421 // qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
423 static dllfunction_t zlibfuncs[] =
425 {"inflate", (void **) &qz_inflate},
426 {"inflateEnd", (void **) &qz_inflateEnd},
427 {"inflateInit2_", (void **) &qz_inflateInit2_},
428 {"inflateReset", (void **) &qz_inflateReset},
429 {"deflateInit2_", (void **) &qz_deflateInit2_},
430 {"deflateEnd", (void **) &qz_deflateEnd},
431 {"deflate", (void **) &qz_deflate},
435 /// Handle for Zlib DLL
436 static dllhandle_t zlib_dll = NULL;
440 static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPTSTR pszPath);
441 static dllfunction_t shfolderfuncs[] =
443 {"SHGetFolderPathA", (void **) &qSHGetFolderPath},
446 static const char* shfolderdllnames [] =
448 "shfolder.dll", // IE 4, or Win NT and higher
451 static dllhandle_t shfolder_dll = NULL;
453 const GUID qFOLDERID_SavedGames = {0x4C5C32FF, 0xBB9D, 0x43b0, {0xB5, 0xB4, 0x2D, 0x72, 0xE5, 0x4E, 0xAA, 0xA4}};
454 #define qREFKNOWNFOLDERID const GUID *
455 #define qKF_FLAG_CREATE 0x8000
456 #define qKF_FLAG_NO_ALIAS 0x1000
457 static HRESULT (WINAPI *qSHGetKnownFolderPath) (qREFKNOWNFOLDERID rfid, DWORD dwFlags, HANDLE hToken, PWSTR *ppszPath);
458 static dllfunction_t shell32funcs[] =
460 {"SHGetKnownFolderPath", (void **) &qSHGetKnownFolderPath},
463 static const char* shell32dllnames [] =
465 "shell32.dll", // Vista and higher
468 static dllhandle_t shell32_dll = NULL;
470 static HRESULT (WINAPI *qCoInitializeEx)(LPVOID pvReserved, DWORD dwCoInit);
471 static void (WINAPI *qCoUninitialize)(void);
472 static void (WINAPI *qCoTaskMemFree)(LPVOID pv);
473 static dllfunction_t ole32funcs[] =
475 {"CoInitializeEx", (void **) &qCoInitializeEx},
476 {"CoUninitialize", (void **) &qCoUninitialize},
477 {"CoTaskMemFree", (void **) &qCoTaskMemFree},
480 static const char* ole32dllnames [] =
482 "ole32.dll", // 2000 and higher
485 static dllhandle_t ole32_dll = NULL;
495 static void PK3_CloseLibrary (void)
498 Sys_UnloadLibrary (&zlib_dll);
507 Try to load the Zlib DLL
510 static qboolean PK3_OpenLibrary (void)
515 const char* dllnames [] =
518 # ifdef ZLIB_USES_WINAPI
524 #elif defined(MACOSX)
538 return Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs);
546 See if zlib is available
549 qboolean FS_HasZlib(void)
554 PK3_OpenLibrary(); // to be safe
555 return (zlib_dll != 0);
561 PK3_GetEndOfCentralDir
563 Extract the end of the central directory from a PK3 package
566 static qboolean PK3_GetEndOfCentralDir (const char *packfile, filedesc_t packhandle, pk3_endOfCentralDir_t *eocd)
568 fs_offset_t filesize, maxsize;
569 unsigned char *buffer, *ptr;
572 // Get the package size
573 filesize = FILEDESC_SEEK (packhandle, 0, SEEK_END);
574 if (filesize < ZIP_END_CDIR_SIZE)
577 // Load the end of the file in memory
578 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
581 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
582 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
583 FILEDESC_SEEK (packhandle, filesize - maxsize, SEEK_SET);
584 if (FILEDESC_READ (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
590 // Look for the end of central dir signature around the end of the file
591 maxsize -= ZIP_END_CDIR_SIZE;
592 ptr = &buffer[maxsize];
594 while (BuffBigLong (ptr) != ZIP_END_HEADER)
606 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
607 eocd->signature = LittleLong (eocd->signature);
608 eocd->disknum = LittleShort (eocd->disknum);
609 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
610 eocd->localentries = LittleShort (eocd->localentries);
611 eocd->nbentries = LittleShort (eocd->nbentries);
612 eocd->cdir_size = LittleLong (eocd->cdir_size);
613 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
614 eocd->comment_size = LittleShort (eocd->comment_size);
615 eocd->prepended_garbage = filesize - (ind + ZIP_END_CDIR_SIZE) - eocd->cdir_offset - eocd->cdir_size; // this detects "SFX" zip files
616 eocd->cdir_offset += eocd->prepended_garbage;
621 eocd->cdir_size > filesize ||
622 eocd->cdir_offset >= filesize ||
623 eocd->cdir_offset + eocd->cdir_size > filesize
626 // Obviously invalid central directory.
638 Extract the file list from a PK3 file
641 static int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
643 unsigned char *central_dir, *ptr;
645 fs_offset_t remaining;
647 // Load the central directory in memory
648 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
649 if (FILEDESC_SEEK (pack->handle, eocd->cdir_offset, SEEK_SET) == -1)
651 Mem_Free (central_dir);
654 if(FILEDESC_READ (pack->handle, central_dir, eocd->cdir_size) != (fs_offset_t) eocd->cdir_size)
656 Mem_Free (central_dir);
660 // Extract the files properties
661 // The parsing is done "by hand" because some fields have variable sizes and
662 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
663 remaining = eocd->cdir_size;
666 for (ind = 0; ind < eocd->nbentries; ind++)
668 fs_offset_t namesize, count;
670 // Checking the remaining size
671 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
673 Mem_Free (central_dir);
676 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
679 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
681 Mem_Free (central_dir);
685 namesize = BuffLittleShort (&ptr[28]); // filename length
687 // Check encryption, compression, and attributes
688 // 1st uint8 : general purpose bit flag
689 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
691 // LadyHavoc: bit 3 would be a problem if we were scanning the archive
692 // but is not a problem in the central directory where the values are
695 // bit 3 seems to always be set by the standard Mac OSX zip maker
697 // 2nd uint8 : external file attributes
698 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
699 if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0)
701 // Still enough bytes for the name?
702 if (namesize < 0 || remaining < namesize || namesize >= (int)sizeof (*pack->files))
704 Mem_Free (central_dir);
708 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
709 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
711 char filename [sizeof (pack->files[0].name)];
712 fs_offset_t offset, packsize, realsize;
715 // Extract the name (strip it if necessary)
716 namesize = min(namesize, (int)sizeof (filename) - 1);
717 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
718 filename[namesize] = '\0';
720 if (BuffLittleShort (&ptr[10]))
721 flags = PACKFILE_FLAG_DEFLATED;
724 offset = (unsigned int)(BuffLittleLong (&ptr[42]) + eocd->prepended_garbage);
725 packsize = (unsigned int)BuffLittleLong (&ptr[20]);
726 realsize = (unsigned int)BuffLittleLong (&ptr[24]);
728 switch(ptr[5]) // C_VERSION_MADE_BY_1
733 if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000)
734 // can't use S_ISLNK here, as this has to compile on non-UNIX too
735 flags |= PACKFILE_FLAG_SYMLINK;
739 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
743 // Skip the name, additionnal field, and comment
744 // 1er uint16 : extra field length
745 // 2eme uint16 : file comment length
746 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
747 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
751 // If the package is empty, central_dir is NULL here
752 if (central_dir != NULL)
753 Mem_Free (central_dir);
754 return pack->numfiles;
762 Create a package entry associated with a PK3 file
765 static pack_t *FS_LoadPackPK3FromFD (const char *packfile, filedesc_t packhandle, qboolean silent)
767 pk3_endOfCentralDir_t eocd;
771 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
774 Con_Printf ("%s is not a PK3 file\n", packfile);
775 FILEDESC_CLOSE(packhandle);
779 // Multi-volume ZIP archives are NOT allowed
780 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
782 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
783 FILEDESC_CLOSE(packhandle);
787 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
788 // since eocd.nbentries is an unsigned 16 bits integer
789 #if MAX_FILES_IN_PACK < 65535
790 if (eocd.nbentries > MAX_FILES_IN_PACK)
792 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
793 FILEDESC_CLOSE(packhandle);
798 // Create a package structure in memory
799 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
800 pack->ignorecase = true; // PK3 ignores case
801 strlcpy (pack->filename, packfile, sizeof (pack->filename));
802 pack->handle = packhandle;
803 pack->numfiles = eocd.nbentries;
804 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
806 real_nb_files = PK3_BuildFileList (pack, &eocd);
807 if (real_nb_files < 0)
809 Con_Printf ("%s is not a valid PK3 file\n", packfile);
810 FILEDESC_CLOSE(pack->handle);
815 Con_DPrintf("Added packfile %s (%i files)\n", packfile, real_nb_files);
819 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qboolean nonblocking);
820 static pack_t *FS_LoadPackPK3 (const char *packfile)
822 filedesc_t packhandle;
823 packhandle = FS_SysOpenFiledesc (packfile, "rb", false);
824 if (!FILEDESC_ISVALID(packhandle))
826 return FS_LoadPackPK3FromFD(packfile, packhandle, false);
832 PK3_GetTrueFileOffset
834 Find where the true file data offset is
837 static qboolean PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
839 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
843 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
846 // Load the local file description
847 if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
849 Con_Printf ("Can't seek in package %s\n", pack->filename);
852 count = FILEDESC_READ (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
853 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
855 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
859 // Skip name and extra field
860 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
862 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
868 =============================================================================
870 OTHER PRIVATE FUNCTIONS
872 =============================================================================
880 Add a file to the list of files contained into a package
883 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
884 fs_offset_t offset, fs_offset_t packsize,
885 fs_offset_t realsize, int flags)
887 int (*strcmp_funct) (const char* str1, const char* str2);
888 int left, right, middle;
891 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
893 // Look for the slot we should put that file into (binary search)
895 right = pack->numfiles - 1;
896 while (left <= right)
900 middle = (left + right) / 2;
901 diff = strcmp_funct (pack->files[middle].name, name);
903 // If we found the file, there's a problem
905 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
907 // If we're too far in the list
914 // We have to move the right of the list by one slot to free the one we need
915 pfile = &pack->files[left];
916 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
919 strlcpy (pfile->name, name, sizeof (pfile->name));
920 pfile->offset = offset;
921 pfile->packsize = packsize;
922 pfile->realsize = realsize;
923 pfile->flags = flags;
929 static void FS_mkdir (const char *path)
931 if(COM_CheckParm("-readonly"))
935 if (_mkdir (path) == -1)
937 if (mkdir (path, 0777) == -1)
940 // No logging for this. The only caller is FS_CreatePath (which
941 // calls it in ways that will intentionally produce EEXIST),
942 // and its own callers always use the directory afterwards and
943 // thus will detect failure that way.
952 Only used for FS_OpenRealFile.
955 void FS_CreatePath (char *path)
959 for (ofs = path+1 ; *ofs ; ofs++)
961 if (*ofs == '/' || *ofs == '\\')
963 // create the directory
979 static void FS_Path_f(cmd_state_t *cmd)
983 Con_Print("Current search path:\n");
984 for (s=fs_searchpaths ; s ; s=s->next)
989 Con_Printf("%sdir (virtual pack)\n", s->pack->filename);
991 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
994 Con_Printf("%s\n", s->filename);
1004 /*! Takes an explicit (not game tree related) path to a pak file.
1005 *Loads the header and directory, adding the files at the beginning
1006 *of the list so they override previous pack files.
1008 static pack_t *FS_LoadPackPAK (const char *packfile)
1010 dpackheader_t header;
1011 int i, numpackfiles;
1012 filedesc_t packhandle;
1016 packhandle = FS_SysOpenFiledesc(packfile, "rb", false);
1017 if (!FILEDESC_ISVALID(packhandle))
1019 if(FILEDESC_READ (packhandle, (void *)&header, sizeof(header)) != sizeof(header))
1021 Con_Printf ("%s is not a packfile\n", packfile);
1022 FILEDESC_CLOSE(packhandle);
1025 if (memcmp(header.id, "PACK", 4))
1027 Con_Printf ("%s is not a packfile\n", packfile);
1028 FILEDESC_CLOSE(packhandle);
1031 header.dirofs = LittleLong (header.dirofs);
1032 header.dirlen = LittleLong (header.dirlen);
1034 if (header.dirlen % sizeof(dpackfile_t))
1036 Con_Printf ("%s has an invalid directory size\n", packfile);
1037 FILEDESC_CLOSE(packhandle);
1041 numpackfiles = header.dirlen / sizeof(dpackfile_t);
1043 if (numpackfiles < 0 || numpackfiles > MAX_FILES_IN_PACK)
1045 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
1046 FILEDESC_CLOSE(packhandle);
1050 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
1051 FILEDESC_SEEK (packhandle, header.dirofs, SEEK_SET);
1052 if(header.dirlen != FILEDESC_READ (packhandle, (void *)info, header.dirlen))
1054 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
1056 FILEDESC_CLOSE(packhandle);
1060 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1061 pack->ignorecase = true; // PAK is sensitive in Quake1 but insensitive in Quake2
1062 strlcpy (pack->filename, packfile, sizeof (pack->filename));
1063 pack->handle = packhandle;
1065 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
1067 // parse the directory
1068 for (i = 0;i < numpackfiles;i++)
1070 fs_offset_t offset = (unsigned int)LittleLong (info[i].filepos);
1071 fs_offset_t size = (unsigned int)LittleLong (info[i].filelen);
1073 // Ensure a zero terminated file name (required by format).
1074 info[i].name[sizeof(info[i].name) - 1] = 0;
1076 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
1081 Con_DPrintf("Added packfile %s (%i files)\n", packfile, numpackfiles);
1086 ====================
1089 Create a package entry associated with a directory file
1090 ====================
1092 static pack_t *FS_LoadPackVirtual (const char *dirname)
1095 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1097 pack->ignorecase = false;
1098 strlcpy (pack->filename, dirname, sizeof(pack->filename));
1099 pack->handle = FILEDESC_INVALID;
1100 pack->numfiles = -1;
1102 Con_DPrintf("Added packfile %s (virtual pack)\n", dirname);
1111 /*! Adds the given pack to the search path.
1112 * The pack type is autodetected by the file extension.
1114 * Returns true if the file was successfully added to the
1115 * search path or if it was already included.
1117 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1118 * plain directories.
1121 static qboolean FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qboolean *already_loaded, qboolean keep_plain_dirs)
1123 searchpath_t *search;
1125 const char *ext = FS_FileExtension(pakfile);
1128 for(search = fs_searchpaths; search; search = search->next)
1130 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
1133 *already_loaded = true;
1134 return true; // already loaded
1139 *already_loaded = false;
1141 if(!strcasecmp(ext, "pk3dir"))
1142 pak = FS_LoadPackVirtual (pakfile);
1143 else if(!strcasecmp(ext, "pak"))
1144 pak = FS_LoadPackPAK (pakfile);
1145 else if(!strcasecmp(ext, "pk3"))
1146 pak = FS_LoadPackPK3 (pakfile);
1147 else if(!strcasecmp(ext, "obb")) // android apk expansion
1148 pak = FS_LoadPackPK3 (pakfile);
1150 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
1154 strlcpy(pak->shortname, shortname, sizeof(pak->shortname));
1156 //Con_DPrintf(" Registered pack with short name %s\n", shortname);
1159 // find the first item whose next one is a pack or NULL
1160 searchpath_t *insertion_point = 0;
1161 if(fs_searchpaths && !fs_searchpaths->pack)
1163 insertion_point = fs_searchpaths;
1166 if(!insertion_point->next)
1168 if(insertion_point->next->pack)
1170 insertion_point = insertion_point->next;
1173 // If insertion_point is NULL, this means that either there is no
1174 // item in the list yet, or that the very first item is a pack. In
1175 // that case, we want to insert at the beginning...
1176 if(!insertion_point)
1178 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1179 search->next = fs_searchpaths;
1180 fs_searchpaths = search;
1183 // otherwise we want to append directly after insertion_point.
1185 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1186 search->next = insertion_point->next;
1187 insertion_point->next = search;
1192 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1193 search->next = fs_searchpaths;
1194 fs_searchpaths = search;
1199 dpsnprintf(search->filename, sizeof(search->filename), "%s/", pakfile);
1200 // if shortname ends with "pk3dir", strip that suffix to make it just "pk3"
1201 // same goes for the name inside the pack structure
1202 l = strlen(pak->shortname);
1204 if(!strcasecmp(pak->shortname + l - 7, ".pk3dir"))
1205 pak->shortname[l - 3] = 0;
1206 l = strlen(pak->filename);
1208 if(!strcasecmp(pak->filename + l - 7, ".pk3dir"))
1209 pak->filename[l - 3] = 0;
1215 Con_Printf(CON_ERROR "unable to load pak \"%s\"\n", pakfile);
1226 /*! Adds the given pack to the search path and searches for it in the game path.
1227 * The pack type is autodetected by the file extension.
1229 * Returns true if the file was successfully added to the
1230 * search path or if it was already included.
1232 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1233 * plain directories.
1235 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
1237 char fullpath[MAX_OSPATH];
1239 searchpath_t *search;
1242 *already_loaded = false;
1244 // then find the real name...
1245 search = FS_FindFile(pakfile, &index, true);
1246 if(!search || search->pack)
1248 Con_Printf("could not find pak \"%s\"\n", pakfile);
1252 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
1254 return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs);
1262 Sets fs_gamedir, adds the directory to the head of the path,
1263 then loads and adds pak1.pak pak2.pak ...
1266 static void FS_AddGameDirectory (const char *dir)
1270 searchpath_t *search;
1272 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
1274 stringlistinit(&list);
1275 listdirectory(&list, "", dir);
1276 stringlistsort(&list, false);
1278 // add any PAK package in the directory
1279 for (i = 0;i < list.numstrings;i++)
1281 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
1283 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1287 // add any PK3 package in the directory
1288 for (i = 0;i < list.numstrings;i++)
1290 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3") || !strcasecmp(FS_FileExtension(list.strings[i]), "obb") || !strcasecmp(FS_FileExtension(list.strings[i]), "pk3dir"))
1292 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1296 stringlistfreecontents(&list);
1298 // Add the directory to the search path
1299 // (unpacked files have the priority over packed files)
1300 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1301 strlcpy (search->filename, dir, sizeof (search->filename));
1302 search->next = fs_searchpaths;
1303 fs_searchpaths = search;
1312 static void FS_AddGameHierarchy (const char *dir)
1315 // Add the common game directory
1316 FS_AddGameDirectory (va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, dir));
1319 FS_AddGameDirectory(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, dir));
1328 const char *FS_FileExtension (const char *in)
1330 const char *separator, *backslash, *colon, *dot;
1332 separator = strrchr(in, '/');
1333 backslash = strrchr(in, '\\');
1334 if (!separator || separator < backslash)
1335 separator = backslash;
1336 colon = strrchr(in, ':');
1337 if (!separator || separator < colon)
1340 dot = strrchr(in, '.');
1341 if (dot == NULL || (separator && (dot < separator)))
1353 const char *FS_FileWithoutPath (const char *in)
1355 const char *separator, *backslash, *colon;
1357 separator = strrchr(in, '/');
1358 backslash = strrchr(in, '\\');
1359 if (!separator || separator < backslash)
1360 separator = backslash;
1361 colon = strrchr(in, ':');
1362 if (!separator || separator < colon)
1364 return separator ? separator + 1 : in;
1373 static void FS_ClearSearchPath (void)
1375 // unload all packs and directory information, close all pack files
1376 // (if a qfile is still reading a pack it won't be harmed because it used
1377 // dup() to get its own handle already)
1378 while (fs_searchpaths)
1380 searchpath_t *search = fs_searchpaths;
1381 fs_searchpaths = search->next;
1382 if (search->pack && search->pack != fs_selfpack)
1384 if(!search->pack->vpack)
1387 FILEDESC_CLOSE(search->pack->handle);
1388 // free any memory associated with it
1389 if (search->pack->files)
1390 Mem_Free(search->pack->files);
1392 Mem_Free(search->pack);
1398 static void FS_AddSelfPack(void)
1402 searchpath_t *search;
1403 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1404 search->next = fs_searchpaths;
1405 search->pack = fs_selfpack;
1406 fs_searchpaths = search;
1416 void FS_Rescan (void)
1419 qboolean fs_modified = false;
1420 qboolean reset = false;
1421 char gamedirbuf[MAX_INPUTLINE];
1426 FS_ClearSearchPath();
1428 // automatically activate gamemode for the gamedirs specified
1430 COM_ChangeGameTypeForGameDirs();
1432 // add the game-specific paths
1433 // gamedirname1 (typically id1)
1434 FS_AddGameHierarchy (gamedirname1);
1435 // update the com_modname (used for server info)
1436 if (gamedirname2 && gamedirname2[0])
1437 strlcpy(com_modname, gamedirname2, sizeof(com_modname));
1439 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1441 // add the game-specific path, if any
1442 // (only used for mission packs and the like, which should set fs_modified)
1443 if (gamedirname2 && gamedirname2[0])
1446 FS_AddGameHierarchy (gamedirname2);
1450 // Adds basedir/gamedir as an override game
1451 // LadyHavoc: now supports multiple -game directories
1452 // set the com_modname (reported in server info)
1454 for (i = 0;i < fs_numgamedirs;i++)
1457 FS_AddGameHierarchy (fs_gamedirs[i]);
1458 // update the com_modname (used server info)
1459 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1461 strlcat(gamedirbuf, va(vabuf, sizeof(vabuf), " %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1463 strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1465 Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1467 // add back the selfpack as new first item
1470 // set the default screenshot name to either the mod name or the
1471 // gamemode screenshot name
1472 if (strcmp(com_modname, gamedirname1))
1473 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1475 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1477 if((i = COM_CheckParm("-modname")) && i < sys.argc - 1)
1478 strlcpy(com_modname, sys.argv[i+1], sizeof(com_modname));
1480 // If "-condebug" is in the command line, remove the previous log file
1481 if (COM_CheckParm ("-condebug") != 0)
1482 unlink (va(vabuf, sizeof(vabuf), "%s/qconsole.log", fs_gamedir));
1484 // look for the pop.lmp file and set registered to true if it is found
1485 if (FS_FileExists("gfx/pop.lmp"))
1486 Cvar_SetValueQuick(®istered, 1);
1492 if (!registered.integer)
1495 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1497 Con_Print("Playing shareware version.\n");
1500 Con_Print("Playing registered version.\n");
1502 case GAME_STEELSTORM:
1503 if (registered.integer)
1504 Con_Print("Playing registered version.\n");
1506 Con_Print("Playing shareware version.\n");
1512 // unload all wads so that future queries will return the new data
1516 static void FS_Rescan_f(cmd_state_t *cmd)
1526 extern qboolean vid_opened;
1527 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing)
1532 if (fs_numgamedirs == numgamedirs)
1534 for (i = 0;i < numgamedirs;i++)
1535 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1537 if (i == numgamedirs)
1538 return true; // already using this set of gamedirs, do nothing
1541 if (numgamedirs > MAX_GAMEDIRS)
1544 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1545 return false; // too many gamedirs
1548 for (i = 0;i < numgamedirs;i++)
1550 // if string is nasty, reject it
1551 p = FS_CheckGameDir(gamedirs[i]);
1555 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1556 return false; // nasty gamedirs
1558 if(p == fs_checkgamedir_missing && failmissing)
1561 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1562 return false; // missing gamedirs
1568 fs_numgamedirs = numgamedirs;
1569 for (i = 0;i < fs_numgamedirs;i++)
1570 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1572 // reinitialize filesystem to detect the new paks
1575 if (cls.demoplayback)
1577 CL_Disconnect_f(&cmd_client);
1581 // unload all sounds so they will be reloaded from the new files as needed
1582 S_UnloadAllSounds_f(&cmd_client);
1584 // restart the video subsystem after the config is executed
1585 Cbuf_InsertText(&cmd_client, "\nloadconfig\nvid_restart\n\n");
1595 static void FS_GameDir_f(cmd_state_t *cmd)
1599 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1601 if (Cmd_Argc(cmd) < 2)
1603 Con_Printf("gamedirs active:");
1604 for (i = 0;i < fs_numgamedirs;i++)
1605 Con_Printf(" %s", fs_gamedirs[i]);
1610 numgamedirs = Cmd_Argc(cmd) - 1;
1611 if (numgamedirs > MAX_GAMEDIRS)
1613 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1617 for (i = 0;i < numgamedirs;i++)
1618 strlcpy(gamedirs[i], Cmd_Argv(cmd, i+1), sizeof(gamedirs[i]));
1620 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1622 // actually, changing during game would work fine, but would be stupid
1623 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1627 // halt demo playback to close the file
1630 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1633 static const char *FS_SysCheckGameDir(const char *gamedir, char *buf, size_t buflength)
1641 stringlistinit(&list);
1642 listdirectory(&list, gamedir, "");
1643 success = list.numstrings > 0;
1644 stringlistfreecontents(&list);
1648 f = FS_SysOpen(va(vabuf, sizeof(vabuf), "%smodinfo.txt", gamedir), "r", false);
1651 n = FS_Read (f, buf, buflength - 1);
1671 const char *FS_CheckGameDir(const char *gamedir)
1674 static char buf[8192];
1677 if (FS_CheckNastyPath(gamedir, true))
1680 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, gamedir), buf, sizeof(buf));
1685 // get description from basedir
1686 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1694 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1698 return fs_checkgamedir_missing;
1701 static void FS_ListGameDirs(void)
1703 stringlist_t list, list2;
1708 fs_all_gamedirs_count = 0;
1710 Mem_Free(fs_all_gamedirs);
1712 stringlistinit(&list);
1713 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_basedir), "");
1714 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_userdir), "");
1715 stringlistsort(&list, false);
1717 stringlistinit(&list2);
1718 for(i = 0; i < list.numstrings; ++i)
1721 if(!strcmp(list.strings[i-1], list.strings[i]))
1723 info = FS_CheckGameDir(list.strings[i]);
1726 if(info == fs_checkgamedir_missing)
1730 stringlistappend(&list2, list.strings[i]);
1732 stringlistfreecontents(&list);
1734 fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1735 for(i = 0; i < list2.numstrings; ++i)
1737 info = FS_CheckGameDir(list2.strings[i]);
1738 // all this cannot happen any more, but better be safe than sorry
1741 if(info == fs_checkgamedir_missing)
1745 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[fs_all_gamedirs_count].name));
1746 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[fs_all_gamedirs_count].description));
1747 ++fs_all_gamedirs_count;
1753 #pragma comment(lib, "shell32.lib")
1758 static void COM_InsertFlags(const char *buf) {
1761 const char **new_argv;
1763 int args_left = 256;
1764 new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*sys.argv) * (sys.argc + args_left + 2));
1766 new_argv[0] = "dummy"; // Can't really happen.
1768 new_argv[0] = sys.argv[0];
1771 while(COM_ParseToken_Console(&p))
1773 size_t sz = strlen(com_token) + 1; // shut up clang
1776 q = (char *)Mem_Alloc(fs_mempool, sz);
1777 strlcpy(q, com_token, sz);
1781 // Now: i <= args_left + 1.
1784 memcpy((char *)(&new_argv[i]), &sys.argv[1], sizeof(*sys.argv) * (sys.argc - 1));
1787 // Now: i <= args_left + (sys.argc || 1).
1789 sys.argv = new_argv;
1793 static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t userdirsize)
1795 #if defined(__IPHONEOS__)
1796 if (userdirmode == USERDIRMODE_HOME)
1798 // fs_basedir is "" by default, to utilize this you can simply add your gamedir to the Resources in xcode
1799 // fs_userdir stores configurations to the Documents folder of the app
1800 strlcpy(userdir, "../Documents/", MAX_OSPATH);
1805 #elif defined(WIN32)
1807 #if _MSC_VER >= 1400
1810 TCHAR mydocsdir[MAX_PATH + 1];
1811 wchar_t *savedgamesdirw;
1812 char savedgamesdir[MAX_OSPATH];
1821 case USERDIRMODE_NOHOME:
1822 strlcpy(userdir, fs_basedir, userdirsize);
1824 case USERDIRMODE_MYGAMES:
1826 Sys_LoadLibrary(shfolderdllnames, &shfolder_dll, shfolderfuncs);
1828 if (qSHGetFolderPath && qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)
1830 dpsnprintf(userdir, userdirsize, "%s/My Games/%s/", mydocsdir, gameuserdirname);
1833 #if _MSC_VER >= 1400
1834 _dupenv_s(&homedir, &homedirlen, "USERPROFILE");
1837 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1842 homedir = getenv("USERPROFILE");
1845 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1850 case USERDIRMODE_SAVEDGAMES:
1852 Sys_LoadLibrary(shell32dllnames, &shell32_dll, shell32funcs);
1854 Sys_LoadLibrary(ole32dllnames, &ole32_dll, ole32funcs);
1855 if (qSHGetKnownFolderPath && qCoInitializeEx && qCoTaskMemFree && qCoUninitialize)
1857 savedgamesdir[0] = 0;
1858 qCoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
1861 if (SHGetKnownFolderPath(FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1863 if (SHGetKnownFolderPath(&FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1866 if (qSHGetKnownFolderPath(&qFOLDERID_SavedGames, qKF_FLAG_CREATE | qKF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1868 memset(savedgamesdir, 0, sizeof(savedgamesdir));
1869 #if _MSC_VER >= 1400
1870 wcstombs_s(NULL, savedgamesdir, sizeof(savedgamesdir), savedgamesdirw, sizeof(savedgamesdir)-1);
1872 wcstombs(savedgamesdir, savedgamesdirw, sizeof(savedgamesdir)-1);
1874 qCoTaskMemFree(savedgamesdirw);
1877 if (savedgamesdir[0])
1879 dpsnprintf(userdir, userdirsize, "%s/%s/", savedgamesdir, gameuserdirname);
1894 case USERDIRMODE_NOHOME:
1895 strlcpy(userdir, fs_basedir, userdirsize);
1897 case USERDIRMODE_HOME:
1898 homedir = getenv("HOME");
1901 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1905 case USERDIRMODE_SAVEDGAMES:
1906 homedir = getenv("HOME");
1910 dpsnprintf(userdir, userdirsize, "%s/Library/Application Support/%s/", homedir, gameuserdirname);
1912 // the XDG say some files would need to go in:
1913 // XDG_CONFIG_HOME (or ~/.config/%s/)
1914 // XDG_DATA_HOME (or ~/.local/share/%s/)
1915 // XDG_CACHE_HOME (or ~/.cache/%s/)
1916 // and also search the following global locations if defined:
1917 // XDG_CONFIG_DIRS (normally /etc/xdg/%s/)
1918 // XDG_DATA_DIRS (normally /usr/share/%s/)
1919 // this would be too complicated...
1929 #if !defined(__IPHONEOS__)
1932 // historical behavior...
1933 if (userdirmode == USERDIRMODE_NOHOME && strcmp(gamedirname1, "id1"))
1934 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
1937 // see if we can write to this path (note: won't create path)
1939 // no access() here, we must try to open the file for appending
1940 fd = FS_SysOpenFiledesc(va(vabuf, sizeof(vabuf), "%s%s/config.cfg", userdir, gamedirname1), "a", false);
1944 // on Unix, we don't need to ACTUALLY attempt to open the file
1945 if(access(va(vabuf, sizeof(vabuf), "%s%s/", userdir, gamedirname1), W_OK | X_OK) >= 0)
1952 return 1; // good choice - the path exists and is writable
1956 if (userdirmode == USERDIRMODE_NOHOME)
1957 return -1; // path usually already exists, we lack permissions
1959 return 0; // probably good - failed to write but maybe we need to create path
1964 void FS_Init_Commands(void)
1966 Cvar_RegisterVariable (&scr_screenshot_name);
1967 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1968 Cvar_RegisterVariable (&cvar_fs_gamedir);
1970 Cmd_AddCommand(CMD_SHARED, "gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1971 Cmd_AddCommand(CMD_SHARED, "fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1972 Cmd_AddCommand(CMD_SHARED, "path", FS_Path_f, "print searchpath (game directories and archives)");
1973 Cmd_AddCommand(CMD_SHARED, "dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1974 Cmd_AddCommand(CMD_SHARED, "ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1975 Cmd_AddCommand(CMD_SHARED, "which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
1978 static void FS_Init_Dir (void)
1988 // Overrides the system supplied base directory (under GAMENAME)
1989 // 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)
1990 i = COM_CheckParm ("-basedir");
1991 if (i && i < sys.argc-1)
1993 strlcpy (fs_basedir, sys.argv[i+1], sizeof (fs_basedir));
1994 i = (int)strlen (fs_basedir);
1995 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1996 fs_basedir[i-1] = 0;
2000 // If the base directory is explicitly defined by the compilation process
2001 #ifdef DP_FS_BASEDIR
2002 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
2003 #elif defined(__ANDROID__)
2004 dpsnprintf(fs_basedir, sizeof(fs_basedir), "/sdcard/%s/", gameuserdirname);
2005 #elif defined(MACOSX)
2006 // FIXME: is there a better way to find the directory outside the .app, without using Objective-C?
2007 if (strstr(sys.argv[0], ".app/"))
2010 strlcpy(fs_basedir, sys.argv[0], sizeof(fs_basedir));
2011 split = strstr(fs_basedir, ".app/");
2014 struct stat statresult;
2016 // truncate to just after the .app/
2018 // see if gamedir exists in Resources
2019 if (stat(va(vabuf, sizeof(vabuf), "%s/Contents/Resources/%s", fs_basedir, gamedirname1), &statresult) == 0)
2021 // found gamedir inside Resources, use it
2022 strlcat(fs_basedir, "Contents/Resources/", sizeof(fs_basedir));
2026 // no gamedir found in Resources, gamedir is probably
2027 // outside the .app, remove .app part of path
2028 while (split > fs_basedir && *split != '/')
2037 // make sure the appending of a path separator won't create an unterminated string
2038 memset(fs_basedir + sizeof(fs_basedir) - 2, 0, 2);
2039 // add a path separator to the end of the basedir if it lacks one
2040 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
2041 strlcat(fs_basedir, "/", sizeof(fs_basedir));
2043 // Add the personal game directory
2044 if((i = COM_CheckParm("-userdir")) && i < sys.argc - 1)
2045 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", sys.argv[i+1]);
2046 else if (COM_CheckParm("-nohome"))
2047 *fs_userdir = 0; // user wants roaming installation, no userdir
2050 #ifdef DP_FS_USERDIR
2051 strlcpy(fs_userdir, DP_FS_USERDIR, sizeof(fs_userdir));
2054 int highestuserdirmode = USERDIRMODE_COUNT - 1;
2055 int preferreduserdirmode = USERDIRMODE_COUNT - 1;
2056 int userdirstatus[USERDIRMODE_COUNT];
2058 // historical behavior...
2059 if (!strcmp(gamedirname1, "id1"))
2060 preferreduserdirmode = USERDIRMODE_NOHOME;
2062 // check what limitations the user wants to impose
2063 if (COM_CheckParm("-home")) preferreduserdirmode = USERDIRMODE_HOME;
2064 if (COM_CheckParm("-mygames")) preferreduserdirmode = USERDIRMODE_MYGAMES;
2065 if (COM_CheckParm("-savedgames")) preferreduserdirmode = USERDIRMODE_SAVEDGAMES;
2066 // gather the status of the possible userdirs
2067 for (dirmode = 0;dirmode < USERDIRMODE_COUNT;dirmode++)
2069 userdirstatus[dirmode] = FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2070 if (userdirstatus[dirmode] == 1)
2071 Con_DPrintf("userdir %i = %s (writable)\n", dirmode, fs_userdir);
2072 else if (userdirstatus[dirmode] == 0)
2073 Con_DPrintf("userdir %i = %s (not writable or does not exist)\n", dirmode, fs_userdir);
2075 Con_DPrintf("userdir %i (not applicable)\n", dirmode);
2077 // some games may prefer writing to basedir, but if write fails we
2078 // have to search for a real userdir...
2079 if (preferreduserdirmode == 0 && userdirstatus[0] < 1)
2080 preferreduserdirmode = highestuserdirmode;
2081 // check for an existing userdir and continue using it if possible...
2082 for (dirmode = USERDIRMODE_COUNT - 1;dirmode > 0;dirmode--)
2083 if (userdirstatus[dirmode] == 1)
2085 // if no existing userdir found, make a new one...
2086 if (dirmode == 0 && preferreduserdirmode > 0)
2087 for (dirmode = preferreduserdirmode;dirmode > 0;dirmode--)
2088 if (userdirstatus[dirmode] >= 0)
2090 // and finally, we picked one...
2091 FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2092 Con_DPrintf("userdir %i is the winner\n", dirmode);
2096 // if userdir equal to basedir, clear it to avoid confusion later
2097 if (!strcmp(fs_basedir, fs_userdir))
2102 p = FS_CheckGameDir(gamedirname1);
2103 if(!p || p == fs_checkgamedir_missing)
2104 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
2108 p = FS_CheckGameDir(gamedirname2);
2109 if(!p || p == fs_checkgamedir_missing)
2110 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
2114 // Adds basedir/gamedir as an override game
2115 // LadyHavoc: now supports multiple -game directories
2116 for (i = 1;i < sys.argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
2120 if (!strcmp (sys.argv[i], "-game") && i < sys.argc-1)
2123 p = FS_CheckGameDir(sys.argv[i]);
2125 Con_Printf("WARNING: Nasty -game name rejected: %s\n", sys.argv[i]);
2126 if(p == fs_checkgamedir_missing)
2127 Con_Printf(CON_WARN "WARNING: -game %s%s/ not found!\n", fs_basedir, sys.argv[i]);
2128 // add the gamedir to the list of active gamedirs
2129 strlcpy (fs_gamedirs[fs_numgamedirs], sys.argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
2134 // generate the searchpath
2137 if (Thread_HasThreads())
2138 fs_mutex = Thread_CreateMutex();
2146 void FS_Init_SelfPack (void)
2150 // Load darkplaces.opt from the FS.
2151 if (!COM_CheckParm("-noopt"))
2153 buf = (char *) FS_SysLoadFile("darkplaces.opt", tempmempool, true, NULL);
2156 COM_InsertFlags(buf);
2162 // Provide the SelfPack.
2163 if (!COM_CheckParm("-noselfpack") && sys.selffd >= 0)
2165 fs_selfpack = FS_LoadPackPK3FromFD(sys.argv[0], sys.selffd, true);
2169 if (!COM_CheckParm("-noopt"))
2171 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
2174 COM_InsertFlags(buf);
2191 fs_mempool = Mem_AllocPool("file management", 0, NULL);
2197 // initialize the self-pack (must be before COM_InitGameType as it may add command line options)
2200 // detect gamemode from commandline options or executable name
2211 void FS_Shutdown (void)
2213 // close all pack files and such
2214 // (hopefully there aren't any other open files, but they'll be cleaned up
2215 // by the OS anyway)
2216 FS_ClearSearchPath();
2217 Mem_FreePool (&fs_mempool);
2218 PK3_CloseLibrary ();
2221 Sys_UnloadLibrary (&shfolder_dll);
2222 Sys_UnloadLibrary (&shell32_dll);
2223 Sys_UnloadLibrary (&ole32_dll);
2227 Thread_DestroyMutex(fs_mutex);
2230 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qboolean nonblocking)
2232 filedesc_t handle = FILEDESC_INVALID;
2235 qboolean dolock = false;
2237 // Parse the mode string
2246 opt = O_CREAT | O_TRUNC;
2250 opt = O_CREAT | O_APPEND;
2253 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
2254 return FILEDESC_INVALID;
2256 for (ind = 1; mode[ind] != '\0'; ind++)
2270 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
2271 filepath, mode, mode[ind]);
2278 if(COM_CheckParm("-readonly") && mod != O_RDONLY)
2279 return FILEDESC_INVALID;
2283 return FILEDESC_INVALID;
2284 handle = SDL_RWFromFile(filepath, mode);
2287 # if _MSC_VER >= 1400
2288 _sopen_s(&handle, filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2290 handle = _sopen (filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2293 handle = open (filepath, mod | opt, 0666);
2294 if(handle >= 0 && dolock)
2297 l.l_type = ((mod == O_RDONLY) ? F_RDLCK : F_WRLCK);
2298 l.l_whence = SEEK_SET;
2301 if(fcntl(handle, F_SETLK, &l) == -1)
2303 FILEDESC_CLOSE(handle);
2313 int FS_SysOpenFD(const char *filepath, const char *mode, qboolean nonblocking)
2318 return FS_SysOpenFiledesc(filepath, mode, nonblocking);
2323 ====================
2326 Internal function used to create a qfile_t and open the relevant non-packed file on disk
2327 ====================
2329 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
2333 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2335 file->handle = FS_SysOpenFiledesc(filepath, mode, nonblocking);
2336 if (!FILEDESC_ISVALID(file->handle))
2342 file->filename = Mem_strdup(fs_mempool, filepath);
2344 file->real_length = FILEDESC_SEEK (file->handle, 0, SEEK_END);
2346 // For files opened in append mode, we start at the end of the file
2348 file->position = file->real_length;
2350 FILEDESC_SEEK (file->handle, 0, SEEK_SET);
2360 Open a packed file using its package file descriptor
2363 static qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
2366 filedesc_t dup_handle;
2369 pfile = &pack->files[pack_ind];
2371 // If we don't have the true offset, get it now
2372 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
2373 if (!PK3_GetTrueFileOffset (pfile, pack))
2376 #ifndef LINK_TO_ZLIB
2377 // No Zlib DLL = no compressed files
2378 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2380 Con_Printf(CON_WARN "WARNING: can't open the compressed file %s\n"
2381 "You need the Zlib DLL to use compressed files\n",
2387 // LadyHavoc: FILEDESC_SEEK affects all duplicates of a handle so we do it before
2388 // the dup() call to avoid having to close the dup_handle on error here
2389 if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
2391 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %08x%08x)\n",
2392 pfile->name, pack->filename, (unsigned int)(pfile->offset >> 32), (unsigned int)(pfile->offset));
2396 dup_handle = FILEDESC_DUP (pack->filename, pack->handle);
2397 if (!FILEDESC_ISVALID(dup_handle))
2399 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2403 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2404 memset (file, 0, sizeof (*file));
2405 file->handle = dup_handle;
2406 file->flags = QFILE_FLAG_PACKED;
2407 file->real_length = pfile->realsize;
2408 file->offset = pfile->offset;
2412 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2416 file->flags |= QFILE_FLAG_DEFLATED;
2418 // We need some more variables
2419 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2421 ztk->comp_length = pfile->packsize;
2423 // Initialize zlib stream
2424 ztk->zstream.next_in = ztk->input;
2425 ztk->zstream.avail_in = 0;
2427 /* From Zlib's "unzip.c":
2429 * windowBits is passed < 0 to tell that there is no zlib header.
2430 * Note that in this case inflate *requires* an extra "dummy" byte
2431 * after the compressed stream in order to complete decompression and
2432 * return Z_STREAM_END.
2433 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2434 * size of both compressed and uncompressed data
2436 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2438 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2439 FILEDESC_CLOSE(dup_handle);
2444 ztk->zstream.next_out = file->buff;
2445 ztk->zstream.avail_out = sizeof (file->buff);
2454 ====================
2457 Return true if the path should be rejected due to one of the following:
2458 1: path elements that are non-portable
2459 2: path elements that would allow access to files outside the game directory,
2460 or are just not a good idea for a mod to be using.
2461 ====================
2463 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
2465 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2469 // Windows: don't allow \ in filenames (windows-only), period.
2470 // (on Windows \ is a directory separator, but / is also supported)
2471 if (strstr(path, "\\"))
2472 return 1; // non-portable
2474 // Mac: don't allow Mac-only filenames - : is a directory separator
2475 // instead of /, but we rely on / working already, so there's no reason to
2476 // support a Mac-only path
2477 // Amiga and Windows: : tries to go to root of drive
2478 if (strstr(path, ":"))
2479 return 1; // non-portable attempt to go to root of drive
2481 // Amiga: // is parent directory
2482 if (strstr(path, "//"))
2483 return 1; // non-portable attempt to go to parent directory
2485 // all: don't allow going to parent directory (../ or /../)
2486 if (strstr(path, ".."))
2487 return 2; // attempt to go outside the game directory
2489 // Windows and UNIXes: don't allow absolute paths
2491 return 2; // attempt to go outside the game directory
2493 // all: don't allow . character immediately before a slash, this catches all imaginable cases of ./, ../, .../, etc
2494 if (strstr(path, "./"))
2495 return 2; // possible attempt to go outside the game directory
2497 // all: forbid trailing slash on gamedir
2498 if (isgamedir && path[strlen(path)-1] == '/')
2501 // all: forbid leading dot on any filename for any reason
2502 if (strstr(path, "/."))
2503 return 2; // attempt to go outside the game directory
2505 // after all these checks we're pretty sure it's a / separated filename
2506 // and won't do much if any harm
2512 ====================
2515 Look for a file in the packages and in the filesystem
2517 Return the searchpath where the file was found (or NULL)
2518 and the file index in the package if relevant
2519 ====================
2521 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
2523 searchpath_t *search;
2526 // search through the path, one element at a time
2527 for (search = fs_searchpaths;search;search = search->next)
2529 // is the element a pak file?
2530 if (search->pack && !search->pack->vpack)
2532 int (*strcmp_funct) (const char* str1, const char* str2);
2533 int left, right, middle;
2536 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2538 // Look for the file (binary search)
2540 right = pak->numfiles - 1;
2541 while (left <= right)
2545 middle = (left + right) / 2;
2546 diff = strcmp_funct (pak->files[middle].name, name);
2551 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2553 // yes, but the first one is empty so we treat it as not being there
2554 if (!quiet && developer_extra.integer)
2555 Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2562 if (!quiet && developer_extra.integer)
2563 Con_DPrintf("FS_FindFile: %s in %s\n",
2564 pak->files[middle].name, pak->filename);
2571 // If we're too far in the list
2580 char netpath[MAX_OSPATH];
2581 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2582 if (FS_SysFileExists (netpath))
2584 if (!quiet && developer_extra.integer)
2585 Con_DPrintf("FS_FindFile: %s\n", netpath);
2594 if (!quiet && developer_extra.integer)
2595 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2607 Look for a file in the search paths and open it in read-only mode
2610 static qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking, int symlinkLevels)
2612 searchpath_t *search;
2615 search = FS_FindFile (filename, &pack_ind, quiet);
2621 // Found in the filesystem?
2624 // this works with vpacks, so we are fine
2625 char path [MAX_OSPATH];
2626 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2627 return FS_SysOpen (path, "rb", nonblocking);
2630 // So, we found it in a package...
2632 // Is it a PK3 symlink?
2633 // TODO also handle directory symlinks by parsing the whole structure...
2634 // but heck, file symlinks are good enough for now
2635 if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2637 if(symlinkLevels <= 0)
2639 Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2644 char linkbuf[MAX_QPATH];
2646 qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2647 const char *mergeslash;
2652 count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2658 // Now combine the paths...
2659 mergeslash = strrchr(filename, '/');
2660 mergestart = linkbuf;
2662 mergeslash = filename;
2663 while(!strncmp(mergestart, "../", 3))
2666 while(mergeslash > filename)
2669 if(*mergeslash == '/')
2673 // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2674 if(mergeslash == filename)
2676 // Either mergeslash == filename, then we just replace the name (done below)
2680 // Or, we append the name after mergeslash;
2681 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2682 int spaceNeeded = mergeslash - filename + 1;
2683 int spaceRemoved = mergestart - linkbuf;
2684 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2686 Con_DPrintf("symlink: too long path rejected\n");
2689 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2690 memcpy(linkbuf, filename, spaceNeeded);
2691 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2692 mergestart = linkbuf;
2694 if (!quiet && developer_loading.integer)
2695 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2696 if(FS_CheckNastyPath (mergestart, false))
2698 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2701 return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2705 return FS_OpenPackedFile (search->pack, pack_ind);
2710 =============================================================================
2712 MAIN PUBLIC FUNCTIONS
2714 =============================================================================
2718 ====================
2721 Open a file in the userpath. The syntax is the same as fopen
2722 Used for savegame scanning in menu, and all file writing.
2723 ====================
2725 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet)
2727 char real_path [MAX_OSPATH];
2729 if (FS_CheckNastyPath(filepath, false))
2731 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2735 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2737 // If the file is opened in "write", "append", or "read/write" mode,
2738 // create directories up to the file.
2739 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2740 FS_CreatePath (real_path);
2741 return FS_SysOpen (real_path, mode, false);
2746 ====================
2749 Open a file. The syntax is the same as fopen
2750 ====================
2752 qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet)
2754 qfile_t *result = NULL;
2755 if (FS_CheckNastyPath(filepath, false))
2757 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2761 if (fs_mutex) Thread_LockMutex(fs_mutex);
2762 result = FS_OpenReadFile (filepath, quiet, false, 16);
2763 if (fs_mutex) Thread_UnlockMutex(fs_mutex);
2769 ====================
2772 Open a file. The syntax is the same as fopen
2773 ====================
2775 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet)
2778 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2779 memset (file, 0, sizeof (*file));
2780 file->flags = QFILE_FLAG_DATA;
2782 file->real_length = size;
2788 ====================
2792 ====================
2794 int FS_Close (qfile_t* file)
2796 if(file->flags & QFILE_FLAG_DATA)
2802 if (FILEDESC_CLOSE (file->handle))
2807 if (file->flags & QFILE_FLAG_REMOVE)
2809 if (remove(file->filename) == -1)
2811 // No need to report this. If removing a just
2812 // written file failed, this most likely means
2813 // someone else deleted it first - which we
2818 Mem_Free((void *) file->filename);
2823 qz_inflateEnd (&file->ztk->zstream);
2824 Mem_Free (file->ztk);
2831 void FS_RemoveOnClose(qfile_t* file)
2833 file->flags |= QFILE_FLAG_REMOVE;
2837 ====================
2840 Write "datasize" bytes into a file
2841 ====================
2843 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2845 fs_offset_t written = 0;
2847 // If necessary, seek to the exact file position we're supposed to be
2848 if (file->buff_ind != file->buff_len)
2850 if (FILEDESC_SEEK (file->handle, file->buff_ind - file->buff_len, SEEK_CUR) == -1)
2852 Con_Printf(CON_WARN "WARNING: could not seek in %s.\n", file->filename);
2856 // Purge cached data
2859 // Write the buffer and update the position
2860 // 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)
2861 while (written < (fs_offset_t)datasize)
2863 // figure out how much to write in one chunk
2864 fs_offset_t maxchunk = 1<<30; // 1 GiB
2865 int chunk = (int)min((fs_offset_t)datasize - written, maxchunk);
2866 int result = (int)FILEDESC_WRITE (file->handle, (const unsigned char *)data + written, chunk);
2867 // if at least some was written, add it to our accumulator
2870 // if the result is not what we expected, consider the write to be incomplete
2871 if (result != chunk)
2874 file->position = FILEDESC_SEEK (file->handle, 0, SEEK_CUR);
2875 if (file->real_length < file->position)
2876 file->real_length = file->position;
2878 // note that this will never be less than 0 even if the write failed
2884 ====================
2887 Read up to "buffersize" bytes from a file
2888 ====================
2890 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2892 fs_offset_t count, done;
2894 if (buffersize == 0 || !buffer)
2897 // Get rid of the ungetc character
2898 if (file->ungetc != EOF)
2900 ((char*)buffer)[0] = file->ungetc;
2908 if(file->flags & QFILE_FLAG_DATA)
2910 size_t left = file->real_length - file->position;
2911 if(buffersize > left)
2913 memcpy(buffer, file->data + file->position, buffersize);
2914 file->position += buffersize;
2918 // First, we copy as many bytes as we can from "buff"
2919 if (file->buff_ind < file->buff_len)
2921 count = file->buff_len - file->buff_ind;
2922 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2924 memcpy (buffer, &file->buff[file->buff_ind], count);
2925 file->buff_ind += count;
2927 buffersize -= count;
2928 if (buffersize == 0)
2932 // NOTE: at this point, the read buffer is always empty
2934 // If the file isn't compressed
2935 if (! (file->flags & QFILE_FLAG_DEFLATED))
2939 // We must take care to not read after the end of the file
2940 count = file->real_length - file->position;
2942 // If we have a lot of data to get, put them directly into "buffer"
2943 if (buffersize > sizeof (file->buff) / 2)
2945 if (count > (fs_offset_t)buffersize)
2946 count = (fs_offset_t)buffersize;
2947 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2949 // Seek failed. When reading from a pipe, and
2950 // the caller never called FS_Seek, this still
2951 // works fine. So no reporting this error.
2953 nb = FILEDESC_READ (file->handle, &((unsigned char*)buffer)[done], count);
2957 file->position += nb;
2959 // Purge cached data
2965 if (count > (fs_offset_t)sizeof (file->buff))
2966 count = (fs_offset_t)sizeof (file->buff);
2967 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2969 // Seek failed. When reading from a pipe, and
2970 // the caller never called FS_Seek, this still
2971 // works fine. So no reporting this error.
2973 nb = FILEDESC_READ (file->handle, file->buff, count);
2976 file->buff_len = nb;
2977 file->position += nb;
2979 // Copy the requested data in "buffer" (as much as we can)
2980 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2981 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2982 file->buff_ind = count;
2990 // If the file is compressed, it's more complicated...
2991 // We cycle through a few operations until we have read enough data
2992 while (buffersize > 0)
2994 ztoolkit_t *ztk = file->ztk;
2997 // NOTE: at this point, the read buffer is always empty
2999 // If "input" is also empty, we need to refill it
3000 if (ztk->in_ind == ztk->in_len)
3002 // If we are at the end of the file
3003 if (file->position == file->real_length)
3006 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
3007 if (count > (fs_offset_t)sizeof (ztk->input))
3008 count = (fs_offset_t)sizeof (ztk->input);
3009 FILEDESC_SEEK (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
3010 if (FILEDESC_READ (file->handle, ztk->input, count) != count)
3012 Con_Printf ("FS_Read: unexpected end of file\n");
3017 ztk->in_len = count;
3018 ztk->in_position += count;
3021 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
3022 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
3024 // Now that we are sure we have compressed data available, we need to determine
3025 // if it's better to inflate it in "file->buff" or directly in "buffer"
3027 // Inflate the data in "file->buff"
3028 if (buffersize < sizeof (file->buff) / 2)
3030 ztk->zstream.next_out = file->buff;
3031 ztk->zstream.avail_out = sizeof (file->buff);
3032 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3033 if (error != Z_OK && error != Z_STREAM_END)
3035 Con_Printf ("FS_Read: Can't inflate file\n");
3038 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3040 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
3041 file->position += file->buff_len;
3043 // Copy the requested data in "buffer" (as much as we can)
3044 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3045 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3046 file->buff_ind = count;
3049 // Else, we inflate directly in "buffer"
3052 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
3053 ztk->zstream.avail_out = (unsigned int)buffersize;
3054 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3055 if (error != Z_OK && error != Z_STREAM_END)
3057 Con_Printf ("FS_Read: Can't inflate file\n");
3060 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3062 // How much data did it inflate?
3063 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
3064 file->position += count;
3066 // Purge cached data
3071 buffersize -= count;
3079 ====================
3082 Print a string into a file
3083 ====================
3085 int FS_Print (qfile_t* file, const char *msg)
3087 return (int)FS_Write (file, msg, strlen (msg));
3091 ====================
3094 Print a string into a file
3095 ====================
3097 int FS_Printf(qfile_t* file, const char* format, ...)
3102 va_start (args, format);
3103 result = FS_VPrintf (file, format, args);
3111 ====================
3114 Print a string into a file
3115 ====================
3117 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
3120 fs_offset_t buff_size = MAX_INPUTLINE;
3125 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
3126 len = dpvsnprintf (tempbuff, buff_size, format, ap);
3127 if (len >= 0 && len < buff_size)
3129 Mem_Free (tempbuff);
3133 len = FILEDESC_WRITE (file->handle, tempbuff, len);
3134 Mem_Free (tempbuff);
3141 ====================
3144 Get the next character of a file
3145 ====================
3147 int FS_Getc (qfile_t* file)
3151 if (FS_Read (file, &c, 1) != 1)
3159 ====================
3162 Put a character back into the read buffer (only supports one character!)
3163 ====================
3165 int FS_UnGetc (qfile_t* file, unsigned char c)
3167 // If there's already a character waiting to be read
3168 if (file->ungetc != EOF)
3177 ====================
3180 Move the position index in a file
3181 ====================
3183 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
3186 unsigned char* buffer;
3187 fs_offset_t buffersize;
3189 // Compute the file offset
3193 offset += file->position - file->buff_len + file->buff_ind;
3200 offset += file->real_length;
3206 if (offset < 0 || offset > file->real_length)
3209 if(file->flags & QFILE_FLAG_DATA)
3211 file->position = offset;
3215 // If we have the data in our read buffer, we don't need to actually seek
3216 if (file->position - file->buff_len <= offset && offset <= file->position)
3218 file->buff_ind = offset + file->buff_len - file->position;
3222 // Purge cached data
3225 // Unpacked or uncompressed files can seek directly
3226 if (! (file->flags & QFILE_FLAG_DEFLATED))
3228 if (FILEDESC_SEEK (file->handle, file->offset + offset, SEEK_SET) == -1)
3230 file->position = offset;
3234 // Seeking in compressed files is more a hack than anything else,
3235 // but we need to support it, so here we go.
3238 // If we have to go back in the file, we need to restart from the beginning
3239 if (offset <= file->position)
3243 ztk->in_position = 0;
3245 if (FILEDESC_SEEK (file->handle, file->offset, SEEK_SET) == -1)
3246 Con_Printf("IMPOSSIBLE: couldn't seek in already opened pk3 file.\n");
3248 // Reset the Zlib stream
3249 ztk->zstream.next_in = ztk->input;
3250 ztk->zstream.avail_in = 0;
3251 qz_inflateReset (&ztk->zstream);
3254 // We need a big buffer to force inflating into it directly
3255 buffersize = 2 * sizeof (file->buff);
3256 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
3258 // Skip all data until we reach the requested offset
3259 while (offset > (file->position - file->buff_len + file->buff_ind))
3261 fs_offset_t diff = offset - (file->position - file->buff_len + file->buff_ind);
3262 fs_offset_t count, len;
3264 count = (diff > buffersize) ? buffersize : diff;
3265 len = FS_Read (file, buffer, count);
3279 ====================
3282 Give the current position in a file
3283 ====================
3285 fs_offset_t FS_Tell (qfile_t* file)
3287 return file->position - file->buff_len + file->buff_ind;
3292 ====================
3295 Give the total size of a file
3296 ====================
3298 fs_offset_t FS_FileSize (qfile_t* file)
3300 return file->real_length;
3305 ====================
3308 Erases any buffered input or output data
3309 ====================
3311 void FS_Purge (qfile_t* file)
3321 FS_LoadAndCloseQFile
3323 Loads full content of a qfile_t and closes it.
3324 Always appends a 0 byte.
3327 static unsigned char *FS_LoadAndCloseQFile (qfile_t *file, const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3329 unsigned char *buf = NULL;
3330 fs_offset_t filesize = 0;
3334 filesize = file->real_length;
3337 Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
3342 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
3343 buf[filesize] = '\0';
3344 FS_Read (file, buf, filesize);
3346 if (developer_loadfile.integer)
3347 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
3350 if (filesizepointer)
3351 *filesizepointer = filesize;
3360 Filename are relative to the quake directory.
3361 Always appends a 0 byte.
3364 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3366 qfile_t *file = FS_OpenVirtualFile(path, quiet);
3367 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3375 Filename are OS paths.
3376 Always appends a 0 byte.
3379 unsigned char *FS_SysLoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3381 qfile_t *file = FS_SysOpen(path, "rb", false);
3382 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3390 The filename will be prefixed by the current game directory
3393 qboolean FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
3397 fs_offset_t lentotal;
3399 file = FS_OpenRealFile(filename, "wb", false);
3402 Con_Printf("FS_WriteFile: failed on %s\n", filename);
3407 for(i = 0; i < count; ++i)
3409 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
3410 for(i = 0; i < count; ++i)
3411 FS_Write (file, data[i], len[i]);
3416 qboolean FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
3418 return FS_WriteFileInBlocks(filename, &data, &len, 1);
3423 =============================================================================
3425 OTHERS PUBLIC FUNCTIONS
3427 =============================================================================
3435 void FS_StripExtension (const char *in, char *out, size_t size_out)
3443 while ((currentchar = *in) && size_out > 1)
3445 if (currentchar == '.')
3447 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3449 *out++ = currentchar;
3465 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3469 // if path doesn't have a .EXT, append extension
3470 // (extension should include the .)
3471 src = path + strlen(path);
3473 while (*src != '/' && src != path)
3476 return; // it has an extension
3480 strlcat (path, extension, size_path);
3488 Look for a file in the packages and in the filesystem
3491 int FS_FileType (const char *filename)
3493 searchpath_t *search;
3494 char fullpath[MAX_OSPATH];
3496 search = FS_FindFile (filename, NULL, true);
3498 return FS_FILETYPE_NONE;
3500 if(search->pack && !search->pack->vpack)
3501 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3503 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3504 return FS_SysFileType(fullpath);
3512 Look for a file in the packages and in the filesystem
3515 qboolean FS_FileExists (const char *filename)
3517 return (FS_FindFile (filename, NULL, true) != NULL);
3525 Look for a file in the filesystem only
3528 int FS_SysFileType (const char *path)
3531 // Sajt - some older sdks are missing this define
3532 # ifndef INVALID_FILE_ATTRIBUTES
3533 # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3536 DWORD result = GetFileAttributes(path);
3538 if(result == INVALID_FILE_ATTRIBUTES)
3539 return FS_FILETYPE_NONE;
3541 if(result & FILE_ATTRIBUTE_DIRECTORY)
3542 return FS_FILETYPE_DIRECTORY;
3544 return FS_FILETYPE_FILE;
3548 if (stat (path,&buf) == -1)
3549 return FS_FILETYPE_NONE;
3552 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3554 if(S_ISDIR(buf.st_mode))
3555 return FS_FILETYPE_DIRECTORY;
3557 return FS_FILETYPE_FILE;
3561 qboolean FS_SysFileExists (const char *path)
3563 return FS_SysFileType (path) != FS_FILETYPE_NONE;
3570 Allocate and fill a search structure with information on matching filenames.
3573 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet, const char *packfile)
3576 searchpath_t *searchpath;
3578 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3579 stringlist_t resultlist;
3580 stringlist_t dirlist;
3581 stringlist_t matchedSet, foundSet;
3582 const char *start, *slash, *backslash, *colon, *separator;
3585 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3590 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3594 stringlistinit(&resultlist);
3595 stringlistinit(&dirlist);
3597 slash = strrchr(pattern, '/');
3598 backslash = strrchr(pattern, '\\');
3599 colon = strrchr(pattern, ':');
3600 separator = max(slash, backslash);
3601 separator = max(separator, colon);
3602 basepathlength = separator ? (separator + 1 - pattern) : 0;
3603 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3605 memcpy(basepath, pattern, basepathlength);
3606 basepath[basepathlength] = 0;
3608 // search through the path, one element at a time
3609 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3611 // is the element a pak file?
3612 if (searchpath->pack && !searchpath->pack->vpack)
3614 // look through all the pak file elements
3615 pak = searchpath->pack;
3618 if(strcmp(packfile, pak->shortname))
3621 for (i = 0;i < pak->numfiles;i++)
3623 char temp[MAX_OSPATH];
3624 strlcpy(temp, pak->files[i].name, sizeof(temp));
3627 if (matchpattern(temp, (char *)pattern, true))
3629 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3630 if (!strcmp(resultlist.strings[resultlistindex], temp))
3632 if (resultlistindex == resultlist.numstrings)
3634 stringlistappend(&resultlist, temp);
3635 if (!quiet && developer_loading.integer)
3636 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3639 // strip off one path element at a time until empty
3640 // this way directories are added to the listing if they match the pattern
3641 slash = strrchr(temp, '/');
3642 backslash = strrchr(temp, '\\');
3643 colon = strrchr(temp, ':');
3645 if (separator < slash)
3647 if (separator < backslash)
3648 separator = backslash;
3649 if (separator < colon)
3651 *((char *)separator) = 0;
3662 stringlistinit(&matchedSet);
3663 stringlistinit(&foundSet);
3664 // add a first entry to the set
3665 stringlistappend(&matchedSet, "");
3666 // iterate through pattern's path
3669 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3670 char subpath[MAX_OSPATH];
3671 char subpattern[MAX_OSPATH];
3673 // find the next wildcard
3674 wildcard = strchr(start, '?');
3675 asterisk = strchr(start, '*');
3676 if (asterisk && (!wildcard || asterisk < wildcard))
3678 wildcard = asterisk;
3683 nextseparator = strchr( wildcard, '/' );
3687 nextseparator = NULL;
3690 if( !nextseparator ) {
3691 nextseparator = start + strlen( start );
3694 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3695 // copy everything up except nextseperator
3696 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3697 // find the last '/' before the wildcard
3698 prevseparator = strrchr( subpattern, '/' );
3700 prevseparator = subpattern;
3703 // copy everything from start to the previous including the '/' (before the wildcard)
3704 // everything up to start is already included in the path of matchedSet's entries
3705 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3707 // for each entry in matchedSet try to open the subdirectories specified in subpath
3708 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3709 char temp[MAX_OSPATH];
3710 strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3711 strlcat( temp, subpath, sizeof(temp) );
3712 listdirectory( &foundSet, searchpath->filename, temp );
3714 if( dirlistindex == 0 ) {
3717 // reset the current result set
3718 stringlistfreecontents( &matchedSet );
3719 // match against the pattern
3720 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3721 const char *direntry = foundSet.strings[ dirlistindex ];
3722 if (matchpattern(direntry, subpattern, true)) {
3723 stringlistappend( &matchedSet, direntry );
3726 stringlistfreecontents( &foundSet );
3728 start = nextseparator;
3731 for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3733 const char *matchtemp = matchedSet.strings[dirlistindex];
3734 if (matchpattern(matchtemp, (char *)pattern, true))
3736 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3737 if (!strcmp(resultlist.strings[resultlistindex], matchtemp))
3739 if (resultlistindex == resultlist.numstrings)
3741 stringlistappend(&resultlist, matchtemp);
3742 if (!quiet && developer_loading.integer)
3743 Con_Printf("SearchDirFile: %s\n", matchtemp);
3747 stringlistfreecontents( &matchedSet );
3751 if (resultlist.numstrings)
3753 stringlistsort(&resultlist, true);
3754 numfiles = resultlist.numstrings;
3756 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3757 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3758 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3759 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3760 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3761 search->numfilenames = (int)numfiles;
3764 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3767 search->filenames[numfiles] = search->filenamesbuffer + numchars;
3768 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3769 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3771 numchars += (int)textlen;
3774 stringlistfreecontents(&resultlist);
3780 void FS_FreeSearch(fssearch_t *search)
3785 extern int con_linewidth;
3786 static int FS_ListDirectory(const char *pattern, int oneperline)
3795 char linebuf[MAX_INPUTLINE];
3797 search = FS_Search(pattern, true, true, NULL);
3800 numfiles = search->numfilenames;
3803 // FIXME: the names could be added to one column list and then
3804 // gradually shifted into the next column if they fit, and then the
3805 // next to make a compact variable width listing but it's a lot more
3807 // find width for columns
3809 for (i = 0;i < numfiles;i++)
3811 l = (int)strlen(search->filenames[i]);
3812 if (columnwidth < l)
3815 // count the spacing character
3817 // calculate number of columns
3818 numcolumns = con_linewidth / columnwidth;
3819 // don't bother with the column printing if it's only one column
3820 if (numcolumns >= 2)
3822 numlines = (numfiles + numcolumns - 1) / numcolumns;
3823 for (i = 0;i < numlines;i++)
3826 for (k = 0;k < numcolumns;k++)
3828 l = i * numcolumns + k;
3831 name = search->filenames[l];
3832 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3833 linebuf[linebufpos++] = name[j];
3834 // space out name unless it's the last on the line
3835 if (k + 1 < numcolumns && l + 1 < numfiles)
3836 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3837 linebuf[linebufpos++] = ' ';
3840 linebuf[linebufpos] = 0;
3841 Con_Printf("%s\n", linebuf);
3848 for (i = 0;i < numfiles;i++)
3849 Con_Printf("%s\n", search->filenames[i]);
3850 FS_FreeSearch(search);
3851 return (int)numfiles;
3854 static void FS_ListDirectoryCmd (cmd_state_t *cmd, const char* cmdname, int oneperline)
3856 const char *pattern;
3857 if (Cmd_Argc(cmd) >= 3)
3859 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3862 if (Cmd_Argc(cmd) == 2)
3863 pattern = Cmd_Argv(cmd, 1);
3866 if (!FS_ListDirectory(pattern, oneperline))
3867 Con_Print("No files found.\n");
3870 void FS_Dir_f(cmd_state_t *cmd)
3872 FS_ListDirectoryCmd(cmd, "dir", true);
3875 void FS_Ls_f(cmd_state_t *cmd)
3877 FS_ListDirectoryCmd(cmd, "ls", false);
3880 void FS_Which_f(cmd_state_t *cmd)
3882 const char *filename;
3885 if (Cmd_Argc(cmd) != 2)
3887 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(cmd, 0));
3890 filename = Cmd_Argv(cmd, 1);
3891 sp = FS_FindFile(filename, &index, true);
3893 Con_Printf("%s isn't anywhere\n", filename);
3899 Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3901 Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3904 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3908 const char *FS_WhichPack(const char *filename)
3911 searchpath_t *sp = FS_FindFile(filename, &index, true);
3913 return sp->pack->shortname;
3921 ====================
3922 FS_IsRegisteredQuakePack
3924 Look for a proof of purchase file file in the requested package
3926 If it is found, this file should NOT be downloaded.
3927 ====================
3929 qboolean FS_IsRegisteredQuakePack(const char *name)
3931 searchpath_t *search;
3934 // search through the path, one element at a time
3935 for (search = fs_searchpaths;search;search = search->next)
3937 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3938 // TODO do we want to support vpacks in here too?
3940 int (*strcmp_funct) (const char* str1, const char* str2);
3941 int left, right, middle;
3944 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3946 // Look for the file (binary search)
3948 right = pak->numfiles - 1;
3949 while (left <= right)
3953 middle = (left + right) / 2;
3954 diff = strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3960 // If we're too far in the list
3967 // we found the requested pack but it is not registered quake
3975 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3978 unsigned char *filedata;
3979 fs_offset_t filesize;
3980 if (filesizepointer)
3981 *filesizepointer = 0;
3982 if (!filename || !*filename)
3984 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
3987 if (filesizepointer)
3988 *filesizepointer = filesize;
3989 crc = CRC_Block(filedata, filesize);
3995 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
3998 unsigned char *out = NULL;
4002 #ifndef LINK_TO_ZLIB
4007 memset(&strm, 0, sizeof(strm));
4008 strm.zalloc = Z_NULL;
4009 strm.zfree = Z_NULL;
4010 strm.opaque = Z_NULL;
4013 level = Z_DEFAULT_COMPRESSION;
4015 if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
4017 Con_Printf("FS_Deflate: deflate init error!\n");
4021 strm.next_in = (unsigned char*)data;
4022 strm.avail_in = (unsigned int)size;
4024 tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
4027 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
4028 qz_deflateEnd(&strm);
4032 strm.next_out = tmp;
4033 strm.avail_out = (unsigned int)size;
4035 if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
4037 Con_Printf("FS_Deflate: deflate failed!\n");
4038 qz_deflateEnd(&strm);
4043 if(qz_deflateEnd(&strm) != Z_OK)
4045 Con_Printf("FS_Deflate: deflateEnd failed\n");
4050 if(strm.total_out >= size)
4052 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
4057 out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
4060 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
4065 *deflated_size = (size_t)strm.total_out;
4067 memcpy(out, tmp, strm.total_out);
4073 static void AssertBufsize(sizebuf_t *buf, int length)
4075 if(buf->cursize + length > buf->maxsize)
4077 int oldsize = buf->maxsize;
4078 unsigned char *olddata;
4079 olddata = buf->data;
4080 buf->maxsize += length;
4081 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
4084 memcpy(buf->data, olddata, oldsize);
4090 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
4094 unsigned char *out = NULL;
4095 unsigned char tmp[2048];
4100 #ifndef LINK_TO_ZLIB
4105 memset(&outbuf, 0, sizeof(outbuf));
4106 outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
4107 outbuf.maxsize = sizeof(tmp);
4109 memset(&strm, 0, sizeof(strm));
4110 strm.zalloc = Z_NULL;
4111 strm.zfree = Z_NULL;
4112 strm.opaque = Z_NULL;
4114 if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
4116 Con_Printf("FS_Inflate: inflate init error!\n");
4117 Mem_Free(outbuf.data);
4121 strm.next_in = (unsigned char*)data;
4122 strm.avail_in = (unsigned int)size;
4126 strm.next_out = tmp;
4127 strm.avail_out = sizeof(tmp);
4128 ret = qz_inflate(&strm, Z_NO_FLUSH);
4129 // it either returns Z_OK on progress, Z_STREAM_END on end
4137 case Z_STREAM_ERROR:
4138 Con_Print("FS_Inflate: stream error!\n");
4141 Con_Print("FS_Inflate: data error!\n");
4144 Con_Print("FS_Inflate: mem error!\n");
4147 Con_Print("FS_Inflate: buf error!\n");
4150 Con_Print("FS_Inflate: unknown error!\n");
4154 if(ret != Z_OK && ret != Z_STREAM_END)
4156 Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
4157 Mem_Free(outbuf.data);
4158 qz_inflateEnd(&strm);
4161 have = sizeof(tmp) - strm.avail_out;
4162 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
4163 SZ_Write(&outbuf, tmp, have);
4164 } while(ret != Z_STREAM_END);
4166 qz_inflateEnd(&strm);
4168 out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
4171 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
4172 Mem_Free(outbuf.data);
4176 memcpy(out, outbuf.data, outbuf.cursize);
4177 Mem_Free(outbuf.data);
4179 *inflated_size = (size_t)outbuf.cursize;