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
25 // on UNIX platforms we need to define this so that video saving does not cause a SIGFSZ (file size) signal when a video clip exceeds 2GB
26 #define _FILE_OFFSET_BITS 64
38 # include <sys/stat.h>
44 // Win32 requires us to add O_BINARY, but the other OSes don't have it
49 // In case the system doesn't support the O_NONBLOCK flag
57 All of Quake's data access is through a hierchal file system, but the contents
58 of the file system can be transparently merged from several sources.
60 The "base directory" is the path to the directory holding the quake.exe and
61 all game directories. The sys_* files pass this to host_init in
62 quakeparms_t->basedir. This can be overridden with the "-basedir" command
63 line parm to allow code debugging in a different directory. The base
64 directory is only used during filesystem initialization.
66 The "game directory" is the first tree on the search path and directory that
67 all generated files (savegames, screenshots, demos, config files) will be
68 saved to. This can be overridden with the "-game" command line parameter.
69 The game directory can never be changed while quake is executing. This is a
70 precaution against having a malicious server instruct clients to write files
71 over areas they shouldn't.
77 =============================================================================
81 =============================================================================
84 // Magic numbers of a ZIP file (big-endian format)
85 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
86 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
87 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
89 // Other constants for ZIP files
90 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
91 #define ZIP_END_CDIR_SIZE 22
92 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
93 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
95 // Zlib constants (from zlib.h)
96 #define Z_SYNC_FLUSH 2
99 #define Z_STREAM_END 1
100 #define ZLIB_VERSION "1.2.3"
102 // Uncomment the following line if the zlib DLL you have still uses
103 // the 1.1.x series calling convention on Win32 (WINAPI)
104 //#define ZLIB_USES_WINAPI
108 =============================================================================
112 =============================================================================
115 // Zlib stream (from zlib.h)
116 // Warning: some pointers we don't use directly have
117 // been cast to "void*" for a matter of simplicity
120 unsigned char *next_in; // next input byte
121 unsigned int avail_in; // number of bytes available at next_in
122 unsigned long total_in; // total nb of input bytes read so far
124 unsigned char *next_out; // next output byte should be put there
125 unsigned int avail_out; // remaining free space at next_out
126 unsigned long total_out; // total nb of bytes output so far
128 char *msg; // last error message, NULL if no error
129 void *state; // not visible by applications
131 void *zalloc; // used to allocate the internal state
132 void *zfree; // used to free the internal state
133 void *opaque; // private data object passed to zalloc and zfree
135 int data_type; // best guess about the data type: ascii or binary
136 unsigned long adler; // adler32 value of the uncompressed data
137 unsigned long reserved; // reserved for future use
141 // inside a package (PAK or PK3)
142 #define QFILE_FLAG_PACKED (1 << 0)
143 // file is compressed using the deflate algorithm (PK3 only)
144 #define QFILE_FLAG_DEFLATED (1 << 1)
146 #define FILE_BUFF_SIZE 2048
150 size_t comp_length; // length of the compressed file
151 size_t in_ind, in_len; // input buffer current index and length
152 size_t in_position; // position in the compressed file
153 unsigned char input [FILE_BUFF_SIZE];
159 int handle; // file descriptor
160 fs_offset_t real_length; // uncompressed file size (for files opened in "read" mode)
161 fs_offset_t position; // current position in the file
162 fs_offset_t offset; // offset into the package (0 if external file)
163 int ungetc; // single stored character from ungetc, cleared to EOF when read
166 fs_offset_t buff_ind, buff_len; // buffer current index and length
167 unsigned char buff [FILE_BUFF_SIZE];
174 // ------ PK3 files on disk ------ //
176 // You can get the complete ZIP format description from PKWARE website
178 typedef struct pk3_endOfCentralDir_s
180 unsigned int signature;
181 unsigned short disknum;
182 unsigned short cdir_disknum; // number of the disk with the start of the central directory
183 unsigned short localentries; // number of entries in the central directory on this disk
184 unsigned short nbentries; // total number of entries in the central directory on this disk
185 unsigned int cdir_size; // size of the central directory
186 unsigned int cdir_offset; // with respect to the starting disk number
187 unsigned short comment_size;
188 } pk3_endOfCentralDir_t;
191 // ------ PAK files on disk ------ //
192 typedef struct dpackfile_s
195 int filepos, filelen;
198 typedef struct dpackheader_s
206 // Packages in memory
207 // the offset in packfile_t is the true contents offset
208 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
209 // file compressed using the deflate algorithm
210 #define PACKFILE_FLAG_DEFLATED (1 << 1)
212 typedef struct packfile_s
214 char name [MAX_QPATH];
217 fs_offset_t packsize; // size in the package
218 fs_offset_t realsize; // real file size (uncompressed)
221 typedef struct pack_s
223 char filename [MAX_OSPATH];
225 int ignorecase; // PK3 ignores case
231 // Search paths for files (including packages)
232 typedef struct searchpath_s
234 // only one of filename / pack will be used
235 char filename[MAX_OSPATH];
237 struct searchpath_s *next;
242 =============================================================================
246 =============================================================================
252 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet);
253 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
254 fs_offset_t offset, fs_offset_t packsize,
255 fs_offset_t realsize, int flags);
259 =============================================================================
263 =============================================================================
266 mempool_t *fs_mempool;
268 searchpath_t *fs_searchpaths = NULL;
270 #define MAX_FILES_IN_PACK 65536
272 char fs_gamedir[MAX_OSPATH];
273 char fs_basedir[MAX_OSPATH];
275 // list of active game directories (empty if not running a mod)
276 #define MAX_GAMEDIRS 16
277 int fs_numgamedirs = 0;
278 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
280 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)"};
284 =============================================================================
286 PRIVATE FUNCTIONS - PK3 HANDLING
288 =============================================================================
291 // Functions exported from zlib
292 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
293 # define ZEXPORT WINAPI
298 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
299 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
300 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
301 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
303 #define qz_inflateInit2(strm, windowBits) \
304 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
306 static dllfunction_t zlibfuncs[] =
308 {"inflate", (void **) &qz_inflate},
309 {"inflateEnd", (void **) &qz_inflateEnd},
310 {"inflateInit2_", (void **) &qz_inflateInit2_},
311 {"inflateReset", (void **) &qz_inflateReset},
315 // Handle for Zlib DLL
316 static dllhandle_t zlib_dll = NULL;
326 void PK3_CloseLibrary (void)
328 Sys_UnloadLibrary (&zlib_dll);
336 Try to load the Zlib DLL
339 qboolean PK3_OpenLibrary (void)
341 const char* dllnames [] =
346 # ifdef ZLIB_USES_WINAPI
352 #elif defined(MACOSX)
366 if (! Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs))
368 Con_Printf ("Compressed files support disabled\n");
372 Con_Printf ("Compressed files support enabled\n");
379 PK3_GetEndOfCentralDir
381 Extract the end of the central directory from a PK3 package
384 qboolean PK3_GetEndOfCentralDir (const char *packfile, int packhandle, pk3_endOfCentralDir_t *eocd)
386 fs_offset_t filesize, maxsize;
387 unsigned char *buffer, *ptr;
390 // Get the package size
391 filesize = lseek (packhandle, 0, SEEK_END);
392 if (filesize < ZIP_END_CDIR_SIZE)
395 // Load the end of the file in memory
396 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
399 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
400 buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
401 lseek (packhandle, filesize - maxsize, SEEK_SET);
402 if (read (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
408 // Look for the end of central dir signature around the end of the file
409 maxsize -= ZIP_END_CDIR_SIZE;
410 ptr = &buffer[maxsize];
412 while (BuffBigLong (ptr) != ZIP_END_HEADER)
424 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
425 eocd->signature = LittleLong (eocd->signature);
426 eocd->disknum = LittleShort (eocd->disknum);
427 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
428 eocd->localentries = LittleShort (eocd->localentries);
429 eocd->nbentries = LittleShort (eocd->nbentries);
430 eocd->cdir_size = LittleLong (eocd->cdir_size);
431 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
432 eocd->comment_size = LittleShort (eocd->comment_size);
444 Extract the file list from a PK3 file
447 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
449 unsigned char *central_dir, *ptr;
451 fs_offset_t remaining;
453 // Load the central directory in memory
454 central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
455 lseek (pack->handle, eocd->cdir_offset, SEEK_SET);
456 read (pack->handle, central_dir, eocd->cdir_size);
458 // Extract the files properties
459 // The parsing is done "by hand" because some fields have variable sizes and
460 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
461 remaining = eocd->cdir_size;
464 for (ind = 0; ind < eocd->nbentries; ind++)
466 fs_offset_t namesize, count;
468 // Checking the remaining size
469 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
471 Mem_Free (central_dir);
474 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
477 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
479 Mem_Free (central_dir);
483 namesize = BuffLittleShort (&ptr[28]); // filename length
485 // Check encryption, compression, and attributes
486 // 1st uint8 : general purpose bit flag
487 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
488 // 2nd uint8 : external file attributes
489 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
490 if ((ptr[8] & 0x29) == 0 && (ptr[38] & 0x18) == 0)
492 // Still enough bytes for the name?
493 if (remaining < namesize || namesize >= (int)sizeof (*pack->files))
495 Mem_Free (central_dir);
499 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
500 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
502 char filename [sizeof (pack->files[0].name)];
503 fs_offset_t offset, packsize, realsize;
506 // Extract the name (strip it if necessary)
507 namesize = min(namesize, (int)sizeof (filename) - 1);
508 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
509 filename[namesize] = '\0';
511 if (BuffLittleShort (&ptr[10]))
512 flags = PACKFILE_FLAG_DEFLATED;
515 offset = BuffLittleLong (&ptr[42]);
516 packsize = BuffLittleLong (&ptr[20]);
517 realsize = BuffLittleLong (&ptr[24]);
518 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
522 // Skip the name, additionnal field, and comment
523 // 1er uint16 : extra field length
524 // 2eme uint16 : file comment length
525 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
526 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
530 // If the package is empty, central_dir is NULL here
531 if (central_dir != NULL)
532 Mem_Free (central_dir);
533 return pack->numfiles;
541 Create a package entry associated with a PK3 file
544 pack_t *FS_LoadPackPK3 (const char *packfile)
547 pk3_endOfCentralDir_t eocd;
551 packhandle = open (packfile, O_RDONLY | O_BINARY);
555 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
557 Con_Printf ("%s is not a PK3 file\n", packfile);
562 // Multi-volume ZIP archives are NOT allowed
563 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
565 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
570 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
571 // since eocd.nbentries is an unsigned 16 bits integer
572 #if MAX_FILES_IN_PACK < 65535
573 if (eocd.nbentries > MAX_FILES_IN_PACK)
575 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
581 // Create a package structure in memory
582 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
583 pack->ignorecase = true; // PK3 ignores case
584 strlcpy (pack->filename, packfile, sizeof (pack->filename));
585 pack->handle = packhandle;
586 pack->numfiles = eocd.nbentries;
587 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
589 real_nb_files = PK3_BuildFileList (pack, &eocd);
590 if (real_nb_files < 0)
592 Con_Printf ("%s is not a valid PK3 file\n", packfile);
598 Con_Printf("Added packfile %s (%i files)\n", packfile, real_nb_files);
605 PK3_GetTrueFileOffset
607 Find where the true file data offset is
610 qboolean PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
612 unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
616 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
619 // Load the local file description
620 lseek (pack->handle, pfile->offset, SEEK_SET);
621 count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
622 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
624 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
628 // Skip name and extra field
629 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
631 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
637 =============================================================================
639 OTHER PRIVATE FUNCTIONS
641 =============================================================================
649 Add a file to the list of files contained into a package
652 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
653 fs_offset_t offset, fs_offset_t packsize,
654 fs_offset_t realsize, int flags)
656 int (*strcmp_funct) (const char* str1, const char* str2);
657 int left, right, middle;
660 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
662 // Look for the slot we should put that file into (binary search)
664 right = pack->numfiles - 1;
665 while (left <= right)
669 middle = (left + right) / 2;
670 diff = strcmp_funct (pack->files[middle].name, name);
672 // If we found the file, there's a problem
674 Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
676 // If we're too far in the list
683 // We have to move the right of the list by one slot to free the one we need
684 pfile = &pack->files[left];
685 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
688 strlcpy (pfile->name, name, sizeof (pfile->name));
689 pfile->offset = offset;
690 pfile->packsize = packsize;
691 pfile->realsize = realsize;
692 pfile->flags = flags;
702 Only used for FS_Open.
705 void FS_CreatePath (char *path)
709 for (ofs = path+1 ; *ofs ; ofs++)
711 if (*ofs == '/' || *ofs == '\\')
713 // create the directory
729 void FS_Path_f (void)
733 Con_Print("Current search path:\n");
734 for (s=fs_searchpaths ; s ; s=s->next)
737 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
739 Con_Printf("%s\n", s->filename);
748 Takes an explicit (not game tree related) path to a pak file.
750 Loads the header and directory, adding the files at the beginning
751 of the list so they override previous pack files.
754 pack_t *FS_LoadPackPAK (const char *packfile)
756 dpackheader_t header;
762 packhandle = open (packfile, O_RDONLY | O_BINARY);
765 read (packhandle, (void *)&header, sizeof(header));
766 if (memcmp(header.id, "PACK", 4))
768 Con_Printf ("%s is not a packfile\n", packfile);
772 header.dirofs = LittleLong (header.dirofs);
773 header.dirlen = LittleLong (header.dirlen);
775 if (header.dirlen % sizeof(dpackfile_t))
777 Con_Printf ("%s has an invalid directory size\n", packfile);
782 numpackfiles = header.dirlen / sizeof(dpackfile_t);
784 if (numpackfiles > MAX_FILES_IN_PACK)
786 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
791 info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
792 lseek (packhandle, header.dirofs, SEEK_SET);
793 if(header.dirlen != read (packhandle, (void *)info, header.dirlen))
795 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
801 pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
802 pack->ignorecase = false; // PAK is case sensitive
803 strlcpy (pack->filename, packfile, sizeof (pack->filename));
804 pack->handle = packhandle;
806 pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
808 // parse the directory
809 for (i = 0;i < numpackfiles;i++)
811 fs_offset_t offset = LittleLong (info[i].filepos);
812 fs_offset_t size = LittleLong (info[i].filelen);
814 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
819 Con_Printf("Added packfile %s (%i files)\n", packfile, numpackfiles);
827 Adds the given pack to the search path.
828 The pack type is autodetected by the file extension.
830 Returns true if the file was successfully added to the
831 search path or if it was already included.
833 If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
837 static qboolean FS_AddPack_Fullpath(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
839 searchpath_t *search;
841 const char *ext = FS_FileExtension(pakfile);
843 for(search = fs_searchpaths; search; search = search->next)
845 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
848 *already_loaded = true;
849 return true; // already loaded
854 *already_loaded = false;
856 if(!strcasecmp(ext, "pak"))
857 pak = FS_LoadPackPAK (pakfile);
858 else if(!strcasecmp(ext, "pk3"))
859 pak = FS_LoadPackPK3 (pakfile);
861 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
867 // find the first item whose next one is a pack or NULL
868 searchpath_t *insertion_point = 0;
869 if(fs_searchpaths && !fs_searchpaths->pack)
871 insertion_point = fs_searchpaths;
874 if(!insertion_point->next)
876 if(insertion_point->next->pack)
878 insertion_point = insertion_point->next;
881 // If insertion_point is NULL, this means that either there is no
882 // item in the list yet, or that the very first item is a pack. In
883 // that case, we want to insert at the beginning...
886 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
888 search->next = fs_searchpaths;
889 fs_searchpaths = search;
892 // otherwise we want to append directly after insertion_point.
894 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
896 search->next = insertion_point->next;
897 insertion_point->next = search;
902 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
904 search->next = fs_searchpaths;
905 fs_searchpaths = search;
911 Con_Printf("unable to load pak \"%s\"\n", pakfile);
921 Adds the given pack to the search path and searches for it in the game path.
922 The pack type is autodetected by the file extension.
924 Returns true if the file was successfully added to the
925 search path or if it was already included.
927 If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
931 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean keep_plain_dirs)
933 char fullpath[MAX_QPATH];
935 searchpath_t *search;
938 *already_loaded = false;
940 // then find the real name...
941 search = FS_FindFile(pakfile, &index, true);
942 if(!search || search->pack)
944 Con_Printf("could not find pak \"%s\"\n", pakfile);
948 dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
950 return FS_AddPack_Fullpath(fullpath, already_loaded, keep_plain_dirs);
958 Sets fs_gamedir, adds the directory to the head of the path,
959 then loads and adds pak1.pak pak2.pak ...
962 void FS_AddGameDirectory (const char *dir)
964 stringlist_t *list, *current;
965 searchpath_t *search;
966 char pakfile[MAX_OSPATH];
968 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
970 list = listdirectory(dir);
972 // add any PAK package in the directory
973 for (current = list;current;current = current->next)
975 if (!strcasecmp(FS_FileExtension(current->text), "pak"))
977 dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, current->text);
978 FS_AddPack_Fullpath(pakfile, NULL, false);
982 // add any PK3 package in the director
983 for (current = list;current;current = current->next)
985 if (!strcasecmp(FS_FileExtension(current->text), "pk3"))
987 dpsnprintf (pakfile, sizeof (pakfile), "%s%s", dir, current->text);
988 FS_AddPack_Fullpath(pakfile, NULL, false);
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 const char *homedir;
1013 // Add the common game directory
1014 FS_AddGameDirectory (va("%s%s/", fs_basedir, dir));
1017 // Add the personal game directory
1018 homedir = getenv ("HOME");
1019 if (homedir != NULL && homedir[0] != '\0')
1020 FS_AddGameDirectory (va("%s/.%s/%s/", homedir, gameuserdirname, dir));
1030 const char *FS_FileExtension (const char *in)
1032 const char *separator, *backslash, *colon, *dot;
1034 separator = strrchr(in, '/');
1035 backslash = strrchr(in, '\\');
1036 if (!separator || separator < backslash)
1037 separator = backslash;
1038 colon = strrchr(in, ':');
1039 if (!separator || separator < colon)
1042 dot = strrchr(in, '.');
1043 if (dot == NULL || (separator && (dot < separator)))
1055 void FS_ClearSearchPath (void)
1057 while (fs_searchpaths)
1059 searchpath_t *search = fs_searchpaths;
1060 fs_searchpaths = search->next;
1063 if (search->pack->files)
1064 Mem_Free(search->pack->files);
1065 Mem_Free(search->pack);
1077 void FS_Rescan_f (void)
1080 qboolean fs_modified = false;
1082 FS_ClearSearchPath();
1084 // add the game-specific paths
1085 // gamedirname1 (typically id1)
1086 FS_AddGameHierarchy (gamedirname1);
1087 // update the com_modname (used for server info)
1088 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1090 // add the game-specific path, if any
1091 // (only used for mission packs and the like, which should set fs_modified)
1095 FS_AddGameHierarchy (gamedirname2);
1099 // Adds basedir/gamedir as an override game
1100 // LordHavoc: now supports multiple -game directories
1101 // set the com_modname (reported in server info)
1102 for (i = 0;i < fs_numgamedirs;i++)
1105 FS_AddGameHierarchy (fs_gamedirs[i]);
1106 // update the com_modname (used server info)
1107 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1110 // set the default screenshot name to either the mod name or the
1111 // gamemode screenshot name
1112 if (strcmp(com_modname, gamedirname1))
1113 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1115 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1117 // If "-condebug" is in the command line, remove the previous log file
1118 if (COM_CheckParm ("-condebug") != 0)
1119 unlink (va("%s/qconsole.log", fs_gamedir));
1121 // look for the pop.lmp file and set registered to true if it is found
1122 if ((gamemode == GAME_NORMAL || gamemode == GAME_HIPNOTIC || gamemode == GAME_ROGUE) && !FS_FileExists("gfx/pop.lmp"))
1125 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1127 Con_Print("Playing shareware version.\n");
1131 Cvar_Set ("registered", "1");
1132 if (gamemode == GAME_NORMAL || gamemode == GAME_HIPNOTIC || gamemode == GAME_ROGUE)
1133 Con_Print("Playing registered version.\n");
1143 void Host_SaveConfig_f (void);
1144 void Host_LoadConfig_f (void);
1145 qboolean FS_ChangeGameDir(const char *string)
1147 // if already using the requested gamedir, do nothing
1148 if (fs_numgamedirs == 1 && !strcmp(fs_gamedirs[0], string))
1151 // if string is nasty, reject it
1152 if(FS_CheckNastyPath(string, true)) // overflowed or nasty?
1154 Con_Printf("FS_ChangeGameDir(\"%s\"): nasty filename rejected\n", string);
1158 // save the current config
1159 Host_SaveConfig_f();
1161 // change to the new gamedir
1163 strlcpy(fs_gamedirs[0], string, sizeof(fs_gamedirs[0]));
1165 // reinitialize filesystem to detect the new paks
1168 // exec the new config
1169 Host_LoadConfig_f();
1171 // reinitialize the loaded sounds
1174 // reinitialize renderer (this reloads hud/console background/etc)
1175 R_Modules_Restart();
1185 void FS_GameDir_f (void)
1191 Con_Printf("gamedirs active:");
1192 for (i = 0;i < fs_numgamedirs;i++)
1193 Con_Printf(" %s", fs_gamedirs[i]);
1198 if (cls.state != ca_disconnected || sv.active)
1200 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1204 Host_SaveConfig_f();
1207 for (i = 1;i < Cmd_Argc() && fs_numgamedirs < MAX_GAMEDIRS;i++)
1209 // if string is nasty, reject it
1210 if(FS_CheckNastyPath(Cmd_Argv(i), true)) // overflowed or nasty?
1212 Con_Printf("FS_GameDir_f(\"%s\"): nasty filename rejected\n", Cmd_Argv(i));
1216 strlcpy(fs_gamedirs[fs_numgamedirs], Cmd_Argv(i), sizeof(fs_gamedirs[fs_numgamedirs]));
1220 // reinitialize filesystem to detect the new paks
1223 // exec the new config
1224 Host_LoadConfig_f();
1226 // reinitialize the loaded sounds
1229 // reinitialize renderer (this reloads hud/console background/etc)
1230 R_Modules_Restart();
1243 fs_mempool = Mem_AllocPool("file management", 0, NULL);
1245 strlcpy(fs_gamedir, "", sizeof(fs_gamedir));
1247 // If the base directory is explicitly defined by the compilation process
1248 #ifdef DP_FS_BASEDIR
1249 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
1251 strlcpy(fs_basedir, "", sizeof(fs_basedir));
1254 // FIXME: is there a better way to find the directory outside the .app?
1255 if (strstr(com_argv[0], ".app/"))
1259 split = strstr(com_argv[0], ".app/");
1260 while (split > com_argv[0] && *split != '/')
1262 strlcpy(fs_basedir, com_argv[0], sizeof(fs_basedir));
1263 fs_basedir[split - com_argv[0]] = 0;
1271 // Overrides the system supplied base directory (under GAMENAME)
1272 // 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)
1273 i = COM_CheckParm ("-basedir");
1274 if (i && i < com_argc-1)
1276 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
1277 i = (int)strlen (fs_basedir);
1278 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1279 fs_basedir[i-1] = 0;
1282 // add a path separator to the end of the basedir if it lacks one
1283 if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
1284 strlcat(fs_basedir, "/", sizeof(fs_basedir));
1287 // Adds basedir/gamedir as an override game
1288 // LordHavoc: now supports multiple -game directories
1289 for (i = 1;i < com_argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
1293 if (!strcmp (com_argv[i], "-game") && i < com_argc-1)
1296 // add the gamedir to the list of active gamedirs
1297 strlcpy (fs_gamedirs[fs_numgamedirs], com_argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
1302 // update the searchpath
1306 void FS_Init_Commands(void)
1308 Cvar_RegisterVariable (&scr_screenshot_name);
1310 Cmd_AddCommand ("gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1311 Cmd_AddCommand ("fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1312 Cmd_AddCommand ("path", FS_Path_f, "print searchpath (game directories and archives)");
1313 Cmd_AddCommand ("dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1314 Cmd_AddCommand ("ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1322 void FS_Shutdown (void)
1324 Mem_FreePool (&fs_mempool);
1328 ====================
1331 Internal function used to create a qfile_t and open the relevant non-packed file on disk
1332 ====================
1334 static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
1340 // Parse the mode string
1349 opt = O_CREAT | O_TRUNC;
1353 opt = O_CREAT | O_APPEND;
1356 Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
1359 for (ind = 1; mode[ind] != '\0'; ind++)
1370 Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
1371 filepath, mode, mode[ind]);
1378 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1379 memset (file, 0, sizeof (*file));
1382 file->handle = open (filepath, mod | opt, 0666);
1383 if (file->handle < 0)
1389 file->real_length = lseek (file->handle, 0, SEEK_END);
1391 // For files opened in append mode, we start at the end of the file
1393 file->position = file->real_length;
1395 lseek (file->handle, 0, SEEK_SET);
1405 Open a packed file using its package file descriptor
1408 qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
1414 pfile = &pack->files[pack_ind];
1416 // If we don't have the true offset, get it now
1417 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
1418 if (!PK3_GetTrueFileOffset (pfile, pack))
1421 // No Zlib DLL = no compressed files
1422 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
1424 Con_Printf("WARNING: can't open the compressed file %s\n"
1425 "You need the Zlib DLL to use compressed files\n",
1430 // LordHavoc: lseek affects all duplicates of a handle so we do it before
1431 // the dup() call to avoid having to close the dup_handle on error here
1432 if (lseek (pack->handle, pfile->offset, SEEK_SET) == -1)
1434 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)\n",
1435 pfile->name, pack->filename, (int) pfile->offset);
1439 dup_handle = dup (pack->handle);
1442 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
1446 file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
1447 memset (file, 0, sizeof (*file));
1448 file->handle = dup_handle;
1449 file->flags = QFILE_FLAG_PACKED;
1450 file->real_length = pfile->realsize;
1451 file->offset = pfile->offset;
1455 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
1459 file->flags |= QFILE_FLAG_DEFLATED;
1461 // We need some more variables
1462 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
1464 ztk->comp_length = pfile->packsize;
1466 // Initialize zlib stream
1467 ztk->zstream.next_in = ztk->input;
1468 ztk->zstream.avail_in = 0;
1470 /* From Zlib's "unzip.c":
1472 * windowBits is passed < 0 to tell that there is no zlib header.
1473 * Note that in this case inflate *requires* an extra "dummy" byte
1474 * after the compressed stream in order to complete decompression and
1475 * return Z_STREAM_END.
1476 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
1477 * size of both compressed and uncompressed data
1479 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
1481 Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
1487 ztk->zstream.next_out = file->buff;
1488 ztk->zstream.avail_out = sizeof (file->buff);
1497 ====================
1500 Return true if the path should be rejected due to one of the following:
1501 1: path elements that are non-portable
1502 2: path elements that would allow access to files outside the game directory,
1503 or are just not a good idea for a mod to be using.
1504 ====================
1506 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
1508 // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
1512 // Windows: don't allow \ in filenames (windows-only), period.
1513 // (on Windows \ is a directory separator, but / is also supported)
1514 if (strstr(path, "\\"))
1515 return 1; // non-portable
1517 // Mac: don't allow Mac-only filenames - : is a directory separator
1518 // instead of /, but we rely on / working already, so there's no reason to
1519 // support a Mac-only path
1520 // Amiga and Windows: : tries to go to root of drive
1521 if (strstr(path, ":"))
1522 return 1; // non-portable attempt to go to root of drive
1524 // Amiga: // is parent directory
1525 if (strstr(path, "//"))
1526 return 1; // non-portable attempt to go to parent directory
1528 // all: don't allow going to parent directory (../ or /../)
1529 if (strstr(path, ".."))
1530 return 2; // attempt to go outside the game directory
1532 // Windows and UNIXes: don't allow absolute paths
1534 return 2; // attempt to go outside the game directory
1536 // 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
1537 if (strchr(path, '.'))
1541 // gamedir is entirely path elements, so simply forbid . entirely
1544 if (strchr(path, '.') < strrchr(path, '/'))
1545 return 2; // possible attempt to go outside the game directory
1548 // all: forbid trailing slash on gamedir
1549 if (isgamedir && path[strlen(path)-1] == '/')
1552 // all: forbid leading dot on any filename for any reason
1553 if (strstr(path, "/."))
1554 return 2; // attempt to go outside the game directory
1556 // after all these checks we're pretty sure it's a / separated filename
1557 // and won't do much if any harm
1563 ====================
1566 Look for a file in the packages and in the filesystem
1568 Return the searchpath where the file was found (or NULL)
1569 and the file index in the package if relevant
1570 ====================
1572 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
1574 searchpath_t *search;
1577 // search through the path, one element at a time
1578 for (search = fs_searchpaths;search;search = search->next)
1580 // is the element a pak file?
1583 int (*strcmp_funct) (const char* str1, const char* str2);
1584 int left, right, middle;
1587 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
1589 // Look for the file (binary search)
1591 right = pak->numfiles - 1;
1592 while (left <= right)
1596 middle = (left + right) / 2;
1597 diff = strcmp_funct (pak->files[middle].name, name);
1602 if (!quiet && developer.integer >= 10)
1603 Con_Printf("FS_FindFile: %s in %s\n",
1604 pak->files[middle].name, pak->filename);
1611 // If we're too far in the list
1620 char netpath[MAX_OSPATH];
1621 dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
1622 if (FS_SysFileExists (netpath))
1624 if (!quiet && developer.integer >= 10)
1625 Con_Printf("FS_FindFile: %s\n", netpath);
1634 if (!quiet && developer.integer >= 10)
1635 Con_Printf("FS_FindFile: can't find %s\n", name);
1647 Look for a file in the search paths and open it in read-only mode
1650 qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking)
1652 searchpath_t *search;
1655 search = FS_FindFile (filename, &pack_ind, quiet);
1661 // Found in the filesystem?
1664 char path [MAX_OSPATH];
1665 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
1666 return FS_SysOpen (path, "rb", nonblocking);
1669 // So, we found it in a package...
1670 return FS_OpenPackedFile (search->pack, pack_ind);
1675 =============================================================================
1677 MAIN PUBLIC FUNCTIONS
1679 =============================================================================
1683 ====================
1686 Open a file. The syntax is the same as fopen
1687 ====================
1689 qfile_t* FS_Open (const char* filepath, const char* mode, qboolean quiet, qboolean nonblocking)
1691 if (FS_CheckNastyPath(filepath, false))
1693 Con_Printf("FS_Open(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
1697 // If the file is opened in "write", "append", or "read/write" mode
1698 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
1700 char real_path [MAX_OSPATH];
1702 // Open the file on disk directly
1703 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath);
1705 // Create directories up to the file
1706 FS_CreatePath (real_path);
1708 return FS_SysOpen (real_path, mode, nonblocking);
1710 // Else, we look at the various search paths and open the file in read-only mode
1712 return FS_OpenReadFile (filepath, quiet, nonblocking);
1717 ====================
1721 ====================
1723 int FS_Close (qfile_t* file)
1725 if (close (file->handle))
1730 qz_inflateEnd (&file->ztk->zstream);
1731 Mem_Free (file->ztk);
1740 ====================
1743 Write "datasize" bytes into a file
1744 ====================
1746 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
1750 // If necessary, seek to the exact file position we're supposed to be
1751 if (file->buff_ind != file->buff_len)
1752 lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
1754 // Purge cached data
1757 // Write the buffer and update the position
1758 result = write (file->handle, data, (fs_offset_t)datasize);
1759 file->position = lseek (file->handle, 0, SEEK_CUR);
1760 if (file->real_length < file->position)
1761 file->real_length = file->position;
1771 ====================
1774 Read up to "buffersize" bytes from a file
1775 ====================
1777 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
1779 fs_offset_t count, done;
1781 if (buffersize == 0)
1784 // Get rid of the ungetc character
1785 if (file->ungetc != EOF)
1787 ((char*)buffer)[0] = file->ungetc;
1795 // First, we copy as many bytes as we can from "buff"
1796 if (file->buff_ind < file->buff_len)
1798 count = file->buff_len - file->buff_ind;
1800 done += ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
1801 memcpy (buffer, &file->buff[file->buff_ind], done);
1802 file->buff_ind += done;
1805 if (buffersize == 0)
1809 // NOTE: at this point, the read buffer is always empty
1811 // If the file isn't compressed
1812 if (! (file->flags & QFILE_FLAG_DEFLATED))
1816 // We must take care to not read after the end of the file
1817 count = file->real_length - file->position;
1819 // If we have a lot of data to get, put them directly into "buffer"
1820 if (buffersize > sizeof (file->buff) / 2)
1822 if (count > (fs_offset_t)buffersize)
1823 count = (fs_offset_t)buffersize;
1824 lseek (file->handle, file->offset + file->position, SEEK_SET);
1825 nb = read (file->handle, &((unsigned char*)buffer)[done], count);
1829 file->position += nb;
1831 // Purge cached data
1837 if (count > (fs_offset_t)sizeof (file->buff))
1838 count = (fs_offset_t)sizeof (file->buff);
1839 lseek (file->handle, file->offset + file->position, SEEK_SET);
1840 nb = read (file->handle, file->buff, count);
1843 file->buff_len = nb;
1844 file->position += nb;
1846 // Copy the requested data in "buffer" (as much as we can)
1847 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
1848 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
1849 file->buff_ind = count;
1857 // If the file is compressed, it's more complicated...
1858 // We cycle through a few operations until we have read enough data
1859 while (buffersize > 0)
1861 ztoolkit_t *ztk = file->ztk;
1864 // NOTE: at this point, the read buffer is always empty
1866 // If "input" is also empty, we need to refill it
1867 if (ztk->in_ind == ztk->in_len)
1869 // If we are at the end of the file
1870 if (file->position == file->real_length)
1873 count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
1874 if (count > (fs_offset_t)sizeof (ztk->input))
1875 count = (fs_offset_t)sizeof (ztk->input);
1876 lseek (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
1877 if (read (file->handle, ztk->input, count) != count)
1879 Con_Printf ("FS_Read: unexpected end of file\n");
1884 ztk->in_len = count;
1885 ztk->in_position += count;
1888 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
1889 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
1891 // Now that we are sure we have compressed data available, we need to determine
1892 // if it's better to inflate it in "file->buff" or directly in "buffer"
1894 // Inflate the data in "file->buff"
1895 if (buffersize < sizeof (file->buff) / 2)
1897 ztk->zstream.next_out = file->buff;
1898 ztk->zstream.avail_out = sizeof (file->buff);
1899 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1900 if (error != Z_OK && error != Z_STREAM_END)
1902 Con_Printf ("FS_Read: Can't inflate file\n");
1905 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
1907 file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
1908 file->position += file->buff_len;
1910 // Copy the requested data in "buffer" (as much as we can)
1911 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
1912 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
1913 file->buff_ind = count;
1916 // Else, we inflate directly in "buffer"
1919 ztk->zstream.next_out = &((unsigned char*)buffer)[done];
1920 ztk->zstream.avail_out = (unsigned int)buffersize;
1921 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1922 if (error != Z_OK && error != Z_STREAM_END)
1924 Con_Printf ("FS_Read: Can't inflate file\n");
1927 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
1929 // How much data did it inflate?
1930 count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
1931 file->position += count;
1933 // Purge cached data
1938 buffersize -= count;
1946 ====================
1949 Print a string into a file
1950 ====================
1952 int FS_Print (qfile_t* file, const char *msg)
1954 return (int)FS_Write (file, msg, strlen (msg));
1958 ====================
1961 Print a string into a file
1962 ====================
1964 int FS_Printf(qfile_t* file, const char* format, ...)
1969 va_start (args, format);
1970 result = FS_VPrintf (file, format, args);
1978 ====================
1981 Print a string into a file
1982 ====================
1984 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
1987 fs_offset_t buff_size = MAX_INPUTLINE;
1992 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
1993 len = dpvsnprintf (tempbuff, buff_size, format, ap);
1994 if (len >= 0 && len < buff_size)
1996 Mem_Free (tempbuff);
2000 len = write (file->handle, tempbuff, len);
2001 Mem_Free (tempbuff);
2008 ====================
2011 Get the next character of a file
2012 ====================
2014 int FS_Getc (qfile_t* file)
2018 if (FS_Read (file, &c, 1) != 1)
2026 ====================
2029 Put a character back into the read buffer (only supports one character!)
2030 ====================
2032 int FS_UnGetc (qfile_t* file, unsigned char c)
2034 // If there's already a character waiting to be read
2035 if (file->ungetc != EOF)
2044 ====================
2047 Move the position index in a file
2048 ====================
2050 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
2053 unsigned char* buffer;
2054 fs_offset_t buffersize;
2056 // Compute the file offset
2060 offset += file->position - file->buff_len + file->buff_ind;
2067 offset += file->real_length;
2073 if (offset < 0 || offset > (long) file->real_length)
2076 // If we have the data in our read buffer, we don't need to actually seek
2077 if (file->position - file->buff_len <= offset && offset <= file->position)
2079 file->buff_ind = offset + file->buff_len - file->position;
2083 // Purge cached data
2086 // Unpacked or uncompressed files can seek directly
2087 if (! (file->flags & QFILE_FLAG_DEFLATED))
2089 if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
2091 file->position = offset;
2095 // Seeking in compressed files is more a hack than anything else,
2096 // but we need to support it, so here we go.
2099 // If we have to go back in the file, we need to restart from the beginning
2100 if (offset <= file->position)
2104 ztk->in_position = 0;
2106 lseek (file->handle, file->offset, SEEK_SET);
2108 // Reset the Zlib stream
2109 ztk->zstream.next_in = ztk->input;
2110 ztk->zstream.avail_in = 0;
2111 qz_inflateReset (&ztk->zstream);
2114 // We need a big buffer to force inflating into it directly
2115 buffersize = 2 * sizeof (file->buff);
2116 buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
2118 // Skip all data until we reach the requested offset
2119 while (offset > file->position)
2121 fs_offset_t diff = offset - file->position;
2122 fs_offset_t count, len;
2124 count = (diff > buffersize) ? buffersize : diff;
2125 len = FS_Read (file, buffer, count);
2139 ====================
2142 Give the current position in a file
2143 ====================
2145 fs_offset_t FS_Tell (qfile_t* file)
2147 return file->position - file->buff_len + file->buff_ind;
2152 ====================
2155 Give the total size of a file
2156 ====================
2158 fs_offset_t FS_FileSize (qfile_t* file)
2160 return file->real_length;
2165 ====================
2168 Erases any buffered input or output data
2169 ====================
2171 void FS_Purge (qfile_t* file)
2183 Filename are relative to the quake directory.
2184 Always appends a 0 byte.
2187 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
2190 unsigned char *buf = NULL;
2191 fs_offset_t filesize = 0;
2193 file = FS_Open (path, "rb", quiet, false);
2196 filesize = file->real_length;
2197 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
2198 buf[filesize] = '\0';
2199 FS_Read (file, buf, filesize);
2203 if (filesizepointer)
2204 *filesizepointer = filesize;
2213 The filename will be prefixed by the current game directory
2216 qboolean FS_WriteFile (const char *filename, void *data, fs_offset_t len)
2220 file = FS_Open (filename, "wb", false, false);
2223 Con_Printf("FS_WriteFile: failed on %s\n", filename);
2227 Con_DPrintf("FS_WriteFile: %s\n", filename);
2228 FS_Write (file, data, len);
2235 =============================================================================
2237 OTHERS PUBLIC FUNCTIONS
2239 =============================================================================
2247 void FS_StripExtension (const char *in, char *out, size_t size_out)
2255 while ((currentchar = *in) && size_out > 1)
2257 if (currentchar == '.')
2259 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
2261 *out++ = currentchar;
2277 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
2281 // if path doesn't have a .EXT, append extension
2282 // (extension should include the .)
2283 src = path + strlen(path) - 1;
2285 while (*src != '/' && src != path)
2288 return; // it has an extension
2292 strlcat (path, extension, size_path);
2300 Look for a file in the packages and in the filesystem
2303 qboolean FS_FileExists (const char *filename)
2305 return (FS_FindFile (filename, NULL, true) != NULL);
2313 Look for a file in the filesystem only
2316 qboolean FS_SysFileExists (const char *path)
2321 // TODO: use another function instead, to avoid opening the file
2322 desc = open (path, O_RDONLY | O_BINARY);
2331 if (stat (path,&buf) == -1)
2338 void FS_mkdir (const char *path)
2351 Allocate and fill a search structure with information on matching filenames.
2354 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
2357 searchpath_t *searchpath;
2359 int i, basepathlength, numfiles, numchars;
2360 stringlist_t *dir, *dirfile, *liststart, *listcurrent, *listtemp;
2361 const char *slash, *backslash, *colon, *separator;
2363 char netpath[MAX_OSPATH];
2364 char temp[MAX_OSPATH];
2366 for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
2371 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
2379 slash = strrchr(pattern, '/');
2380 backslash = strrchr(pattern, '\\');
2381 colon = strrchr(pattern, ':');
2382 separator = max(slash, backslash);
2383 separator = max(separator, colon);
2384 basepathlength = separator ? (separator + 1 - pattern) : 0;
2385 basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
2387 memcpy(basepath, pattern, basepathlength);
2388 basepath[basepathlength] = 0;
2390 // search through the path, one element at a time
2391 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
2393 // is the element a pak file?
2394 if (searchpath->pack)
2396 // look through all the pak file elements
2397 pak = searchpath->pack;
2398 for (i = 0;i < pak->numfiles;i++)
2400 strlcpy(temp, pak->files[i].name, sizeof(temp));
2403 if (matchpattern(temp, (char *)pattern, true))
2405 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2406 if (!strcmp(listtemp->text, temp))
2408 if (listtemp == NULL)
2410 listcurrent = stringlistappend(listcurrent, temp);
2411 if (liststart == NULL)
2412 liststart = listcurrent;
2414 Con_DPrintf("SearchPackFile: %s : %s\n", pak->filename, temp);
2417 // strip off one path element at a time until empty
2418 // this way directories are added to the listing if they match the pattern
2419 slash = strrchr(temp, '/');
2420 backslash = strrchr(temp, '\\');
2421 colon = strrchr(temp, ':');
2423 if (separator < slash)
2425 if (separator < backslash)
2426 separator = backslash;
2427 if (separator < colon)
2429 *((char *)separator) = 0;
2435 // get a directory listing and look at each name
2436 dpsnprintf(netpath, sizeof (netpath), "%s%s", searchpath->filename, basepath);
2437 if ((dir = listdirectory(netpath)))
2439 for (dirfile = dir;dirfile;dirfile = dirfile->next)
2441 dpsnprintf(temp, sizeof(temp), "%s%s", basepath, dirfile->text);
2442 if (matchpattern(temp, (char *)pattern, true))
2444 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2445 if (!strcmp(listtemp->text, temp))
2447 if (listtemp == NULL)
2449 listcurrent = stringlistappend(listcurrent, temp);
2450 if (liststart == NULL)
2451 liststart = listcurrent;
2453 Con_DPrintf("SearchDirFile: %s\n", temp);
2464 liststart = stringlistsort(liststart);
2467 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2470 numchars += (int)strlen(listtemp->text) + 1;
2472 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
2473 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
2474 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
2475 search->numfilenames = (int)numfiles;
2478 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2481 search->filenames[numfiles] = search->filenamesbuffer + numchars;
2482 textlen = strlen(listtemp->text) + 1;
2483 memcpy(search->filenames[numfiles], listtemp->text, textlen);
2485 numchars += (int)textlen;
2488 stringlistfree(liststart);
2495 void FS_FreeSearch(fssearch_t *search)
2500 extern int con_linewidth;
2501 int FS_ListDirectory(const char *pattern, int oneperline)
2510 char linebuf[MAX_INPUTLINE];
2512 search = FS_Search(pattern, true, true);
2515 numfiles = search->numfilenames;
2518 // FIXME: the names could be added to one column list and then
2519 // gradually shifted into the next column if they fit, and then the
2520 // next to make a compact variable width listing but it's a lot more
2522 // find width for columns
2524 for (i = 0;i < numfiles;i++)
2526 l = (int)strlen(search->filenames[i]);
2527 if (columnwidth < l)
2530 // count the spacing character
2532 // calculate number of columns
2533 numcolumns = con_linewidth / columnwidth;
2534 // don't bother with the column printing if it's only one column
2535 if (numcolumns >= 2)
2537 numlines = (numfiles + numcolumns - 1) / numcolumns;
2538 for (i = 0;i < numlines;i++)
2541 for (k = 0;k < numcolumns;k++)
2543 l = i * numcolumns + k;
2546 name = search->filenames[l];
2547 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
2548 linebuf[linebufpos++] = name[j];
2549 // space out name unless it's the last on the line
2550 if (k + 1 < numcolumns && l + 1 < numfiles)
2551 for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
2552 linebuf[linebufpos++] = ' ';
2555 linebuf[linebufpos] = 0;
2556 Con_Printf("%s\n", linebuf);
2563 for (i = 0;i < numfiles;i++)
2564 Con_Printf("%s\n", search->filenames[i]);
2565 FS_FreeSearch(search);
2566 return (int)numfiles;
2569 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
2571 const char *pattern;
2574 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
2577 if (Cmd_Argc() == 2)
2578 pattern = Cmd_Argv(1);
2581 if (!FS_ListDirectory(pattern, oneperline))
2582 Con_Print("No files found.\n");
2587 FS_ListDirectoryCmd("dir", true);
2592 FS_ListDirectoryCmd("ls", false);
2595 const char *FS_WhichPack(const char *filename)
2598 searchpath_t *sp = FS_FindFile(filename, &index, true);
2600 return sp->pack->filename;