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
36 # 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
60 All of Quake's data access is through a hierchal file system, but the contents
61 of the file system can be transparently merged from several sources.
63 The "base directory" is the path to the directory holding the quake.exe and
64 all game directories. The sys_* files pass this to host_init in
65 quakeparms_t->basedir. This can be overridden with the "-basedir" command
66 line parm to allow code debugging in a different directory. The base
67 directory is only used during filesystem initialization.
69 The "game directory" is the first tree on the search path and directory that
70 all generated files (savegames, screenshots, demos, config files) will be
71 saved to. This can be overridden with the "-game" command line parameter.
72 The game directory can never be changed while quake is executing. This is a
73 precaution against having a malicious server instruct clients to write files
74 over areas they shouldn't.
80 =============================================================================
84 =============================================================================
87 // Magic numbers of a ZIP file (big-endian format)
88 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
89 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
90 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
92 // Other constants for ZIP files
93 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
94 #define ZIP_END_CDIR_SIZE 22
95 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
96 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
98 // Zlib constants (from zlib.h)
99 #define Z_SYNC_FLUSH 2
102 #define Z_STREAM_END 1
103 #define ZLIB_VERSION "1.2.3"
105 // Uncomment the following line if the zlib DLL you have still uses
106 // the 1.1.x series calling convention on Win32 (WINAPI)
107 //#define ZLIB_USES_WINAPI
111 =============================================================================
115 =============================================================================
118 // Zlib stream (from zlib.h)
119 // Warning: some pointers we don't use directly have
120 // been cast to "void*" for a matter of simplicity
123 unsigned char *next_in; // next input byte
124 unsigned int avail_in; // number of bytes available at next_in
125 unsigned long total_in; // total nb of input bytes read so far
127 unsigned char *next_out; // next output byte should be put there
128 unsigned int avail_out; // remaining free space at next_out
129 unsigned long total_out; // total nb of bytes output so far
131 char *msg; // last error message, NULL if no error
132 void *state; // not visible by applications
134 void *zalloc; // used to allocate the internal state
135 void *zfree; // used to free the internal state
136 void *opaque; // private data object passed to zalloc and zfree
138 int data_type; // best guess about the data type: ascii or binary
139 unsigned long adler; // adler32 value of the uncompressed data
140 unsigned long reserved; // reserved for future use
144 // inside a package (PAK or PK3)
145 #define QFILE_FLAG_PACKED (1 << 0)
146 // file is compressed using the deflate algorithm (PK3 only)
147 #define QFILE_FLAG_DEFLATED (1 << 1)
149 #define FILE_BUFF_SIZE 2048
153 size_t comp_length; // length of the compressed file
154 size_t in_ind, in_len; // input buffer current index and length
155 size_t in_position; // position in the compressed file
156 unsigned char input [FILE_BUFF_SIZE];
162 int handle; // file descriptor
163 fs_offset_t real_length; // uncompressed file size (for files opened in "read" mode)
164 fs_offset_t position; // current position in the file
165 fs_offset_t offset; // offset into the package (0 if external file)
166 int ungetc; // single stored character from ungetc, cleared to EOF when read
169 fs_offset_t buff_ind, buff_len; // buffer current index and length
170 unsigned char buff [FILE_BUFF_SIZE];
177 // ------ PK3 files on disk ------ //
179 // You can get the complete ZIP format description from PKWARE website
181 typedef struct pk3_endOfCentralDir_s
183 unsigned int signature;
184 unsigned short disknum;
185 unsigned short cdir_disknum; // number of the disk with the start of the central directory
186 unsigned short localentries; // number of entries in the central directory on this disk
187 unsigned short nbentries; // total number of entries in the central directory on this disk
188 unsigned int cdir_size; // size of the central directory
189 unsigned int cdir_offset; // with respect to the starting disk number
190 unsigned short comment_size;
191 } pk3_endOfCentralDir_t;
194 // ------ PAK files on disk ------ //
195 typedef struct dpackfile_s
198 int filepos, filelen;
201 typedef struct dpackheader_s
209 // Packages in memory
210 // the offset in packfile_t is the true contents offset
211 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
212 // file compressed using the deflate algorithm
213 #define PACKFILE_FLAG_DEFLATED (1 << 1)
215 typedef struct packfile_s
217 char name [MAX_QPATH];
220 fs_offset_t packsize; // size in the package
221 fs_offset_t realsize; // real file size (uncompressed)
224 typedef struct pack_s
226 char filename [MAX_OSPATH];
228 int ignorecase; // PK3 ignores case
234 // Search paths for files (including packages)
235 typedef struct searchpath_s
237 // only one of filename / pack will be used
238 char filename[MAX_OSPATH];
240 struct searchpath_s *next;
245 =============================================================================
249 =============================================================================
255 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet);
256 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
257 fs_offset_t offset, fs_offset_t packsize,
258 fs_offset_t realsize, int flags);
262 =============================================================================
266 =============================================================================
269 mempool_t *fs_mempool;
271 searchpath_t *fs_searchpaths = NULL;
273 #define MAX_FILES_IN_PACK 65536
275 char fs_gamedir[MAX_OSPATH];
276 char fs_basedir[MAX_OSPATH];
278 // list of active game directories (empty if not running a mod)
279 int fs_numgamedirs = 0;
280 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
282 cvar_t scr_screenshot_name = {0, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running)"};
283 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"};
287 =============================================================================
289 PRIVATE FUNCTIONS - PK3 HANDLING
291 =============================================================================
294 // Functions exported from zlib
295 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
296 # define ZEXPORT WINAPI
301 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
302 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
303 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
304 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
306 #define qz_inflateInit2(strm, windowBits) \
307 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
309 static dllfunction_t zlibfuncs[] =
311 {"inflate", (void **) &qz_inflate},
312 {"inflateEnd", (void **) &qz_inflateEnd},
313 {"inflateInit2_", (void **) &qz_inflateInit2_},
314 {"inflateReset", (void **) &qz_inflateReset},
318 // Handle for Zlib DLL
319 static dllhandle_t zlib_dll = NULL;
329 void PK3_CloseLibrary (void)
331 Sys_UnloadLibrary (&zlib_dll);
339 Try to load the Zlib DLL
342 qboolean PK3_OpenLibrary (void)
344 const char* dllnames [] =
349 # ifdef ZLIB_USES_WINAPI
355 #elif defined(MACOSX)
369 return Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs);
375 PK3_GetEndOfCentralDir
377 Extract the end of the central directory from a PK3 package
380 qboolean PK3_GetEndOfCentralDir (const char *packfile, int packhandle, pk3_endOfCentralDir_t *eocd)
382 fs_offset_t filesize, maxsize;
383 unsigned char *buffer, *ptr;
386 // Get the package size
387 filesize = lseek (packhandle, 0, SEEK_END);
388 if (filesize < ZIP_END_CDIR_SIZE)
391 // Load the end of the file in memory
392 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
395 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
396 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
397 lseek (packhandle, filesize - maxsize, SEEK_SET);
398 if (read (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
404 // Look for the end of central dir signature around the end of the file
405 maxsize -= ZIP_END_CDIR_SIZE;
406 ptr = &buffer[maxsize];
408 while (BuffBigLong (ptr) != ZIP_END_HEADER)
420 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
421 eocd->signature = LittleLong (eocd->signature);
422 eocd->disknum = LittleShort (eocd->disknum);
423 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
424 eocd->localentries = LittleShort (eocd->localentries);
425 eocd->nbentries = LittleShort (eocd->nbentries);
426 eocd->cdir_size = LittleLong (eocd->cdir_size);
427 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
428 eocd->comment_size = LittleShort (eocd->comment_size);
440 Extract the file list from a PK3 file
443 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
445 unsigned char *central_dir, *ptr;
447 fs_offset_t remaining;
449 // Load the central directory in memory
450 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
451 lseek (pack->handle, eocd->cdir_offset, SEEK_SET);
452 read (pack->handle, central_dir, eocd->cdir_size);
454 // Extract the files properties
455 // The parsing is done "by hand" because some fields have variable sizes and
456 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
457 remaining = eocd->cdir_size;
460 for (ind = 0; ind < eocd->nbentries; ind++)
462 fs_offset_t namesize, count;
464 // Checking the remaining size
465 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
467 Mem_Free (central_dir);
470 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
473 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
475 Mem_Free (central_dir);
479 namesize = BuffLittleShort (&ptr[28]); // filename length
481 // Check encryption, compression, and attributes
482 // 1st uint8 : general purpose bit flag
483 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
484 // 2nd uint8 : external file attributes
485 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
486 if ((ptr[8] & 0x29) == 0 && (ptr[38] & 0x18) == 0)
488 // Still enough bytes for the name?
489 if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
491 Mem_Free (central_dir);
495 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
496 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
498 char filename [sizeof (pack->files[0].name)];
499 fs_offset_t offset, packsize, realsize;
502 // Extract the name (strip it if necessary)
503 namesize = min(namesize, (int)sizeof (filename) - 1);
504 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
505 filename[namesize] = '\0';
507 if (BuffLittleShort (&ptr[10]))
508 flags = PACKFILE_FLAG_DEFLATED;
511 offset = BuffLittleLong (&ptr[42]);
512 packsize = BuffLittleLong (&ptr[20]);
513 realsize = BuffLittleLong (&ptr[24]);
514 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
518 // Skip the name, additionnal field, and comment
519 // 1er uint16 : extra field length
520 // 2eme uint16 : file comment length
521 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
522 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
526 // If the package is empty, central_dir is NULL here
527 if (central_dir != NULL)
528 Mem_Free (central_dir);
529 return pack->numfiles;
537 Create a package entry associated with a PK3 file
540 pack_t *FS_LoadPackPK3 (const char *packfile)
543 pk3_endOfCentralDir_t eocd;
547 packhandle = open (packfile, O_RDONLY | O_BINARY);
551 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
553 Con_Printf ("%s is not a PK3 file\n", packfile);
558 // Multi-volume ZIP archives are NOT allowed
559 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
561 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
566 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
567 // since eocd.nbentries is an unsigned 16 bits integer
568 #if MAX_FILES_IN_PACK < 65535
569 if (eocd.nbentries > MAX_FILES_IN_PACK)
571 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
577 // Create a package structure in memory
578 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
579 pack->ignorecase = true; // PK3 ignores case
580 strlcpy (pack->filename, packfile, sizeof (pack->filename));
581 pack->handle = packhandle;
582 pack->numfiles = eocd.nbentries;
583 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
585 real_nb_files = PK3_BuildFileList (pack, &eocd);
586 if (real_nb_files < 0)
588 Con_Printf ("%s is not a valid PK3 file\n", packfile);
594 Con_Printf("Added packfile %s (%i files)\n", packfile, real_nb_files);
601 PK3_GetTrueFileOffset
603 Find where the true file data offset is
606 qboolean PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
608 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
612 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
615 // Load the local file description
616 lseek (pack->handle, pfile->offset, SEEK_SET);
617 count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
618 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
620 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
624 // Skip name and extra field
625 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
627 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
633 =============================================================================
635 OTHER PRIVATE FUNCTIONS
637 =============================================================================
645 Add a file to the list of files contained into a package
648 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
649 fs_offset_t offset, fs_offset_t packsize,
650 fs_offset_t realsize, int flags)
652 int (*strcmp_funct) (const char* str1, const char* str2);
653 int left, right, middle;
656 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
658 // Look for the slot we should put that file into (binary search)
660 right = pack->numfiles - 1;
661 while (left <= right)
665 middle = (left + right) / 2;
666 diff = strcmp_funct (pack->files[middle].name, name);
668 // If we found the file, there's a problem
670 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
672 // If we're too far in the list
679 // We have to move the right of the list by one slot to free the one we need
680 pfile = &pack->files[left];
681 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
684 strlcpy (pfile->name, name, sizeof (pfile->name));
685 pfile->offset = offset;
686 pfile->packsize = packsize;
687 pfile->realsize = realsize;
688 pfile->flags = flags;
698 Only used for FS_Open.
701 void FS_CreatePath (char *path)
705 for (ofs = path+1 ; *ofs ; ofs++)
707 if (*ofs == '/' || *ofs == '\\')
709 // create the directory
725 void FS_Path_f (void)
729 Con_Print("Current search path:\n");
730 for (s=fs_searchpaths ; s ; s=s->next)
733 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
735 Con_Printf("%s\n", s->filename);
744 Takes an explicit (not game tree related) path to a pak file.
746 Loads the header and directory, adding the files at the beginning
747 of the list so they override previous pack files.
750 pack_t *FS_LoadPackPAK (const char *packfile)
752 dpackheader_t header;
758 packhandle = open (packfile, O_RDONLY | O_BINARY);
761 read (packhandle, (void *)&header, sizeof(header));
762 if (memcmp(header.id, "PACK", 4))
764 Con_Printf ("%s is not a packfile\n", packfile);
768 header.dirofs = LittleLong (header.dirofs);
769 header.dirlen = LittleLong (header.dirlen);
771 if (header.dirlen % sizeof(dpackfile_t))
773 Con_Printf ("%s has an invalid directory size\n", packfile);
778 numpackfiles = header.dirlen / sizeof(dpackfile_t);
780 if (numpackfiles > MAX_FILES_IN_PACK)
782 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
787 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
788 lseek (packhandle, header.dirofs, SEEK_SET);
789 if(header.dirlen != read (packhandle, (void *)info, header.dirlen))
791 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
797 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
798 pack->ignorecase = false; // PAK is case sensitive
799 strlcpy (pack->filename, packfile, sizeof (pack->filename));
800 pack->handle = packhandle;
802 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
804 // parse the directory
805 for (i = 0;i < numpackfiles;i++)
807 fs_offset_t offset = LittleLong (info[i].filepos);
808 fs_offset_t size = LittleLong (info[i].filelen);
810 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
815 Con_Printf("Added packfile %s (%i files)\n", packfile, numpackfiles);
823 Adds the given pack to the search path.
824 The pack type is autodetected by the file extension.
826 Returns true if the file was successfully added to the
827 search path or if it was already included.
829 If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
833 static qboolean FS_AddPack_Fullpath(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
835 searchpath_t *search;
837 const char *ext = FS_FileExtension(pakfile);
839 for(search = fs_searchpaths; search; search = search->next)
841 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
844 *already_loaded = true;
845 return true; // already loaded
850 *already_loaded = false;
852 if(!strcasecmp(ext, "pak"))
853 pak = FS_LoadPackPAK (pakfile);
854 else if(!strcasecmp(ext, "pk3"))
855 pak = FS_LoadPackPK3 (pakfile);
857 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
863 // find the first item whose next one is a pack or NULL
864 searchpath_t *insertion_point = 0;
865 if(fs_searchpaths && !fs_searchpaths->pack)
867 insertion_point = fs_searchpaths;
870 if(!insertion_point->next)
872 if(insertion_point->next->pack)
874 insertion_point = insertion_point->next;
877 // If insertion_point is NULL, this means that either there is no
878 // item in the list yet, or that the very first item is a pack. In
879 // that case, we want to insert at the beginning...
882 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
884 search->next = fs_searchpaths;
885 fs_searchpaths = search;
888 // otherwise we want to append directly after insertion_point.
890 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
892 search->next = insertion_point->next;
893 insertion_point->next = search;
898 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
900 search->next = fs_searchpaths;
901 fs_searchpaths = search;
907 Con_Printf("unable to load pak \"%s\"\n", pakfile);
917 Adds the given pack to the search path and searches for it in the game path.
918 The pack type is autodetected by the file extension.
920 Returns true if the file was successfully added to the
921 search path or if it was already included.
923 If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
927 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
929 char fullpath[MAX_QPATH];
931 searchpath_t *search;
934 *already_loaded = false;
936 // then find the real name...
937 search = FS_FindFile(pakfile, &index, true);
938 if(!search || search->pack)
940 Con_Printf("could not find pak \"%s\"\n", pakfile);
944 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
946 return FS_AddPack_Fullpath(fullpath, already_loaded, keep_plain_dirs);
954 Sets fs_gamedir, adds the directory to the head of the path,
955 then loads and adds pak1.pak pak2.pak ...
958 void FS_AddGameDirectory (const char *dir)
962 searchpath_t *search;
963 char pakfile[MAX_OSPATH];
965 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
967 stringlistinit(&list);
968 listdirectory(&list, dir);
969 stringlistsort(&list);
971 // add any PAK package in the directory
972 for (i = 0;i < list.numstrings;i++)
974 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
976 dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, list.strings[i]);
977 FS_AddPack_Fullpath(pakfile, NULL, false);
981 // add any PK3 package in the directory
982 for (i = 0;i < list.numstrings;i++)
984 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3"))
986 dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, list.strings[i]);
987 FS_AddPack_Fullpath(pakfile, NULL, false);
991 stringlistfreecontents(&list);
993 // Add the directory to the search path
994 // (unpacked files have the priority over packed files)
995 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
996 strlcpy (search->filename, dir, sizeof (search->filename));
997 search->next = fs_searchpaths;
998 fs_searchpaths = search;
1007 void FS_AddGameHierarchy (const char *dir)
1010 char userdir[MAX_QPATH];
1012 TCHAR mydocsdir[MAX_PATH + 1];
1014 const char *homedir;
1017 // Add the common game directory
1018 FS_AddGameDirectory (va("%s%s/", fs_basedir, dir));
1022 // Add the personal game directory
1024 if(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)
1025 dpsnprintf(userdir, sizeof(userdir), "%s/My Games/%s/", mydocsdir, gameuserdirname);
1026 fprintf(stderr, "userdir = %s\n", userdir);
1028 homedir = getenv ("HOME");
1030 dpsnprintf(userdir, sizeof(userdir), "%s/.%s/", homedir, gameuserdirname);
1034 if(!COM_CheckParm("-mygames"))
1036 int fd = open (va("%s%s/config.cfg", fs_basedir, dir), O_WRONLY | O_CREAT, 0666); // note: no O_TRUNC here!
1040 *userdir = 0; // we have write access to the game dir, so let's use it
1045 if(COM_CheckParm("-nohome"))
1048 if((i = COM_CheckParm("-userdir")) && i < com_argc - 1)
1049 dpsnprintf(userdir, sizeof(userdir), "%s/", com_argv[i+1]);
1052 FS_AddGameDirectory(va("%s%s/", userdir, dir));
1061 const char *FS_FileExtension (const char *in)
1063 const char *separator, *backslash, *colon, *dot;
1065 separator = strrchr(in, '/');
1066 backslash = strrchr(in, '\\');
1067 if (!separator || separator < backslash)
1068 separator = backslash;
1069 colon = strrchr(in, ':');
1070 if (!separator || separator < colon)
1073 dot = strrchr(in, '.');
1074 if (dot == NULL || (separator && (dot < separator)))
1086 const char *FS_FileWithoutPath (const char *in)
1088 const char *separator, *backslash, *colon;
1090 separator = strrchr(in, '/');
1091 backslash = strrchr(in, '\\');
1092 if (!separator || separator < backslash)
1093 separator = backslash;
1094 colon = strrchr(in, ':');
1095 if (!separator || separator < colon)
1097 return separator ? separator + 1 : in;
1106 void FS_ClearSearchPath (void)
1108 // unload all packs and directory information, close all pack files
1109 // (if a qfile is still reading a pack it won't be harmed because it used
1110 // dup() to get its own handle already)
1111 while (fs_searchpaths)
1113 searchpath_t *search = fs_searchpaths;
1114 fs_searchpaths = search->next;
1118 close(search->pack->handle);
1119 // free any memory associated with it
1120 if (search->pack->files)
1121 Mem_Free(search->pack->files);
1122 Mem_Free(search->pack);
1134 void FS_Rescan (void)
1137 qboolean fs_modified = false;
1139 FS_ClearSearchPath();
1141 // add the game-specific paths
1142 // gamedirname1 (typically id1)
1143 FS_AddGameHierarchy (gamedirname1);
1144 // update the com_modname (used for server info)
1145 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1147 // add the game-specific path, if any
1148 // (only used for mission packs and the like, which should set fs_modified)
1152 FS_AddGameHierarchy (gamedirname2);
1156 // Adds basedir/gamedir as an override game
1157 // LordHavoc: now supports multiple -game directories
1158 // set the com_modname (reported in server info)
1159 for (i = 0;i < fs_numgamedirs;i++)
1162 FS_AddGameHierarchy (fs_gamedirs[i]);
1163 // update the com_modname (used server info)
1164 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1167 // set the default screenshot name to either the mod name or the
1168 // gamemode screenshot name
1169 if (strcmp(com_modname, gamedirname1))
1170 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1172 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1174 // If "-condebug" is in the command line, remove the previous log file
1175 if (COM_CheckParm ("-condebug") != 0)
1176 unlink (va("%s/qconsole.log", fs_gamedir));
1178 // look for the pop.lmp file and set registered to true if it is found
1179 if ((gamemode == GAME_NORMAL || gamemode == GAME_HIPNOTIC || gamemode == GAME_ROGUE) && !FS_FileExists("gfx/pop.lmp"))
1182 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1184 Con_Print("Playing shareware version.\n");
1188 Cvar_Set ("registered", "1");
1189 if (gamemode == GAME_NORMAL || gamemode == GAME_HIPNOTIC || gamemode == GAME_ROGUE)
1190 Con_Print("Playing registered version.\n");
1193 // unload all wads so that future queries will return the new data
1197 void FS_Rescan_f(void)
1207 extern void Host_SaveConfig (void);
1208 extern void Host_LoadConfig_f (void);
1209 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean failmissing)
1213 if (fs_numgamedirs == numgamedirs)
1215 for (i = 0;i < numgamedirs;i++)
1216 if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1218 if (i == numgamedirs)
1219 return true; // already using this set of gamedirs, do nothing
1222 if (numgamedirs > MAX_GAMEDIRS)
1225 Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1226 return false; // too many gamedirs
1229 for (i = 0;i < numgamedirs;i++)
1231 // if string is nasty, reject it
1232 if(FS_CheckNastyPath(gamedirs[i], true))
1235 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1236 return false; // nasty gamedirs
1240 for (i = 0;i < numgamedirs;i++)
1242 if (!FS_CheckGameDir(gamedirs[i]) && failmissing)
1245 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1246 return false; // missing gamedirs
1250 // halt demo playback to close the file
1255 fs_numgamedirs = numgamedirs;
1256 for (i = 0;i < fs_numgamedirs;i++)
1257 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1259 // reinitialize filesystem to detect the new paks
1262 // exec the new config
1263 Host_LoadConfig_f();
1265 // unload all sounds so they will be reloaded from the new files as needed
1266 S_UnloadAllSounds_f();
1268 // reinitialize renderer (this reloads hud/console background/etc)
1269 R_Modules_Restart();
1279 void FS_GameDir_f (void)
1283 char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1287 Con_Printf("gamedirs active:");
1288 for (i = 0;i < fs_numgamedirs;i++)
1289 Con_Printf(" %s", fs_gamedirs[i]);
1294 numgamedirs = Cmd_Argc() - 1;
1295 if (numgamedirs > MAX_GAMEDIRS)
1297 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1301 for (i = 0;i < numgamedirs;i++)
1302 strlcpy(gamedirs[i], Cmd_Argv(i+1), sizeof(gamedirs[i]));
1304 if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1306 // actually, changing during game would work fine, but would be stupid
1307 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1311 FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1320 qboolean FS_CheckGameDir(const char *gamedir)
1324 stringlistinit(&list);
1325 listdirectory(&list, va("%s%s/", fs_basedir, gamedir));
1326 success = list.numstrings > 0;
1327 stringlistfreecontents(&list);
1341 fs_mempool = Mem_AllocPool("file management", 0, NULL);
1343 strlcpy(fs_gamedir, "", sizeof(fs_gamedir));
1345 // If the base directory is explicitly defined by the compilation process
1346 #ifdef DP_FS_BASEDIR
1347 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
1349 strlcpy(fs_basedir, "", sizeof(fs_basedir));
1352 // FIXME: is there a better way to find the directory outside the .app?
1353 if (strstr(com_argv[0], ".app/"))
1357 split = strstr(com_argv[0], ".app/");
1358 while (split > com_argv[0] && *split != '/')
1360 strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir));
1361 fs_basedir[split - com_argv[0]] = 0;
1369 // Overrides the system supplied base directory (under GAMENAME)
1370 // 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)
1371 i = COM_CheckParm ("-basedir");
1372 if (i && i < com_argc-1)
1374 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
1375 i = (int)strlen (fs_basedir);
1376 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1377 fs_basedir[i-1] = 0;
1380 // add a path separator to the end of the basedir if it lacks one
1381 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
1382 strlcat(fs_basedir, "/", sizeof(fs_basedir));
1384 if (!FS_CheckGameDir(gamedirname1))
1385 Sys_Error("base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
1387 if (gamedirname2 && !FS_CheckGameDir(gamedirname2))
1388 Sys_Error("base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
1391 // Adds basedir/gamedir as an override game
1392 // LordHavoc: now supports multiple -game directories
1393 for (i = 1;i < com_argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
1397 if (!strcmp (com_argv[i], "-game") && i < com_argc-1)
1400 if (FS_CheckNastyPath(com_argv[i], true))
1401 Sys_Error("-game %s%s/ is a dangerous/non-portable path\n", fs_basedir, com_argv[i]);
1402 if (!FS_CheckGameDir(com_argv[i]))
1403 Sys_Error("-game %s%s/ not found!\n", fs_basedir, com_argv[i]);
1404 // add the gamedir to the list of active gamedirs
1405 strlcpy (fs_gamedirs[fs_numgamedirs], com_argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
1410 // generate the searchpath
1414 void FS_Init_Commands(void)
1416 Cvar_RegisterVariable (&scr_screenshot_name);
1417 Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1419 Cmd_AddCommand ("gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1420 Cmd_AddCommand ("fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1421 Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)");
1422 Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1423 Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1431 void FS_Shutdown (void)
1433 // close all pack files and such
1434 // (hopefully there aren't any other open files, but they'll be cleaned up
1435 // by the OS anyway)
1436 FS_ClearSearchPath();
1437 Mem_FreePool (&fs_mempool);
1441 ====================
1444 Internal function used to create a qfile_t and open the relevant non-packed file on disk
1445 ====================
1447 static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
1453 // Parse the mode string
1462 opt = O_CREAT | O_TRUNC;
1466 opt = O_CREAT | O_APPEND;
1469 Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
1472 for (ind = 1; mode[ind] != '\0'; ind++)
1483 Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
1484 filepath, mode, mode[ind]);
1491 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1492 memset (file, 0, sizeof (*file));
1495 file->handle = open (filepath, mod | opt, 0666);
1496 if (file->handle < 0)
1502 file->real_length = lseek (file->handle, 0, SEEK_END);
1504 // For files opened in append mode, we start at the end of the file
1506 file->position = file->real_length;
1508 lseek (file->handle, 0, SEEK_SET);
1518 Open a packed file using its package file descriptor
1521 qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
1527 pfile = &pack->files[pack_ind];
1529 // If we don't have the true offset, get it now
1530 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
1531 if (!PK3_GetTrueFileOffset (pfile, pack))
1534 // No Zlib DLL = no compressed files
1535 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
1537 Con_Printf("WARNING: can't open the compressed file %s\n"
1538 "You need the Zlib DLL to use compressed files\n",
1543 // LordHavoc: lseek affects all duplicates of a handle so we do it before
1544 // the dup() call to avoid having to close the dup_handle on error here
1545 if (lseek (pack->handle, pfile->offset, SEEK_SET) == -1)
1547 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n",
1548 pfile->name, pack->filename, (int) pfile->offset);
1552 dup_handle = dup (pack->handle);
1555 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
1559 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1560 memset (file, 0, sizeof (*file));
1561 file->handle = dup_handle;
1562 file->flags = QFILE_FLAG_PACKED;
1563 file->real_length = pfile->realsize;
1564 file->offset = pfile->offset;
1568 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
1572 file->flags |= QFILE_FLAG_DEFLATED;
1574 // We need some more variables
1575 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
1577 ztk->comp_length = pfile->packsize;
1579 // Initialize zlib stream
1580 ztk->zstream.next_in = ztk->input;
1581 ztk->zstream.avail_in = 0;
1583 /* From Zlib's "unzip.c":
1585 * windowBits is passed < 0 to tell that there is no zlib header.
1586 * Note that in this case inflate *requires* an extra "dummy" byte
1587 * after the compressed stream in order to complete decompression and
1588 * return Z_STREAM_END.
1589 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
1590 * size of both compressed and uncompressed data
1592 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
1594 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
1600 ztk->zstream.next_out = file->buff;
1601 ztk->zstream.avail_out = sizeof (file->buff);
1610 ====================
1613 Return true if the path should be rejected due to one of the following:
1614 1: path elements that are non-portable
1615 2: path elements that would allow access to files outside the game directory,
1616 or are just not a good idea for a mod to be using.
1617 ====================
1619 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
1621 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
1625 // Windows: don't allow \ in filenames (windows-only), period.
1626 // (on Windows \ is a directory separator, but / is also supported)
1627 if (strstr(path, "\\"))
1628 return 1; // non-portable
1630 // Mac: don't allow Mac-only filenames - : is a directory separator
1631 // instead of /, but we rely on / working already, so there's no reason to
1632 // support a Mac-only path
1633 // Amiga and Windows: : tries to go to root of drive
1634 if (strstr(path, ":"))
1635 return 1; // non-portable attempt to go to root of drive
1637 // Amiga: // is parent directory
1638 if (strstr(path, "//"))
1639 return 1; // non-portable attempt to go to parent directory
1641 // all: don't allow going to parent directory (../ or /../)
1642 if (strstr(path, ".."))
1643 return 2; // attempt to go outside the game directory
1645 // Windows and UNIXes: don't allow absolute paths
1647 return 2; // attempt to go outside the game directory
1649 // 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
1650 if (strchr(path, '.'))
1654 // gamedir is entirely path elements, so simply forbid . entirely
1657 if (strchr(path, '.') < strrchr(path, '/'))
1658 return 2; // possible attempt to go outside the game directory
1661 // all: forbid trailing slash on gamedir
1662 if (isgamedir && path[strlen(path)-1] == '/')
1665 // all: forbid leading dot on any filename for any reason
1666 if (strstr(path, "/."))
1667 return 2; // attempt to go outside the game directory
1669 // after all these checks we're pretty sure it's a / separated filename
1670 // and won't do much if any harm
1676 ====================
1679 Look for a file in the packages and in the filesystem
1681 Return the searchpath where the file was found (or NULL)
1682 and the file index in the package if relevant
1683 ====================
1685 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
1687 searchpath_t *search;
1690 // search through the path, one element at a time
1691 for (search = fs_searchpaths;search;search = search->next)
1693 // is the element a pak file?
1696 int (*strcmp_funct) (const char* str1, const char* str2);
1697 int left, right, middle;
1700 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
1702 // Look for the file (binary search)
1704 right = pak->numfiles - 1;
1705 while (left <= right)
1709 middle = (left + right) / 2;
1710 diff = strcmp_funct (pak->files[middle].name, name);
1715 if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
1717 // yes, but the first one is empty so we treat it as not being there
1718 if (!quiet && developer.integer >= 10)
1719 Con_Printf("FS_FindFile: %s is marked as deleted\n", name);
1726 if (!quiet && developer.integer >= 10)
1727 Con_Printf("FS_FindFile: %s in %s\n",
1728 pak->files[middle].name, pak->filename);
1735 // If we're too far in the list
1744 char netpath[MAX_OSPATH];
1745 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
1746 if (FS_SysFileExists (netpath))
1748 if (!quiet && developer.integer >= 10)
1749 Con_Printf("FS_FindFile: %s\n", netpath);
1758 if (!quiet && developer.integer >= 10)
1759 Con_Printf("FS_FindFile: can't find %s\n", name);
1771 Look for a file in the search paths and open it in read-only mode
1774 qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking)
1776 searchpath_t *search;
1779 search = FS_FindFile (filename, &pack_ind, quiet);
1785 // Found in the filesystem?
1788 char path [MAX_OSPATH];
1789 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
1790 return FS_SysOpen (path, "rb", nonblocking);
1793 // So, we found it in a package...
1794 return FS_OpenPackedFile (search->pack, pack_ind);
1799 =============================================================================
1801 MAIN PUBLIC FUNCTIONS
1803 =============================================================================
1807 ====================
1810 Open a file. The syntax is the same as fopen
1811 ====================
1813 qfile_t* FS_Open (const char* filepath, const char* mode, qboolean quiet, qboolean nonblocking)
1816 char fixedFileName[MAX_QPATH];
1818 strlcpy( fixedFileName, filepath, MAX_QPATH );
1819 // try to fix common mistakes (\ instead of /)
1820 for( d = fixedFileName ; *d ; d++ )
1823 filepath = fixedFileName;
1826 if (FS_CheckNastyPath(filepath, false))
1828 Con_Printf("FS_Open(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
1832 // If the file is opened in "write", "append", or "read/write" mode
1833 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
1835 char real_path [MAX_OSPATH];
1837 // Open the file on disk directly
1838 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath);
1840 // Create directories up to the file
1841 FS_CreatePath (real_path);
1843 return FS_SysOpen (real_path, mode, nonblocking);
1845 // Else, we look at the various search paths and open the file in read-only mode
1847 return FS_OpenReadFile (filepath, quiet, nonblocking);
1852 ====================
1856 ====================
1858 int FS_Close (qfile_t* file)
1860 if (close (file->handle))
1865 qz_inflateEnd (&file->ztk->zstream);
1866 Mem_Free (file->ztk);
1875 ====================
1878 Write "datasize" bytes into a file
1879 ====================
1881 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
1885 // If necessary, seek to the exact file position we're supposed to be
1886 if (file->buff_ind != file->buff_len)
1887 lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
1889 // Purge cached data
1892 // Write the buffer and update the position
1893 result = write (file->handle, data, (fs_offset_t)datasize);
1894 file->position = lseek (file->handle, 0, SEEK_CUR);
1895 if (file->real_length < file->position)
1896 file->real_length = file->position;
1906 ====================
1909 Read up to "buffersize" bytes from a file
1910 ====================
1912 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
1914 fs_offset_t count, done;
1916 if (buffersize == 0)
1919 // Get rid of the ungetc character
1920 if (file->ungetc != EOF)
1922 ((char*)buffer)[0] = file->ungetc;
1930 // First, we copy as many bytes as we can from "buff"
1931 if (file->buff_ind < file->buff_len)
1933 count = file->buff_len - file->buff_ind;
1934 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
1936 memcpy (buffer, &file->buff[file->buff_ind], count);
1937 file->buff_ind += count;
1939 buffersize -= count;
1940 if (buffersize == 0)
1944 // NOTE: at this point, the read buffer is always empty
1946 // If the file isn't compressed
1947 if (! (file->flags & QFILE_FLAG_DEFLATED))
1951 // We must take care to not read after the end of the file
1952 count = file->real_length - file->position;
1954 // If we have a lot of data to get, put them directly into "buffer"
1955 if (buffersize > sizeof (file->buff) / 2)
1957 if (count > (fs_offset_t)buffersize)
1958 count = (fs_offset_t)buffersize;
1959 lseek (file->handle, file->offset + file->position, SEEK_SET);
1960 nb = read (file->handle, &((unsigned char*)buffer)[done], count);
1964 file->position += nb;
1966 // Purge cached data
1972 if (count > (fs_offset_t)sizeof (file->buff))
1973 count = (fs_offset_t)sizeof (file->buff);
1974 lseek (file->handle, file->offset + file->position, SEEK_SET);
1975 nb = read (file->handle, file->buff, count);
1978 file->buff_len = nb;
1979 file->position += nb;
1981 // Copy the requested data in "buffer" (as much as we can)
1982 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
1983 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
1984 file->buff_ind = count;
1992 // If the file is compressed, it's more complicated...
1993 // We cycle through a few operations until we have read enough data
1994 while (buffersize > 0)
1996 ztoolkit_t *ztk = file->ztk;
1999 // NOTE: at this point, the read buffer is always empty
2001 // If "input" is also empty, we need to refill it
2002 if (ztk->in_ind == ztk->in_len)
2004 // If we are at the end of the file
2005 if (file->position == file->real_length)
2008 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
2009 if (count > (fs_offset_t)sizeof (ztk->input))
2010 count = (fs_offset_t)sizeof (ztk->input);
2011 lseek (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
2012 if (read (file->handle, ztk->input, count) != count)
2014 Con_Printf ("FS_Read: unexpected end of file\n");
2019 ztk->in_len = count;
2020 ztk->in_position += count;
2023 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
2024 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
2026 // Now that we are sure we have compressed data available, we need to determine
2027 // if it's better to inflate it in "file->buff" or directly in "buffer"
2029 // Inflate the data in "file->buff"
2030 if (buffersize < sizeof (file->buff) / 2)
2032 ztk->zstream.next_out = file->buff;
2033 ztk->zstream.avail_out = sizeof (file->buff);
2034 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2035 if (error != Z_OK && error != Z_STREAM_END)
2037 Con_Printf ("FS_Read: Can't inflate file\n");
2040 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2042 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
2043 file->position += file->buff_len;
2045 // Copy the requested data in "buffer" (as much as we can)
2046 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2047 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2048 file->buff_ind = count;
2051 // Else, we inflate directly in "buffer"
2054 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
2055 ztk->zstream.avail_out = (unsigned int)buffersize;
2056 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
2057 if (error != Z_OK && error != Z_STREAM_END)
2059 Con_Printf ("FS_Read: Can't inflate file\n");
2062 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
2064 // How much data did it inflate?
2065 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
2066 file->position += count;
2068 // Purge cached data
2073 buffersize -= count;
2081 ====================
2084 Print a string into a file
2085 ====================
2087 int FS_Print (qfile_t* file, const char *msg)
2089 return (int)FS_Write (file, msg, strlen (msg));
2093 ====================
2096 Print a string into a file
2097 ====================
2099 int FS_Printf(qfile_t* file, const char* format, ...)
2104 va_start (args, format);
2105 result = FS_VPrintf (file, format, args);
2113 ====================
2116 Print a string into a file
2117 ====================
2119 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
2122 fs_offset_t buff_size = MAX_INPUTLINE;
2127 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
2128 len = dpvsnprintf (tempbuff, buff_size, format, ap);
2129 if (len >= 0 && len < buff_size)
2131 Mem_Free (tempbuff);
2135 len = write (file->handle, tempbuff, len);
2136 Mem_Free (tempbuff);
2143 ====================
2146 Get the next character of a file
2147 ====================
2149 int FS_Getc (qfile_t* file)
2153 if (FS_Read (file, &c, 1) != 1)
2161 ====================
2164 Put a character back into the read buffer (only supports one character!)
2165 ====================
2167 int FS_UnGetc (qfile_t* file, unsigned char c)
2169 // If there's already a character waiting to be read
2170 if (file->ungetc != EOF)
2179 ====================
2182 Move the position index in a file
2183 ====================
2185 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
2188 unsigned char* buffer;
2189 fs_offset_t buffersize;
2191 // Compute the file offset
2195 offset += file->position - file->buff_len + file->buff_ind;
2202 offset += file->real_length;
2208 if (offset < 0 || offset > file->real_length)
2211 // If we have the data in our read buffer, we don't need to actually seek
2212 if (file->position - file->buff_len <= offset && offset <= file->position)
2214 file->buff_ind = offset + file->buff_len - file->position;
2218 // Purge cached data
2221 // Unpacked or uncompressed files can seek directly
2222 if (! (file->flags & QFILE_FLAG_DEFLATED))
2224 if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
2226 file->position = offset;
2230 // Seeking in compressed files is more a hack than anything else,
2231 // but we need to support it, so here we go.
2234 // If we have to go back in the file, we need to restart from the beginning
2235 if (offset <= file->position)
2239 ztk->in_position = 0;
2241 lseek (file->handle, file->offset, SEEK_SET);
2243 // Reset the Zlib stream
2244 ztk->zstream.next_in = ztk->input;
2245 ztk->zstream.avail_in = 0;
2246 qz_inflateReset (&ztk->zstream);
2249 // We need a big buffer to force inflating into it directly
2250 buffersize = 2 * sizeof (file->buff);
2251 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
2253 // Skip all data until we reach the requested offset
2254 while (offset > file->position)
2256 fs_offset_t diff = offset - file->position;
2257 fs_offset_t count, len;
2259 count = (diff > buffersize) ? buffersize : diff;
2260 len = FS_Read (file, buffer, count);
2274 ====================
2277 Give the current position in a file
2278 ====================
2280 fs_offset_t FS_Tell (qfile_t* file)
2282 return file->position - file->buff_len + file->buff_ind;
2287 ====================
2290 Give the total size of a file
2291 ====================
2293 fs_offset_t FS_FileSize (qfile_t* file)
2295 return file->real_length;
2300 ====================
2303 Erases any buffered input or output data
2304 ====================
2306 void FS_Purge (qfile_t* file)
2318 Filename are relative to the quake directory.
2319 Always appends a 0 byte.
2322 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
2325 unsigned char *buf = NULL;
2326 fs_offset_t filesize = 0;
2328 file = FS_Open (path, "rb", quiet, false);
2331 filesize = file->real_length;
2332 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
2333 buf[filesize] = '\0';
2334 FS_Read (file, buf, filesize);
2336 if (developer_loadfile.integer)
2337 Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
2340 if (filesizepointer)
2341 *filesizepointer = filesize;
2350 The filename will be prefixed by the current game directory
2353 qboolean FS_WriteFile (const char *filename, void *data, fs_offset_t len)
2357 file = FS_Open (filename, "wb", false, false);
2360 Con_Printf("FS_WriteFile: failed on %s\n", filename);
2364 Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)len);
2365 FS_Write (file, data, len);
2372 =============================================================================
2374 OTHERS PUBLIC FUNCTIONS
2376 =============================================================================
2384 void FS_StripExtension (const char *in, char *out, size_t size_out)
2392 while ((currentchar = *in) && size_out > 1)
2394 if (currentchar == '.')
2396 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
2398 *out++ = currentchar;
2414 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
2418 // if path doesn't have a .EXT, append extension
2419 // (extension should include the .)
2420 src = path + strlen(path) - 1;
2422 while (*src != '/' && src != path)
2425 return; // it has an extension
2429 strlcat (path, extension, size_path);
2437 Look for a file in the packages and in the filesystem
2440 int FS_FileType (const char *filename)
2442 searchpath_t *search;
2443 char fullpath[MAX_QPATH];
2445 search = FS_FindFile (filename, NULL, true);
2447 return FS_FILETYPE_NONE;
2450 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
2452 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
2453 return FS_SysFileType(fullpath);
2461 Look for a file in the packages and in the filesystem
2464 qboolean FS_FileExists (const char *filename)
2466 return (FS_FindFile (filename, NULL, true) != NULL);
2474 Look for a file in the filesystem only
2477 int FS_SysFileType (const char *path)
2480 DWORD result = GetFileAttributes(path);
2482 if(result == INVALID_FILE_ATTRIBUTES)
2483 return FS_FILETYPE_NONE;
2485 if(result & FILE_ATTRIBUTE_DIRECTORY)
2486 return FS_FILETYPE_DIRECTORY;
2488 return FS_FILETYPE_FILE;
2492 if (stat (path,&buf) == -1)
2493 return FS_FILETYPE_NONE;
2495 if(S_ISDIR(buf.st_mode))
2496 return FS_FILETYPE_DIRECTORY;
2498 return FS_FILETYPE_FILE;
2502 qboolean FS_SysFileExists (const char *path)
2504 return FS_SysFileType (path) != FS_FILETYPE_NONE;
2507 void FS_mkdir (const char *path)
2520 Allocate and fill a search structure with information on matching filenames.
2523 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
2526 searchpath_t *searchpath;
2528 int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
2529 stringlist_t resultlist;
2530 stringlist_t dirlist;
2531 const char *slash, *backslash, *colon, *separator;
2533 char netpath[MAX_OSPATH];
2534 char temp[MAX_OSPATH];
2536 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
2541 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
2545 stringlistinit(&resultlist);
2546 stringlistinit(&dirlist);
2548 slash = strrchr(pattern, '/');
2549 backslash = strrchr(pattern, '\\');
2550 colon = strrchr(pattern, ':');
2551 separator = max(slash, backslash);
2552 separator = max(separator, colon);
2553 basepathlength = separator ? (separator + 1 - pattern) : 0;
2554 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
2556 memcpy(basepath, pattern, basepathlength);
2557 basepath[basepathlength] = 0;
2559 // search through the path, one element at a time
2560 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
2562 // is the element a pak file?
2563 if (searchpath->pack)
2565 // look through all the pak file elements
2566 pak = searchpath->pack;
2567 for (i = 0;i < pak->numfiles;i++)
2569 strlcpy(temp, pak->files[i].name, sizeof(temp));
2572 if (matchpattern(temp, (char *)pattern, true))
2574 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
2575 if (!strcmp(resultlist.strings[resultlistindex], temp))
2577 if (resultlistindex == resultlist.numstrings)
2579 stringlistappend(&resultlist, temp);
2580 if (!quiet && developer_loading.integer)
2581 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
2584 // strip off one path element at a time until empty
2585 // this way directories are added to the listing if they match the pattern
2586 slash = strrchr(temp, '/');
2587 backslash = strrchr(temp, '\\');
2588 colon = strrchr(temp, ':');
2590 if (separator < slash)
2592 if (separator < backslash)
2593 separator = backslash;
2594 if (separator < colon)
2596 *((char *)separator) = 0;
2602 // get a directory listing and look at each name
2603 dpsnprintf(netpath, sizeof (netpath), "%s%s", searchpath->filename, basepath);
2604 stringlistinit(&dirlist);
2605 listdirectory(&dirlist, netpath);
2606 for (dirlistindex = 0;dirlistindex < dirlist.numstrings;dirlistindex++)
2608 dpsnprintf(temp, sizeof(temp), "%s%s", basepath, dirlist.strings[dirlistindex]);
2609 if (matchpattern(temp, (char *)pattern, true))
2611 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
2612 if (!strcmp(resultlist.strings[resultlistindex], temp))
2614 if (resultlistindex == resultlist.numstrings)
2616 stringlistappend(&resultlist, temp);
2617 if (!quiet && developer_loading.integer)
2618 Con_Printf("SearchDirFile: %s\n", temp);
2622 stringlistfreecontents(&dirlist);
2626 if (resultlist.numstrings)
2628 stringlistsort(&resultlist);
2629 numfiles = resultlist.numstrings;
2631 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
2632 numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
2633 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
2634 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
2635 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
2636 search->numfilenames = (int)numfiles;
2639 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
2642 search->filenames[numfiles] = search->filenamesbuffer + numchars;
2643 textlen = strlen(resultlist.strings[resultlistindex]) + 1;
2644 memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
2646 numchars += (int)textlen;
2649 stringlistfreecontents(&resultlist);
2655 void FS_FreeSearch(fssearch_t *search)
2660 extern int con_linewidth;
2661 int FS_ListDirectory(const char *pattern, int oneperline)
2670 char linebuf[MAX_INPUTLINE];
2672 search = FS_Search(pattern, true, true);
2675 numfiles = search->numfilenames;
2678 // FIXME: the names could be added to one column list and then
2679 // gradually shifted into the next column if they fit, and then the
2680 // next to make a compact variable width listing but it's a lot more
2682 // find width for columns
2684 for (i = 0;i < numfiles;i++)
2686 l = (int)strlen(search->filenames[i]);
2687 if (columnwidth < l)
2690 // count the spacing character
2692 // calculate number of columns
2693 numcolumns = con_linewidth / columnwidth;
2694 // don't bother with the column printing if it's only one column
2695 if (numcolumns >= 2)
2697 numlines = (numfiles + numcolumns - 1) / numcolumns;
2698 for (i = 0;i < numlines;i++)
2701 for (k = 0;k < numcolumns;k++)
2703 l = i * numcolumns + k;
2706 name = search->filenames[l];
2707 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
2708 linebuf[linebufpos++] = name[j];
2709 // space out name unless it's the last on the line
2710 if (k + 1 < numcolumns && l + 1 < numfiles)
2711 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
2712 linebuf[linebufpos++] = ' ';
2715 linebuf[linebufpos] = 0;
2716 Con_Printf("%s\n", linebuf);
2723 for (i = 0;i < numfiles;i++)
2724 Con_Printf("%s\n", search->filenames[i]);
2725 FS_FreeSearch(search);
2726 return (int)numfiles;
2729 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
2731 const char *pattern;
2734 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
2737 if (Cmd_Argc() == 2)
2738 pattern = Cmd_Argv(1);
2741 if (!FS_ListDirectory(pattern, oneperline))
2742 Con_Print("No files found.\n");
2747 FS_ListDirectoryCmd("dir", true);
2752 FS_ListDirectoryCmd("ls", false);
2755 const char *FS_WhichPack(const char *filename)
2758 searchpath_t *sp = FS_FindFile(filename, &index, true);
2760 return sp->pack->filename;
2766 ====================
2767 FS_IsRegisteredQuakePack
2769 Look for a proof of purchase file file in the requested package
2771 If it is found, this file should NOT be downloaded.
2772 ====================
2774 qboolean FS_IsRegisteredQuakePack(const char *name)
2776 searchpath_t *search;
2779 // search through the path, one element at a time
2780 for (search = fs_searchpaths;search;search = search->next)
2782 if (search->pack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
2784 int (*strcmp_funct) (const char* str1, const char* str2);
2785 int left, right, middle;
2788 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2790 // Look for the file (binary search)
2792 right = pak->numfiles - 1;
2793 while (left <= right)
2797 middle = (left + right) / 2;
2798 diff = !strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
2804 // If we're too far in the list
2811 // we found the requested pack but it is not registered quake
2819 int FS_CRCFile(const char *filename, size_t *filesizepointer)
2822 unsigned char *filedata;
2823 fs_offset_t filesize;
2824 if (filesizepointer)
2825 *filesizepointer = 0;
2826 if (!filename || !*filename)
2828 filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
2831 if (filesizepointer)
2832 *filesizepointer = filesize;
2833 crc = CRC_Block(filedata, filesize);