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
26 // include SDL for IPHONEOS code
27 # include <TargetConditionals.h>
42 # include <sys/stat.h>
51 // Win32 requires us to add O_BINARY, but the other OSes don't have it
56 // In case the system doesn't support the O_NONBLOCK flag
61 // largefile support for Win32
63 # define lseek _lseeki64
67 // suppress deprecated warnings
68 # include <sys/stat.h>
73 # define unlink _unlink
77 /** \page fs File System
79 All of Quake's data access is through a hierchal file system, but the contents
80 of the file system can be transparently merged from several sources.
82 The "base directory" is the path to the directory holding the quake.exe and
83 all game directories. The sys_* files pass this to host_init in
84 quakeparms_t->basedir. This can be overridden with the "-basedir" command
85 line parm to allow code debugging in a different directory. The base
86 directory is only used during filesystem initialization.
88 The "game directory" is the first tree on the search path and directory that
89 all generated files (savegames, screenshots, demos, config files) will be
90 saved to. This can be overridden with the "-game" command line parameter.
91 The game directory can never be changed while quake is executing. This is a
92 precaution against having a malicious server instruct clients to write files
93 over areas they shouldn't.
99 =============================================================================
103 =============================================================================
106 // Magic numbers of a ZIP file (big-endian format)
107 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
108 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
109 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
111 // Other constants for ZIP files
112 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
113 #define ZIP_END_CDIR_SIZE 22
114 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
115 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
120 #define qz_inflate inflate
121 #define qz_inflateEnd inflateEnd
122 #define qz_inflateInit2_ inflateInit2_
123 #define qz_inflateReset inflateReset
124 #define qz_deflateInit2_ deflateInit2_
125 #define qz_deflateEnd deflateEnd
126 #define qz_deflate deflate
127 #define Z_MEMLEVEL_DEFAULT 8
130 // Zlib constants (from zlib.h)
131 #define Z_SYNC_FLUSH 2
134 #define Z_STREAM_END 1
135 #define Z_STREAM_ERROR (-2)
136 #define Z_DATA_ERROR (-3)
137 #define Z_MEM_ERROR (-4)
138 #define Z_BUF_ERROR (-5)
139 #define ZLIB_VERSION "1.2.3"
143 #define Z_MEMLEVEL_DEFAULT 8
146 #define Z_DEFAULT_COMPRESSION (-1)
148 #define Z_SYNC_FLUSH 2
149 #define Z_FULL_FLUSH 3
152 // Uncomment the following line if the zlib DLL you have still uses
153 // the 1.1.x series calling convention on Win32 (WINAPI)
154 //#define ZLIB_USES_WINAPI
158 =============================================================================
162 =============================================================================
165 /*! Zlib stream (from zlib.h)
166 * \warning: some pointers we don't use directly have
167 * been cast to "void*" for a matter of simplicity
171 unsigned char *next_in; ///< next input byte
172 unsigned int avail_in; ///< number of bytes available at next_in
173 unsigned long total_in; ///< total nb of input bytes read so far
175 unsigned char *next_out; ///< next output byte should be put there
176 unsigned int avail_out; ///< remaining free space at next_out
177 unsigned long total_out; ///< total nb of bytes output so far
179 char *msg; ///< last error message, NULL if no error
180 void *state; ///< not visible by applications
182 void *zalloc; ///< used to allocate the internal state
183 void *zfree; ///< used to free the internal state
184 void *opaque; ///< private data object passed to zalloc and zfree
186 int data_type; ///< best guess about the data type: ascii or binary
187 unsigned long adler; ///< adler32 value of the uncompressed data
188 unsigned long reserved; ///< reserved for future use
193 /// inside a package (PAK or PK3)
194 #define QFILE_FLAG_PACKED (1 << 0)
195 /// file is compressed using the deflate algorithm (PK3 only)
196 #define QFILE_FLAG_DEFLATED (1 << 1)
197 /// file is actually already loaded data
198 #define QFILE_FLAG_DATA (1 << 2)
199 /// real file will be removed on close
200 #define QFILE_FLAG_REMOVE (1 << 3)
202 #define FILE_BUFF_SIZE 2048
206 size_t comp_length; ///< length of the compressed file
207 size_t in_ind, in_len; ///< input buffer current index and length
208 size_t in_position; ///< position in the compressed file
209 unsigned char input [FILE_BUFF_SIZE];
215 int handle; ///< file descriptor
216 fs_offset_t real_length; ///< uncompressed file size (for files opened in "read" mode)
217 fs_offset_t position; ///< current position in the file
218 fs_offset_t offset; ///< offset into the package (0 if external file)
219 int ungetc; ///< single stored character from ungetc, cleared to EOF when read
222 fs_offset_t buff_ind, buff_len; ///< buffer current index and length
223 unsigned char buff [FILE_BUFF_SIZE];
225 ztoolkit_t* ztk; ///< For zipped files.
227 const unsigned char *data; ///< For data files.
229 const char *filename; ///< Kept around for QFILE_FLAG_REMOVE, unused otherwise
233 // ------ PK3 files on disk ------ //
235 // You can get the complete ZIP format description from PKWARE website
237 typedef struct pk3_endOfCentralDir_s
239 unsigned int signature;
240 unsigned short disknum;
241 unsigned short cdir_disknum; ///< number of the disk with the start of the central directory
242 unsigned short localentries; ///< number of entries in the central directory on this disk
243 unsigned short nbentries; ///< total number of entries in the central directory on this disk
244 unsigned int cdir_size; ///< size of the central directory
245 unsigned int cdir_offset; ///< with respect to the starting disk number
246 unsigned short comment_size;
247 fs_offset_t prepended_garbage;
248 } pk3_endOfCentralDir_t;
251 // ------ PAK files on disk ------ //
252 typedef struct dpackfile_s
255 int filepos, filelen;
258 typedef struct dpackheader_s
266 /*! \name Packages in memory
269 /// the offset in packfile_t is the true contents offset
270 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
271 /// file compressed using the deflate algorithm
272 #define PACKFILE_FLAG_DEFLATED (1 << 1)
273 /// file is a symbolic link
274 #define PACKFILE_FLAG_SYMLINK (1 << 2)
276 typedef struct packfile_s
278 char name [MAX_QPATH];
281 fs_offset_t packsize; ///< size in the package
282 fs_offset_t realsize; ///< real file size (uncompressed)
285 typedef struct pack_s
287 char filename [MAX_OSPATH];
288 char shortname [MAX_QPATH];
290 int ignorecase; ///< PK3 ignores case
297 /// Search paths for files (including packages)
298 typedef struct searchpath_s
300 // only one of filename / pack will be used
301 char filename[MAX_OSPATH];
303 struct searchpath_s *next;
308 =============================================================================
312 =============================================================================
317 void FS_Which_f(void);
319 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet);
320 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
321 fs_offset_t offset, fs_offset_t packsize,
322 fs_offset_t realsize, int flags);
326 =============================================================================
330 =============================================================================
333 mempool_t *fs_mempool;
335 searchpath_t *fs_searchpaths = NULL;
336 const char *const fs_checkgamedir_missing = "missing";
338 #define MAX_FILES_IN_PACK 65536
340 char fs_userdir[MAX_OSPATH];
341 char fs_gamedir[MAX_OSPATH];
342 char fs_basedir[MAX_OSPATH];
343 static pack_t *fs_selfpack = NULL;
345 // list of active game directories (empty if not running a mod)
346 int fs_numgamedirs = 0;
347 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
349 // list of all gamedirs with modinfo.txt
350 gamedir_t *fs_all_gamedirs = NULL;
351 int fs_all_gamedirs_count = 0;
353 cvar_t scr_screenshot_name = {CVAR_NORESETTODEFAULTS, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
354 cvar_t fs_empty_files_in_pack_mark_deletions = {0, "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"};
355 cvar_t cvar_fs_gamedir = {CVAR_READONLY | CVAR_NORESETTODEFAULTS, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
359 =============================================================================
361 PRIVATE FUNCTIONS - PK3 HANDLING
363 =============================================================================
367 // Functions exported from zlib
368 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
369 # define ZEXPORT WINAPI
374 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
375 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
376 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
377 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
378 static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size);
379 static int (ZEXPORT *qz_deflateEnd) (z_stream* strm);
380 static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush);
383 #define qz_inflateInit2(strm, windowBits) \
384 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
385 #define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
386 qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream))
389 // qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
391 static dllfunction_t zlibfuncs[] =
393 {"inflate", (void **) &qz_inflate},
394 {"inflateEnd", (void **) &qz_inflateEnd},
395 {"inflateInit2_", (void **) &qz_inflateInit2_},
396 {"inflateReset", (void **) &qz_inflateReset},
397 {"deflateInit2_", (void **) &qz_deflateInit2_},
398 {"deflateEnd", (void **) &qz_deflateEnd},
399 {"deflate", (void **) &qz_deflate},
403 /// Handle for Zlib DLL
404 static dllhandle_t zlib_dll = NULL;
408 static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPTSTR pszPath);
409 static dllfunction_t shfolderfuncs[] =
411 {"SHGetFolderPathA", (void **) &qSHGetFolderPath},
414 static dllhandle_t shfolder_dll = NULL;
424 void PK3_CloseLibrary (void)
427 Sys_UnloadLibrary (&zlib_dll);
436 Try to load the Zlib DLL
439 qboolean PK3_OpenLibrary (void)
444 const char* dllnames [] =
447 # ifdef ZLIB_USES_WINAPI
453 #elif defined(MACOSX)
467 return Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs);
475 See if zlib is available
478 qboolean FS_HasZlib(void)
483 PK3_OpenLibrary(); // to be safe
484 return (zlib_dll != 0);
490 PK3_GetEndOfCentralDir
492 Extract the end of the central directory from a PK3 package
495 qboolean PK3_GetEndOfCentralDir (const char *packfile, int packhandle, pk3_endOfCentralDir_t *eocd)
497 fs_offset_t filesize, maxsize;
498 unsigned char *buffer, *ptr;
501 // Get the package size
502 filesize = lseek (packhandle, 0, SEEK_END);
503 if (filesize < ZIP_END_CDIR_SIZE)
506 // Load the end of the file in memory
507 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
510 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
511 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
512 lseek (packhandle, filesize - maxsize, SEEK_SET);
513 if (read (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
519 // Look for the end of central dir signature around the end of the file
520 maxsize -= ZIP_END_CDIR_SIZE;
521 ptr = &buffer[maxsize];
523 while (BuffBigLong (ptr) != ZIP_END_HEADER)
535 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
536 eocd->signature = LittleLong (eocd->signature);
537 eocd->disknum = LittleShort (eocd->disknum);
538 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
539 eocd->localentries = LittleShort (eocd->localentries);
540 eocd->nbentries = LittleShort (eocd->nbentries);
541 eocd->cdir_size = LittleLong (eocd->cdir_size);
542 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
543 eocd->comment_size = LittleShort (eocd->comment_size);
544 eocd->prepended_garbage = filesize - (ind + ZIP_END_CDIR_SIZE) - eocd->cdir_offset - eocd->cdir_size; // this detects "SFX" zip files
545 eocd->cdir_offset += eocd->prepended_garbage;
557 Extract the file list from a PK3 file
560 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
562 unsigned char *central_dir, *ptr;
564 fs_offset_t remaining;
566 // Load the central directory in memory
567 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
568 lseek (pack->handle, eocd->cdir_offset, SEEK_SET);
569 if(read (pack->handle, central_dir, eocd->cdir_size) != (fs_offset_t) eocd->cdir_size)
571 Mem_Free (central_dir);
575 // Extract the files properties
576 // The parsing is done "by hand" because some fields have variable sizes and
577 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
578 remaining = eocd->cdir_size;
581 for (ind = 0; ind < eocd->nbentries; ind++)
583 fs_offset_t namesize, count;
585 // Checking the remaining size
586 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
588 Mem_Free (central_dir);
591 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
594 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
596 Mem_Free (central_dir);
600 namesize = BuffLittleShort (&ptr[28]); // filename length
602 // Check encryption, compression, and attributes
603 // 1st uint8 : general purpose bit flag
604 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
606 // LordHavoc: bit 3 would be a problem if we were scanning the archive
607 // but is not a problem in the central directory where the values are
610 // bit 3 seems to always be set by the standard Mac OSX zip maker
612 // 2nd uint8 : external file attributes
613 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
614 if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0)
616 // Still enough bytes for the name?
617 if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
619 Mem_Free (central_dir);
623 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
624 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
626 char filename [sizeof (pack->files[0].name)];
627 fs_offset_t offset, packsize, realsize;
630 // Extract the name (strip it if necessary)
631 namesize = min(namesize, (int)sizeof (filename) - 1);
632 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
633 filename[namesize] = '\0';
635 if (BuffLittleShort (&ptr[10]))
636 flags = PACKFILE_FLAG_DEFLATED;
639 offset = BuffLittleLong (&ptr[42]) + eocd->prepended_garbage;
640 packsize = BuffLittleLong (&ptr[20]);
641 realsize = BuffLittleLong (&ptr[24]);
643 switch(ptr[5]) // C_VERSION_MADE_BY_1
648 if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000)
649 // can't use S_ISLNK here, as this has to compile on non-UNIX too
650 flags |= PACKFILE_FLAG_SYMLINK;
654 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
658 // Skip the name, additionnal field, and comment
659 // 1er uint16 : extra field length
660 // 2eme uint16 : file comment length
661 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
662 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
666 // If the package is empty, central_dir is NULL here
667 if (central_dir != NULL)
668 Mem_Free (central_dir);
669 return pack->numfiles;
677 Create a package entry associated with a PK3 file
680 pack_t *FS_LoadPackPK3FromFD (const char *packfile, int packhandle, qboolean silent)
682 pk3_endOfCentralDir_t eocd;
686 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
689 Con_Printf ("%s is not a PK3 file\n", packfile);
694 // Multi-volume ZIP archives are NOT allowed
695 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
697 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
702 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
703 // since eocd.nbentries is an unsigned 16 bits integer
704 #if MAX_FILES_IN_PACK < 65535
705 if (eocd.nbentries > MAX_FILES_IN_PACK)
707 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
713 // Create a package structure in memory
714 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
715 pack->ignorecase = true; // PK3 ignores case
716 strlcpy (pack->filename, packfile, sizeof (pack->filename));
717 pack->handle = packhandle;
718 pack->numfiles = eocd.nbentries;
719 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
721 real_nb_files = PK3_BuildFileList (pack, &eocd);
722 if (real_nb_files < 0)
724 Con_Printf ("%s is not a valid PK3 file\n", packfile);
730 Con_DPrintf("Added packfile %s (%i files)\n", packfile, real_nb_files);
733 pack_t *FS_LoadPackPK3 (const char *packfile)
737 _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE);
739 packhandle = open (packfile, O_RDONLY | O_BINARY);
743 return FS_LoadPackPK3FromFD(packfile, packhandle, false);
749 PK3_GetTrueFileOffset
751 Find where the true file data offset is
754 qboolean PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
756 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
760 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
763 // Load the local file description
764 lseek (pack->handle, pfile->offset, SEEK_SET);
765 count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
766 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
768 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
772 // Skip name and extra field
773 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
775 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
781 =============================================================================
783 OTHER PRIVATE FUNCTIONS
785 =============================================================================
793 Add a file to the list of files contained into a package
796 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
797 fs_offset_t offset, fs_offset_t packsize,
798 fs_offset_t realsize, int flags)
800 int (*strcmp_funct) (const char* str1, const char* str2);
801 int left, right, middle;
804 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
806 // Look for the slot we should put that file into (binary search)
808 right = pack->numfiles - 1;
809 while (left <= right)
813 middle = (left + right) / 2;
814 diff = strcmp_funct (pack->files[middle].name, name);
816 // If we found the file, there's a problem
818 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
820 // If we're too far in the list
827 // We have to move the right of the list by one slot to free the one we need
828 pfile = &pack->files[left];
829 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
832 strlcpy (pfile->name, name, sizeof (pfile->name));
833 pfile->offset = offset;
834 pfile->packsize = packsize;
835 pfile->realsize = realsize;
836 pfile->flags = flags;
846 Only used for FS_OpenRealFile.
849 void FS_CreatePath (char *path)
853 for (ofs = path+1 ; *ofs ; ofs++)
855 if (*ofs == '/' || *ofs == '\\')
857 // create the directory
873 void FS_Path_f (void)
877 Con_Print("Current search path:\n");
878 for (s=fs_searchpaths ; s ; s=s->next)
883 Con_Printf("%sdir (virtual pack)\n", s->pack->filename);
885 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
888 Con_Printf("%s\n", s->filename);
898 /*! Takes an explicit (not game tree related) path to a pak file.
899 *Loads the header and directory, adding the files at the beginning
900 *of the list so they override previous pack files.
902 pack_t *FS_LoadPackPAK (const char *packfile)
904 dpackheader_t header;
911 _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE);
913 packhandle = open (packfile, O_RDONLY | O_BINARY);
917 if(read (packhandle, (void *)&header, sizeof(header)) != sizeof(header))
919 Con_Printf ("%s is not a packfile\n", packfile);
923 if (memcmp(header.id, "PACK", 4))
925 Con_Printf ("%s is not a packfile\n", packfile);
929 header.dirofs = LittleLong (header.dirofs);
930 header.dirlen = LittleLong (header.dirlen);
932 if (header.dirlen % sizeof(dpackfile_t))
934 Con_Printf ("%s has an invalid directory size\n", packfile);
939 numpackfiles = header.dirlen / sizeof(dpackfile_t);
941 if (numpackfiles > MAX_FILES_IN_PACK)
943 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
948 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
949 lseek (packhandle, header.dirofs, SEEK_SET);
950 if(header.dirlen != read (packhandle, (void *)info, header.dirlen))
952 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
958 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
959 pack->ignorecase = false; // PAK is case sensitive
960 strlcpy (pack->filename, packfile, sizeof (pack->filename));
961 pack->handle = packhandle;
963 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
965 // parse the directory
966 for (i = 0;i < numpackfiles;i++)
968 fs_offset_t offset = LittleLong (info[i].filepos);
969 fs_offset_t size = LittleLong (info[i].filelen);
971 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
976 Con_DPrintf("Added packfile %s (%i files)\n", packfile, numpackfiles);
984 Create a package entry associated with a directory file
987 pack_t *FS_LoadPackVirtual (const char *dirname)
990 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
992 pack->ignorecase = false;
993 strlcpy (pack->filename, dirname, sizeof(pack->filename));
997 Con_DPrintf("Added packfile %s (virtual pack)\n", dirname);
1006 /*! Adds the given pack to the search path.
1007 * The pack type is autodetected by the file extension.
1009 * Returns true if the file was successfully added to the
1010 * search path or if it was already included.
1012 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1013 * plain directories.
1016 static qboolean FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qboolean *already_loaded, qboolean keep_plain_dirs)
1018 searchpath_t *search;
1020 const char *ext = FS_FileExtension(pakfile);
1023 for(search = fs_searchpaths; search; search = search->next)
1025 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
1028 *already_loaded = true;
1029 return true; // already loaded
1034 *already_loaded = false;
1036 if(!strcasecmp(ext, "pk3dir"))
1037 pak = FS_LoadPackVirtual (pakfile);
1038 else if(!strcasecmp(ext, "pak"))
1039 pak = FS_LoadPackPAK (pakfile);
1040 else if(!strcasecmp(ext, "pk3"))
1041 pak = FS_LoadPackPK3 (pakfile);
1043 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
1047 strlcpy(pak->shortname, shortname, sizeof(pak->shortname));
1049 //Con_DPrintf(" Registered pack with short name %s\n", shortname);
1052 // find the first item whose next one is a pack or NULL
1053 searchpath_t *insertion_point = 0;
1054 if(fs_searchpaths && !fs_searchpaths->pack)
1056 insertion_point = fs_searchpaths;
1059 if(!insertion_point->next)
1061 if(insertion_point->next->pack)
1063 insertion_point = insertion_point->next;
1066 // If insertion_point is NULL, this means that either there is no
1067 // item in the list yet, or that the very first item is a pack. In
1068 // that case, we want to insert at the beginning...
1069 if(!insertion_point)
1071 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1072 search->next = fs_searchpaths;
1073 fs_searchpaths = search;
1076 // otherwise we want to append directly after insertion_point.
1078 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1079 search->next = insertion_point->next;
1080 insertion_point->next = search;
1085 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1086 search->next = fs_searchpaths;
1087 fs_searchpaths = search;
1092 dpsnprintf(search->filename, sizeof(search->filename), "%s/", pakfile);
1093 // if shortname ends with "pk3dir", strip that suffix to make it just "pk3"
1094 // same goes for the name inside the pack structure
1095 l = strlen(pak->shortname);
1097 if(!strcasecmp(pak->shortname + l - 7, ".pk3dir"))
1098 pak->shortname[l - 3] = 0;
1099 l = strlen(pak->filename);
1101 if(!strcasecmp(pak->filename + l - 7, ".pk3dir"))
1102 pak->filename[l - 3] = 0;
1108 Con_Printf("unable to load pak \"%s\"\n", pakfile);
1119 /*! Adds the given pack to the search path and searches for it in the game path.
1120 * The pack type is autodetected by the file extension.
1122 * Returns true if the file was successfully added to the
1123 * search path or if it was already included.
1125 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1126 * plain directories.
1128 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
1130 char fullpath[MAX_OSPATH];
1132 searchpath_t *search;
1135 *already_loaded = false;
1137 // then find the real name...
1138 search = FS_FindFile(pakfile, &index, true);
1139 if(!search || search->pack)
1141 Con_Printf("could not find pak \"%s\"\n", pakfile);
1145 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
1147 return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs);
1155 Sets fs_gamedir, adds the directory to the head of the path,
1156 then loads and adds pak1.pak pak2.pak ...
1159 void FS_AddGameDirectory (const char *dir)
1163 searchpath_t *search;
1165 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
1167 stringlistinit(&list);
1168 listdirectory(&list, "", dir);
1169 stringlistsort(&list);
1171 // add any PAK package in the directory
1172 for (i = 0;i < list.numstrings;i++)
1174 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
1176 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1180 // add any PK3 package in the directory
1181 for (i = 0;i < list.numstrings;i++)
1183 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3") || !strcasecmp(FS_FileExtension(list.strings[i]), "pk3dir"))
1185 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1189 stringlistfreecontents(&list);
1191 // Add the directory to the search path
1192 // (unpacked files have the priority over packed files)
1193 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1194 strlcpy (search->filename, dir, sizeof (search->filename));
1195 search->next = fs_searchpaths;
1196 fs_searchpaths = search;
1205 void FS_AddGameHierarchy (const char *dir)
1207 // Add the common game directory
1208 FS_AddGameDirectory (va("%s%s/", fs_basedir, dir));
1211 FS_AddGameDirectory(va("%s%s/", fs_userdir, dir));
1220 const char *FS_FileExtension (const char *in)
1222 const char *separator, *backslash, *colon, *dot;
1224 separator = strrchr(in, '/');
1225 backslash = strrchr(in, '\\');
1226 if (!separator || separator < backslash)
1227 separator = backslash;
1228 colon = strrchr(in, ':');
1229 if (!separator || separator < colon)
1232 dot = strrchr(in, '.');
1233 if (dot == NULL || (separator && (dot < separator)))
1245 const char *FS_FileWithoutPath (const char *in)
1247 const char *separator, *backslash, *colon;
1249 separator = strrchr(in, '/');
1250 backslash = strrchr(in, '\\');
1251 if (!separator || separator < backslash)
1252 separator = backslash;
1253 colon = strrchr(in, ':');
1254 if (!separator || separator < colon)
1256 return separator ? separator + 1 : in;
1265 void FS_ClearSearchPath (void)
1267 // unload all packs and directory information, close all pack files
1268 // (if a qfile is still reading a pack it won't be harmed because it used
1269 // dup() to get its own handle already)
1270 while (fs_searchpaths)
1272 searchpath_t *search = fs_searchpaths;
1273 fs_searchpaths = search->next;
1274 if (search->pack && search->pack != fs_selfpack)
1276 if(!search->pack->vpack)
1279 close(search->pack->handle);
1280 // free any memory associated with it
1281 if (search->pack->files)
1282 Mem_Free(search->pack->files);
1284 Mem_Free(search->pack);
1290 static void FS_AddSelfPack(void)
1294 searchpath_t *search;
1295 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1296 search->next = fs_searchpaths;
1297 search->pack = fs_selfpack;
1298 fs_searchpaths = search;
1308 void FS_Rescan (void)
1311 qboolean fs_modified = false;
1312 char gamedirbuf[MAX_INPUTLINE];
1314 FS_ClearSearchPath();
1316 // add the game-specific paths
1317 // gamedirname1 (typically id1)
1318 FS_AddGameHierarchy (gamedirname1);
1319 // update the com_modname (used for server info)
1320 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1322 // add the game-specific path, if any
1323 // (only used for mission packs and the like, which should set fs_modified)
1327 FS_AddGameHierarchy (gamedirname2);
1331 // Adds basedir/gamedir as an override game
1332 // LordHavoc: now supports multiple -game directories
1333 // set the com_modname (reported in server info)
1335 for (i = 0;i < fs_numgamedirs;i++)
1338 FS_AddGameHierarchy (fs_gamedirs[i]);
1339 // update the com_modname (used server info)
1340 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1342 strlcat(gamedirbuf, va(" %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1344 strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1346 Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1348 // add back the selfpack as new first item
1351 // set the default screenshot name to either the mod name or the
1352 // gamemode screenshot name
1353 if (strcmp(com_modname, gamedirname1))
1354 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1356 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1358 if((i = COM_CheckParm("-modname")) && i < com_argc - 1)
1359 strlcpy(com_modname, com_argv[i+1], sizeof(com_modname));
1361 // If "-condebug" is in the command line, remove the previous log file
1362 if (COM_CheckParm ("-condebug") != 0)
1363 unlink (va("%s/qconsole.log", fs_gamedir));
1365 // look for the pop.lmp file and set registered to true if it is found
1366 if (FS_FileExists("gfx/pop.lmp"))
1367 Cvar_Set ("registered", "1");
1373 if (!registered.integer)
1376 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1378 Con_Print("Playing shareware version.\n");
1381 Con_Print("Playing registered version.\n");
1383 case GAME_STEELSTORM:
1384 if (registered.integer)
1385 Con_Print("Playing registered version.\n");
1387 Con_Print("Playing shareware version.\n");
1393 // unload all wads so that future queries will return the new data
1397 void FS_Rescan_f(void)
1407 extern void Host_SaveConfig (void);
1408 extern void Host_LoadConfig_f (void);
1409 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing)
1414 if (fs_numgamedirs == numgamedirs)
1416 for (i = 0;i < numgamedirs;i++)
1417 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1419 if (i == numgamedirs)
1420 return true; // already using this set of gamedirs, do nothing
1423 if (numgamedirs > MAX_GAMEDIRS)
1426 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1427 return false; // too many gamedirs
1430 for (i = 0;i < numgamedirs;i++)
1432 // if string is nasty, reject it
1433 p = FS_CheckGameDir(gamedirs[i]);
1437 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1438 return false; // nasty gamedirs
1440 if(p == fs_checkgamedir_missing && failmissing)
1443 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1444 return false; // missing gamedirs
1450 fs_numgamedirs = numgamedirs;
1451 for (i = 0;i < fs_numgamedirs;i++)
1452 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1454 // reinitialize filesystem to detect the new paks
1457 // exec the new config
1458 Host_LoadConfig_f();
1460 // unload all sounds so they will be reloaded from the new files as needed
1461 S_UnloadAllSounds_f();
1463 // reinitialize renderer (this reloads hud/console background/etc)
1464 R_Modules_Restart();
1474 void FS_GameDir_f (void)
1478 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1482 Con_Printf("gamedirs active:");
1483 for (i = 0;i < fs_numgamedirs;i++)
1484 Con_Printf(" %s", fs_gamedirs[i]);
1489 numgamedirs = Cmd_Argc() - 1;
1490 if (numgamedirs > MAX_GAMEDIRS)
1492 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1496 for (i = 0;i < numgamedirs;i++)
1497 strlcpy(gamedirs[i], Cmd_Argv(i+1), sizeof(gamedirs[i]));
1499 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1501 // actually, changing during game would work fine, but would be stupid
1502 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1506 // halt demo playback to close the file
1509 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1512 static const char *FS_SysCheckGameDir(const char *gamedir)
1514 static char buf[8192];
1520 stringlistinit(&list);
1521 listdirectory(&list, gamedir, "");
1522 success = list.numstrings > 0;
1523 stringlistfreecontents(&list);
1527 f = FS_SysOpen(va("%smodinfo.txt", gamedir), "r", false);
1530 n = FS_Read (f, buf, sizeof(buf) - 1);
1550 const char *FS_CheckGameDir(const char *gamedir)
1554 if (FS_CheckNastyPath(gamedir, true))
1557 ret = FS_SysCheckGameDir(va("%s%s/", fs_userdir, gamedir));
1562 // get description from basedir
1563 ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir));
1571 ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir));
1575 return fs_checkgamedir_missing;
1578 static void FS_ListGameDirs(void)
1580 stringlist_t list, list2;
1584 fs_all_gamedirs_count = 0;
1586 Mem_Free(fs_all_gamedirs);
1588 stringlistinit(&list);
1589 listdirectory(&list, va("%s/", fs_basedir), "");
1590 listdirectory(&list, va("%s/", fs_userdir), "");
1591 stringlistsort(&list);
1593 stringlistinit(&list2);
1594 for(i = 0; i < list.numstrings; ++i)
1597 if(!strcmp(list.strings[i-1], list.strings[i]))
1599 info = FS_CheckGameDir(list.strings[i]);
1602 if(info == fs_checkgamedir_missing)
1606 stringlistappend(&list2, list.strings[i]);
1608 stringlistfreecontents(&list);
1610 fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1611 for(i = 0; i < list2.numstrings; ++i)
1613 info = FS_CheckGameDir(list2.strings[i]);
1614 // all this cannot happen any more, but better be safe than sorry
1617 if(info == fs_checkgamedir_missing)
1621 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[j].name));
1622 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[j].description));
1623 ++fs_all_gamedirs_count;
1632 void FS_Init_SelfPack (void)
1635 fs_mempool = Mem_AllocPool("file management", 0, NULL);
1638 fs_selfpack = FS_LoadPackPK3FromFD(com_argv[0], com_selffd, true);
1644 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
1647 const char **new_argv;
1649 int args_left = 256;
1650 new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*com_argv) * (com_argc + args_left + 2));
1653 new_argv[0] = "dummy";
1658 memcpy((char *)(&new_argv[0]), &com_argv[0], sizeof(*com_argv) * com_argc);
1661 while(COM_ParseToken_Console(&p))
1665 q = (char *)Mem_Alloc(fs_mempool, strlen(com_token) + 1);
1666 strlcpy(q, com_token, strlen(com_token) + 1);
1667 new_argv[com_argc + i] = q;
1670 new_argv[i+com_argc] = NULL;
1671 com_argv = new_argv;
1672 com_argc = com_argc + i;
1689 TCHAR mydocsdir[MAX_PATH + 1];
1690 #if _MSC_VER >= 1400
1694 #ifndef __IPHONEOS__
1699 const char* dllnames [] =
1701 "shfolder.dll", // IE 4, or Win NT and higher
1704 Sys_LoadLibrary(dllnames, &shfolder_dll, shfolderfuncs);
1705 // don't care for the result; if it fails, %USERPROFILE% will be used instead
1713 // FIXME: set fs_userdir to the documents folder
1715 // Add the personal game directory
1716 if((i = COM_CheckParm("-userdir")) && i < com_argc - 1)
1718 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", com_argv[i+1]);
1720 else if(COM_CheckParm("-nohome"))
1727 if(qSHGetFolderPath && (qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK))
1729 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Games/%s/", mydocsdir, gameuserdirname);
1730 Con_DPrintf("Obtained personal directory %s from SHGetFolderPath\n", fs_userdir);
1734 // use the environment
1735 #if _MSC_VER >= 1400
1736 _dupenv_s (&homedir, &homedirlen, "USERPROFILE");
1738 homedir = getenv("USERPROFILE");
1743 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Documents/My Games/%s/", homedir, gameuserdirname);
1744 #if _MSC_VER >= 1400
1747 Con_DPrintf("Obtained personal directory %s from environment\n", fs_userdir);
1752 Con_DPrintf("Could not obtain home directory; not supporting -mygames\n");
1754 homedir = getenv ("HOME");
1756 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/.%s/", homedir, gameuserdirname);
1759 Con_DPrintf("Could not obtain home directory; assuming -nohome\n");
1763 if(!COM_CheckParm("-mygames"))
1765 #if _MSC_VER >= 1400
1767 _sopen_s(&fd, va("%s%s/config.cfg", fs_basedir, gamedirname1), O_WRONLY | O_CREAT, _SH_DENYNO, _S_IREAD | _S_IWRITE); // note: no O_TRUNC here!
1769 int fd = open (va("%s%s/config.cfg", fs_basedir, gamedirname1), O_WRONLY | O_CREAT, 0666); // note: no O_TRUNC here!
1774 *fs_userdir = 0; // we have write access to the game dir, so let's use it
1780 strlcpy(fs_gamedir, "", sizeof(fs_gamedir));
1782 // If the base directory is explicitly defined by the compilation process
1783 #ifdef DP_FS_BASEDIR
1784 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
1789 // FIXME: is there a better way to find the directory outside the .app?
1790 if (strstr(com_argv[0], ".app/"))
1794 split = strstr(com_argv[0], ".app/");
1795 while (split > com_argv[0] && *split != '/')
1797 strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir));
1798 fs_basedir[split - com_argv[0]] = 0;
1805 // Overrides the system supplied base directory (under GAMENAME)
1806 // 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)
1807 i = COM_CheckParm ("-basedir");
1808 if (i && i < com_argc-1)
1810 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
1811 i = (int)strlen (fs_basedir);
1812 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1813 fs_basedir[i-1] = 0;
1816 // add a path separator to the end of the basedir if it lacks one
1817 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
1818 strlcat(fs_basedir, "/", sizeof(fs_basedir));
1822 p = FS_CheckGameDir(gamedirname1);
1823 if(!p || p == fs_checkgamedir_missing)
1824 Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
1828 p = FS_CheckGameDir(gamedirname2);
1829 if(!p || p == fs_checkgamedir_missing)
1830 Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
1834 // Adds basedir/gamedir as an override game
1835 // LordHavoc: now supports multiple -game directories
1836 for (i = 1;i < com_argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
1840 if (!strcmp (com_argv[i], "-game") && i < com_argc-1)
1843 p = FS_CheckGameDir(com_argv[i]);
1845 Sys_Error("Nasty -game name rejected: %s", com_argv[i]);
1846 if(p == fs_checkgamedir_missing)
1847 Con_Printf("WARNING: -game %s%s/ not found!\n", fs_basedir, com_argv[i]);
1848 // add the gamedir to the list of active gamedirs
1849 strlcpy (fs_gamedirs[fs_numgamedirs], com_argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
1854 // generate the searchpath
1858 void FS_Init_Commands(void)
1860 Cvar_RegisterVariable (&scr_screenshot_name);
1861 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1862 Cvar_RegisterVariable (&cvar_fs_gamedir);
1864 Cmd_AddCommand ("gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1865 Cmd_AddCommand ("fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1866 Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)");
1867 Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1868 Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1869 Cmd_AddCommand ("which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
1877 void FS_Shutdown (void)
1879 // close all pack files and such
1880 // (hopefully there aren't any other open files, but they'll be cleaned up
1881 // by the OS anyway)
1882 FS_ClearSearchPath();
1883 Mem_FreePool (&fs_mempool);
1886 Sys_UnloadLibrary (&shfolder_dll);
1890 int FS_SysOpenFD(const char *filepath, const char *mode, qboolean nonblocking)
1896 // Parse the mode string
1905 opt = O_CREAT | O_TRUNC;
1909 opt = O_CREAT | O_APPEND;
1912 Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
1915 for (ind = 1; mode[ind] != '\0'; ind++)
1926 Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
1927 filepath, mode, mode[ind]);
1934 #if _MSC_VER >= 1400
1935 _sopen_s(&handle, filepath, mod | opt, _SH_DENYNO, _S_IREAD | _S_IWRITE);
1937 handle = open (filepath, mod | opt, 0666);
1943 ====================
1946 Internal function used to create a qfile_t and open the relevant non-packed file on disk
1947 ====================
1949 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
1953 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1955 file->handle = FS_SysOpenFD(filepath, mode, nonblocking);
1956 if (file->handle < 0)
1962 file->filename = Mem_strdup(fs_mempool, filepath);
1964 file->real_length = lseek (file->handle, 0, SEEK_END);
1966 // For files opened in append mode, we start at the end of the file
1968 file->position = file->real_length;
1970 lseek (file->handle, 0, SEEK_SET);
1980 Open a packed file using its package file descriptor
1983 qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
1989 pfile = &pack->files[pack_ind];
1991 // If we don't have the true offset, get it now
1992 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
1993 if (!PK3_GetTrueFileOffset (pfile, pack))
1996 #ifndef LINK_TO_ZLIB
1997 // No Zlib DLL = no compressed files
1998 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2000 Con_Printf("WARNING: can't open the compressed file %s\n"
2001 "You need the Zlib DLL to use compressed files\n",
2007 // LordHavoc: lseek affects all duplicates of a handle so we do it before
2008 // the dup() call to avoid having to close the dup_handle on error here
2009 if (lseek (pack->handle, pfile->offset, SEEK_SET) == -1)
2011 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n",
2012 pfile->name, pack->filename, (int) pfile->offset);
2016 dup_handle = dup (pack->handle);
2019 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2023 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2024 memset (file, 0, sizeof (*file));
2025 file->handle = dup_handle;
2026 file->flags = QFILE_FLAG_PACKED;
2027 file->real_length = pfile->realsize;
2028 file->offset = pfile->offset;
2032 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2036 file->flags |= QFILE_FLAG_DEFLATED;
2038 // We need some more variables
2039 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2041 ztk->comp_length = pfile->packsize;
2043 // Initialize zlib stream
2044 ztk->zstream.next_in = ztk->input;
2045 ztk->zstream.avail_in = 0;
2047 /* From Zlib's "unzip.c":
2049 * windowBits is passed < 0 to tell that there is no zlib header.
2050 * Note that in this case inflate *requires* an extra "dummy" byte
2051 * after the compressed stream in order to complete decompression and
2052 * return Z_STREAM_END.
2053 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2054 * size of both compressed and uncompressed data
2056 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2058 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2064 ztk->zstream.next_out = file->buff;
2065 ztk->zstream.avail_out = sizeof (file->buff);
2074 ====================
2077 Return true if the path should be rejected due to one of the following:
2078 1: path elements that are non-portable
2079 2: path elements that would allow access to files outside the game directory,
2080 or are just not a good idea for a mod to be using.
2081 ====================
2083 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
2085 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2089 // Windows: don't allow \ in filenames (windows-only), period.
2090 // (on Windows \ is a directory separator, but / is also supported)
2091 if (strstr(path, "\\"))
2092 return 1; // non-portable
2094 // Mac: don't allow Mac-only filenames - : is a directory separator
2095 // instead of /, but we rely on / working already, so there's no reason to
2096 // support a Mac-only path
2097 // Amiga and Windows: : tries to go to root of drive
2098 if (strstr(path, ":"))
2099 return 1; // non-portable attempt to go to root of drive
2101 // Amiga: // is parent directory
2102 if (strstr(path, "//"))
2103 return 1; // non-portable attempt to go to parent directory
2105 // all: don't allow going to parent directory (../ or /../)
2106 if (strstr(path, ".."))
2107 return 2; // attempt to go outside the game directory
2109 // Windows and UNIXes: don't allow absolute paths
2111 return 2; // attempt to go outside the game directory
2113 // all: don't allow . characters before the last slash (it should only be used in filenames, not path elements), this catches all imaginable cases of ./, ../, .../, etc
2114 if (strchr(path, '.'))
2118 // gamedir is entirely path elements, so simply forbid . entirely
2121 if (strchr(path, '.') < strrchr(path, '/'))
2122 return 2; // possible attempt to go outside the game directory
2125 // all: forbid trailing slash on gamedir
2126 if (isgamedir && path[strlen(path)-1] == '/')
2129 // all: forbid leading dot on any filename for any reason
2130 if (strstr(path, "/."))
2131 return 2; // attempt to go outside the game directory
2133 // after all these checks we're pretty sure it's a / separated filename
2134 // and won't do much if any harm
2140 ====================
2143 Look for a file in the packages and in the filesystem
2145 Return the searchpath where the file was found (or NULL)
2146 and the file index in the package if relevant
2147 ====================
2149 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
2151 searchpath_t *search;
2154 // search through the path, one element at a time
2155 for (search = fs_searchpaths;search;search = search->next)
2157 // is the element a pak file?
2158 if (search->pack && !search->pack->vpack)
2160 int (*strcmp_funct) (const char* str1, const char* str2);
2161 int left, right, middle;
2164 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2166 // Look for the file (binary search)
2168 right = pak->numfiles - 1;
2169 while (left <= right)
2173 middle = (left + right) / 2;
2174 diff = strcmp_funct (pak->files[middle].name, name);
2179 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2181 // yes, but the first one is empty so we treat it as not being there
2182 if (!quiet && developer_extra.integer)
2183 Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2190 if (!quiet && developer_extra.integer)
2191 Con_DPrintf("FS_FindFile: %s in %s\n",
2192 pak->files[middle].name, pak->filename);
2199 // If we're too far in the list
2208 char netpath[MAX_OSPATH];
2209 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2210 if (FS_SysFileExists (netpath))
2212 if (!quiet && developer_extra.integer)
2213 Con_DPrintf("FS_FindFile: %s\n", netpath);
2222 if (!quiet && developer_extra.integer)
2223 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2235 Look for a file in the search paths and open it in read-only mode
2238 qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking, int symlinkLevels)
2240 searchpath_t *search;
2243 search = FS_FindFile (filename, &pack_ind, quiet);
2249 // Found in the filesystem?
2252 // this works with vpacks, so we are fine
2253 char path [MAX_OSPATH];
2254 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2255 return FS_SysOpen (path, "rb", nonblocking);
2258 // So, we found it in a package...
2260 // Is it a PK3 symlink?
2261 // TODO also handle directory symlinks by parsing the whole structure...
2262 // but heck, file symlinks are good enough for now
2263 if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2265 if(symlinkLevels <= 0)
2267 Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2272 char linkbuf[MAX_QPATH];
2274 qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2275 const char *mergeslash;
2280 count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2286 // Now combine the paths...
2287 mergeslash = strrchr(filename, '/');
2288 mergestart = linkbuf;
2290 mergeslash = filename;
2291 while(!strncmp(mergestart, "../", 3))
2294 while(mergeslash > filename)
2297 if(*mergeslash == '/')
2301 // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2302 if(mergeslash == filename)
2304 // Either mergeslash == filename, then we just replace the name (done below)
2308 // Or, we append the name after mergeslash;
2309 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2310 int spaceNeeded = mergeslash - filename + 1;
2311 int spaceRemoved = mergestart - linkbuf;
2312 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2314 Con_DPrintf("symlink: too long path rejected\n");
2317 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2318 memcpy(linkbuf, filename, spaceNeeded);
2319 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2320 mergestart = linkbuf;
2322 if (!quiet && developer_loading.integer)
2323 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2324 if(FS_CheckNastyPath (mergestart, false))
2326 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2329 return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2333 return FS_OpenPackedFile (search->pack, pack_ind);
2338 =============================================================================
2340 MAIN PUBLIC FUNCTIONS
2342 =============================================================================
2346 ====================
2349 Open a file in the userpath. The syntax is the same as fopen
2350 Used for savegame scanning in menu, and all file writing.
2351 ====================
2353 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet)
2355 char real_path [MAX_OSPATH];
2357 if (FS_CheckNastyPath(filepath, false))
2359 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2363 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2365 // If the file is opened in "write", "append", or "read/write" mode,
2366 // create directories up to the file.
2367 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2368 FS_CreatePath (real_path);
2369 return FS_SysOpen (real_path, mode, false);
2374 ====================
2377 Open a file. The syntax is the same as fopen
2378 ====================
2380 qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet)
2382 if (FS_CheckNastyPath(filepath, false))
2384 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2388 return FS_OpenReadFile (filepath, quiet, false, 16);
2393 ====================
2396 Open a file. The syntax is the same as fopen
2397 ====================
2399 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet)
2402 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2403 memset (file, 0, sizeof (*file));
2404 file->flags = QFILE_FLAG_DATA;
2406 file->real_length = size;
2412 ====================
2416 ====================
2418 int FS_Close (qfile_t* file)
2420 if(file->flags & QFILE_FLAG_DATA)
2426 if (close (file->handle))
2431 if (file->flags & QFILE_FLAG_REMOVE)
2432 remove(file->filename);
2434 Mem_Free((void *) file->filename);
2439 qz_inflateEnd (&file->ztk->zstream);
2440 Mem_Free (file->ztk);
2447 void FS_RemoveOnClose(qfile_t* file)
2449 file->flags |= QFILE_FLAG_REMOVE;
2453 ====================
2456 Write "datasize" bytes into a file
2457 ====================
2459 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2463 // If necessary, seek to the exact file position we're supposed to be
2464 if (file->buff_ind != file->buff_len)
2465 lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
2467 // Purge cached data
2470 // Write the buffer and update the position
2471 result = write (file->handle, data, (fs_offset_t)datasize);
2472 file->position = lseek (file->handle, 0, SEEK_CUR);
2473 if (file->real_length < file->position)
2474 file->real_length = file->position;
2484 ====================
2487 Read up to "buffersize" bytes from a file
2488 ====================
2490 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2492 fs_offset_t count, done;
2494 if (buffersize == 0)
2497 // Get rid of the ungetc character
2498 if (file->ungetc != EOF)
2500 ((char*)buffer)[0] = file->ungetc;
2508 if(file->flags & QFILE_FLAG_DATA)
2510 size_t left = file->real_length - file->position;
2511 if(buffersize > left)
2513 memcpy(buffer, file->data + file->position, buffersize);
2514 file->position += buffersize;
2518 // First, we copy as many bytes as we can from "buff"
2519 if (file->buff_ind < file->buff_len)
2521 count = file->buff_len - file->buff_ind;
2522 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2524 memcpy (buffer, &file->buff[file->buff_ind], count);
2525 file->buff_ind += count;
2527 buffersize -= count;
2528 if (buffersize == 0)
2532 // NOTE: at this point, the read buffer is always empty
2534 // If the file isn't compressed
2535 if (! (file->flags & QFILE_FLAG_DEFLATED))
2539 // We must take care to not read after the end of the file
2540 count = file->real_length - file->position;
2542 // If we have a lot of data to get, put them directly into "buffer"
2543 if (buffersize > sizeof (file->buff) / 2)
2545 if (count > (fs_offset_t)buffersize)
2546 count = (fs_offset_t)buffersize;
2547 lseek (file->handle, file->offset + file->position, SEEK_SET);
2548 nb = read (file->handle, &((unsigned char*)buffer)[done], count);
2552 file->position += nb;
2554 // Purge cached data
2560 if (count > (fs_offset_t)sizeof (file->buff))
2561 count = (fs_offset_t)sizeof (file->buff);
2562 lseek (file->handle, file->offset + file->position, SEEK_SET);
2563 nb = read (file->handle, file->buff, count);
2566 file->buff_len = nb;
2567 file->position += nb;
2569 // Copy the requested data in "buffer" (as much as we can)
2570 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2571 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2572 file->buff_ind = count;
2580 // If the file is compressed, it's more complicated...
2581 // We cycle through a few operations until we have read enough data
2582 while (buffersize > 0)
2584 ztoolkit_t *ztk = file->ztk;
2587 // NOTE: at this point, the read buffer is always empty
2589 // If "input" is also empty, we need to refill it
2590 if (ztk->in_ind == ztk->in_len)
2592 // If we are at the end of the file
2593 if (file->position == file->real_length)
2596 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
2597 if (count > (fs_offset_t)sizeof (ztk->input))
2598 count = (fs_offset_t)sizeof (ztk->input);
2599 lseek (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
2600 if (read (file->handle, ztk->input, count) != count)
2602 Con_Printf ("FS_Read: unexpected end of file\n");
2607 ztk->in_len = count;
2608 ztk->in_position += count;
2611 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
2612 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
2614 // Now that we are sure we have compressed data available, we need to determine
2615 // if it's better to inflate it in "file->buff" or directly in "buffer"
2617 // Inflate the data in "file->buff"
2618 if (buffersize < sizeof (file->buff) / 2)
2620 ztk->zstream.next_out = file->buff;
2621 ztk->zstream.avail_out = sizeof (file->buff);
2622 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2623 if (error != Z_OK && error != Z_STREAM_END)
2625 Con_Printf ("FS_Read: Can't inflate file\n");
2628 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2630 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
2631 file->position += file->buff_len;
2633 // Copy the requested data in "buffer" (as much as we can)
2634 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2635 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2636 file->buff_ind = count;
2639 // Else, we inflate directly in "buffer"
2642 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
2643 ztk->zstream.avail_out = (unsigned int)buffersize;
2644 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2645 if (error != Z_OK && error != Z_STREAM_END)
2647 Con_Printf ("FS_Read: Can't inflate file\n");
2650 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2652 // How much data did it inflate?
2653 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
2654 file->position += count;
2656 // Purge cached data
2661 buffersize -= count;
2669 ====================
2672 Print a string into a file
2673 ====================
2675 int FS_Print (qfile_t* file, const char *msg)
2677 return (int)FS_Write (file, msg, strlen (msg));
2681 ====================
2684 Print a string into a file
2685 ====================
2687 int FS_Printf(qfile_t* file, const char* format, ...)
2692 va_start (args, format);
2693 result = FS_VPrintf (file, format, args);
2701 ====================
2704 Print a string into a file
2705 ====================
2707 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
2710 fs_offset_t buff_size = MAX_INPUTLINE;
2715 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
2716 len = dpvsnprintf (tempbuff, buff_size, format, ap);
2717 if (len >= 0 && len < buff_size)
2719 Mem_Free (tempbuff);
2723 len = write (file->handle, tempbuff, len);
2724 Mem_Free (tempbuff);
2731 ====================
2734 Get the next character of a file
2735 ====================
2737 int FS_Getc (qfile_t* file)
2741 if (FS_Read (file, &c, 1) != 1)
2749 ====================
2752 Put a character back into the read buffer (only supports one character!)
2753 ====================
2755 int FS_UnGetc (qfile_t* file, unsigned char c)
2757 // If there's already a character waiting to be read
2758 if (file->ungetc != EOF)
2767 ====================
2770 Move the position index in a file
2771 ====================
2773 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
2776 unsigned char* buffer;
2777 fs_offset_t buffersize;
2779 // Compute the file offset
2783 offset += file->position - file->buff_len + file->buff_ind;
2790 offset += file->real_length;
2796 if (offset < 0 || offset > file->real_length)
2799 if(file->flags & QFILE_FLAG_DATA)
2801 file->position = offset;
2805 // If we have the data in our read buffer, we don't need to actually seek
2806 if (file->position - file->buff_len <= offset && offset <= file->position)
2808 file->buff_ind = offset + file->buff_len - file->position;
2812 // Purge cached data
2815 // Unpacked or uncompressed files can seek directly
2816 if (! (file->flags & QFILE_FLAG_DEFLATED))
2818 if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
2820 file->position = offset;
2824 // Seeking in compressed files is more a hack than anything else,
2825 // but we need to support it, so here we go.
2828 // If we have to go back in the file, we need to restart from the beginning
2829 if (offset <= file->position)
2833 ztk->in_position = 0;
2835 lseek (file->handle, file->offset, SEEK_SET);
2837 // Reset the Zlib stream
2838 ztk->zstream.next_in = ztk->input;
2839 ztk->zstream.avail_in = 0;
2840 qz_inflateReset (&ztk->zstream);
2843 // We need a big buffer to force inflating into it directly
2844 buffersize = 2 * sizeof (file->buff);
2845 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
2847 // Skip all data until we reach the requested offset
2848 while (offset > file->position)
2850 fs_offset_t diff = offset - file->position;
2851 fs_offset_t count, len;
2853 count = (diff > buffersize) ? buffersize : diff;
2854 len = FS_Read (file, buffer, count);
2868 ====================
2871 Give the current position in a file
2872 ====================
2874 fs_offset_t FS_Tell (qfile_t* file)
2876 return file->position - file->buff_len + file->buff_ind;
2881 ====================
2884 Give the total size of a file
2885 ====================
2887 fs_offset_t FS_FileSize (qfile_t* file)
2889 return file->real_length;
2894 ====================
2897 Erases any buffered input or output data
2898 ====================
2900 void FS_Purge (qfile_t* file)
2912 Filename are relative to the quake directory.
2913 Always appends a 0 byte.
2916 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
2919 unsigned char *buf = NULL;
2920 fs_offset_t filesize = 0;
2922 file = FS_OpenVirtualFile(path, quiet);
2925 filesize = file->real_length;
2928 Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
2933 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
2934 buf[filesize] = '\0';
2935 FS_Read (file, buf, filesize);
2937 if (developer_loadfile.integer)
2938 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
2941 if (filesizepointer)
2942 *filesizepointer = filesize;
2951 The filename will be prefixed by the current game directory
2954 qboolean FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
2958 fs_offset_t lentotal;
2960 file = FS_OpenRealFile(filename, "wb", false);
2963 Con_Printf("FS_WriteFile: failed on %s\n", filename);
2968 for(i = 0; i < count; ++i)
2970 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
2971 for(i = 0; i < count; ++i)
2972 FS_Write (file, data[i], len[i]);
2977 qboolean FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
2979 return FS_WriteFileInBlocks(filename, &data, &len, 1);
2984 =============================================================================
2986 OTHERS PUBLIC FUNCTIONS
2988 =============================================================================
2996 void FS_StripExtension (const char *in, char *out, size_t size_out)
3004 while ((currentchar = *in) && size_out > 1)
3006 if (currentchar == '.')
3008 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3010 *out++ = currentchar;
3026 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3030 // if path doesn't have a .EXT, append extension
3031 // (extension should include the .)
3032 src = path + strlen(path) - 1;
3034 while (*src != '/' && src != path)
3037 return; // it has an extension
3041 strlcat (path, extension, size_path);
3049 Look for a file in the packages and in the filesystem
3052 int FS_FileType (const char *filename)
3054 searchpath_t *search;
3055 char fullpath[MAX_OSPATH];
3057 search = FS_FindFile (filename, NULL, true);
3059 return FS_FILETYPE_NONE;
3061 if(search->pack && !search->pack->vpack)
3062 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3064 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3065 return FS_SysFileType(fullpath);
3073 Look for a file in the packages and in the filesystem
3076 qboolean FS_FileExists (const char *filename)
3078 return (FS_FindFile (filename, NULL, true) != NULL);
3086 Look for a file in the filesystem only
3089 int FS_SysFileType (const char *path)
3092 // Sajt - some older sdks are missing this define
3093 # ifndef INVALID_FILE_ATTRIBUTES
3094 # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3097 DWORD result = GetFileAttributes(path);
3099 if(result == INVALID_FILE_ATTRIBUTES)
3100 return FS_FILETYPE_NONE;
3102 if(result & FILE_ATTRIBUTE_DIRECTORY)
3103 return FS_FILETYPE_DIRECTORY;
3105 return FS_FILETYPE_FILE;
3109 if (stat (path,&buf) == -1)
3110 return FS_FILETYPE_NONE;
3113 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3115 if(S_ISDIR(buf.st_mode))
3116 return FS_FILETYPE_DIRECTORY;
3118 return FS_FILETYPE_FILE;
3122 qboolean FS_SysFileExists (const char *path)
3124 return FS_SysFileType (path) != FS_FILETYPE_NONE;
3127 void FS_mkdir (const char *path)
3140 Allocate and fill a search structure with information on matching filenames.
3143 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
3146 searchpath_t *searchpath;
3148 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3149 stringlist_t resultlist;
3150 stringlist_t dirlist;
3151 const char *slash, *backslash, *colon, *separator;
3153 char temp[MAX_OSPATH];
3155 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3160 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3164 stringlistinit(&resultlist);
3165 stringlistinit(&dirlist);
3167 slash = strrchr(pattern, '/');
3168 backslash = strrchr(pattern, '\\');
3169 colon = strrchr(pattern, ':');
3170 separator = max(slash, backslash);
3171 separator = max(separator, colon);
3172 basepathlength = separator ? (separator + 1 - pattern) : 0;
3173 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3175 memcpy(basepath, pattern, basepathlength);
3176 basepath[basepathlength] = 0;
3178 // search through the path, one element at a time
3179 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3181 // is the element a pak file?
3182 if (searchpath->pack && !searchpath->pack->vpack)
3184 // look through all the pak file elements
3185 pak = searchpath->pack;
3186 for (i = 0;i < pak->numfiles;i++)
3188 strlcpy(temp, pak->files[i].name, sizeof(temp));
3191 if (matchpattern(temp, (char *)pattern, true))
3193 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3194 if (!strcmp(resultlist.strings[resultlistindex], temp))
3196 if (resultlistindex == resultlist.numstrings)
3198 stringlistappend(&resultlist, temp);
3199 if (!quiet && developer_loading.integer)
3200 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3203 // strip off one path element at a time until empty
3204 // this way directories are added to the listing if they match the pattern
3205 slash = strrchr(temp, '/');
3206 backslash = strrchr(temp, '\\');
3207 colon = strrchr(temp, ':');
3209 if (separator < slash)
3211 if (separator < backslash)
3212 separator = backslash;
3213 if (separator < colon)
3215 *((char *)separator) = 0;
3221 stringlist_t matchedSet, foundSet;
3222 const char *start = pattern;
3224 stringlistinit(&matchedSet);
3225 stringlistinit(&foundSet);
3226 // add a first entry to the set
3227 stringlistappend(&matchedSet, "");
3228 // iterate through pattern's path
3231 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3232 char subpath[MAX_OSPATH];
3233 char subpattern[MAX_OSPATH];
3235 // find the next wildcard
3236 wildcard = strchr(start, '?');
3237 asterisk = strchr(start, '*');
3238 if (asterisk && (!wildcard || asterisk < wildcard))
3240 wildcard = asterisk;
3245 nextseparator = strchr( wildcard, '/' );
3249 nextseparator = NULL;
3252 if( !nextseparator ) {
3253 nextseparator = start + strlen( start );
3256 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3257 // copy everything up except nextseperator
3258 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3259 // find the last '/' before the wildcard
3260 prevseparator = strrchr( subpattern, '/' );
3262 prevseparator = subpattern;
3265 // copy everything from start to the previous including the '/' (before the wildcard)
3266 // everything up to start is already included in the path of matchedSet's entries
3267 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3269 // for each entry in matchedSet try to open the subdirectories specified in subpath
3270 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3271 strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3272 strlcat( temp, subpath, sizeof(temp) );
3273 listdirectory( &foundSet, searchpath->filename, temp );
3275 if( dirlistindex == 0 ) {
3278 // reset the current result set
3279 stringlistfreecontents( &matchedSet );
3280 // match against the pattern
3281 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3282 const char *direntry = foundSet.strings[ dirlistindex ];
3283 if (matchpattern(direntry, subpattern, true)) {
3284 stringlistappend( &matchedSet, direntry );
3287 stringlistfreecontents( &foundSet );
3289 start = nextseparator;
3292 for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3294 const char *temp = matchedSet.strings[dirlistindex];
3295 if (matchpattern(temp, (char *)pattern, true))
3297 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3298 if (!strcmp(resultlist.strings[resultlistindex], temp))
3300 if (resultlistindex == resultlist.numstrings)
3302 stringlistappend(&resultlist, temp);
3303 if (!quiet && developer_loading.integer)
3304 Con_Printf("SearchDirFile: %s\n", temp);
3308 stringlistfreecontents( &matchedSet );
3312 if (resultlist.numstrings)
3314 stringlistsort(&resultlist);
3315 numfiles = resultlist.numstrings;
3317 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3318 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3319 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3320 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3321 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3322 search->numfilenames = (int)numfiles;
3325 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3328 search->filenames[numfiles] = search->filenamesbuffer + numchars;
3329 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3330 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3332 numchars += (int)textlen;
3335 stringlistfreecontents(&resultlist);
3341 void FS_FreeSearch(fssearch_t *search)
3346 extern int con_linewidth;
3347 int FS_ListDirectory(const char *pattern, int oneperline)
3356 char linebuf[MAX_INPUTLINE];
3358 search = FS_Search(pattern, true, true);
3361 numfiles = search->numfilenames;
3364 // FIXME: the names could be added to one column list and then
3365 // gradually shifted into the next column if they fit, and then the
3366 // next to make a compact variable width listing but it's a lot more
3368 // find width for columns
3370 for (i = 0;i < numfiles;i++)
3372 l = (int)strlen(search->filenames[i]);
3373 if (columnwidth < l)
3376 // count the spacing character
3378 // calculate number of columns
3379 numcolumns = con_linewidth / columnwidth;
3380 // don't bother with the column printing if it's only one column
3381 if (numcolumns >= 2)
3383 numlines = (numfiles + numcolumns - 1) / numcolumns;
3384 for (i = 0;i < numlines;i++)
3387 for (k = 0;k < numcolumns;k++)
3389 l = i * numcolumns + k;
3392 name = search->filenames[l];
3393 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3394 linebuf[linebufpos++] = name[j];
3395 // space out name unless it's the last on the line
3396 if (k + 1 < numcolumns && l + 1 < numfiles)
3397 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3398 linebuf[linebufpos++] = ' ';
3401 linebuf[linebufpos] = 0;
3402 Con_Printf("%s\n", linebuf);
3409 for (i = 0;i < numfiles;i++)
3410 Con_Printf("%s\n", search->filenames[i]);
3411 FS_FreeSearch(search);
3412 return (int)numfiles;
3415 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
3417 const char *pattern;
3420 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3423 if (Cmd_Argc() == 2)
3424 pattern = Cmd_Argv(1);
3427 if (!FS_ListDirectory(pattern, oneperline))
3428 Con_Print("No files found.\n");
3433 FS_ListDirectoryCmd("dir", true);
3438 FS_ListDirectoryCmd("ls", false);
3441 void FS_Which_f(void)
3443 const char *filename;
3446 if (Cmd_Argc() != 2)
3448 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(0));
3451 filename = Cmd_Argv(1);
3452 sp = FS_FindFile(filename, &index, true);
3454 Con_Printf("%s isn't anywhere\n", filename);
3460 Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3462 Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3465 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3469 const char *FS_WhichPack(const char *filename)
3472 searchpath_t *sp = FS_FindFile(filename, &index, true);
3474 return sp->pack->shortname;
3480 ====================
3481 FS_IsRegisteredQuakePack
3483 Look for a proof of purchase file file in the requested package
3485 If it is found, this file should NOT be downloaded.
3486 ====================
3488 qboolean FS_IsRegisteredQuakePack(const char *name)
3490 searchpath_t *search;
3493 // search through the path, one element at a time
3494 for (search = fs_searchpaths;search;search = search->next)
3496 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3497 // TODO do we want to support vpacks in here too?
3499 int (*strcmp_funct) (const char* str1, const char* str2);
3500 int left, right, middle;
3503 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3505 // Look for the file (binary search)
3507 right = pak->numfiles - 1;
3508 while (left <= right)
3512 middle = (left + right) / 2;
3513 diff = !strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3519 // If we're too far in the list
3526 // we found the requested pack but it is not registered quake
3534 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3537 unsigned char *filedata;
3538 fs_offset_t filesize;
3539 if (filesizepointer)
3540 *filesizepointer = 0;
3541 if (!filename || !*filename)
3543 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
3546 if (filesizepointer)
3547 *filesizepointer = filesize;
3548 crc = CRC_Block(filedata, filesize);
3554 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
3557 unsigned char *out = NULL;
3561 #ifndef LINK_TO_ZLIB
3566 memset(&strm, 0, sizeof(strm));
3567 strm.zalloc = Z_NULL;
3568 strm.zfree = Z_NULL;
3569 strm.opaque = Z_NULL;
3572 level = Z_DEFAULT_COMPRESSION;
3574 if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
3576 Con_Printf("FS_Deflate: deflate init error!\n");
3580 strm.next_in = (unsigned char*)data;
3581 strm.avail_in = size;
3583 tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
3586 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
3587 qz_deflateEnd(&strm);
3591 strm.next_out = tmp;
3592 strm.avail_out = size;
3594 if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
3596 Con_Printf("FS_Deflate: deflate failed!\n");
3597 qz_deflateEnd(&strm);
3602 if(qz_deflateEnd(&strm) != Z_OK)
3604 Con_Printf("FS_Deflate: deflateEnd failed\n");
3609 if(strm.total_out >= size)
3611 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
3616 out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
3619 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
3625 *deflated_size = (size_t)strm.total_out;
3627 memcpy(out, tmp, strm.total_out);
3633 static void AssertBufsize(sizebuf_t *buf, int length)
3635 if(buf->cursize + length > buf->maxsize)
3637 int oldsize = buf->maxsize;
3638 unsigned char *olddata;
3639 olddata = buf->data;
3640 buf->maxsize += length;
3641 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
3644 memcpy(buf->data, olddata, oldsize);
3650 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
3654 unsigned char *out = NULL;
3655 unsigned char tmp[2048];
3660 #ifndef LINK_TO_ZLIB
3665 memset(&outbuf, 0, sizeof(outbuf));
3666 outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
3667 outbuf.maxsize = sizeof(tmp);
3669 memset(&strm, 0, sizeof(strm));
3670 strm.zalloc = Z_NULL;
3671 strm.zfree = Z_NULL;
3672 strm.opaque = Z_NULL;
3674 if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
3676 Con_Printf("FS_Inflate: inflate init error!\n");
3677 Mem_Free(outbuf.data);
3681 strm.next_in = (unsigned char*)data;
3682 strm.avail_in = size;
3686 strm.next_out = tmp;
3687 strm.avail_out = sizeof(tmp);
3688 ret = qz_inflate(&strm, Z_NO_FLUSH);
3689 // it either returns Z_OK on progress, Z_STREAM_END on end
3697 case Z_STREAM_ERROR:
3698 Con_Print("FS_Inflate: stream error!\n");
3701 Con_Print("FS_Inflate: data error!\n");
3704 Con_Print("FS_Inflate: mem error!\n");
3707 Con_Print("FS_Inflate: buf error!\n");
3710 Con_Print("FS_Inflate: unknown error!\n");
3714 if(ret != Z_OK && ret != Z_STREAM_END)
3716 Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
3717 Mem_Free(outbuf.data);
3718 qz_inflateEnd(&strm);
3721 have = sizeof(tmp) - strm.avail_out;
3722 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
3723 SZ_Write(&outbuf, tmp, have);
3724 } while(ret != Z_STREAM_END);
3726 qz_inflateEnd(&strm);
3728 out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
3731 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
3732 Mem_Free(outbuf.data);
3736 memcpy(out, outbuf.data, outbuf.cursize);
3737 Mem_Free(outbuf.data);
3740 *inflated_size = (size_t)outbuf.cursize;