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, qbool 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 = {CF_CLIENT | CF_PERSISTENT, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
386 cvar_t fs_empty_files_in_pack_mark_deletions = {CF_CLIENT | CF_SERVER, "fs_empty_files_in_pack_mark_deletions", "0", "if enabled, empty files in a pak/pk3 count as not existing but cancel the search in further packs, effectively allowing patch pak/pk3 files to 'delete' files"};
387 cvar_t cvar_fs_gamedir = {CF_CLIENT | CF_SERVER | CF_READONLY | CF_PERSISTENT, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
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_FreeLibrary (&zlib_dll);
507 Try to load the Zlib DLL
510 static qbool PK3_OpenLibrary (void)
515 const char* dllnames [] =
518 # ifdef ZLIB_USES_WINAPI
524 #elif defined(MACOSX)
538 return Sys_LoadDependency (dllnames, &zlib_dll, zlibfuncs);
546 See if zlib is available
549 qbool 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 qbool 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, qbool 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, qbool 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 qbool 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(Sys_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 qbool FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qbool *already_loaded, qbool 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 qbool FS_AddPack(const char *pakfile, qbool *already_loaded, qbool 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 dot = strrchr(in, '.');
1336 separator = strrchr(in, '/');
1337 backslash = strrchr(in, '\\');
1338 if (!separator || separator < backslash)
1339 separator = backslash;
1340 colon = strrchr(in, ':');
1341 if (!separator || separator < colon)
1344 if (separator && (dot < separator))
1356 const char *FS_FileWithoutPath (const char *in)
1358 const char *separator, *backslash, *colon;
1360 separator = strrchr(in, '/');
1361 backslash = strrchr(in, '\\');
1362 if (!separator || separator < backslash)
1363 separator = backslash;
1364 colon = strrchr(in, ':');
1365 if (!separator || separator < colon)
1367 return separator ? separator + 1 : in;
1376 static void FS_ClearSearchPath (void)
1378 // unload all packs and directory information, close all pack files
1379 // (if a qfile is still reading a pack it won't be harmed because it used
1380 // dup() to get its own handle already)
1381 while (fs_searchpaths)
1383 searchpath_t *search = fs_searchpaths;
1384 fs_searchpaths = search->next;
1385 if (search->pack && search->pack != fs_selfpack)
1387 if(!search->pack->vpack)
1390 FILEDESC_CLOSE(search->pack->handle);
1391 // free any memory associated with it
1392 if (search->pack->files)
1393 Mem_Free(search->pack->files);
1395 Mem_Free(search->pack);
1401 static void FS_AddSelfPack(void)
1405 searchpath_t *search;
1406 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1407 search->next = fs_searchpaths;
1408 search->pack = fs_selfpack;
1409 fs_searchpaths = search;
1419 void FS_Rescan (void)
1422 qbool fs_modified = false;
1423 qbool reset = false;
1424 char gamedirbuf[MAX_INPUTLINE];
1429 FS_ClearSearchPath();
1431 // automatically activate gamemode for the gamedirs specified
1433 COM_ChangeGameTypeForGameDirs();
1435 // add the game-specific paths
1436 // gamedirname1 (typically id1)
1437 FS_AddGameHierarchy (gamedirname1);
1438 // update the com_modname (used for server info)
1439 if (gamedirname2 && gamedirname2[0])
1440 strlcpy(com_modname, gamedirname2, sizeof(com_modname));
1442 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1444 // add the game-specific path, if any
1445 // (only used for mission packs and the like, which should set fs_modified)
1446 if (gamedirname2 && gamedirname2[0])
1449 FS_AddGameHierarchy (gamedirname2);
1453 // Adds basedir/gamedir as an override game
1454 // LadyHavoc: now supports multiple -game directories
1455 // set the com_modname (reported in server info)
1457 for (i = 0;i < fs_numgamedirs;i++)
1460 FS_AddGameHierarchy (fs_gamedirs[i]);
1461 // update the com_modname (used server info)
1462 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1464 strlcat(gamedirbuf, va(vabuf, sizeof(vabuf), " %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1466 strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1468 Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1470 // add back the selfpack as new first item
1473 // set the default screenshot name to either the mod name or the
1474 // gamemode screenshot name
1475 if (strcmp(com_modname, gamedirname1))
1476 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1478 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1480 if((i = Sys_CheckParm("-modname")) && i < sys.argc - 1)
1481 strlcpy(com_modname, sys.argv[i+1], sizeof(com_modname));
1483 // If "-condebug" is in the command line, remove the previous log file
1484 if (Sys_CheckParm ("-condebug") != 0)
1485 unlink (va(vabuf, sizeof(vabuf), "%s/qconsole.log", fs_gamedir));
1487 // look for the pop.lmp file and set registered to true if it is found
1488 if (FS_FileExists("gfx/pop.lmp"))
1489 Cvar_SetValueQuick(®istered, 1);
1495 if (!registered.integer)
1498 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1500 Con_Print("Playing shareware version.\n");
1503 Con_Print("Playing registered version.\n");
1505 case GAME_STEELSTORM:
1506 if (registered.integer)
1507 Con_Print("Playing registered version.\n");
1509 Con_Print("Playing shareware version.\n");
1515 // unload all wads so that future queries will return the new data
1519 static void FS_Rescan_f(cmd_state_t *cmd)
1529 extern qbool vid_opened;
1530 qbool FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qbool complain, qbool failmissing)
1535 if (fs_numgamedirs == numgamedirs)
1537 for (i = 0;i < numgamedirs;i++)
1538 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1540 if (i == numgamedirs)
1541 return true; // already using this set of gamedirs, do nothing
1544 if (numgamedirs > MAX_GAMEDIRS)
1547 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1548 return false; // too many gamedirs
1551 for (i = 0;i < numgamedirs;i++)
1553 // if string is nasty, reject it
1554 p = FS_CheckGameDir(gamedirs[i]);
1558 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1559 return false; // nasty gamedirs
1561 if(p == fs_checkgamedir_missing && failmissing)
1564 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1565 return false; // missing gamedirs
1569 Host_SaveConfig(CONFIGFILENAME);
1571 fs_numgamedirs = numgamedirs;
1572 for (i = 0;i < fs_numgamedirs;i++)
1573 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1575 // reinitialize filesystem to detect the new paks
1578 if (cls.demoplayback)
1584 // unload all sounds so they will be reloaded from the new files as needed
1585 S_UnloadAllSounds_f(cmd_local);
1587 // restart the video subsystem after the config is executed
1588 Cbuf_InsertText(cmd_local, "\nloadconfig\nvid_restart\n\n");
1598 static void FS_GameDir_f(cmd_state_t *cmd)
1602 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1604 if (Cmd_Argc(cmd) < 2)
1606 Con_Printf("gamedirs active:");
1607 for (i = 0;i < fs_numgamedirs;i++)
1608 Con_Printf(" %s", fs_gamedirs[i]);
1613 numgamedirs = Cmd_Argc(cmd) - 1;
1614 if (numgamedirs > MAX_GAMEDIRS)
1616 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1620 for (i = 0;i < numgamedirs;i++)
1621 strlcpy(gamedirs[i], Cmd_Argv(cmd, i+1), sizeof(gamedirs[i]));
1623 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1625 // actually, changing during game would work fine, but would be stupid
1626 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1630 // halt demo playback to close the file
1633 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1636 static const char *FS_SysCheckGameDir(const char *gamedir, char *buf, size_t buflength)
1644 stringlistinit(&list);
1645 listdirectory(&list, gamedir, "");
1646 success = list.numstrings > 0;
1647 stringlistfreecontents(&list);
1651 f = FS_SysOpen(va(vabuf, sizeof(vabuf), "%smodinfo.txt", gamedir), "r", false);
1654 n = FS_Read (f, buf, buflength - 1);
1674 const char *FS_CheckGameDir(const char *gamedir)
1677 static char buf[8192];
1680 if (FS_CheckNastyPath(gamedir, true))
1683 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, gamedir), buf, sizeof(buf));
1688 // get description from basedir
1689 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1697 ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1701 return fs_checkgamedir_missing;
1704 static void FS_ListGameDirs(void)
1706 stringlist_t list, list2;
1711 fs_all_gamedirs_count = 0;
1713 Mem_Free(fs_all_gamedirs);
1715 stringlistinit(&list);
1716 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_basedir), "");
1717 listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_userdir), "");
1718 stringlistsort(&list, false);
1720 stringlistinit(&list2);
1721 for(i = 0; i < list.numstrings; ++i)
1724 if(!strcmp(list.strings[i-1], list.strings[i]))
1726 info = FS_CheckGameDir(list.strings[i]);
1729 if(info == fs_checkgamedir_missing)
1733 stringlistappend(&list2, list.strings[i]);
1735 stringlistfreecontents(&list);
1737 fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1738 for(i = 0; i < list2.numstrings; ++i)
1740 info = FS_CheckGameDir(list2.strings[i]);
1741 // all this cannot happen any more, but better be safe than sorry
1744 if(info == fs_checkgamedir_missing)
1748 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[fs_all_gamedirs_count].name));
1749 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[fs_all_gamedirs_count].description));
1750 ++fs_all_gamedirs_count;
1756 #pragma comment(lib, "shell32.lib")
1761 static void COM_InsertFlags(const char *buf) {
1764 const char **new_argv;
1766 int args_left = 256;
1767 new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*sys.argv) * (sys.argc + args_left + 2));
1769 new_argv[0] = "dummy"; // Can't really happen.
1771 new_argv[0] = sys.argv[0];
1774 while(COM_ParseToken_Console(&p))
1776 size_t sz = strlen(com_token) + 1; // shut up clang
1779 q = (char *)Mem_Alloc(fs_mempool, sz);
1780 strlcpy(q, com_token, sz);
1784 // Now: i <= args_left + 1.
1787 memcpy((char *)(&new_argv[i]), &sys.argv[1], sizeof(*sys.argv) * (sys.argc - 1));
1790 // Now: i <= args_left + (sys.argc || 1).
1792 sys.argv = new_argv;
1796 static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t userdirsize)
1798 #if defined(__IPHONEOS__)
1799 if (userdirmode == USERDIRMODE_HOME)
1801 // fs_basedir is "" by default, to utilize this you can simply add your gamedir to the Resources in xcode
1802 // fs_userdir stores configurations to the Documents folder of the app
1803 strlcpy(userdir, "../Documents/", MAX_OSPATH);
1808 #elif defined(WIN32)
1810 #if _MSC_VER >= 1400
1813 TCHAR mydocsdir[MAX_PATH + 1];
1814 wchar_t *savedgamesdirw;
1815 char savedgamesdir[MAX_OSPATH];
1824 case USERDIRMODE_NOHOME:
1825 strlcpy(userdir, fs_basedir, userdirsize);
1827 case USERDIRMODE_MYGAMES:
1829 Sys_LoadDependency(shfolderdllnames, &shfolder_dll, shfolderfuncs);
1831 if (qSHGetFolderPath && qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)
1833 dpsnprintf(userdir, userdirsize, "%s/My Games/%s/", mydocsdir, gameuserdirname);
1836 #if _MSC_VER >= 1400
1837 _dupenv_s(&homedir, &homedirlen, "USERPROFILE");
1840 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1845 homedir = getenv("USERPROFILE");
1848 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1853 case USERDIRMODE_SAVEDGAMES:
1855 Sys_LoadDependency(shell32dllnames, &shell32_dll, shell32funcs);
1857 Sys_LoadDependency(ole32dllnames, &ole32_dll, ole32funcs);
1858 if (qSHGetKnownFolderPath && qCoInitializeEx && qCoTaskMemFree && qCoUninitialize)
1860 savedgamesdir[0] = 0;
1861 qCoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
1864 if (SHGetKnownFolderPath(FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1866 if (SHGetKnownFolderPath(&FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1869 if (qSHGetKnownFolderPath(&qFOLDERID_SavedGames, qKF_FLAG_CREATE | qKF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1871 memset(savedgamesdir, 0, sizeof(savedgamesdir));
1872 #if _MSC_VER >= 1400
1873 wcstombs_s(NULL, savedgamesdir, sizeof(savedgamesdir), savedgamesdirw, sizeof(savedgamesdir)-1);
1875 wcstombs(savedgamesdir, savedgamesdirw, sizeof(savedgamesdir)-1);
1877 qCoTaskMemFree(savedgamesdirw);
1880 if (savedgamesdir[0])
1882 dpsnprintf(userdir, userdirsize, "%s/%s/", savedgamesdir, gameuserdirname);
1897 case USERDIRMODE_NOHOME:
1898 strlcpy(userdir, fs_basedir, userdirsize);
1900 case USERDIRMODE_HOME:
1901 homedir = getenv("HOME");
1904 dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1908 case USERDIRMODE_SAVEDGAMES:
1909 homedir = getenv("HOME");
1913 dpsnprintf(userdir, userdirsize, "%s/Library/Application Support/%s/", homedir, gameuserdirname);
1915 // the XDG say some files would need to go in:
1916 // XDG_CONFIG_HOME (or ~/.config/%s/)
1917 // XDG_DATA_HOME (or ~/.local/share/%s/)
1918 // XDG_CACHE_HOME (or ~/.cache/%s/)
1919 // and also search the following global locations if defined:
1920 // XDG_CONFIG_DIRS (normally /etc/xdg/%s/)
1921 // XDG_DATA_DIRS (normally /usr/share/%s/)
1922 // this would be too complicated...
1932 #if !defined(__IPHONEOS__)
1935 // historical behavior...
1936 if (userdirmode == USERDIRMODE_NOHOME && strcmp(gamedirname1, "id1"))
1937 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
1940 // see if we can write to this path (note: won't create path)
1942 // no access() here, we must try to open the file for appending
1943 fd = FS_SysOpenFiledesc(va(vabuf, sizeof(vabuf), "%s%s/config.cfg", userdir, gamedirname1), "a", false);
1947 // on Unix, we don't need to ACTUALLY attempt to open the file
1948 if(access(va(vabuf, sizeof(vabuf), "%s%s/", userdir, gamedirname1), W_OK | X_OK) >= 0)
1955 return 1; // good choice - the path exists and is writable
1959 if (userdirmode == USERDIRMODE_NOHOME)
1960 return -1; // path usually already exists, we lack permissions
1962 return 0; // probably good - failed to write but maybe we need to create path
1967 void FS_Init_Commands(void)
1969 Cvar_RegisterVariable (&scr_screenshot_name);
1970 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1971 Cvar_RegisterVariable (&cvar_fs_gamedir);
1973 Cmd_AddCommand(CF_SHARED, "gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1974 Cmd_AddCommand(CF_SHARED, "fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1975 Cmd_AddCommand(CF_SHARED, "path", FS_Path_f, "print searchpath (game directories and archives)");
1976 Cmd_AddCommand(CF_SHARED, "dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1977 Cmd_AddCommand(CF_SHARED, "ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1978 Cmd_AddCommand(CF_SHARED, "which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
1981 static void FS_Init_Dir (void)
1991 // Overrides the system supplied base directory (under GAMENAME)
1992 // 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)
1993 i = Sys_CheckParm ("-basedir");
1994 if (i && i < sys.argc-1)
1996 strlcpy (fs_basedir, sys.argv[i+1], sizeof (fs_basedir));
1997 i = (int)strlen (fs_basedir);
1998 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1999 fs_basedir[i-1] = 0;
2003 // If the base directory is explicitly defined by the compilation process
2004 #ifdef DP_FS_BASEDIR
2005 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
2006 #elif defined(__ANDROID__)
2007 dpsnprintf(fs_basedir, sizeof(fs_basedir), "/sdcard/%s/", gameuserdirname);
2008 #elif defined(MACOSX)
2009 // FIXME: is there a better way to find the directory outside the .app, without using Objective-C?
2010 if (strstr(sys.argv[0], ".app/"))
2013 strlcpy(fs_basedir, sys.argv[0], sizeof(fs_basedir));
2014 split = strstr(fs_basedir, ".app/");
2017 struct stat statresult;
2019 // truncate to just after the .app/
2021 // see if gamedir exists in Resources
2022 if (stat(va(vabuf, sizeof(vabuf), "%s/Contents/Resources/%s", fs_basedir, gamedirname1), &statresult) == 0)
2024 // found gamedir inside Resources, use it
2025 strlcat(fs_basedir, "Contents/Resources/", sizeof(fs_basedir));
2029 // no gamedir found in Resources, gamedir is probably
2030 // outside the .app, remove .app part of path
2031 while (split > fs_basedir && *split != '/')
2040 // make sure the appending of a path separator won't create an unterminated string
2041 memset(fs_basedir + sizeof(fs_basedir) - 2, 0, 2);
2042 // add a path separator to the end of the basedir if it lacks one
2043 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
2044 strlcat(fs_basedir, "/", sizeof(fs_basedir));
2046 // Add the personal game directory
2047 if((i = Sys_CheckParm("-userdir")) && i < sys.argc - 1)
2048 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", sys.argv[i+1]);
2049 else if (Sys_CheckParm("-nohome"))
2050 *fs_userdir = 0; // user wants roaming installation, no userdir
2053 #ifdef DP_FS_USERDIR
2054 strlcpy(fs_userdir, DP_FS_USERDIR, sizeof(fs_userdir));
2057 int highestuserdirmode = USERDIRMODE_COUNT - 1;
2058 int preferreduserdirmode = USERDIRMODE_COUNT - 1;
2059 int userdirstatus[USERDIRMODE_COUNT];
2061 // historical behavior...
2062 if (!strcmp(gamedirname1, "id1"))
2063 preferreduserdirmode = USERDIRMODE_NOHOME;
2065 // check what limitations the user wants to impose
2066 if (Sys_CheckParm("-home")) preferreduserdirmode = USERDIRMODE_HOME;
2067 if (Sys_CheckParm("-mygames")) preferreduserdirmode = USERDIRMODE_MYGAMES;
2068 if (Sys_CheckParm("-savedgames")) preferreduserdirmode = USERDIRMODE_SAVEDGAMES;
2069 // gather the status of the possible userdirs
2070 for (dirmode = 0;dirmode < USERDIRMODE_COUNT;dirmode++)
2072 userdirstatus[dirmode] = FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2073 if (userdirstatus[dirmode] == 1)
2074 Con_DPrintf("userdir %i = %s (writable)\n", dirmode, fs_userdir);
2075 else if (userdirstatus[dirmode] == 0)
2076 Con_DPrintf("userdir %i = %s (not writable or does not exist)\n", dirmode, fs_userdir);
2078 Con_DPrintf("userdir %i (not applicable)\n", dirmode);
2080 // some games may prefer writing to basedir, but if write fails we
2081 // have to search for a real userdir...
2082 if (preferreduserdirmode == 0 && userdirstatus[0] < 1)
2083 preferreduserdirmode = highestuserdirmode;
2084 // check for an existing userdir and continue using it if possible...
2085 for (dirmode = USERDIRMODE_COUNT - 1;dirmode > 0;dirmode--)
2086 if (userdirstatus[dirmode] == 1)
2088 // if no existing userdir found, make a new one...
2089 if (dirmode == 0 && preferreduserdirmode > 0)
2090 for (dirmode = preferreduserdirmode;dirmode > 0;dirmode--)
2091 if (userdirstatus[dirmode] >= 0)
2093 // and finally, we picked one...
2094 FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2095 Con_DPrintf("userdir %i is the winner\n", dirmode);
2099 // if userdir equal to basedir, clear it to avoid confusion later
2100 if (!strcmp(fs_basedir, fs_userdir))
2105 p = FS_CheckGameDir(gamedirname1);
2106 if(!p || p == fs_checkgamedir_missing)
2107 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
2111 p = FS_CheckGameDir(gamedirname2);
2112 if(!p || p == fs_checkgamedir_missing)
2113 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
2117 // Adds basedir/gamedir as an override game
2118 // LadyHavoc: now supports multiple -game directories
2119 for (i = 1;i < sys.argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
2123 if (!strcmp (sys.argv[i], "-game") && i < sys.argc-1)
2126 p = FS_CheckGameDir(sys.argv[i]);
2128 Con_Printf("WARNING: Nasty -game name rejected: %s\n", sys.argv[i]);
2129 if(p == fs_checkgamedir_missing)
2130 Con_Printf(CON_WARN "WARNING: -game %s%s/ not found!\n", fs_basedir, sys.argv[i]);
2131 // add the gamedir to the list of active gamedirs
2132 strlcpy (fs_gamedirs[fs_numgamedirs], sys.argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
2137 // generate the searchpath
2140 if (Thread_HasThreads())
2141 fs_mutex = Thread_CreateMutex();
2149 void FS_Init_SelfPack (void)
2153 // Load darkplaces.opt from the FS.
2154 if (!Sys_CheckParm("-noopt"))
2156 buf = (char *) FS_SysLoadFile("darkplaces.opt", tempmempool, true, NULL);
2159 COM_InsertFlags(buf);
2165 // Provide the SelfPack.
2166 if (!Sys_CheckParm("-noselfpack") && sys.selffd >= 0)
2168 fs_selfpack = FS_LoadPackPK3FromFD(sys.argv[0], sys.selffd, true);
2172 if (!Sys_CheckParm("-noopt"))
2174 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
2177 COM_InsertFlags(buf);
2194 fs_mempool = Mem_AllocPool("file management", 0, NULL);
2200 // initialize the self-pack (must be before COM_InitGameType as it may add command line options)
2203 // detect gamemode from commandline options or executable name
2214 void FS_Shutdown (void)
2216 // close all pack files and such
2217 // (hopefully there aren't any other open files, but they'll be cleaned up
2218 // by the OS anyway)
2219 FS_ClearSearchPath();
2220 Mem_FreePool (&fs_mempool);
2221 PK3_CloseLibrary ();
2224 Sys_FreeLibrary (&shfolder_dll);
2225 Sys_FreeLibrary (&shell32_dll);
2226 Sys_FreeLibrary (&ole32_dll);
2230 Thread_DestroyMutex(fs_mutex);
2233 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qbool nonblocking)
2235 filedesc_t handle = FILEDESC_INVALID;
2238 qbool dolock = false;
2240 // Parse the mode string
2249 opt = O_CREAT | O_TRUNC;
2253 opt = O_CREAT | O_APPEND;
2256 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
2257 return FILEDESC_INVALID;
2259 for (ind = 1; mode[ind] != '\0'; ind++)
2273 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
2274 filepath, mode, mode[ind]);
2281 if(Sys_CheckParm("-readonly") && mod != O_RDONLY)
2282 return FILEDESC_INVALID;
2286 return FILEDESC_INVALID;
2287 handle = SDL_RWFromFile(filepath, mode);
2290 # if _MSC_VER >= 1400
2291 _sopen_s(&handle, filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2293 handle = _sopen (filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2296 handle = open (filepath, mod | opt, 0666);
2297 if(handle >= 0 && dolock)
2300 l.l_type = ((mod == O_RDONLY) ? F_RDLCK : F_WRLCK);
2301 l.l_whence = SEEK_SET;
2304 if(fcntl(handle, F_SETLK, &l) == -1)
2306 FILEDESC_CLOSE(handle);
2316 int FS_SysOpenFD(const char *filepath, const char *mode, qbool nonblocking)
2321 return FS_SysOpenFiledesc(filepath, mode, nonblocking);
2326 ====================
2329 Internal function used to create a qfile_t and open the relevant non-packed file on disk
2330 ====================
2332 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qbool nonblocking)
2336 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2338 file->handle = FS_SysOpenFiledesc(filepath, mode, nonblocking);
2339 if (!FILEDESC_ISVALID(file->handle))
2345 file->filename = Mem_strdup(fs_mempool, filepath);
2347 file->real_length = FILEDESC_SEEK (file->handle, 0, SEEK_END);
2349 // For files opened in append mode, we start at the end of the file
2351 file->position = file->real_length;
2353 FILEDESC_SEEK (file->handle, 0, SEEK_SET);
2363 Open a packed file using its package file descriptor
2366 static qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
2369 filedesc_t dup_handle;
2372 pfile = &pack->files[pack_ind];
2374 // If we don't have the true offset, get it now
2375 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
2376 if (!PK3_GetTrueFileOffset (pfile, pack))
2379 #ifndef LINK_TO_ZLIB
2380 // No Zlib DLL = no compressed files
2381 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2383 Con_Printf(CON_WARN "WARNING: can't open the compressed file %s\n"
2384 "You need the Zlib DLL to use compressed files\n",
2390 // LadyHavoc: FILEDESC_SEEK affects all duplicates of a handle so we do it before
2391 // the dup() call to avoid having to close the dup_handle on error here
2392 if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
2394 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %08x%08x)\n",
2395 pfile->name, pack->filename, (unsigned int)(pfile->offset >> 32), (unsigned int)(pfile->offset));
2399 dup_handle = FILEDESC_DUP (pack->filename, pack->handle);
2400 if (!FILEDESC_ISVALID(dup_handle))
2402 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2406 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2407 memset (file, 0, sizeof (*file));
2408 file->handle = dup_handle;
2409 file->flags = QFILE_FLAG_PACKED;
2410 file->real_length = pfile->realsize;
2411 file->offset = pfile->offset;
2415 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2419 file->flags |= QFILE_FLAG_DEFLATED;
2421 // We need some more variables
2422 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2424 ztk->comp_length = pfile->packsize;
2426 // Initialize zlib stream
2427 ztk->zstream.next_in = ztk->input;
2428 ztk->zstream.avail_in = 0;
2430 /* From Zlib's "unzip.c":
2432 * windowBits is passed < 0 to tell that there is no zlib header.
2433 * Note that in this case inflate *requires* an extra "dummy" byte
2434 * after the compressed stream in order to complete decompression and
2435 * return Z_STREAM_END.
2436 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2437 * size of both compressed and uncompressed data
2439 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2441 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2442 FILEDESC_CLOSE(dup_handle);
2447 ztk->zstream.next_out = file->buff;
2448 ztk->zstream.avail_out = sizeof (file->buff);
2457 ====================
2460 Return true if the path should be rejected due to one of the following:
2461 1: path elements that are non-portable
2462 2: path elements that would allow access to files outside the game directory,
2463 or are just not a good idea for a mod to be using.
2464 ====================
2466 int FS_CheckNastyPath (const char *path, qbool isgamedir)
2468 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2472 // Windows: don't allow \ in filenames (windows-only), period.
2473 // (on Windows \ is a directory separator, but / is also supported)
2474 if (strstr(path, "\\"))
2475 return 1; // non-portable
2477 // Mac: don't allow Mac-only filenames - : is a directory separator
2478 // instead of /, but we rely on / working already, so there's no reason to
2479 // support a Mac-only path
2480 // Amiga and Windows: : tries to go to root of drive
2481 if (strstr(path, ":"))
2482 return 1; // non-portable attempt to go to root of drive
2484 // Amiga: // is parent directory
2485 if (strstr(path, "//"))
2486 return 1; // non-portable attempt to go to parent directory
2488 // all: don't allow going to parent directory (../ or /../)
2489 if (strstr(path, ".."))
2490 return 2; // attempt to go outside the game directory
2492 // Windows and UNIXes: don't allow absolute paths
2494 return 2; // attempt to go outside the game directory
2496 // all: don't allow . character immediately before a slash, this catches all imaginable cases of ./, ../, .../, etc
2497 if (strstr(path, "./"))
2498 return 2; // possible attempt to go outside the game directory
2500 // all: forbid trailing slash on gamedir
2501 if (isgamedir && path[strlen(path)-1] == '/')
2504 // all: forbid leading dot on any filename for any reason
2505 if (strstr(path, "/."))
2506 return 2; // attempt to go outside the game directory
2508 // after all these checks we're pretty sure it's a / separated filename
2509 // and won't do much if any harm
2514 ====================
2517 Sanitize path (replace non-portable characters
2518 with portable ones in-place, etc)
2519 ====================
2521 void FS_SanitizePath(char *path)
2523 for (; *path; path++)
2529 ====================
2532 Look for a file in the packages and in the filesystem
2534 Return the searchpath where the file was found (or NULL)
2535 and the file index in the package if relevant
2536 ====================
2538 static searchpath_t *FS_FindFile (const char *name, int* index, qbool quiet)
2540 searchpath_t *search;
2543 // search through the path, one element at a time
2544 for (search = fs_searchpaths;search;search = search->next)
2546 // is the element a pak file?
2547 if (search->pack && !search->pack->vpack)
2549 int (*strcmp_funct) (const char* str1, const char* str2);
2550 int left, right, middle;
2553 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2555 // Look for the file (binary search)
2557 right = pak->numfiles - 1;
2558 while (left <= right)
2562 middle = (left + right) / 2;
2563 diff = strcmp_funct (pak->files[middle].name, name);
2568 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2570 // yes, but the first one is empty so we treat it as not being there
2571 if (!quiet && developer_extra.integer)
2572 Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2579 if (!quiet && developer_extra.integer)
2580 Con_DPrintf("FS_FindFile: %s in %s\n",
2581 pak->files[middle].name, pak->filename);
2588 // If we're too far in the list
2597 char netpath[MAX_OSPATH];
2598 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2599 if (FS_SysFileExists (netpath))
2601 if (!quiet && developer_extra.integer)
2602 Con_DPrintf("FS_FindFile: %s\n", netpath);
2611 if (!quiet && developer_extra.integer)
2612 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2624 Look for a file in the search paths and open it in read-only mode
2627 static qfile_t *FS_OpenReadFile (const char *filename, qbool quiet, qbool nonblocking, int symlinkLevels)
2629 searchpath_t *search;
2632 search = FS_FindFile (filename, &pack_ind, quiet);
2638 // Found in the filesystem?
2641 // this works with vpacks, so we are fine
2642 char path [MAX_OSPATH];
2643 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2644 return FS_SysOpen (path, "rb", nonblocking);
2647 // So, we found it in a package...
2649 // Is it a PK3 symlink?
2650 // TODO also handle directory symlinks by parsing the whole structure...
2651 // but heck, file symlinks are good enough for now
2652 if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2654 if(symlinkLevels <= 0)
2656 Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2661 char linkbuf[MAX_QPATH];
2663 qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2664 const char *mergeslash;
2669 count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2675 // Now combine the paths...
2676 mergeslash = strrchr(filename, '/');
2677 mergestart = linkbuf;
2679 mergeslash = filename;
2680 while(!strncmp(mergestart, "../", 3))
2683 while(mergeslash > filename)
2686 if(*mergeslash == '/')
2690 // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2691 if(mergeslash == filename)
2693 // Either mergeslash == filename, then we just replace the name (done below)
2697 // Or, we append the name after mergeslash;
2698 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2699 int spaceNeeded = mergeslash - filename + 1;
2700 int spaceRemoved = mergestart - linkbuf;
2701 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2703 Con_DPrintf("symlink: too long path rejected\n");
2706 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2707 memcpy(linkbuf, filename, spaceNeeded);
2708 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2709 mergestart = linkbuf;
2711 if (!quiet && developer_loading.integer)
2712 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2713 if(FS_CheckNastyPath (mergestart, false))
2715 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2718 return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2722 return FS_OpenPackedFile (search->pack, pack_ind);
2727 =============================================================================
2729 MAIN PUBLIC FUNCTIONS
2731 =============================================================================
2735 ====================
2738 Open a file in the userpath. The syntax is the same as fopen
2739 Used for savegame scanning in menu, and all file writing.
2740 ====================
2742 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qbool quiet)
2744 char real_path [MAX_OSPATH];
2746 if (FS_CheckNastyPath(filepath, false))
2748 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2752 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2754 // If the file is opened in "write", "append", or "read/write" mode,
2755 // create directories up to the file.
2756 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2757 FS_CreatePath (real_path);
2758 return FS_SysOpen (real_path, mode, false);
2763 ====================
2766 Open a file. The syntax is the same as fopen
2767 ====================
2769 qfile_t* FS_OpenVirtualFile (const char* filepath, qbool quiet)
2771 qfile_t *result = NULL;
2772 if (FS_CheckNastyPath(filepath, false))
2774 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2778 if (fs_mutex) Thread_LockMutex(fs_mutex);
2779 result = FS_OpenReadFile (filepath, quiet, false, 16);
2780 if (fs_mutex) Thread_UnlockMutex(fs_mutex);
2786 ====================
2789 Open a file. The syntax is the same as fopen
2790 ====================
2792 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qbool quiet)
2795 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2796 memset (file, 0, sizeof (*file));
2797 file->flags = QFILE_FLAG_DATA;
2799 file->real_length = size;
2805 ====================
2809 ====================
2811 int FS_Close (qfile_t* file)
2813 if(file->flags & QFILE_FLAG_DATA)
2819 if (FILEDESC_CLOSE (file->handle))
2824 if (file->flags & QFILE_FLAG_REMOVE)
2826 if (remove(file->filename) == -1)
2828 // No need to report this. If removing a just
2829 // written file failed, this most likely means
2830 // someone else deleted it first - which we
2835 Mem_Free((void *) file->filename);
2840 qz_inflateEnd (&file->ztk->zstream);
2841 Mem_Free (file->ztk);
2848 void FS_RemoveOnClose(qfile_t* file)
2850 file->flags |= QFILE_FLAG_REMOVE;
2854 ====================
2857 Write "datasize" bytes into a file
2858 ====================
2860 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2862 fs_offset_t written = 0;
2864 // If necessary, seek to the exact file position we're supposed to be
2865 if (file->buff_ind != file->buff_len)
2867 if (FILEDESC_SEEK (file->handle, file->buff_ind - file->buff_len, SEEK_CUR) == -1)
2869 Con_Printf(CON_WARN "WARNING: could not seek in %s.\n", file->filename);
2873 // Purge cached data
2876 // Write the buffer and update the position
2877 // 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)
2878 while (written < (fs_offset_t)datasize)
2880 // figure out how much to write in one chunk
2881 fs_offset_t maxchunk = 1<<30; // 1 GiB
2882 int chunk = (int)min((fs_offset_t)datasize - written, maxchunk);
2883 int result = (int)FILEDESC_WRITE (file->handle, (const unsigned char *)data + written, chunk);
2884 // if at least some was written, add it to our accumulator
2887 // if the result is not what we expected, consider the write to be incomplete
2888 if (result != chunk)
2891 file->position = FILEDESC_SEEK (file->handle, 0, SEEK_CUR);
2892 if (file->real_length < file->position)
2893 file->real_length = file->position;
2895 // note that this will never be less than 0 even if the write failed
2901 ====================
2904 Read up to "buffersize" bytes from a file
2905 ====================
2907 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2909 fs_offset_t count, done;
2911 if (buffersize == 0 || !buffer)
2914 // Get rid of the ungetc character
2915 if (file->ungetc != EOF)
2917 ((char*)buffer)[0] = file->ungetc;
2925 if(file->flags & QFILE_FLAG_DATA)
2927 size_t left = file->real_length - file->position;
2928 if(buffersize > left)
2930 memcpy(buffer, file->data + file->position, buffersize);
2931 file->position += buffersize;
2935 // First, we copy as many bytes as we can from "buff"
2936 if (file->buff_ind < file->buff_len)
2938 count = file->buff_len - file->buff_ind;
2939 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2941 memcpy (buffer, &file->buff[file->buff_ind], count);
2942 file->buff_ind += count;
2944 buffersize -= count;
2945 if (buffersize == 0)
2949 // NOTE: at this point, the read buffer is always empty
2951 // If the file isn't compressed
2952 if (! (file->flags & QFILE_FLAG_DEFLATED))
2956 // We must take care to not read after the end of the file
2957 count = file->real_length - file->position;
2959 // If we have a lot of data to get, put them directly into "buffer"
2960 if (buffersize > sizeof (file->buff) / 2)
2962 if (count > (fs_offset_t)buffersize)
2963 count = (fs_offset_t)buffersize;
2964 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2966 // Seek failed. When reading from a pipe, and
2967 // the caller never called FS_Seek, this still
2968 // works fine. So no reporting this error.
2970 nb = FILEDESC_READ (file->handle, &((unsigned char*)buffer)[done], count);
2974 file->position += nb;
2976 // Purge cached data
2982 if (count > (fs_offset_t)sizeof (file->buff))
2983 count = (fs_offset_t)sizeof (file->buff);
2984 if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2986 // Seek failed. When reading from a pipe, and
2987 // the caller never called FS_Seek, this still
2988 // works fine. So no reporting this error.
2990 nb = FILEDESC_READ (file->handle, file->buff, count);
2993 file->buff_len = nb;
2994 file->position += nb;
2996 // Copy the requested data in "buffer" (as much as we can)
2997 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2998 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2999 file->buff_ind = count;
3007 // If the file is compressed, it's more complicated...
3008 // We cycle through a few operations until we have read enough data
3009 while (buffersize > 0)
3011 ztoolkit_t *ztk = file->ztk;
3014 // NOTE: at this point, the read buffer is always empty
3016 // If "input" is also empty, we need to refill it
3017 if (ztk->in_ind == ztk->in_len)
3019 // If we are at the end of the file
3020 if (file->position == file->real_length)
3023 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
3024 if (count > (fs_offset_t)sizeof (ztk->input))
3025 count = (fs_offset_t)sizeof (ztk->input);
3026 FILEDESC_SEEK (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
3027 if (FILEDESC_READ (file->handle, ztk->input, count) != count)
3029 Con_Printf ("FS_Read: unexpected end of file\n");
3034 ztk->in_len = count;
3035 ztk->in_position += count;
3038 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
3039 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
3041 // Now that we are sure we have compressed data available, we need to determine
3042 // if it's better to inflate it in "file->buff" or directly in "buffer"
3044 // Inflate the data in "file->buff"
3045 if (buffersize < sizeof (file->buff) / 2)
3047 ztk->zstream.next_out = file->buff;
3048 ztk->zstream.avail_out = sizeof (file->buff);
3049 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3050 if (error != Z_OK && error != Z_STREAM_END)
3052 Con_Printf ("FS_Read: Can't inflate file\n");
3055 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3057 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
3058 file->position += file->buff_len;
3060 // Copy the requested data in "buffer" (as much as we can)
3061 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3062 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3063 file->buff_ind = count;
3066 // Else, we inflate directly in "buffer"
3069 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
3070 ztk->zstream.avail_out = (unsigned int)buffersize;
3071 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3072 if (error != Z_OK && error != Z_STREAM_END)
3074 Con_Printf ("FS_Read: Can't inflate file\n");
3077 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3079 // How much data did it inflate?
3080 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
3081 file->position += count;
3083 // Purge cached data
3088 buffersize -= count;
3096 ====================
3099 Print a string into a file
3100 ====================
3102 int FS_Print (qfile_t* file, const char *msg)
3104 return (int)FS_Write (file, msg, strlen (msg));
3108 ====================
3111 Print a string into a file
3112 ====================
3114 int FS_Printf(qfile_t* file, const char* format, ...)
3119 va_start (args, format);
3120 result = FS_VPrintf (file, format, args);
3128 ====================
3131 Print a string into a file
3132 ====================
3134 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
3137 fs_offset_t buff_size = MAX_INPUTLINE;
3142 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
3143 len = dpvsnprintf (tempbuff, buff_size, format, ap);
3144 if (len >= 0 && len < buff_size)
3146 Mem_Free (tempbuff);
3150 len = FILEDESC_WRITE (file->handle, tempbuff, len);
3151 Mem_Free (tempbuff);
3158 ====================
3161 Get the next character of a file
3162 ====================
3164 int FS_Getc (qfile_t* file)
3168 if (FS_Read (file, &c, 1) != 1)
3176 ====================
3179 Put a character back into the read buffer (only supports one character!)
3180 ====================
3182 int FS_UnGetc (qfile_t* file, unsigned char c)
3184 // If there's already a character waiting to be read
3185 if (file->ungetc != EOF)
3194 ====================
3197 Move the position index in a file
3198 ====================
3200 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
3203 unsigned char* buffer;
3204 fs_offset_t buffersize;
3206 // Compute the file offset
3210 offset += file->position - file->buff_len + file->buff_ind;
3217 offset += file->real_length;
3223 if (offset < 0 || offset > file->real_length)
3226 if(file->flags & QFILE_FLAG_DATA)
3228 file->position = offset;
3232 // If we have the data in our read buffer, we don't need to actually seek
3233 if (file->position - file->buff_len <= offset && offset <= file->position)
3235 file->buff_ind = offset + file->buff_len - file->position;
3239 // Purge cached data
3242 // Unpacked or uncompressed files can seek directly
3243 if (! (file->flags & QFILE_FLAG_DEFLATED))
3245 if (FILEDESC_SEEK (file->handle, file->offset + offset, SEEK_SET) == -1)
3247 file->position = offset;
3251 // Seeking in compressed files is more a hack than anything else,
3252 // but we need to support it, so here we go.
3255 // If we have to go back in the file, we need to restart from the beginning
3256 if (offset <= file->position)
3260 ztk->in_position = 0;
3262 if (FILEDESC_SEEK (file->handle, file->offset, SEEK_SET) == -1)
3263 Con_Printf("IMPOSSIBLE: couldn't seek in already opened pk3 file.\n");
3265 // Reset the Zlib stream
3266 ztk->zstream.next_in = ztk->input;
3267 ztk->zstream.avail_in = 0;
3268 qz_inflateReset (&ztk->zstream);
3271 // We need a big buffer to force inflating into it directly
3272 buffersize = 2 * sizeof (file->buff);
3273 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
3275 // Skip all data until we reach the requested offset
3276 while (offset > (file->position - file->buff_len + file->buff_ind))
3278 fs_offset_t diff = offset - (file->position - file->buff_len + file->buff_ind);
3279 fs_offset_t count, len;
3281 count = (diff > buffersize) ? buffersize : diff;
3282 len = FS_Read (file, buffer, count);
3296 ====================
3299 Give the current position in a file
3300 ====================
3302 fs_offset_t FS_Tell (qfile_t* file)
3304 return file->position - file->buff_len + file->buff_ind;
3309 ====================
3312 Give the total size of a file
3313 ====================
3315 fs_offset_t FS_FileSize (qfile_t* file)
3317 return file->real_length;
3322 ====================
3325 Erases any buffered input or output data
3326 ====================
3328 void FS_Purge (qfile_t* file)
3338 FS_LoadAndCloseQFile
3340 Loads full content of a qfile_t and closes it.
3341 Always appends a 0 byte.
3344 static unsigned char *FS_LoadAndCloseQFile (qfile_t *file, const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3346 unsigned char *buf = NULL;
3347 fs_offset_t filesize = 0;
3351 filesize = file->real_length;
3354 Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
3359 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
3360 buf[filesize] = '\0';
3361 FS_Read (file, buf, filesize);
3363 if (developer_loadfile.integer)
3364 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
3367 if (filesizepointer)
3368 *filesizepointer = filesize;
3377 Filename are relative to the quake directory.
3378 Always appends a 0 byte.
3381 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3383 qfile_t *file = FS_OpenVirtualFile(path, quiet);
3384 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3392 Filename are OS paths.
3393 Always appends a 0 byte.
3396 unsigned char *FS_SysLoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3398 qfile_t *file = FS_SysOpen(path, "rb", false);
3399 return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3407 The filename will be prefixed by the current game directory
3410 qbool FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
3414 fs_offset_t lentotal;
3416 file = FS_OpenRealFile(filename, "wb", false);
3419 Con_Printf("FS_WriteFile: failed on %s\n", filename);
3424 for(i = 0; i < count; ++i)
3426 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
3427 for(i = 0; i < count; ++i)
3428 FS_Write (file, data[i], len[i]);
3433 qbool FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
3435 return FS_WriteFileInBlocks(filename, &data, &len, 1);
3440 =============================================================================
3442 OTHERS PUBLIC FUNCTIONS
3444 =============================================================================
3452 void FS_StripExtension (const char *in, char *out, size_t size_out)
3460 while ((currentchar = *in) && size_out > 1)
3462 if (currentchar == '.')
3464 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3466 *out++ = currentchar;
3482 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3486 // if path doesn't have a .EXT, append extension
3487 // (extension should include the .)
3488 src = path + strlen(path);
3490 while (*src != '/' && src != path)
3493 return; // it has an extension
3497 strlcat (path, extension, size_path);
3505 Look for a file in the packages and in the filesystem
3508 int FS_FileType (const char *filename)
3510 searchpath_t *search;
3511 char fullpath[MAX_OSPATH];
3513 search = FS_FindFile (filename, NULL, true);
3515 return FS_FILETYPE_NONE;
3517 if(search->pack && !search->pack->vpack)
3518 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3520 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3521 return FS_SysFileType(fullpath);
3529 Look for a file in the packages and in the filesystem
3532 qbool FS_FileExists (const char *filename)
3534 return (FS_FindFile (filename, NULL, true) != NULL);
3542 Look for a file in the filesystem only
3545 int FS_SysFileType (const char *path)
3548 // Sajt - some older sdks are missing this define
3549 # ifndef INVALID_FILE_ATTRIBUTES
3550 # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3553 DWORD result = GetFileAttributes(path);
3555 if(result == INVALID_FILE_ATTRIBUTES)
3556 return FS_FILETYPE_NONE;
3558 if(result & FILE_ATTRIBUTE_DIRECTORY)
3559 return FS_FILETYPE_DIRECTORY;
3561 return FS_FILETYPE_FILE;
3565 if (stat (path,&buf) == -1)
3566 return FS_FILETYPE_NONE;
3569 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3571 if(S_ISDIR(buf.st_mode))
3572 return FS_FILETYPE_DIRECTORY;
3574 return FS_FILETYPE_FILE;
3578 qbool FS_SysFileExists (const char *path)
3580 return FS_SysFileType (path) != FS_FILETYPE_NONE;
3587 Allocate and fill a search structure with information on matching filenames.
3590 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet, const char *packfile)
3593 searchpath_t *searchpath;
3595 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3596 stringlist_t resultlist;
3597 stringlist_t dirlist;
3598 stringlist_t matchedSet, foundSet;
3599 const char *start, *slash, *backslash, *colon, *separator;
3602 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3607 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3611 stringlistinit(&resultlist);
3612 stringlistinit(&dirlist);
3614 slash = strrchr(pattern, '/');
3615 backslash = strrchr(pattern, '\\');
3616 colon = strrchr(pattern, ':');
3617 separator = max(slash, backslash);
3618 separator = max(separator, colon);
3619 basepathlength = separator ? (separator + 1 - pattern) : 0;
3620 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3622 memcpy(basepath, pattern, basepathlength);
3623 basepath[basepathlength] = 0;
3625 // search through the path, one element at a time
3626 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3628 // is the element a pak file?
3629 if (searchpath->pack && !searchpath->pack->vpack)
3631 // look through all the pak file elements
3632 pak = searchpath->pack;
3635 if(strcmp(packfile, pak->shortname))
3638 for (i = 0;i < pak->numfiles;i++)
3640 char temp[MAX_OSPATH];
3641 strlcpy(temp, pak->files[i].name, sizeof(temp));
3644 if (matchpattern(temp, (char *)pattern, true))
3646 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3647 if (!strcmp(resultlist.strings[resultlistindex], temp))
3649 if (resultlistindex == resultlist.numstrings)
3651 stringlistappend(&resultlist, temp);
3652 if (!quiet && developer_loading.integer)
3653 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3656 // strip off one path element at a time until empty
3657 // this way directories are added to the listing if they match the pattern
3658 slash = strrchr(temp, '/');
3659 backslash = strrchr(temp, '\\');
3660 colon = strrchr(temp, ':');
3662 if (separator < slash)
3664 if (separator < backslash)
3665 separator = backslash;
3666 if (separator < colon)
3668 *((char *)separator) = 0;
3679 stringlistinit(&matchedSet);
3680 stringlistinit(&foundSet);
3681 // add a first entry to the set
3682 stringlistappend(&matchedSet, "");
3683 // iterate through pattern's path
3686 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3687 char subpath[MAX_OSPATH];
3688 char subpattern[MAX_OSPATH];
3690 // find the next wildcard
3691 wildcard = strchr(start, '?');
3692 asterisk = strchr(start, '*');
3693 if (asterisk && (!wildcard || asterisk < wildcard))
3695 wildcard = asterisk;
3700 nextseparator = strchr( wildcard, '/' );
3704 nextseparator = NULL;
3707 if( !nextseparator ) {
3708 nextseparator = start + strlen( start );
3711 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3712 // copy everything up except nextseperator
3713 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3714 // find the last '/' before the wildcard
3715 prevseparator = strrchr( subpattern, '/' );
3717 prevseparator = subpattern;
3720 // copy everything from start to the previous including the '/' (before the wildcard)
3721 // everything up to start is already included in the path of matchedSet's entries
3722 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3724 // for each entry in matchedSet try to open the subdirectories specified in subpath
3725 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3726 char temp[MAX_OSPATH];
3727 strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3728 strlcat( temp, subpath, sizeof(temp) );
3729 listdirectory( &foundSet, searchpath->filename, temp );
3731 if( dirlistindex == 0 ) {
3734 // reset the current result set
3735 stringlistfreecontents( &matchedSet );
3736 // match against the pattern
3737 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3738 const char *direntry = foundSet.strings[ dirlistindex ];
3739 if (matchpattern(direntry, subpattern, true)) {
3740 stringlistappend( &matchedSet, direntry );
3743 stringlistfreecontents( &foundSet );
3745 start = nextseparator;
3748 for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3750 const char *matchtemp = matchedSet.strings[dirlistindex];
3751 if (matchpattern(matchtemp, (char *)pattern, true))
3753 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3754 if (!strcmp(resultlist.strings[resultlistindex], matchtemp))
3756 if (resultlistindex == resultlist.numstrings)
3758 stringlistappend(&resultlist, matchtemp);
3759 if (!quiet && developer_loading.integer)
3760 Con_Printf("SearchDirFile: %s\n", matchtemp);
3764 stringlistfreecontents( &matchedSet );
3768 if (resultlist.numstrings)
3770 stringlistsort(&resultlist, true);
3771 numfiles = resultlist.numstrings;
3773 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3774 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3775 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3776 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3777 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3778 search->numfilenames = (int)numfiles;
3781 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3784 search->filenames[numfiles] = search->filenamesbuffer + numchars;
3785 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3786 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3788 numchars += (int)textlen;
3791 stringlistfreecontents(&resultlist);
3797 void FS_FreeSearch(fssearch_t *search)
3802 extern int con_linewidth;
3803 static int FS_ListDirectory(const char *pattern, int oneperline)
3812 char linebuf[MAX_INPUTLINE];
3814 search = FS_Search(pattern, true, true, NULL);
3817 numfiles = search->numfilenames;
3820 // FIXME: the names could be added to one column list and then
3821 // gradually shifted into the next column if they fit, and then the
3822 // next to make a compact variable width listing but it's a lot more
3824 // find width for columns
3826 for (i = 0;i < numfiles;i++)
3828 l = (int)strlen(search->filenames[i]);
3829 if (columnwidth < l)
3832 // count the spacing character
3834 // calculate number of columns
3835 numcolumns = con_linewidth / columnwidth;
3836 // don't bother with the column printing if it's only one column
3837 if (numcolumns >= 2)
3839 numlines = (numfiles + numcolumns - 1) / numcolumns;
3840 for (i = 0;i < numlines;i++)
3843 for (k = 0;k < numcolumns;k++)
3845 l = i * numcolumns + k;
3848 name = search->filenames[l];
3849 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3850 linebuf[linebufpos++] = name[j];
3851 // space out name unless it's the last on the line
3852 if (k + 1 < numcolumns && l + 1 < numfiles)
3853 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3854 linebuf[linebufpos++] = ' ';
3857 linebuf[linebufpos] = 0;
3858 Con_Printf("%s\n", linebuf);
3865 for (i = 0;i < numfiles;i++)
3866 Con_Printf("%s\n", search->filenames[i]);
3867 FS_FreeSearch(search);
3868 return (int)numfiles;
3871 static void FS_ListDirectoryCmd (cmd_state_t *cmd, const char* cmdname, int oneperline)
3873 const char *pattern;
3874 if (Cmd_Argc(cmd) >= 3)
3876 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3879 if (Cmd_Argc(cmd) == 2)
3880 pattern = Cmd_Argv(cmd, 1);
3883 if (!FS_ListDirectory(pattern, oneperline))
3884 Con_Print("No files found.\n");
3887 void FS_Dir_f(cmd_state_t *cmd)
3889 FS_ListDirectoryCmd(cmd, "dir", true);
3892 void FS_Ls_f(cmd_state_t *cmd)
3894 FS_ListDirectoryCmd(cmd, "ls", false);
3897 void FS_Which_f(cmd_state_t *cmd)
3899 const char *filename;
3902 if (Cmd_Argc(cmd) != 2)
3904 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(cmd, 0));
3907 filename = Cmd_Argv(cmd, 1);
3908 sp = FS_FindFile(filename, &index, true);
3910 Con_Printf("%s isn't anywhere\n", filename);
3916 Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3918 Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3921 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3925 const char *FS_WhichPack(const char *filename)
3928 searchpath_t *sp = FS_FindFile(filename, &index, true);
3930 return sp->pack->shortname;
3938 ====================
3939 FS_IsRegisteredQuakePack
3941 Look for a proof of purchase file file in the requested package
3943 If it is found, this file should NOT be downloaded.
3944 ====================
3946 qbool FS_IsRegisteredQuakePack(const char *name)
3948 searchpath_t *search;
3951 // search through the path, one element at a time
3952 for (search = fs_searchpaths;search;search = search->next)
3954 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3955 // TODO do we want to support vpacks in here too?
3957 int (*strcmp_funct) (const char* str1, const char* str2);
3958 int left, right, middle;
3961 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3963 // Look for the file (binary search)
3965 right = pak->numfiles - 1;
3966 while (left <= right)
3970 middle = (left + right) / 2;
3971 diff = strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3977 // If we're too far in the list
3984 // we found the requested pack but it is not registered quake
3992 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3995 unsigned char *filedata;
3996 fs_offset_t filesize;
3997 if (filesizepointer)
3998 *filesizepointer = 0;
3999 if (!filename || !*filename)
4001 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
4004 if (filesizepointer)
4005 *filesizepointer = filesize;
4006 crc = CRC_Block(filedata, filesize);
4012 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
4015 unsigned char *out = NULL;
4019 #ifndef LINK_TO_ZLIB
4024 memset(&strm, 0, sizeof(strm));
4025 strm.zalloc = Z_NULL;
4026 strm.zfree = Z_NULL;
4027 strm.opaque = Z_NULL;
4030 level = Z_DEFAULT_COMPRESSION;
4032 if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
4034 Con_Printf("FS_Deflate: deflate init error!\n");
4038 strm.next_in = (unsigned char*)data;
4039 strm.avail_in = (unsigned int)size;
4041 tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
4044 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
4045 qz_deflateEnd(&strm);
4049 strm.next_out = tmp;
4050 strm.avail_out = (unsigned int)size;
4052 if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
4054 Con_Printf("FS_Deflate: deflate failed!\n");
4055 qz_deflateEnd(&strm);
4060 if(qz_deflateEnd(&strm) != Z_OK)
4062 Con_Printf("FS_Deflate: deflateEnd failed\n");
4067 if(strm.total_out >= size)
4069 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
4074 out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
4077 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
4082 *deflated_size = (size_t)strm.total_out;
4084 memcpy(out, tmp, strm.total_out);
4090 static void AssertBufsize(sizebuf_t *buf, int length)
4092 if(buf->cursize + length > buf->maxsize)
4094 int oldsize = buf->maxsize;
4095 unsigned char *olddata;
4096 olddata = buf->data;
4097 buf->maxsize += length;
4098 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
4101 memcpy(buf->data, olddata, oldsize);
4107 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
4111 unsigned char *out = NULL;
4112 unsigned char tmp[2048];
4117 #ifndef LINK_TO_ZLIB
4122 memset(&outbuf, 0, sizeof(outbuf));
4123 outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
4124 outbuf.maxsize = sizeof(tmp);
4126 memset(&strm, 0, sizeof(strm));
4127 strm.zalloc = Z_NULL;
4128 strm.zfree = Z_NULL;
4129 strm.opaque = Z_NULL;
4131 if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
4133 Con_Printf("FS_Inflate: inflate init error!\n");
4134 Mem_Free(outbuf.data);
4138 strm.next_in = (unsigned char*)data;
4139 strm.avail_in = (unsigned int)size;
4143 strm.next_out = tmp;
4144 strm.avail_out = sizeof(tmp);
4145 ret = qz_inflate(&strm, Z_NO_FLUSH);
4146 // it either returns Z_OK on progress, Z_STREAM_END on end
4154 case Z_STREAM_ERROR:
4155 Con_Print("FS_Inflate: stream error!\n");
4158 Con_Print("FS_Inflate: data error!\n");
4161 Con_Print("FS_Inflate: mem error!\n");
4164 Con_Print("FS_Inflate: buf error!\n");
4167 Con_Print("FS_Inflate: unknown error!\n");
4171 if(ret != Z_OK && ret != Z_STREAM_END)
4173 Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
4174 Mem_Free(outbuf.data);
4175 qz_inflateEnd(&strm);
4178 have = sizeof(tmp) - strm.avail_out;
4179 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
4180 SZ_Write(&outbuf, tmp, have);
4181 } while(ret != Z_STREAM_END);
4183 qz_inflateEnd(&strm);
4185 out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
4188 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
4189 Mem_Free(outbuf.data);
4193 memcpy(out, outbuf.data, outbuf.cursize);
4194 Mem_Free(outbuf.data);
4196 *inflated_size = (size_t)outbuf.cursize;