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
34 # include <sys/stat.h>
43 // Win32 requires us to add O_BINARY, but the other OSes don't have it
48 // In case the system doesn't support the O_NONBLOCK flag
53 // largefile support for Win32
55 # define lseek _lseeki64
59 // suppress deprecated warnings
60 # include <sys/stat.h>
65 # define unlink _unlink
69 /** \page fs File System
71 All of Quake's data access is through a hierchal file system, but the contents
72 of the file system can be transparently merged from several sources.
74 The "base directory" is the path to the directory holding the quake.exe and
75 all game directories. The sys_* files pass this to host_init in
76 quakeparms_t->basedir. This can be overridden with the "-basedir" command
77 line parm to allow code debugging in a different directory. The base
78 directory is only used during filesystem initialization.
80 The "game directory" is the first tree on the search path and directory that
81 all generated files (savegames, screenshots, demos, config files) will be
82 saved to. This can be overridden with the "-game" command line parameter.
83 The game directory can never be changed while quake is executing. This is a
84 precaution against having a malicious server instruct clients to write files
85 over areas they shouldn't.
91 =============================================================================
95 =============================================================================
98 // Magic numbers of a ZIP file (big-endian format)
99 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
100 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
101 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
103 // Other constants for ZIP files
104 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
105 #define ZIP_END_CDIR_SIZE 22
106 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
107 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
112 #define qz_inflate inflate
113 #define qz_inflateEnd inflateEnd
114 #define qz_inflateInit2_ inflateInit2_
115 #define qz_inflateReset inflateReset
116 #define qz_deflateInit2_ deflateInit2_
117 #define qz_deflateEnd deflateEnd
118 #define qz_deflate deflate
119 #define Z_MEMLEVEL_DEFAULT 8
122 // Zlib constants (from zlib.h)
123 #define Z_SYNC_FLUSH 2
126 #define Z_STREAM_END 1
127 #define Z_STREAM_ERROR (-2)
128 #define Z_DATA_ERROR (-3)
129 #define Z_MEM_ERROR (-4)
130 #define Z_BUF_ERROR (-5)
131 #define ZLIB_VERSION "1.2.3"
135 #define Z_MEMLEVEL_DEFAULT 8
138 #define Z_DEFAULT_COMPRESSION (-1)
140 #define Z_SYNC_FLUSH 2
141 #define Z_FULL_FLUSH 3
144 // Uncomment the following line if the zlib DLL you have still uses
145 // the 1.1.x series calling convention on Win32 (WINAPI)
146 //#define ZLIB_USES_WINAPI
150 =============================================================================
154 =============================================================================
157 /*! Zlib stream (from zlib.h)
158 * \warning: some pointers we don't use directly have
159 * been cast to "void*" for a matter of simplicity
163 unsigned char *next_in; ///< next input byte
164 unsigned int avail_in; ///< number of bytes available at next_in
165 unsigned long total_in; ///< total nb of input bytes read so far
167 unsigned char *next_out; ///< next output byte should be put there
168 unsigned int avail_out; ///< remaining free space at next_out
169 unsigned long total_out; ///< total nb of bytes output so far
171 char *msg; ///< last error message, NULL if no error
172 void *state; ///< not visible by applications
174 void *zalloc; ///< used to allocate the internal state
175 void *zfree; ///< used to free the internal state
176 void *opaque; ///< private data object passed to zalloc and zfree
178 int data_type; ///< best guess about the data type: ascii or binary
179 unsigned long adler; ///< adler32 value of the uncompressed data
180 unsigned long reserved; ///< reserved for future use
185 /// inside a package (PAK or PK3)
186 #define QFILE_FLAG_PACKED (1 << 0)
187 /// file is compressed using the deflate algorithm (PK3 only)
188 #define QFILE_FLAG_DEFLATED (1 << 1)
189 /// file is actually already loaded data
190 #define QFILE_FLAG_DATA (1 << 2)
191 /// real file will be removed on close
192 #define QFILE_FLAG_REMOVE (1 << 3)
194 #define FILE_BUFF_SIZE 2048
198 size_t comp_length; ///< length of the compressed file
199 size_t in_ind, in_len; ///< input buffer current index and length
200 size_t in_position; ///< position in the compressed file
201 unsigned char input [FILE_BUFF_SIZE];
207 int handle; ///< file descriptor
208 fs_offset_t real_length; ///< uncompressed file size (for files opened in "read" mode)
209 fs_offset_t position; ///< current position in the file
210 fs_offset_t offset; ///< offset into the package (0 if external file)
211 int ungetc; ///< single stored character from ungetc, cleared to EOF when read
214 fs_offset_t buff_ind, buff_len; ///< buffer current index and length
215 unsigned char buff [FILE_BUFF_SIZE];
217 ztoolkit_t* ztk; ///< For zipped files.
219 const unsigned char *data; ///< For data files.
221 const char *filename; ///< Kept around for QFILE_FLAG_REMOVE, unused otherwise
225 // ------ PK3 files on disk ------ //
227 // You can get the complete ZIP format description from PKWARE website
229 typedef struct pk3_endOfCentralDir_s
231 unsigned int signature;
232 unsigned short disknum;
233 unsigned short cdir_disknum; ///< number of the disk with the start of the central directory
234 unsigned short localentries; ///< number of entries in the central directory on this disk
235 unsigned short nbentries; ///< total number of entries in the central directory on this disk
236 unsigned int cdir_size; ///< size of the central directory
237 unsigned int cdir_offset; ///< with respect to the starting disk number
238 unsigned short comment_size;
239 fs_offset_t prepended_garbage;
240 } pk3_endOfCentralDir_t;
243 // ------ PAK files on disk ------ //
244 typedef struct dpackfile_s
247 int filepos, filelen;
250 typedef struct dpackheader_s
258 /*! \name Packages in memory
261 /// the offset in packfile_t is the true contents offset
262 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
263 /// file compressed using the deflate algorithm
264 #define PACKFILE_FLAG_DEFLATED (1 << 1)
265 /// file is a symbolic link
266 #define PACKFILE_FLAG_SYMLINK (1 << 2)
268 typedef struct packfile_s
270 char name [MAX_QPATH];
273 fs_offset_t packsize; ///< size in the package
274 fs_offset_t realsize; ///< real file size (uncompressed)
277 typedef struct pack_s
279 char filename [MAX_OSPATH];
280 char shortname [MAX_QPATH];
282 int ignorecase; ///< PK3 ignores case
289 /// Search paths for files (including packages)
290 typedef struct searchpath_s
292 // only one of filename / pack will be used
293 char filename[MAX_OSPATH];
295 struct searchpath_s *next;
300 =============================================================================
304 =============================================================================
309 void FS_Which_f(void);
311 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet);
312 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
313 fs_offset_t offset, fs_offset_t packsize,
314 fs_offset_t realsize, int flags);
318 =============================================================================
322 =============================================================================
325 mempool_t *fs_mempool;
327 searchpath_t *fs_searchpaths = NULL;
328 const char *const fs_checkgamedir_missing = "missing";
330 #define MAX_FILES_IN_PACK 65536
332 char fs_userdir[MAX_OSPATH];
333 char fs_gamedir[MAX_OSPATH];
334 char fs_basedir[MAX_OSPATH];
335 static pack_t *fs_selfpack = NULL;
337 // list of active game directories (empty if not running a mod)
338 int fs_numgamedirs = 0;
339 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
341 // list of all gamedirs with modinfo.txt
342 gamedir_t *fs_all_gamedirs = NULL;
343 int fs_all_gamedirs_count = 0;
345 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)"};
346 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"};
347 cvar_t cvar_fs_gamedir = {CVAR_READONLY | CVAR_NORESETTODEFAULTS, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
351 =============================================================================
353 PRIVATE FUNCTIONS - PK3 HANDLING
355 =============================================================================
359 // Functions exported from zlib
360 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
361 # define ZEXPORT WINAPI
366 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
367 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
368 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
369 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
370 static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size);
371 static int (ZEXPORT *qz_deflateEnd) (z_stream* strm);
372 static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush);
375 #define qz_inflateInit2(strm, windowBits) \
376 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
377 #define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
378 qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream))
381 // qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
383 static dllfunction_t zlibfuncs[] =
385 {"inflate", (void **) &qz_inflate},
386 {"inflateEnd", (void **) &qz_inflateEnd},
387 {"inflateInit2_", (void **) &qz_inflateInit2_},
388 {"inflateReset", (void **) &qz_inflateReset},
389 {"deflateInit2_", (void **) &qz_deflateInit2_},
390 {"deflateEnd", (void **) &qz_deflateEnd},
391 {"deflate", (void **) &qz_deflate},
395 /// Handle for Zlib DLL
396 static dllhandle_t zlib_dll = NULL;
400 static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPTSTR pszPath);
401 static dllfunction_t shfolderfuncs[] =
403 {"SHGetFolderPathA", (void **) &qSHGetFolderPath},
406 static dllhandle_t shfolder_dll = NULL;
416 void PK3_CloseLibrary (void)
419 Sys_UnloadLibrary (&zlib_dll);
428 Try to load the Zlib DLL
431 qboolean PK3_OpenLibrary (void)
436 const char* dllnames [] =
439 # ifdef ZLIB_USES_WINAPI
445 #elif defined(MACOSX)
459 return Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs);
467 See if zlib is available
470 qboolean FS_HasZlib(void)
475 PK3_OpenLibrary(); // to be safe
476 return (zlib_dll != 0);
482 PK3_GetEndOfCentralDir
484 Extract the end of the central directory from a PK3 package
487 qboolean PK3_GetEndOfCentralDir (const char *packfile, int packhandle, pk3_endOfCentralDir_t *eocd)
489 fs_offset_t filesize, maxsize;
490 unsigned char *buffer, *ptr;
493 // Get the package size
494 filesize = lseek (packhandle, 0, SEEK_END);
495 if (filesize < ZIP_END_CDIR_SIZE)
498 // Load the end of the file in memory
499 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
502 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
503 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
504 lseek (packhandle, filesize - maxsize, SEEK_SET);
505 if (read (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
511 // Look for the end of central dir signature around the end of the file
512 maxsize -= ZIP_END_CDIR_SIZE;
513 ptr = &buffer[maxsize];
515 while (BuffBigLong (ptr) != ZIP_END_HEADER)
527 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
528 eocd->signature = LittleLong (eocd->signature);
529 eocd->disknum = LittleShort (eocd->disknum);
530 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
531 eocd->localentries = LittleShort (eocd->localentries);
532 eocd->nbentries = LittleShort (eocd->nbentries);
533 eocd->cdir_size = LittleLong (eocd->cdir_size);
534 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
535 eocd->comment_size = LittleShort (eocd->comment_size);
536 eocd->prepended_garbage = filesize - (ind + ZIP_END_CDIR_SIZE) - eocd->cdir_offset - eocd->cdir_size; // this detects "SFX" zip files
537 eocd->cdir_offset += eocd->prepended_garbage;
549 Extract the file list from a PK3 file
552 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
554 unsigned char *central_dir, *ptr;
556 fs_offset_t remaining;
558 // Load the central directory in memory
559 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
560 lseek (pack->handle, eocd->cdir_offset, SEEK_SET);
561 if(read (pack->handle, central_dir, eocd->cdir_size) != (fs_offset_t) eocd->cdir_size)
563 Mem_Free (central_dir);
567 // Extract the files properties
568 // The parsing is done "by hand" because some fields have variable sizes and
569 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
570 remaining = eocd->cdir_size;
573 for (ind = 0; ind < eocd->nbentries; ind++)
575 fs_offset_t namesize, count;
577 // Checking the remaining size
578 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
580 Mem_Free (central_dir);
583 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
586 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
588 Mem_Free (central_dir);
592 namesize = BuffLittleShort (&ptr[28]); // filename length
594 // Check encryption, compression, and attributes
595 // 1st uint8 : general purpose bit flag
596 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
598 // LordHavoc: bit 3 would be a problem if we were scanning the archive
599 // but is not a problem in the central directory where the values are
602 // bit 3 seems to always be set by the standard Mac OSX zip maker
604 // 2nd uint8 : external file attributes
605 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
606 if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0)
608 // Still enough bytes for the name?
609 if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
611 Mem_Free (central_dir);
615 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
616 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
618 char filename [sizeof (pack->files[0].name)];
619 fs_offset_t offset, packsize, realsize;
622 // Extract the name (strip it if necessary)
623 namesize = min(namesize, (int)sizeof (filename) - 1);
624 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
625 filename[namesize] = '\0';
627 if (BuffLittleShort (&ptr[10]))
628 flags = PACKFILE_FLAG_DEFLATED;
631 offset = BuffLittleLong (&ptr[42]) + eocd->prepended_garbage;
632 packsize = BuffLittleLong (&ptr[20]);
633 realsize = BuffLittleLong (&ptr[24]);
635 switch(ptr[5]) // C_VERSION_MADE_BY_1
640 if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000)
641 // can't use S_ISLNK here, as this has to compile on non-UNIX too
642 flags |= PACKFILE_FLAG_SYMLINK;
646 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
650 // Skip the name, additionnal field, and comment
651 // 1er uint16 : extra field length
652 // 2eme uint16 : file comment length
653 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
654 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
658 // If the package is empty, central_dir is NULL here
659 if (central_dir != NULL)
660 Mem_Free (central_dir);
661 return pack->numfiles;
669 Create a package entry associated with a PK3 file
672 pack_t *FS_LoadPackPK3FromFD (const char *packfile, int packhandle)
674 pk3_endOfCentralDir_t eocd;
678 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
680 Con_Printf ("%s is not a PK3 file\n", packfile);
685 // Multi-volume ZIP archives are NOT allowed
686 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
688 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
693 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
694 // since eocd.nbentries is an unsigned 16 bits integer
695 #if MAX_FILES_IN_PACK < 65535
696 if (eocd.nbentries > MAX_FILES_IN_PACK)
698 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
704 // Create a package structure in memory
705 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
706 pack->ignorecase = true; // PK3 ignores case
707 strlcpy (pack->filename, packfile, sizeof (pack->filename));
708 pack->handle = packhandle;
709 pack->numfiles = eocd.nbentries;
710 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
712 real_nb_files = PK3_BuildFileList (pack, &eocd);
713 if (real_nb_files < 0)
715 Con_Printf ("%s is not a valid PK3 file\n", packfile);
721 Con_DPrintf("Added packfile %s (%i files)\n", packfile, real_nb_files);
724 pack_t *FS_LoadPackPK3 (const char *packfile)
728 _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE);
730 packhandle = open (packfile, O_RDONLY | O_BINARY);
734 return FS_LoadPackPK3FromFD(packfile, packhandle);
740 PK3_GetTrueFileOffset
742 Find where the true file data offset is
745 qboolean PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
747 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
751 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
754 // Load the local file description
755 lseek (pack->handle, pfile->offset, SEEK_SET);
756 count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
757 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
759 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
763 // Skip name and extra field
764 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
766 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
772 =============================================================================
774 OTHER PRIVATE FUNCTIONS
776 =============================================================================
784 Add a file to the list of files contained into a package
787 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
788 fs_offset_t offset, fs_offset_t packsize,
789 fs_offset_t realsize, int flags)
791 int (*strcmp_funct) (const char* str1, const char* str2);
792 int left, right, middle;
795 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
797 // Look for the slot we should put that file into (binary search)
799 right = pack->numfiles - 1;
800 while (left <= right)
804 middle = (left + right) / 2;
805 diff = strcmp_funct (pack->files[middle].name, name);
807 // If we found the file, there's a problem
809 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
811 // If we're too far in the list
818 // We have to move the right of the list by one slot to free the one we need
819 pfile = &pack->files[left];
820 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
823 strlcpy (pfile->name, name, sizeof (pfile->name));
824 pfile->offset = offset;
825 pfile->packsize = packsize;
826 pfile->realsize = realsize;
827 pfile->flags = flags;
837 Only used for FS_OpenRealFile.
840 void FS_CreatePath (char *path)
844 for (ofs = path+1 ; *ofs ; ofs++)
846 if (*ofs == '/' || *ofs == '\\')
848 // create the directory
864 void FS_Path_f (void)
868 Con_Print("Current search path:\n");
869 for (s=fs_searchpaths ; s ; s=s->next)
874 Con_Printf("%sdir (virtual pack)\n", s->pack->filename);
876 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
879 Con_Printf("%s\n", s->filename);
889 /*! Takes an explicit (not game tree related) path to a pak file.
890 *Loads the header and directory, adding the files at the beginning
891 *of the list so they override previous pack files.
893 pack_t *FS_LoadPackPAK (const char *packfile)
895 dpackheader_t header;
902 _sopen_s(&packhandle, packfile, O_RDONLY | O_BINARY, _SH_DENYNO, _S_IREAD | _S_IWRITE);
904 packhandle = open (packfile, O_RDONLY | O_BINARY);
908 if(read (packhandle, (void *)&header, sizeof(header)) != sizeof(header))
910 Con_Printf ("%s is not a packfile\n", packfile);
914 if (memcmp(header.id, "PACK", 4))
916 Con_Printf ("%s is not a packfile\n", packfile);
920 header.dirofs = LittleLong (header.dirofs);
921 header.dirlen = LittleLong (header.dirlen);
923 if (header.dirlen % sizeof(dpackfile_t))
925 Con_Printf ("%s has an invalid directory size\n", packfile);
930 numpackfiles = header.dirlen / sizeof(dpackfile_t);
932 if (numpackfiles > MAX_FILES_IN_PACK)
934 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
939 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
940 lseek (packhandle, header.dirofs, SEEK_SET);
941 if(header.dirlen != read (packhandle, (void *)info, header.dirlen))
943 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
949 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
950 pack->ignorecase = false; // PAK is case sensitive
951 strlcpy (pack->filename, packfile, sizeof (pack->filename));
952 pack->handle = packhandle;
954 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
956 // parse the directory
957 for (i = 0;i < numpackfiles;i++)
959 fs_offset_t offset = LittleLong (info[i].filepos);
960 fs_offset_t size = LittleLong (info[i].filelen);
962 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
967 Con_DPrintf("Added packfile %s (%i files)\n", packfile, numpackfiles);
975 Create a package entry associated with a directory file
978 pack_t *FS_LoadPackVirtual (const char *dirname)
981 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
983 pack->ignorecase = false;
984 strlcpy (pack->filename, dirname, sizeof(pack->filename));
988 Con_DPrintf("Added packfile %s (virtual pack)\n", dirname);
997 /*! Adds the given pack to the search path.
998 * The pack type is autodetected by the file extension.
1000 * Returns true if the file was successfully added to the
1001 * search path or if it was already included.
1003 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1004 * plain directories.
1007 static qboolean FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qboolean *already_loaded, qboolean keep_plain_dirs)
1009 searchpath_t *search;
1011 const char *ext = FS_FileExtension(pakfile);
1014 for(search = fs_searchpaths; search; search = search->next)
1016 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
1019 *already_loaded = true;
1020 return true; // already loaded
1025 *already_loaded = false;
1027 if(!strcasecmp(ext, "pk3dir"))
1028 pak = FS_LoadPackVirtual (pakfile);
1029 else if(!strcasecmp(ext, "pak"))
1030 pak = FS_LoadPackPAK (pakfile);
1031 else if(!strcasecmp(ext, "pk3"))
1032 pak = FS_LoadPackPK3 (pakfile);
1034 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
1038 strlcpy(pak->shortname, shortname, sizeof(pak->shortname));
1040 //Con_DPrintf(" Registered pack with short name %s\n", shortname);
1043 // find the first item whose next one is a pack or NULL
1044 searchpath_t *insertion_point = 0;
1045 if(fs_searchpaths && !fs_searchpaths->pack)
1047 insertion_point = fs_searchpaths;
1050 if(!insertion_point->next)
1052 if(insertion_point->next->pack)
1054 insertion_point = insertion_point->next;
1057 // If insertion_point is NULL, this means that either there is no
1058 // item in the list yet, or that the very first item is a pack. In
1059 // that case, we want to insert at the beginning...
1060 if(!insertion_point)
1062 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1063 search->next = fs_searchpaths;
1064 fs_searchpaths = search;
1067 // otherwise we want to append directly after insertion_point.
1069 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1070 search->next = insertion_point->next;
1071 insertion_point->next = search;
1076 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1077 search->next = fs_searchpaths;
1078 fs_searchpaths = search;
1083 dpsnprintf(search->filename, sizeof(search->filename), "%s/", pakfile);
1084 // if shortname ends with "pk3dir", strip that suffix to make it just "pk3"
1085 // same goes for the name inside the pack structure
1086 l = strlen(pak->shortname);
1088 if(!strcasecmp(pak->shortname + l - 7, ".pk3dir"))
1089 pak->shortname[l - 3] = 0;
1090 l = strlen(pak->filename);
1092 if(!strcasecmp(pak->filename + l - 7, ".pk3dir"))
1093 pak->filename[l - 3] = 0;
1099 Con_Printf("unable to load pak \"%s\"\n", pakfile);
1110 /*! Adds the given pack to the search path and searches for it in the game path.
1111 * The pack type is autodetected by the file extension.
1113 * Returns true if the file was successfully added to the
1114 * search path or if it was already included.
1116 * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1117 * plain directories.
1119 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
1121 char fullpath[MAX_OSPATH];
1123 searchpath_t *search;
1126 *already_loaded = false;
1128 // then find the real name...
1129 search = FS_FindFile(pakfile, &index, true);
1130 if(!search || search->pack)
1132 Con_Printf("could not find pak \"%s\"\n", pakfile);
1136 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
1138 return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs);
1146 Sets fs_gamedir, adds the directory to the head of the path,
1147 then loads and adds pak1.pak pak2.pak ...
1150 void FS_AddGameDirectory (const char *dir)
1154 searchpath_t *search;
1156 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
1158 stringlistinit(&list);
1159 listdirectory(&list, "", dir);
1160 stringlistsort(&list);
1162 // add any PAK package in the directory
1163 for (i = 0;i < list.numstrings;i++)
1165 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
1167 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1171 // add any PK3 package in the directory
1172 for (i = 0;i < list.numstrings;i++)
1174 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3") || !strcasecmp(FS_FileExtension(list.strings[i]), "pk3dir"))
1176 FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1180 stringlistfreecontents(&list);
1182 // Add the directory to the search path
1183 // (unpacked files have the priority over packed files)
1184 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1185 strlcpy (search->filename, dir, sizeof (search->filename));
1186 search->next = fs_searchpaths;
1187 fs_searchpaths = search;
1196 void FS_AddGameHierarchy (const char *dir)
1198 // Add the common game directory
1199 FS_AddGameDirectory (va("%s%s/", fs_basedir, dir));
1202 FS_AddGameDirectory(va("%s%s/", fs_userdir, dir));
1211 const char *FS_FileExtension (const char *in)
1213 const char *separator, *backslash, *colon, *dot;
1215 separator = strrchr(in, '/');
1216 backslash = strrchr(in, '\\');
1217 if (!separator || separator < backslash)
1218 separator = backslash;
1219 colon = strrchr(in, ':');
1220 if (!separator || separator < colon)
1223 dot = strrchr(in, '.');
1224 if (dot == NULL || (separator && (dot < separator)))
1236 const char *FS_FileWithoutPath (const char *in)
1238 const char *separator, *backslash, *colon;
1240 separator = strrchr(in, '/');
1241 backslash = strrchr(in, '\\');
1242 if (!separator || separator < backslash)
1243 separator = backslash;
1244 colon = strrchr(in, ':');
1245 if (!separator || separator < colon)
1247 return separator ? separator + 1 : in;
1256 void FS_ClearSearchPath (void)
1258 // unload all packs and directory information, close all pack files
1259 // (if a qfile is still reading a pack it won't be harmed because it used
1260 // dup() to get its own handle already)
1261 while (fs_searchpaths)
1263 searchpath_t *search = fs_searchpaths;
1264 fs_searchpaths = search->next;
1265 if (search->pack && search->pack != fs_selfpack)
1267 if(!search->pack->vpack)
1270 close(search->pack->handle);
1271 // free any memory associated with it
1272 if (search->pack->files)
1273 Mem_Free(search->pack->files);
1275 Mem_Free(search->pack);
1281 static void FS_AddSelfPack(void)
1285 searchpath_t *search;
1286 search = Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1287 search->next = fs_searchpaths;
1288 search->pack = fs_selfpack;
1289 fs_searchpaths = search;
1299 void FS_Rescan (void)
1302 qboolean fs_modified = false;
1303 char gamedirbuf[MAX_INPUTLINE];
1305 FS_ClearSearchPath();
1307 // add the game-specific paths
1308 // gamedirname1 (typically id1)
1309 FS_AddGameHierarchy (gamedirname1);
1310 // update the com_modname (used for server info)
1311 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1313 // add the game-specific path, if any
1314 // (only used for mission packs and the like, which should set fs_modified)
1318 FS_AddGameHierarchy (gamedirname2);
1322 // Adds basedir/gamedir as an override game
1323 // LordHavoc: now supports multiple -game directories
1324 // set the com_modname (reported in server info)
1326 for (i = 0;i < fs_numgamedirs;i++)
1329 FS_AddGameHierarchy (fs_gamedirs[i]);
1330 // update the com_modname (used server info)
1331 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1333 strlcat(gamedirbuf, va(" %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1335 strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1337 Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1339 // add back the selfpack as new first item
1342 // set the default screenshot name to either the mod name or the
1343 // gamemode screenshot name
1344 if (strcmp(com_modname, gamedirname1))
1345 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1347 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1349 if((i = COM_CheckParm("-modname")) && i < com_argc - 1)
1350 strlcpy(com_modname, com_argv[i+1], sizeof(com_modname));
1352 // If "-condebug" is in the command line, remove the previous log file
1353 if (COM_CheckParm ("-condebug") != 0)
1354 unlink (va("%s/qconsole.log", fs_gamedir));
1356 // look for the pop.lmp file and set registered to true if it is found
1357 if (FS_FileExists("gfx/pop.lmp"))
1358 Cvar_Set ("registered", "1");
1364 if (!registered.integer)
1367 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1369 Con_Print("Playing shareware version.\n");
1372 Con_Print("Playing registered version.\n");
1374 case GAME_STEELSTORM:
1375 if (registered.integer)
1376 Con_Print("Playing registered version.\n");
1378 Con_Print("Playing shareware version.\n");
1384 // unload all wads so that future queries will return the new data
1388 void FS_Rescan_f(void)
1398 extern void Host_SaveConfig (void);
1399 extern void Host_LoadConfig_f (void);
1400 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing)
1405 if (fs_numgamedirs == numgamedirs)
1407 for (i = 0;i < numgamedirs;i++)
1408 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1410 if (i == numgamedirs)
1411 return true; // already using this set of gamedirs, do nothing
1414 if (numgamedirs > MAX_GAMEDIRS)
1417 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1418 return false; // too many gamedirs
1421 for (i = 0;i < numgamedirs;i++)
1423 // if string is nasty, reject it
1424 p = FS_CheckGameDir(gamedirs[i]);
1428 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1429 return false; // nasty gamedirs
1431 if(p == fs_checkgamedir_missing && failmissing)
1434 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1435 return false; // missing gamedirs
1441 fs_numgamedirs = numgamedirs;
1442 for (i = 0;i < fs_numgamedirs;i++)
1443 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1445 // reinitialize filesystem to detect the new paks
1448 // exec the new config
1449 Host_LoadConfig_f();
1451 // unload all sounds so they will be reloaded from the new files as needed
1452 S_UnloadAllSounds_f();
1454 // reinitialize renderer (this reloads hud/console background/etc)
1455 R_Modules_Restart();
1465 void FS_GameDir_f (void)
1469 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1473 Con_Printf("gamedirs active:");
1474 for (i = 0;i < fs_numgamedirs;i++)
1475 Con_Printf(" %s", fs_gamedirs[i]);
1480 numgamedirs = Cmd_Argc() - 1;
1481 if (numgamedirs > MAX_GAMEDIRS)
1483 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1487 for (i = 0;i < numgamedirs;i++)
1488 strlcpy(gamedirs[i], Cmd_Argv(i+1), sizeof(gamedirs[i]));
1490 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1492 // actually, changing during game would work fine, but would be stupid
1493 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1497 // halt demo playback to close the file
1500 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1503 static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking);
1504 static const char *FS_SysCheckGameDir(const char *gamedir)
1506 static char buf[8192];
1512 stringlistinit(&list);
1513 listdirectory(&list, gamedir, "");
1514 success = list.numstrings > 0;
1515 stringlistfreecontents(&list);
1519 f = FS_SysOpen(va("%smodinfo.txt", gamedir), "r", false);
1522 n = FS_Read (f, buf, sizeof(buf) - 1);
1542 const char *FS_CheckGameDir(const char *gamedir)
1546 if (FS_CheckNastyPath(gamedir, true))
1549 ret = FS_SysCheckGameDir(va("%s%s/", fs_userdir, gamedir));
1554 // get description from basedir
1555 ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir));
1563 ret = FS_SysCheckGameDir(va("%s%s/", fs_basedir, gamedir));
1567 return fs_checkgamedir_missing;
1570 static void FS_ListGameDirs(void)
1572 stringlist_t list, list2;
1576 fs_all_gamedirs_count = 0;
1578 Mem_Free(fs_all_gamedirs);
1580 stringlistinit(&list);
1581 listdirectory(&list, va("%s/", fs_basedir), "");
1582 listdirectory(&list, va("%s/", fs_userdir), "");
1583 stringlistsort(&list);
1585 stringlistinit(&list2);
1586 for(i = 0; i < list.numstrings; ++i)
1589 if(!strcmp(list.strings[i-1], list.strings[i]))
1591 info = FS_CheckGameDir(list.strings[i]);
1594 if(info == fs_checkgamedir_missing)
1598 stringlistappend(&list2, list.strings[i]);
1600 stringlistfreecontents(&list);
1602 fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1603 for(i = 0; i < list2.numstrings; ++i)
1605 info = FS_CheckGameDir(list2.strings[i]);
1606 // all this cannot happen any more, but better be safe than sorry
1609 if(info == fs_checkgamedir_missing)
1613 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[j].name));
1614 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[j].description));
1615 ++fs_all_gamedirs_count;
1624 void FS_Init_SelfPack (void)
1627 fs_mempool = Mem_AllocPool("file management", 0, NULL);
1630 fs_selfpack = FS_LoadPackPK3FromFD(com_argv[0], com_selffd);
1636 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
1639 const char **new_argv;
1641 int args_left = 256;
1642 new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*com_argv) * (com_argc + args_left + 2));
1645 new_argv[0] = "dummy";
1650 memcpy((char *)(&new_argv[0]), &com_argv[0], sizeof(*com_argv) * com_argc);
1653 while(COM_ParseToken_Console(&p))
1657 q = (char *)Mem_Alloc(fs_mempool, strlen(com_token) + 1);
1658 strlcpy(q, com_token, strlen(com_token) + 1);
1659 new_argv[com_argc + i] = q;
1662 new_argv[i+com_argc] = NULL;
1663 com_argv = new_argv;
1664 com_argc = com_argc + i;
1681 TCHAR mydocsdir[MAX_PATH + 1];
1682 #if _MSC_VER >= 1400
1689 const char* dllnames [] =
1691 "shfolder.dll", // IE 4, or Win NT and higher
1694 Sys_LoadLibrary(dllnames, &shfolder_dll, shfolderfuncs);
1695 // don't care for the result; if it fails, %USERPROFILE% will be used instead
1698 // Add the personal game directory
1699 if((i = COM_CheckParm("-userdir")) && i < com_argc - 1)
1701 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", com_argv[i+1]);
1703 else if(COM_CheckParm("-nohome"))
1710 if(qSHGetFolderPath && (qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK))
1712 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Games/%s/", mydocsdir, gameuserdirname);
1713 Con_DPrintf("Obtained personal directory %s from SHGetFolderPath\n", fs_userdir);
1717 // use the environment
1718 #if _MSC_VER >= 1400
1719 _dupenv_s (&homedir, &homedirlen, "USERPROFILE");
1721 homedir = getenv("USERPROFILE");
1726 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/My Documents/My Games/%s/", homedir, gameuserdirname);
1727 #if _MSC_VER >= 1400
1730 Con_DPrintf("Obtained personal directory %s from environment\n", fs_userdir);
1735 Con_DPrintf("Could not obtain home directory; not supporting -mygames\n");
1737 homedir = getenv ("HOME");
1739 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/.%s/", homedir, gameuserdirname);
1742 Con_DPrintf("Could not obtain home directory; assuming -nohome\n");
1746 if(!COM_CheckParm("-mygames"))
1748 #if _MSC_VER >= 1400
1750 _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!
1752 int fd = open (va("%s%s/config.cfg", fs_basedir, gamedirname1), O_WRONLY | O_CREAT, 0666); // note: no O_TRUNC here!
1757 *fs_userdir = 0; // we have write access to the game dir, so let's use it
1763 strlcpy(fs_gamedir, "", sizeof(fs_gamedir));
1765 // If the base directory is explicitly defined by the compilation process
1766 #ifdef DP_FS_BASEDIR
1767 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
1772 // FIXME: is there a better way to find the directory outside the .app?
1773 if (strstr(com_argv[0], ".app/"))
1777 split = strstr(com_argv[0], ".app/");
1778 while (split > com_argv[0] && *split != '/')
1780 strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir));
1781 fs_basedir[split - com_argv[0]] = 0;
1787 // Overrides the system supplied base directory (under GAMENAME)
1788 // 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)
1789 i = COM_CheckParm ("-basedir");
1790 if (i && i < com_argc-1)
1792 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
1793 i = (int)strlen (fs_basedir);
1794 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1795 fs_basedir[i-1] = 0;
1798 // add a path separator to the end of the basedir if it lacks one
1799 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
1800 strlcat(fs_basedir, "/", sizeof(fs_basedir));
1804 p = FS_CheckGameDir(gamedirname1);
1805 if(!p || p == fs_checkgamedir_missing)
1806 Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
1810 p = FS_CheckGameDir(gamedirname2);
1811 if(!p || p == fs_checkgamedir_missing)
1812 Con_Printf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
1816 // Adds basedir/gamedir as an override game
1817 // LordHavoc: now supports multiple -game directories
1818 for (i = 1;i < com_argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
1822 if (!strcmp (com_argv[i], "-game") && i < com_argc-1)
1825 p = FS_CheckGameDir(com_argv[i]);
1827 Sys_Error("Nasty -game name rejected: %s", com_argv[i]);
1828 if(p == fs_checkgamedir_missing)
1829 Con_Printf("WARNING: -game %s%s/ not found!\n", fs_basedir, com_argv[i]);
1830 // add the gamedir to the list of active gamedirs
1831 strlcpy (fs_gamedirs[fs_numgamedirs], com_argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
1836 // generate the searchpath
1840 void FS_Init_Commands(void)
1842 Cvar_RegisterVariable (&scr_screenshot_name);
1843 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1844 Cvar_RegisterVariable (&cvar_fs_gamedir);
1846 Cmd_AddCommand ("gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1847 Cmd_AddCommand ("fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1848 Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)");
1849 Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1850 Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1851 Cmd_AddCommand ("which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
1859 void FS_Shutdown (void)
1861 // close all pack files and such
1862 // (hopefully there aren't any other open files, but they'll be cleaned up
1863 // by the OS anyway)
1864 FS_ClearSearchPath();
1865 Mem_FreePool (&fs_mempool);
1868 Sys_UnloadLibrary (&shfolder_dll);
1872 int FS_SysOpenFD(const char *filepath, const char *mode, qboolean nonblocking)
1878 // Parse the mode string
1887 opt = O_CREAT | O_TRUNC;
1891 opt = O_CREAT | O_APPEND;
1894 Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
1897 for (ind = 1; mode[ind] != '\0'; ind++)
1908 Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
1909 filepath, mode, mode[ind]);
1916 #if _MSC_VER >= 1400
1917 _sopen_s(&handle, filepath, mod | opt, _SH_DENYNO, _S_IREAD | _S_IWRITE);
1919 handle = open (filepath, mod | opt, 0666);
1925 ====================
1928 Internal function used to create a qfile_t and open the relevant non-packed file on disk
1929 ====================
1931 static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
1935 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1937 file->handle = FS_SysOpenFD(filepath, mode, nonblocking);
1938 if (file->handle < 0)
1944 file->filename = Mem_strdup(fs_mempool, filepath);
1946 file->real_length = lseek (file->handle, 0, SEEK_END);
1948 // For files opened in append mode, we start at the end of the file
1950 file->position = file->real_length;
1952 lseek (file->handle, 0, SEEK_SET);
1962 Open a packed file using its package file descriptor
1965 qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
1971 pfile = &pack->files[pack_ind];
1973 // If we don't have the true offset, get it now
1974 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
1975 if (!PK3_GetTrueFileOffset (pfile, pack))
1978 #ifndef LINK_TO_ZLIB
1979 // No Zlib DLL = no compressed files
1980 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
1982 Con_Printf("WARNING: can't open the compressed file %s\n"
1983 "You need the Zlib DLL to use compressed files\n",
1989 // LordHavoc: lseek affects all duplicates of a handle so we do it before
1990 // the dup() call to avoid having to close the dup_handle on error here
1991 if (lseek (pack->handle, pfile->offset, SEEK_SET) == -1)
1993 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n",
1994 pfile->name, pack->filename, (int) pfile->offset);
1998 dup_handle = dup (pack->handle);
2001 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2005 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2006 memset (file, 0, sizeof (*file));
2007 file->handle = dup_handle;
2008 file->flags = QFILE_FLAG_PACKED;
2009 file->real_length = pfile->realsize;
2010 file->offset = pfile->offset;
2014 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2018 file->flags |= QFILE_FLAG_DEFLATED;
2020 // We need some more variables
2021 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2023 ztk->comp_length = pfile->packsize;
2025 // Initialize zlib stream
2026 ztk->zstream.next_in = ztk->input;
2027 ztk->zstream.avail_in = 0;
2029 /* From Zlib's "unzip.c":
2031 * windowBits is passed < 0 to tell that there is no zlib header.
2032 * Note that in this case inflate *requires* an extra "dummy" byte
2033 * after the compressed stream in order to complete decompression and
2034 * return Z_STREAM_END.
2035 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2036 * size of both compressed and uncompressed data
2038 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2040 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2046 ztk->zstream.next_out = file->buff;
2047 ztk->zstream.avail_out = sizeof (file->buff);
2056 ====================
2059 Return true if the path should be rejected due to one of the following:
2060 1: path elements that are non-portable
2061 2: path elements that would allow access to files outside the game directory,
2062 or are just not a good idea for a mod to be using.
2063 ====================
2065 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
2067 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2071 // Windows: don't allow \ in filenames (windows-only), period.
2072 // (on Windows \ is a directory separator, but / is also supported)
2073 if (strstr(path, "\\"))
2074 return 1; // non-portable
2076 // Mac: don't allow Mac-only filenames - : is a directory separator
2077 // instead of /, but we rely on / working already, so there's no reason to
2078 // support a Mac-only path
2079 // Amiga and Windows: : tries to go to root of drive
2080 if (strstr(path, ":"))
2081 return 1; // non-portable attempt to go to root of drive
2083 // Amiga: // is parent directory
2084 if (strstr(path, "//"))
2085 return 1; // non-portable attempt to go to parent directory
2087 // all: don't allow going to parent directory (../ or /../)
2088 if (strstr(path, ".."))
2089 return 2; // attempt to go outside the game directory
2091 // Windows and UNIXes: don't allow absolute paths
2093 return 2; // attempt to go outside the game directory
2095 // 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
2096 if (strchr(path, '.'))
2100 // gamedir is entirely path elements, so simply forbid . entirely
2103 if (strchr(path, '.') < strrchr(path, '/'))
2104 return 2; // possible attempt to go outside the game directory
2107 // all: forbid trailing slash on gamedir
2108 if (isgamedir && path[strlen(path)-1] == '/')
2111 // all: forbid leading dot on any filename for any reason
2112 if (strstr(path, "/."))
2113 return 2; // attempt to go outside the game directory
2115 // after all these checks we're pretty sure it's a / separated filename
2116 // and won't do much if any harm
2122 ====================
2125 Look for a file in the packages and in the filesystem
2127 Return the searchpath where the file was found (or NULL)
2128 and the file index in the package if relevant
2129 ====================
2131 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
2133 searchpath_t *search;
2136 // search through the path, one element at a time
2137 for (search = fs_searchpaths;search;search = search->next)
2139 // is the element a pak file?
2140 if (search->pack && !search->pack->vpack)
2142 int (*strcmp_funct) (const char* str1, const char* str2);
2143 int left, right, middle;
2146 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2148 // Look for the file (binary search)
2150 right = pak->numfiles - 1;
2151 while (left <= right)
2155 middle = (left + right) / 2;
2156 diff = strcmp_funct (pak->files[middle].name, name);
2161 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2163 // yes, but the first one is empty so we treat it as not being there
2164 if (!quiet && developer_extra.integer)
2165 Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2172 if (!quiet && developer_extra.integer)
2173 Con_DPrintf("FS_FindFile: %s in %s\n",
2174 pak->files[middle].name, pak->filename);
2181 // If we're too far in the list
2190 char netpath[MAX_OSPATH];
2191 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2192 if (FS_SysFileExists (netpath))
2194 if (!quiet && developer_extra.integer)
2195 Con_DPrintf("FS_FindFile: %s\n", netpath);
2204 if (!quiet && developer_extra.integer)
2205 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2217 Look for a file in the search paths and open it in read-only mode
2220 qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking, int symlinkLevels)
2222 searchpath_t *search;
2225 search = FS_FindFile (filename, &pack_ind, quiet);
2231 // Found in the filesystem?
2234 // this works with vpacks, so we are fine
2235 char path [MAX_OSPATH];
2236 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2237 return FS_SysOpen (path, "rb", nonblocking);
2240 // So, we found it in a package...
2242 // Is it a PK3 symlink?
2243 // TODO also handle directory symlinks by parsing the whole structure...
2244 // but heck, file symlinks are good enough for now
2245 if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2247 if(symlinkLevels <= 0)
2249 Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2254 char linkbuf[MAX_QPATH];
2256 qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2257 const char *mergeslash;
2262 count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2268 // Now combine the paths...
2269 mergeslash = strrchr(filename, '/');
2270 mergestart = linkbuf;
2272 mergeslash = filename;
2273 while(!strncmp(mergestart, "../", 3))
2276 while(mergeslash > filename)
2279 if(*mergeslash == '/')
2283 // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2284 if(mergeslash == filename)
2286 // Either mergeslash == filename, then we just replace the name (done below)
2290 // Or, we append the name after mergeslash;
2291 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2292 int spaceNeeded = mergeslash - filename + 1;
2293 int spaceRemoved = mergestart - linkbuf;
2294 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2296 Con_DPrintf("symlink: too long path rejected\n");
2299 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2300 memcpy(linkbuf, filename, spaceNeeded);
2301 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2302 mergestart = linkbuf;
2304 if (!quiet && developer_loading.integer)
2305 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2306 if(FS_CheckNastyPath (mergestart, false))
2308 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2311 return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2315 return FS_OpenPackedFile (search->pack, pack_ind);
2320 =============================================================================
2322 MAIN PUBLIC FUNCTIONS
2324 =============================================================================
2328 ====================
2331 Open a file in the userpath. The syntax is the same as fopen
2332 Used for savegame scanning in menu, and all file writing.
2333 ====================
2335 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet)
2337 char real_path [MAX_OSPATH];
2339 if (FS_CheckNastyPath(filepath, false))
2341 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2345 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2347 // If the file is opened in "write", "append", or "read/write" mode,
2348 // create directories up to the file.
2349 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2350 FS_CreatePath (real_path);
2351 return FS_SysOpen (real_path, mode, false);
2356 ====================
2359 Open a file. The syntax is the same as fopen
2360 ====================
2362 qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet)
2364 if (FS_CheckNastyPath(filepath, false))
2366 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2370 return FS_OpenReadFile (filepath, quiet, false, 16);
2375 ====================
2378 Open a file. The syntax is the same as fopen
2379 ====================
2381 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet)
2384 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2385 memset (file, 0, sizeof (*file));
2386 file->flags = QFILE_FLAG_DATA;
2388 file->real_length = size;
2394 ====================
2398 ====================
2400 int FS_Close (qfile_t* file)
2402 if(file->flags & QFILE_FLAG_DATA)
2408 if (close (file->handle))
2413 if (file->flags & QFILE_FLAG_REMOVE)
2414 remove(file->filename);
2416 Mem_Free((void *) file->filename);
2421 qz_inflateEnd (&file->ztk->zstream);
2422 Mem_Free (file->ztk);
2429 void FS_RemoveOnClose(qfile_t* file)
2431 file->flags |= QFILE_FLAG_REMOVE;
2435 ====================
2438 Write "datasize" bytes into a file
2439 ====================
2441 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2445 // If necessary, seek to the exact file position we're supposed to be
2446 if (file->buff_ind != file->buff_len)
2447 lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
2449 // Purge cached data
2452 // Write the buffer and update the position
2453 result = write (file->handle, data, (fs_offset_t)datasize);
2454 file->position = lseek (file->handle, 0, SEEK_CUR);
2455 if (file->real_length < file->position)
2456 file->real_length = file->position;
2466 ====================
2469 Read up to "buffersize" bytes from a file
2470 ====================
2472 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2474 fs_offset_t count, done;
2476 if (buffersize == 0)
2479 // Get rid of the ungetc character
2480 if (file->ungetc != EOF)
2482 ((char*)buffer)[0] = file->ungetc;
2490 if(file->flags & QFILE_FLAG_DATA)
2492 size_t left = file->real_length - file->position;
2493 if(buffersize > left)
2495 memcpy(buffer, file->data + file->position, buffersize);
2496 file->position += buffersize;
2500 // First, we copy as many bytes as we can from "buff"
2501 if (file->buff_ind < file->buff_len)
2503 count = file->buff_len - file->buff_ind;
2504 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2506 memcpy (buffer, &file->buff[file->buff_ind], count);
2507 file->buff_ind += count;
2509 buffersize -= count;
2510 if (buffersize == 0)
2514 // NOTE: at this point, the read buffer is always empty
2516 // If the file isn't compressed
2517 if (! (file->flags & QFILE_FLAG_DEFLATED))
2521 // We must take care to not read after the end of the file
2522 count = file->real_length - file->position;
2524 // If we have a lot of data to get, put them directly into "buffer"
2525 if (buffersize > sizeof (file->buff) / 2)
2527 if (count > (fs_offset_t)buffersize)
2528 count = (fs_offset_t)buffersize;
2529 lseek (file->handle, file->offset + file->position, SEEK_SET);
2530 nb = read (file->handle, &((unsigned char*)buffer)[done], count);
2534 file->position += nb;
2536 // Purge cached data
2542 if (count > (fs_offset_t)sizeof (file->buff))
2543 count = (fs_offset_t)sizeof (file->buff);
2544 lseek (file->handle, file->offset + file->position, SEEK_SET);
2545 nb = read (file->handle, file->buff, count);
2548 file->buff_len = nb;
2549 file->position += nb;
2551 // Copy the requested data in "buffer" (as much as we can)
2552 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2553 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2554 file->buff_ind = count;
2562 // If the file is compressed, it's more complicated...
2563 // We cycle through a few operations until we have read enough data
2564 while (buffersize > 0)
2566 ztoolkit_t *ztk = file->ztk;
2569 // NOTE: at this point, the read buffer is always empty
2571 // If "input" is also empty, we need to refill it
2572 if (ztk->in_ind == ztk->in_len)
2574 // If we are at the end of the file
2575 if (file->position == file->real_length)
2578 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
2579 if (count > (fs_offset_t)sizeof (ztk->input))
2580 count = (fs_offset_t)sizeof (ztk->input);
2581 lseek (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
2582 if (read (file->handle, ztk->input, count) != count)
2584 Con_Printf ("FS_Read: unexpected end of file\n");
2589 ztk->in_len = count;
2590 ztk->in_position += count;
2593 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
2594 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
2596 // Now that we are sure we have compressed data available, we need to determine
2597 // if it's better to inflate it in "file->buff" or directly in "buffer"
2599 // Inflate the data in "file->buff"
2600 if (buffersize < sizeof (file->buff) / 2)
2602 ztk->zstream.next_out = file->buff;
2603 ztk->zstream.avail_out = sizeof (file->buff);
2604 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2605 if (error != Z_OK && error != Z_STREAM_END)
2607 Con_Printf ("FS_Read: Can't inflate file\n");
2610 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2612 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
2613 file->position += file->buff_len;
2615 // Copy the requested data in "buffer" (as much as we can)
2616 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2617 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2618 file->buff_ind = count;
2621 // Else, we inflate directly in "buffer"
2624 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
2625 ztk->zstream.avail_out = (unsigned int)buffersize;
2626 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2627 if (error != Z_OK && error != Z_STREAM_END)
2629 Con_Printf ("FS_Read: Can't inflate file\n");
2632 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2634 // How much data did it inflate?
2635 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
2636 file->position += count;
2638 // Purge cached data
2643 buffersize -= count;
2651 ====================
2654 Print a string into a file
2655 ====================
2657 int FS_Print (qfile_t* file, const char *msg)
2659 return (int)FS_Write (file, msg, strlen (msg));
2663 ====================
2666 Print a string into a file
2667 ====================
2669 int FS_Printf(qfile_t* file, const char* format, ...)
2674 va_start (args, format);
2675 result = FS_VPrintf (file, format, args);
2683 ====================
2686 Print a string into a file
2687 ====================
2689 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
2692 fs_offset_t buff_size = MAX_INPUTLINE;
2697 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
2698 len = dpvsnprintf (tempbuff, buff_size, format, ap);
2699 if (len >= 0 && len < buff_size)
2701 Mem_Free (tempbuff);
2705 len = write (file->handle, tempbuff, len);
2706 Mem_Free (tempbuff);
2713 ====================
2716 Get the next character of a file
2717 ====================
2719 int FS_Getc (qfile_t* file)
2723 if (FS_Read (file, &c, 1) != 1)
2731 ====================
2734 Put a character back into the read buffer (only supports one character!)
2735 ====================
2737 int FS_UnGetc (qfile_t* file, unsigned char c)
2739 // If there's already a character waiting to be read
2740 if (file->ungetc != EOF)
2749 ====================
2752 Move the position index in a file
2753 ====================
2755 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
2758 unsigned char* buffer;
2759 fs_offset_t buffersize;
2761 // Compute the file offset
2765 offset += file->position - file->buff_len + file->buff_ind;
2772 offset += file->real_length;
2778 if (offset < 0 || offset > file->real_length)
2781 if(file->flags & QFILE_FLAG_DATA)
2783 file->position = offset;
2787 // If we have the data in our read buffer, we don't need to actually seek
2788 if (file->position - file->buff_len <= offset && offset <= file->position)
2790 file->buff_ind = offset + file->buff_len - file->position;
2794 // Purge cached data
2797 // Unpacked or uncompressed files can seek directly
2798 if (! (file->flags & QFILE_FLAG_DEFLATED))
2800 if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
2802 file->position = offset;
2806 // Seeking in compressed files is more a hack than anything else,
2807 // but we need to support it, so here we go.
2810 // If we have to go back in the file, we need to restart from the beginning
2811 if (offset <= file->position)
2815 ztk->in_position = 0;
2817 lseek (file->handle, file->offset, SEEK_SET);
2819 // Reset the Zlib stream
2820 ztk->zstream.next_in = ztk->input;
2821 ztk->zstream.avail_in = 0;
2822 qz_inflateReset (&ztk->zstream);
2825 // We need a big buffer to force inflating into it directly
2826 buffersize = 2 * sizeof (file->buff);
2827 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
2829 // Skip all data until we reach the requested offset
2830 while (offset > file->position)
2832 fs_offset_t diff = offset - file->position;
2833 fs_offset_t count, len;
2835 count = (diff > buffersize) ? buffersize : diff;
2836 len = FS_Read (file, buffer, count);
2850 ====================
2853 Give the current position in a file
2854 ====================
2856 fs_offset_t FS_Tell (qfile_t* file)
2858 return file->position - file->buff_len + file->buff_ind;
2863 ====================
2866 Give the total size of a file
2867 ====================
2869 fs_offset_t FS_FileSize (qfile_t* file)
2871 return file->real_length;
2876 ====================
2879 Erases any buffered input or output data
2880 ====================
2882 void FS_Purge (qfile_t* file)
2894 Filename are relative to the quake directory.
2895 Always appends a 0 byte.
2898 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
2901 unsigned char *buf = NULL;
2902 fs_offset_t filesize = 0;
2904 file = FS_OpenVirtualFile(path, quiet);
2907 filesize = file->real_length;
2910 Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
2915 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
2916 buf[filesize] = '\0';
2917 FS_Read (file, buf, filesize);
2919 if (developer_loadfile.integer)
2920 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
2923 if (filesizepointer)
2924 *filesizepointer = filesize;
2933 The filename will be prefixed by the current game directory
2936 qboolean FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
2940 fs_offset_t lentotal;
2942 file = FS_OpenRealFile(filename, "wb", false);
2945 Con_Printf("FS_WriteFile: failed on %s\n", filename);
2950 for(i = 0; i < count; ++i)
2952 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
2953 for(i = 0; i < count; ++i)
2954 FS_Write (file, data[i], len[i]);
2959 qboolean FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
2961 return FS_WriteFileInBlocks(filename, &data, &len, 1);
2966 =============================================================================
2968 OTHERS PUBLIC FUNCTIONS
2970 =============================================================================
2978 void FS_StripExtension (const char *in, char *out, size_t size_out)
2986 while ((currentchar = *in) && size_out > 1)
2988 if (currentchar == '.')
2990 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
2992 *out++ = currentchar;
3008 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3012 // if path doesn't have a .EXT, append extension
3013 // (extension should include the .)
3014 src = path + strlen(path) - 1;
3016 while (*src != '/' && src != path)
3019 return; // it has an extension
3023 strlcat (path, extension, size_path);
3031 Look for a file in the packages and in the filesystem
3034 int FS_FileType (const char *filename)
3036 searchpath_t *search;
3037 char fullpath[MAX_OSPATH];
3039 search = FS_FindFile (filename, NULL, true);
3041 return FS_FILETYPE_NONE;
3043 if(search->pack && !search->pack->vpack)
3044 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3046 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3047 return FS_SysFileType(fullpath);
3055 Look for a file in the packages and in the filesystem
3058 qboolean FS_FileExists (const char *filename)
3060 return (FS_FindFile (filename, NULL, true) != NULL);
3068 Look for a file in the filesystem only
3071 int FS_SysFileType (const char *path)
3074 // Sajt - some older sdks are missing this define
3075 # ifndef INVALID_FILE_ATTRIBUTES
3076 # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3079 DWORD result = GetFileAttributes(path);
3081 if(result == INVALID_FILE_ATTRIBUTES)
3082 return FS_FILETYPE_NONE;
3084 if(result & FILE_ATTRIBUTE_DIRECTORY)
3085 return FS_FILETYPE_DIRECTORY;
3087 return FS_FILETYPE_FILE;
3091 if (stat (path,&buf) == -1)
3092 return FS_FILETYPE_NONE;
3095 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3097 if(S_ISDIR(buf.st_mode))
3098 return FS_FILETYPE_DIRECTORY;
3100 return FS_FILETYPE_FILE;
3104 qboolean FS_SysFileExists (const char *path)
3106 return FS_SysFileType (path) != FS_FILETYPE_NONE;
3109 void FS_mkdir (const char *path)
3122 Allocate and fill a search structure with information on matching filenames.
3125 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
3128 searchpath_t *searchpath;
3130 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3131 stringlist_t resultlist;
3132 stringlist_t dirlist;
3133 const char *slash, *backslash, *colon, *separator;
3135 char temp[MAX_OSPATH];
3137 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3142 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3146 stringlistinit(&resultlist);
3147 stringlistinit(&dirlist);
3149 slash = strrchr(pattern, '/');
3150 backslash = strrchr(pattern, '\\');
3151 colon = strrchr(pattern, ':');
3152 separator = max(slash, backslash);
3153 separator = max(separator, colon);
3154 basepathlength = separator ? (separator + 1 - pattern) : 0;
3155 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3157 memcpy(basepath, pattern, basepathlength);
3158 basepath[basepathlength] = 0;
3160 // search through the path, one element at a time
3161 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3163 // is the element a pak file?
3164 if (searchpath->pack && !searchpath->pack->vpack)
3166 // look through all the pak file elements
3167 pak = searchpath->pack;
3168 for (i = 0;i < pak->numfiles;i++)
3170 strlcpy(temp, pak->files[i].name, sizeof(temp));
3173 if (matchpattern(temp, (char *)pattern, true))
3175 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3176 if (!strcmp(resultlist.strings[resultlistindex], temp))
3178 if (resultlistindex == resultlist.numstrings)
3180 stringlistappend(&resultlist, temp);
3181 if (!quiet && developer_loading.integer)
3182 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3185 // strip off one path element at a time until empty
3186 // this way directories are added to the listing if they match the pattern
3187 slash = strrchr(temp, '/');
3188 backslash = strrchr(temp, '\\');
3189 colon = strrchr(temp, ':');
3191 if (separator < slash)
3193 if (separator < backslash)
3194 separator = backslash;
3195 if (separator < colon)
3197 *((char *)separator) = 0;
3203 stringlist_t matchedSet, foundSet;
3204 const char *start = pattern;
3206 stringlistinit(&matchedSet);
3207 stringlistinit(&foundSet);
3208 // add a first entry to the set
3209 stringlistappend(&matchedSet, "");
3210 // iterate through pattern's path
3213 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3214 char subpath[MAX_OSPATH];
3215 char subpattern[MAX_OSPATH];
3217 // find the next wildcard
3218 wildcard = strchr(start, '?');
3219 asterisk = strchr(start, '*');
3220 if (asterisk && (!wildcard || asterisk < wildcard))
3222 wildcard = asterisk;
3227 nextseparator = strchr( wildcard, '/' );
3231 nextseparator = NULL;
3234 if( !nextseparator ) {
3235 nextseparator = start + strlen( start );
3238 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3239 // copy everything up except nextseperator
3240 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3241 // find the last '/' before the wildcard
3242 prevseparator = strrchr( subpattern, '/' );
3244 prevseparator = subpattern;
3247 // copy everything from start to the previous including the '/' (before the wildcard)
3248 // everything up to start is already included in the path of matchedSet's entries
3249 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3251 // for each entry in matchedSet try to open the subdirectories specified in subpath
3252 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3253 strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3254 strlcat( temp, subpath, sizeof(temp) );
3255 listdirectory( &foundSet, searchpath->filename, temp );
3257 if( dirlistindex == 0 ) {
3260 // reset the current result set
3261 stringlistfreecontents( &matchedSet );
3262 // match against the pattern
3263 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3264 const char *direntry = foundSet.strings[ dirlistindex ];
3265 if (matchpattern(direntry, subpattern, true)) {
3266 stringlistappend( &matchedSet, direntry );
3269 stringlistfreecontents( &foundSet );
3271 start = nextseparator;
3274 for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3276 const char *temp = matchedSet.strings[dirlistindex];
3277 if (matchpattern(temp, (char *)pattern, true))
3279 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3280 if (!strcmp(resultlist.strings[resultlistindex], temp))
3282 if (resultlistindex == resultlist.numstrings)
3284 stringlistappend(&resultlist, temp);
3285 if (!quiet && developer_loading.integer)
3286 Con_Printf("SearchDirFile: %s\n", temp);
3290 stringlistfreecontents( &matchedSet );
3294 if (resultlist.numstrings)
3296 stringlistsort(&resultlist);
3297 numfiles = resultlist.numstrings;
3299 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3300 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3301 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3302 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3303 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3304 search->numfilenames = (int)numfiles;
3307 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3310 search->filenames[numfiles] = search->filenamesbuffer + numchars;
3311 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3312 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3314 numchars += (int)textlen;
3317 stringlistfreecontents(&resultlist);
3323 void FS_FreeSearch(fssearch_t *search)
3328 extern int con_linewidth;
3329 int FS_ListDirectory(const char *pattern, int oneperline)
3338 char linebuf[MAX_INPUTLINE];
3340 search = FS_Search(pattern, true, true);
3343 numfiles = search->numfilenames;
3346 // FIXME: the names could be added to one column list and then
3347 // gradually shifted into the next column if they fit, and then the
3348 // next to make a compact variable width listing but it's a lot more
3350 // find width for columns
3352 for (i = 0;i < numfiles;i++)
3354 l = (int)strlen(search->filenames[i]);
3355 if (columnwidth < l)
3358 // count the spacing character
3360 // calculate number of columns
3361 numcolumns = con_linewidth / columnwidth;
3362 // don't bother with the column printing if it's only one column
3363 if (numcolumns >= 2)
3365 numlines = (numfiles + numcolumns - 1) / numcolumns;
3366 for (i = 0;i < numlines;i++)
3369 for (k = 0;k < numcolumns;k++)
3371 l = i * numcolumns + k;
3374 name = search->filenames[l];
3375 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3376 linebuf[linebufpos++] = name[j];
3377 // space out name unless it's the last on the line
3378 if (k + 1 < numcolumns && l + 1 < numfiles)
3379 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3380 linebuf[linebufpos++] = ' ';
3383 linebuf[linebufpos] = 0;
3384 Con_Printf("%s\n", linebuf);
3391 for (i = 0;i < numfiles;i++)
3392 Con_Printf("%s\n", search->filenames[i]);
3393 FS_FreeSearch(search);
3394 return (int)numfiles;
3397 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
3399 const char *pattern;
3402 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3405 if (Cmd_Argc() == 2)
3406 pattern = Cmd_Argv(1);
3409 if (!FS_ListDirectory(pattern, oneperline))
3410 Con_Print("No files found.\n");
3415 FS_ListDirectoryCmd("dir", true);
3420 FS_ListDirectoryCmd("ls", false);
3423 void FS_Which_f(void)
3425 const char *filename;
3428 if (Cmd_Argc() != 2)
3430 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(0));
3433 filename = Cmd_Argv(1);
3434 sp = FS_FindFile(filename, &index, true);
3436 Con_Printf("%s isn't anywhere\n", filename);
3442 Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3444 Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3447 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3451 const char *FS_WhichPack(const char *filename)
3454 searchpath_t *sp = FS_FindFile(filename, &index, true);
3456 return sp->pack->shortname;
3462 ====================
3463 FS_IsRegisteredQuakePack
3465 Look for a proof of purchase file file in the requested package
3467 If it is found, this file should NOT be downloaded.
3468 ====================
3470 qboolean FS_IsRegisteredQuakePack(const char *name)
3472 searchpath_t *search;
3475 // search through the path, one element at a time
3476 for (search = fs_searchpaths;search;search = search->next)
3478 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3479 // TODO do we want to support vpacks in here too?
3481 int (*strcmp_funct) (const char* str1, const char* str2);
3482 int left, right, middle;
3485 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3487 // Look for the file (binary search)
3489 right = pak->numfiles - 1;
3490 while (left <= right)
3494 middle = (left + right) / 2;
3495 diff = !strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3501 // If we're too far in the list
3508 // we found the requested pack but it is not registered quake
3516 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3519 unsigned char *filedata;
3520 fs_offset_t filesize;
3521 if (filesizepointer)
3522 *filesizepointer = 0;
3523 if (!filename || !*filename)
3525 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
3528 if (filesizepointer)
3529 *filesizepointer = filesize;
3530 crc = CRC_Block(filedata, filesize);
3536 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
3539 unsigned char *out = NULL;
3543 #ifndef LINK_TO_ZLIB
3548 memset(&strm, 0, sizeof(strm));
3549 strm.zalloc = Z_NULL;
3550 strm.zfree = Z_NULL;
3551 strm.opaque = Z_NULL;
3554 level = Z_DEFAULT_COMPRESSION;
3556 if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
3558 Con_Printf("FS_Deflate: deflate init error!\n");
3562 strm.next_in = (unsigned char*)data;
3563 strm.avail_in = size;
3565 tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
3568 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
3569 qz_deflateEnd(&strm);
3573 strm.next_out = tmp;
3574 strm.avail_out = size;
3576 if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
3578 Con_Printf("FS_Deflate: deflate failed!\n");
3579 qz_deflateEnd(&strm);
3584 if(qz_deflateEnd(&strm) != Z_OK)
3586 Con_Printf("FS_Deflate: deflateEnd failed\n");
3591 if(strm.total_out >= size)
3593 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
3598 out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
3601 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
3607 *deflated_size = (size_t)strm.total_out;
3609 memcpy(out, tmp, strm.total_out);
3615 static void AssertBufsize(sizebuf_t *buf, int length)
3617 if(buf->cursize + length > buf->maxsize)
3619 int oldsize = buf->maxsize;
3620 unsigned char *olddata;
3621 olddata = buf->data;
3622 buf->maxsize += length;
3623 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
3626 memcpy(buf->data, olddata, oldsize);
3632 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
3636 unsigned char *out = NULL;
3637 unsigned char tmp[2048];
3642 #ifndef LINK_TO_ZLIB
3647 memset(&outbuf, 0, sizeof(outbuf));
3648 outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
3649 outbuf.maxsize = sizeof(tmp);
3651 memset(&strm, 0, sizeof(strm));
3652 strm.zalloc = Z_NULL;
3653 strm.zfree = Z_NULL;
3654 strm.opaque = Z_NULL;
3656 if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
3658 Con_Printf("FS_Inflate: inflate init error!\n");
3659 Mem_Free(outbuf.data);
3663 strm.next_in = (unsigned char*)data;
3664 strm.avail_in = size;
3668 strm.next_out = tmp;
3669 strm.avail_out = sizeof(tmp);
3670 ret = qz_inflate(&strm, Z_NO_FLUSH);
3671 // it either returns Z_OK on progress, Z_STREAM_END on end
3679 case Z_STREAM_ERROR:
3680 Con_Print("FS_Inflate: stream error!\n");
3683 Con_Print("FS_Inflate: data error!\n");
3686 Con_Print("FS_Inflate: mem error!\n");
3689 Con_Print("FS_Inflate: buf error!\n");
3692 Con_Print("FS_Inflate: unknown error!\n");
3696 if(ret != Z_OK && ret != Z_STREAM_END)
3698 Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
3699 Mem_Free(outbuf.data);
3700 qz_inflateEnd(&strm);
3703 have = sizeof(tmp) - strm.avail_out;
3704 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
3705 SZ_Write(&outbuf, tmp, have);
3706 } while(ret != Z_STREAM_END);
3708 qz_inflateEnd(&strm);
3710 out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
3713 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
3714 Mem_Free(outbuf.data);
3718 memcpy(out, outbuf.data, outbuf.cursize);
3719 Mem_Free(outbuf.data);
3722 *inflated_size = (size_t)outbuf.cursize;