4 Copyright (C) 2003-2005 Mathieu Olivier
5 Copyright (C) 1999,2000 contributors of the QuakeForge project
7 This program is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public License
9 as published by the Free Software Foundation; either version 2
10 of the License, or (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16 See the GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to:
21 Free Software Foundation, Inc.
22 59 Temple Place - Suite 330
23 Boston, MA 02111-1307, USA
36 # include <sys/stat.h>
42 // Win32 requires us to add O_BINARY, but the other OSes don't have it
50 All of Quake's data access is through a hierchal file system, but the contents
51 of the file system can be transparently merged from several sources.
53 The "base directory" is the path to the directory holding the quake.exe and
54 all game directories. The sys_* files pass this to host_init in
55 quakeparms_t->basedir. This can be overridden with the "-basedir" command
56 line parm to allow code debugging in a different directory. The base
57 directory is only used during filesystem initialization.
59 The "game directory" is the first tree on the search path and directory that
60 all generated files (savegames, screenshots, demos, config files) will be
61 saved to. This can be overridden with the "-game" command line parameter.
62 The game directory can never be changed while quake is executing. This is a
63 precaution against having a malicious server instruct clients to write files
64 over areas they shouldn't.
70 =============================================================================
74 =============================================================================
77 // Magic numbers of a ZIP file (big-endian format)
78 #define ZIP_DATA_HEADER 0x504B0304 // "PK\3\4"
79 #define ZIP_CDIR_HEADER 0x504B0102 // "PK\1\2"
80 #define ZIP_END_HEADER 0x504B0506 // "PK\5\6"
82 // Other constants for ZIP files
83 #define ZIP_MAX_COMMENTS_SIZE ((unsigned short)0xFFFF)
84 #define ZIP_END_CDIR_SIZE 22
85 #define ZIP_CDIR_CHUNK_BASE_SIZE 46
86 #define ZIP_LOCAL_CHUNK_BASE_SIZE 30
88 // Zlib constants (from zlib.h)
89 #define Z_SYNC_FLUSH 2
92 #define Z_STREAM_END 1
93 #define ZLIB_VERSION "1.1.4"
97 =============================================================================
101 =============================================================================
104 // Zlib stream (from zlib.h)
105 // Warning: some pointers we don't use directly have
106 // been cast to "void*" for a matter of simplicity
109 qbyte *next_in; // next input byte
110 unsigned int avail_in; // number of bytes available at next_in
111 unsigned long total_in; // total nb of input bytes read so far
113 qbyte *next_out; // next output byte should be put there
114 unsigned int avail_out; // remaining free space at next_out
115 unsigned long total_out; // total nb of bytes output so far
117 char *msg; // last error message, NULL if no error
118 void *state; // not visible by applications
120 void *zalloc; // used to allocate the internal state
121 void *zfree; // used to free the internal state
122 void *opaque; // private data object passed to zalloc and zfree
124 int data_type; // best guess about the data type: ascii or binary
125 unsigned long adler; // adler32 value of the uncompressed data
126 unsigned long reserved; // reserved for future use
133 QFILE_FLAG_PACKED = (1 << 0), // inside a package (PAK or PK3)
134 QFILE_FLAG_DEFLATED = (1 << 1) // file is compressed using the deflate algorithm (PK3 only)
137 #define FILE_BUFF_SIZE 2048
141 size_t comp_length; // length of the compressed file
142 size_t in_ind, in_len; // input buffer current index and length
143 size_t in_position; // position in the compressed file
144 qbyte input [FILE_BUFF_SIZE];
150 int handle; // file descriptor
151 size_t real_length; // uncompressed file size (for files opened in "read" mode)
152 size_t position; // current position in the file
153 size_t offset; // offset into the package (0 if external file)
154 int ungetc; // single stored character from ungetc, cleared to EOF when read
157 size_t buff_ind, buff_len; // buffer current index and length
158 qbyte buff [FILE_BUFF_SIZE];
165 // ------ PK3 files on disk ------ //
167 // You can get the complete ZIP format description from PKWARE website
171 unsigned int signature;
172 unsigned short disknum;
173 unsigned short cdir_disknum; // number of the disk with the start of the central directory
174 unsigned short localentries; // number of entries in the central directory on this disk
175 unsigned short nbentries; // total number of entries in the central directory on this disk
176 unsigned int cdir_size; // size of the central directory
177 unsigned int cdir_offset; // with respect to the starting disk number
178 unsigned short comment_size;
179 } pk3_endOfCentralDir_t;
182 // ------ PAK files on disk ------ //
186 int filepos, filelen;
197 // Packages in memory
200 PACKFILE_FLAG_NONE = 0,
201 PACKFILE_FLAG_TRUEOFFS = (1 << 0), // the offset in packfile_t is the true contents offset
202 PACKFILE_FLAG_DEFLATED = (1 << 1) // file compressed using the deflate algorithm
207 char name [MAX_QPATH];
208 packfile_flags_t flags;
210 size_t packsize; // size in the package
211 size_t realsize; // real file size (uncompressed)
214 typedef struct pack_s
216 char filename [MAX_OSPATH];
218 int ignorecase; // PK3 ignores case
225 // Search paths for files (including packages)
226 typedef struct searchpath_s
228 // only one of filename / pack will be used
229 char filename[MAX_OSPATH];
231 struct searchpath_s *next;
236 =============================================================================
240 =============================================================================
246 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
247 size_t offset, size_t packsize,
248 size_t realsize, packfile_flags_t flags);
252 =============================================================================
256 =============================================================================
259 mempool_t *fs_mempool;
263 pack_t *packlist = NULL;
265 searchpath_t *fs_searchpaths = NULL;
267 #define MAX_FILES_IN_PACK 65536
269 char fs_gamedir[MAX_OSPATH];
270 char fs_basedir[MAX_OSPATH];
272 qboolean fs_modified; // set true if using non-id files
276 =============================================================================
278 PRIVATE FUNCTIONS - PK3 HANDLING
280 =============================================================================
283 // Functions exported from zlib
285 # define ZEXPORT WINAPI
290 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
291 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
292 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
293 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
295 #define qz_inflateInit2(strm, windowBits) \
296 qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
298 static dllfunction_t zlibfuncs[] =
300 {"inflate", (void **) &qz_inflate},
301 {"inflateEnd", (void **) &qz_inflateEnd},
302 {"inflateInit2_", (void **) &qz_inflateInit2_},
303 {"inflateReset", (void **) &qz_inflateReset},
307 // Handle for Zlib DLL
308 static dllhandle_t zlib_dll = NULL;
318 void PK3_CloseLibrary (void)
320 Sys_UnloadLibrary (&zlib_dll);
328 Try to load the Zlib DLL
331 qboolean PK3_OpenLibrary (void)
333 const char* dllnames [] =
337 #elif defined(MACOSX)
351 if (! Sys_LoadLibrary (dllnames, &zlib_dll, zlibfuncs))
353 Con_Printf ("Compressed files support disabled\n");
357 Con_Printf ("Compressed files support enabled\n");
364 PK3_GetEndOfCentralDir
366 Extract the end of the central directory from a PK3 package
369 qboolean PK3_GetEndOfCentralDir (const char *packfile, int packhandle, pk3_endOfCentralDir_t *eocd)
371 long filesize, maxsize;
375 // Get the package size
376 filesize = lseek (packhandle, 0, SEEK_END);
377 if (filesize < ZIP_END_CDIR_SIZE)
380 // Load the end of the file in memory
381 if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
384 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
385 buffer = Mem_Alloc (tempmempool, maxsize);
386 lseek (packhandle, filesize - maxsize, SEEK_SET);
387 if (read (packhandle, buffer, maxsize) != (ssize_t) maxsize)
393 // Look for the end of central dir signature around the end of the file
394 maxsize -= ZIP_END_CDIR_SIZE;
395 ptr = &buffer[maxsize];
397 while (BuffBigLong (ptr) != ZIP_END_HEADER)
409 memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
410 eocd->signature = LittleLong (eocd->signature);
411 eocd->disknum = LittleShort (eocd->disknum);
412 eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
413 eocd->localentries = LittleShort (eocd->localentries);
414 eocd->nbentries = LittleShort (eocd->nbentries);
415 eocd->cdir_size = LittleLong (eocd->cdir_size);
416 eocd->cdir_offset = LittleLong (eocd->cdir_offset);
417 eocd->comment_size = LittleShort (eocd->comment_size);
429 Extract the file list from a PK3 file
432 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
434 qbyte *central_dir, *ptr;
438 // Load the central directory in memory
439 central_dir = Mem_Alloc (tempmempool, eocd->cdir_size);
440 lseek (pack->handle, eocd->cdir_offset, SEEK_SET);
441 read (pack->handle, central_dir, eocd->cdir_size);
443 // Extract the files properties
444 // The parsing is done "by hand" because some fields have variable sizes and
445 // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
446 remaining = eocd->cdir_size;
449 for (ind = 0; ind < eocd->nbentries; ind++)
451 size_t namesize, count;
453 // Checking the remaining size
454 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
456 Mem_Free (central_dir);
459 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
462 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
464 Mem_Free (central_dir);
468 namesize = BuffLittleShort (&ptr[28]); // filename length
470 // Check encryption, compression, and attributes
471 // 1st uint8 : general purpose bit flag
472 // Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
473 // 2nd uint8 : external file attributes
474 // Check bits 3 (file is a directory) and 5 (file is a volume (?))
475 if ((ptr[8] & 0x29) == 0 && (ptr[38] & 0x18) == 0)
477 // Still enough bytes for the name?
478 if ((size_t) remaining < namesize || namesize >= sizeof (*pack->files))
480 Mem_Free (central_dir);
484 // WinZip doesn't use the "directory" attribute, so we need to check the name directly
485 if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
487 char filename [sizeof (pack->files[0].name)];
488 size_t offset, packsize, realsize;
489 packfile_flags_t flags;
491 // Extract the name (strip it if necessary)
492 if (namesize >= sizeof (filename))
493 namesize = sizeof (filename) - 1;
494 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
495 filename[namesize] = '\0';
497 if (BuffLittleShort (&ptr[10]))
498 flags = PACKFILE_FLAG_DEFLATED;
501 offset = BuffLittleLong (&ptr[42]);
502 packsize = BuffLittleLong (&ptr[20]);
503 realsize = BuffLittleLong (&ptr[24]);
504 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
508 // Skip the name, additionnal field, and comment
509 // 1er uint16 : extra field length
510 // 2eme uint16 : file comment length
511 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
512 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
516 // If the package is empty, central_dir is NULL here
517 if (central_dir != NULL)
518 Mem_Free (central_dir);
519 return pack->numfiles;
527 Create a package entry associated with a PK3 file
530 pack_t *FS_LoadPackPK3 (const char *packfile)
533 pk3_endOfCentralDir_t eocd;
537 packhandle = open (packfile, O_RDONLY | O_BINARY);
541 if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
542 Sys_Error ("%s is not a PK3 file", packfile);
544 // Multi-volume ZIP archives are NOT allowed
545 if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
546 Sys_Error ("%s is a multi-volume ZIP archive", packfile);
548 // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
549 // since eocd.nbentries is an unsigned 16 bits integer
550 #if MAX_FILES_IN_PACK < 65535
551 if (eocd.nbentries > MAX_FILES_IN_PACK)
552 Sys_Error ("%s contains too many files (%hu)", packfile, eocd.nbentries);
555 // Create a package structure in memory
556 pack = Mem_Alloc(fs_mempool, sizeof (pack_t));
557 pack->ignorecase = true; // PK3 ignores case
558 strlcpy (pack->filename, packfile, sizeof (pack->filename));
559 pack->handle = packhandle;
560 pack->numfiles = eocd.nbentries;
561 pack->files = Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
562 pack->next = packlist;
565 real_nb_files = PK3_BuildFileList (pack, &eocd);
566 if (real_nb_files < 0)
567 Sys_Error ("%s is not a valid PK3 file", packfile);
569 Con_Printf("Added packfile %s (%i files)\n", packfile, real_nb_files);
576 PK3_GetTrueFileOffset
578 Find where the true file data offset is
581 void PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
583 qbyte buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
587 if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
590 // Load the local file description
591 lseek (pack->handle, pfile->offset, SEEK_SET);
592 count = read (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
593 if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
594 Sys_Error ("Can't retrieve file %s in package %s", pfile->name, pack->filename);
596 // Skip name and extra field
597 pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
599 pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
604 =============================================================================
606 OTHER PRIVATE FUNCTIONS
608 =============================================================================
616 Add a file to the list of files contained into a package
619 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
620 size_t offset, size_t packsize,
621 size_t realsize, packfile_flags_t flags)
623 int (*strcmp_funct) (const char* str1, const char* str2);
624 int left, right, middle;
627 strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
629 // Look for the slot we should put that file into (binary search)
631 right = pack->numfiles - 1;
632 while (left <= right)
636 middle = (left + right) / 2;
637 diff = strcmp_funct (pack->files[middle].name, name);
639 // If we found the file, there's a problem
641 Sys_Error ("Package %s contains the file %s several times\n",
642 pack->filename, name);
644 // If we're too far in the list
651 // We have to move the right of the list by one slot to free the one we need
652 pfile = &pack->files[left];
653 memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
656 strlcpy (pfile->name, name, sizeof (pfile->name));
657 pfile->offset = offset;
658 pfile->packsize = packsize;
659 pfile->realsize = realsize;
660 pfile->flags = flags;
670 Only used for FS_Open.
673 void FS_CreatePath (char *path)
677 for (ofs = path+1 ; *ofs ; ofs++)
679 if (*ofs == '/' || *ofs == '\\')
681 // create the directory
697 void FS_Path_f (void)
701 Con_Print("Current search path:\n");
702 for (s=fs_searchpaths ; s ; s=s->next)
706 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
709 Con_Printf("%s\n", s->filename);
718 Takes an explicit (not game tree related) path to a pak file.
720 Loads the header and directory, adding the files at the beginning
721 of the list so they override previous pack files.
724 pack_t *FS_LoadPackPAK (const char *packfile)
726 dpackheader_t header;
732 packhandle = open (packfile, O_RDONLY | O_BINARY);
735 read (packhandle, (void *)&header, sizeof(header));
736 if (memcmp(header.id, "PACK", 4))
737 Sys_Error ("%s is not a packfile", packfile);
738 header.dirofs = LittleLong (header.dirofs);
739 header.dirlen = LittleLong (header.dirlen);
741 if (header.dirlen % sizeof(dpackfile_t))
742 Sys_Error ("%s has an invalid directory size", packfile);
744 numpackfiles = header.dirlen / sizeof(dpackfile_t);
746 if (numpackfiles > MAX_FILES_IN_PACK)
747 Sys_Error ("%s has %i files", packfile, numpackfiles);
749 pack = Mem_Alloc(fs_mempool, sizeof (pack_t));
750 pack->ignorecase = false; // PAK is case sensitive
751 strlcpy (pack->filename, packfile, sizeof (pack->filename));
752 pack->handle = packhandle;
754 pack->files = Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
755 pack->next = packlist;
758 info = Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
759 lseek (packhandle, header.dirofs, SEEK_SET);
760 read (packhandle, (void *)info, header.dirlen);
762 // parse the directory
763 for (i = 0;i < numpackfiles;i++)
765 size_t offset = LittleLong (info[i].filepos);
766 size_t size = LittleLong (info[i].filelen);
768 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
773 Con_Printf("Added packfile %s (%i files)\n", packfile, numpackfiles);
782 Sets fs_gamedir, adds the directory to the head of the path,
783 then loads and adds pak1.pak pak2.pak ...
786 void FS_AddGameDirectory (const char *dir)
788 stringlist_t *list, *current;
789 searchpath_t *search;
791 char pakfile[MAX_OSPATH];
793 strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
795 list = listdirectory(dir);
797 // add any PAK package in the directory
798 for (current = list;current;current = current->next)
800 if (matchpattern(current->text, "*.pak", true))
802 dpsnprintf (pakfile, sizeof (pakfile), "%s/%s", dir, current->text);
803 pak = FS_LoadPackPAK (pakfile);
806 search = Mem_Alloc(fs_mempool, sizeof(searchpath_t));
808 search->next = fs_searchpaths;
809 fs_searchpaths = search;
812 Con_Printf("unable to load pak \"%s\"\n", pakfile);
816 // add any PK3 package in the director
817 for (current = list;current;current = current->next)
819 if (matchpattern(current->text, "*.pk3", true))
821 dpsnprintf (pakfile, sizeof (pakfile), "%s/%s", dir, current->text);
822 pak = FS_LoadPackPK3 (pakfile);
825 search = Mem_Alloc(fs_mempool, sizeof(searchpath_t));
827 search->next = fs_searchpaths;
828 fs_searchpaths = search;
831 Con_Printf("unable to load pak \"%s\"\n", pakfile);
836 // Add the directory to the search path
837 // (unpacked files have the priority over packed files)
838 search = Mem_Alloc(fs_mempool, sizeof(searchpath_t));
839 strlcpy (search->filename, dir, sizeof (search->filename));
840 search->next = fs_searchpaths;
841 fs_searchpaths = search;
850 void FS_AddGameHierarchy (const char *dir)
856 strlcpy (com_modname, dir, sizeof (com_modname));
858 // Add the common game directory
859 FS_AddGameDirectory (va("%s/%s", fs_basedir, dir));
862 // Add the personal game directory
863 homedir = getenv ("HOME");
864 if (homedir != NULL && homedir[0] != '\0')
865 FS_AddGameDirectory (va("%s/.%s/%s", homedir, gameuserdirname, dir));
875 static const char *FS_FileExtension (const char *in)
877 const char *separator, *backslash, *colon, *dot;
879 separator = strrchr(in, '/');
880 backslash = strrchr(in, '\\');
881 if (separator < backslash)
882 separator = backslash;
883 colon = strrchr(in, ':');
884 if (separator < colon)
887 dot = strrchr(in, '.');
888 if (dot == NULL || dot < separator)
903 searchpath_t *search;
905 fs_mempool = Mem_AllocPool("file management", 0, NULL);
907 Cvar_RegisterVariable (&scr_screenshot_name);
909 Cmd_AddCommand ("path", FS_Path_f);
910 Cmd_AddCommand ("dir", FS_Dir_f);
911 Cmd_AddCommand ("ls", FS_Ls_f);
913 strcpy(fs_basedir, ".");
914 strcpy(fs_gamedir, ".");
919 // Overrides the system supplied base directory (under GAMENAME)
920 // 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)
921 i = COM_CheckParm ("-basedir");
922 if (i && i < com_argc-1)
924 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
925 i = strlen (fs_basedir);
926 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
930 // -path <dir or packfile> [<dir or packfile>] ...
931 // Fully specifies the exact search path, overriding the generated one
932 // COMMANDLINEOPTION: Filesystem: -path <path ..> specifies the full search path manually, overriding the generated one, example: -path c:\quake\id1 c:\quake\pak0.pak c:\quake\pak1.pak (not recommended)
933 i = COM_CheckParm ("-path");
937 while (++i < com_argc)
939 if (!com_argv[i] || com_argv[i][0] == '+' || com_argv[i][0] == '-')
942 search = Mem_Alloc(fs_mempool, sizeof(searchpath_t));
943 if (!strcasecmp (FS_FileExtension(com_argv[i]), "pak"))
945 search->pack = FS_LoadPackPAK (com_argv[i]);
947 Sys_Error ("Couldn't load packfile: %s", com_argv[i]);
949 else if (!strcasecmp (FS_FileExtension (com_argv[i]), "pk3"))
951 search->pack = FS_LoadPackPK3 (com_argv[i]);
953 Sys_Error ("Couldn't load packfile: %s", com_argv[i]);
956 strlcpy (search->filename, com_argv[i], sizeof (search->filename));
957 search->next = fs_searchpaths;
958 fs_searchpaths = search;
963 // add the game-specific paths
964 // gamedirname1 (typically id1)
965 FS_AddGameHierarchy (gamedirname1);
966 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
968 // add the game-specific path, if any
972 FS_AddGameHierarchy (gamedirname2);
976 // Adds basedir/gamedir as an override game
977 // LordHavoc: now supports multiple -game directories
978 for (i = 1;i < com_argc;i++)
982 if (!strcmp (com_argv[i], "-game") && i < com_argc-1)
986 FS_AddGameHierarchy (com_argv[i]);
987 Cvar_SetQuick (&scr_screenshot_name, com_modname);
991 // If "-condebug" is in the command line, remove the previous log file
992 if (COM_CheckParm ("-condebug") != 0)
993 unlink (va("%s/qconsole.log", fs_gamedir));
1001 void FS_Shutdown (void)
1003 Mem_FreePool (&fs_mempool);
1007 ====================
1010 Internal function used to create a qfile_t and open the relevant non-packed file on disk
1011 ====================
1013 static qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
1019 // Parse the mode string
1028 opt = O_CREAT | O_TRUNC;
1032 opt = O_CREAT | O_APPEND;
1035 Con_Printf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
1038 for (ind = 1; mode[ind] != '\0'; ind++)
1049 Con_Printf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
1050 filepath, mode, mode[ind]);
1059 file = Mem_Alloc (fs_mempool, sizeof (*file));
1060 memset (file, 0, sizeof (*file));
1063 file->handle = open (filepath, mod | opt, 0666);
1064 if (file->handle < 0)
1070 file->real_length = lseek (file->handle, 0, SEEK_END);
1072 // For files opened in append mode, we start at the end of the file
1074 file->position = file->real_length;
1076 lseek (file->handle, 0, SEEK_SET);
1086 Open a packed file using its package file descriptor
1089 qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
1095 pfile = &pack->files[pack_ind];
1097 // If we don't have the true offset, get it now
1098 if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
1099 PK3_GetTrueFileOffset (pfile, pack);
1101 // No Zlib DLL = no compressed files
1102 if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
1104 Con_Printf("WARNING: can't open the compressed file %s\n"
1105 "You need the Zlib DLL to use compressed files\n",
1111 dup_handle = dup (pack->handle);
1113 Sys_Error ("FS_OpenPackedFile: can't dup package's handle (pack: %s)", pack->filename);
1115 file = Mem_Alloc (fs_mempool, sizeof (*file));
1116 memset (file, 0, sizeof (*file));
1117 file->handle = dup_handle;
1118 file->flags = QFILE_FLAG_PACKED;
1119 file->real_length = pfile->realsize;
1120 file->offset = pfile->offset;
1124 if (lseek (file->handle, file->offset, SEEK_SET) == -1)
1125 Sys_Error ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %d)",
1126 pfile->name, pack->filename, file->offset);
1128 if (pfile->flags & PACKFILE_FLAG_DEFLATED)
1132 file->flags |= QFILE_FLAG_DEFLATED;
1134 // We need some more variables
1135 ztk = Mem_Alloc (fs_mempool, sizeof (*ztk));
1137 ztk->comp_length = pfile->packsize;
1139 // Initialize zlib stream
1140 ztk->zstream.next_in = ztk->input;
1141 ztk->zstream.avail_in = 0;
1143 /* From Zlib's "unzip.c":
1145 * windowBits is passed < 0 to tell that there is no zlib header.
1146 * Note that in this case inflate *requires* an extra "dummy" byte
1147 * after the compressed stream in order to complete decompression and
1148 * return Z_STREAM_END.
1149 * In unzip, i don't wait absolutely Z_STREAM_END because I known the
1150 * size of both compressed and uncompressed data
1152 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
1153 Sys_Error ("FS_OpenPackedFile: inflate init error (file: %s)", pfile->name);
1155 ztk->zstream.next_out = file->buff;
1156 ztk->zstream.avail_out = sizeof (file->buff);
1161 fs_filesize = pfile->realsize;
1167 ====================
1170 Return true if the path should be rejected due to one of the following:
1171 1: path elements that are non-portable
1172 2: path elements that would allow access to files outside the game directory,
1173 or are just not a good idea for a mod to be using.
1174 ====================
1176 int FS_CheckNastyPath (const char *path)
1178 // Windows: don't allow \ in filenames (windows-only), period.
1179 // (on Windows \ is a directory separator, but / is also supported)
1180 if (strstr(path, "\\"))
1181 return 1; // non-portable
1183 // Mac: don't allow Mac-only filenames - : is a directory separator
1184 // instead of /, but we rely on / working already, so there's no reason to
1185 // support a Mac-only path
1186 // Amiga and Windows: : tries to go to root of drive
1187 if (strstr(path, ":"))
1188 return 1; // non-portable attempt to go to root of drive
1190 // Amiga: // is parent directory
1191 if (strstr(path, "//"))
1192 return 1; // non-portable attempt to go to parent directory
1194 // all: don't allow going to current directory (./) or parent directory (../ or /../)
1195 if (strstr(path, "./"))
1196 return 2; // attempt to go outside the game directory
1198 // Windows and UNIXes: don't allow absolute paths
1200 return 2; // attempt to go outside the game directory
1202 // after all these checks we're pretty sure it's a / separated filename
1203 // and won't do much if any harm
1209 ====================
1212 Look for a file in the packages and in the filesystem
1214 Return the searchpath where the file was found (or NULL)
1215 and the file index in the package if relevant
1216 ====================
1218 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
1220 searchpath_t *search;
1223 // search through the path, one element at a time
1224 for (search = fs_searchpaths;search;search = search->next)
1226 // is the element a pak file?
1229 int (*strcmp_funct) (const char* str1, const char* str2);
1230 int left, right, middle;
1233 strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
1235 // Look for the file (binary search)
1237 right = pak->numfiles - 1;
1238 while (left <= right)
1242 middle = (left + right) / 2;
1243 diff = strcmp_funct (pak->files[middle].name, name);
1249 Con_DPrintf("FS_FindFile: %s in %s\n",
1250 pak->files[middle].name, pak->filename);
1257 // If we're too far in the list
1266 char netpath[MAX_OSPATH];
1267 dpsnprintf(netpath, sizeof(netpath), "%s/%s", search->filename, name);
1268 if (FS_SysFileExists (netpath))
1271 Con_DPrintf("FS_FindFile: %s\n", netpath);
1281 Con_DPrintf("FS_FindFile: can't find %s\n", name);
1293 Look for a file in the search paths and open it in read-only mode
1298 qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking)
1300 searchpath_t *search;
1303 search = FS_FindFile (filename, &pack_ind, quiet);
1312 // Found in the filesystem?
1315 char path [MAX_OSPATH];
1316 dpsnprintf (path, sizeof (path), "%s/%s", search->filename, filename);
1317 return FS_SysOpen (path, "rb", nonblocking);
1320 // So, we found it in a package...
1321 return FS_OpenPackedFile (search->pack, pack_ind);
1326 =============================================================================
1328 MAIN PUBLIC FUNCTIONS
1330 =============================================================================
1334 ====================
1337 Open a file. The syntax is the same as fopen
1338 ====================
1340 qfile_t* FS_Open (const char* filepath, const char* mode, qboolean quiet, qboolean nonblocking)
1344 if (FS_CheckNastyPath(filepath))
1346 Con_Printf("FS_Open(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
1350 // If the file is opened in "write", "append", or "read/write" mode
1351 if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
1353 char real_path [MAX_OSPATH];
1355 // Open the file on disk directly
1356 dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath);
1358 // Create directories up to the file
1359 FS_CreatePath (real_path);
1361 return FS_SysOpen (real_path, mode, nonblocking);
1364 // Else, we look at the various search paths and open the file in read-only mode
1365 file = FS_OpenReadFile (filepath, quiet, nonblocking);
1367 fs_filesize = file->real_length;
1374 ====================
1378 ====================
1380 int FS_Close (qfile_t* file)
1382 if (close (file->handle))
1387 qz_inflateEnd (&file->ztk->zstream);
1388 Mem_Free (file->ztk);
1397 ====================
1400 Write "datasize" bytes into a file
1401 ====================
1403 size_t FS_Write (qfile_t* file, const void* data, size_t datasize)
1407 // If necessary, seek to the exact file position we're supposed to be
1408 if (file->buff_ind != file->buff_len)
1409 lseek (file->handle, file->buff_ind - file->buff_len, SEEK_CUR);
1411 // Purge cached data
1414 // Write the buffer and update the position
1415 result = write (file->handle, data, datasize);
1416 file->position = lseek (file->handle, 0, SEEK_CUR);
1417 if (file->real_length < file->position)
1418 file->real_length = file->position;
1428 ====================
1431 Read up to "buffersize" bytes from a file
1432 ====================
1434 size_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
1438 if (buffersize == 0)
1441 // Get rid of the ungetc character
1442 if (file->ungetc != EOF)
1444 ((char*)buffer)[0] = file->ungetc;
1452 // First, we copy as many bytes as we can from "buff"
1453 if (file->buff_ind < file->buff_len)
1455 count = file->buff_len - file->buff_ind;
1457 done += (buffersize > count) ? count : buffersize;
1458 memcpy (buffer, &file->buff[file->buff_ind], done);
1459 file->buff_ind += done;
1462 if (buffersize == 0)
1466 // NOTE: at this point, the read buffer is always empty
1468 // If the file isn't compressed
1469 if (! (file->flags & QFILE_FLAG_DEFLATED))
1473 // We must take care to not read after the end of the file
1474 count = file->real_length - file->position;
1476 // If we have a lot of data to get, put them directly into "buffer"
1477 if (buffersize > sizeof (file->buff) / 2)
1479 if (count > buffersize)
1481 lseek (file->handle, file->offset + file->position, SEEK_SET);
1482 nb = read (file->handle, &((qbyte*)buffer)[done], count);
1486 file->position += nb;
1488 // Purge cached data
1494 if (count > sizeof (file->buff))
1495 count = sizeof (file->buff);
1496 lseek (file->handle, file->offset + file->position, SEEK_SET);
1497 nb = read (file->handle, file->buff, count);
1500 file->buff_len = nb;
1501 file->position += nb;
1503 // Copy the requested data in "buffer" (as much as we can)
1504 count = (buffersize > file->buff_len) ? file->buff_len : buffersize;
1505 memcpy (&((qbyte*)buffer)[done], file->buff, count);
1506 file->buff_ind = count;
1514 // If the file is compressed, it's more complicated...
1515 // We cycle through a few operations until we have read enough data
1516 while (buffersize > 0)
1518 ztoolkit_t *ztk = file->ztk;
1521 // NOTE: at this point, the read buffer is always empty
1523 // If "input" is also empty, we need to refill it
1524 if (ztk->in_ind == ztk->in_len)
1526 // If we are at the end of the file
1527 if (file->position == file->real_length)
1530 count = ztk->comp_length - ztk->in_position;
1531 if (count > sizeof (ztk->input))
1532 count = sizeof (ztk->input);
1533 lseek (file->handle, file->offset + ztk->in_position, SEEK_SET);
1534 if (read (file->handle, ztk->input, count) != (ssize_t)count)
1535 Sys_Error ("FS_Read: unexpected end of file");
1538 ztk->in_len = count;
1539 ztk->in_position += count;
1542 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
1543 ztk->zstream.avail_in = ztk->in_len - ztk->in_ind;
1545 // Now that we are sure we have compressed data available, we need to determine
1546 // if it's better to inflate it in "file->buff" or directly in "buffer"
1548 // Inflate the data in "file->buff"
1549 if (buffersize < sizeof (file->buff) / 2)
1551 ztk->zstream.next_out = file->buff;
1552 ztk->zstream.avail_out = sizeof (file->buff);
1553 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1554 if (error != Z_OK && error != Z_STREAM_END)
1555 Sys_Error ("Can't inflate file");
1556 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
1558 file->buff_len = sizeof (file->buff) - ztk->zstream.avail_out;
1559 file->position += file->buff_len;
1561 // Copy the requested data in "buffer" (as much as we can)
1562 count = (buffersize > file->buff_len) ? file->buff_len : buffersize;
1563 memcpy (&((qbyte*)buffer)[done], file->buff, count);
1564 file->buff_ind = count;
1567 // Else, we inflate directly in "buffer"
1570 ztk->zstream.next_out = &((qbyte*)buffer)[done];
1571 ztk->zstream.avail_out = buffersize;
1572 error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1573 if (error != Z_OK && error != Z_STREAM_END)
1574 Sys_Error ("Can't inflate file");
1575 ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
1577 // How much data did it inflate?
1578 count = buffersize - ztk->zstream.avail_out;
1579 file->position += count;
1581 // Purge cached data
1586 buffersize -= count;
1594 ====================
1597 Print a string into a file
1598 ====================
1600 int FS_Print (qfile_t* file, const char *msg)
1602 return FS_Write (file, msg, strlen (msg));
1606 ====================
1609 Print a string into a file
1610 ====================
1612 int FS_Printf(qfile_t* file, const char* format, ...)
1617 va_start (args, format);
1618 result = FS_VPrintf (file, format, args);
1626 ====================
1629 Print a string into a file
1630 ====================
1632 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
1636 char *tempbuff = NULL;
1639 tempbuff = Mem_Alloc (tempmempool, buff_size);
1640 len = dpvsnprintf (tempbuff, buff_size, format, ap);
1643 Mem_Free (tempbuff);
1645 tempbuff = Mem_Alloc (tempmempool, buff_size);
1646 len = dpvsnprintf (tempbuff, buff_size, format, ap);
1649 len = write (file->handle, tempbuff, len);
1650 Mem_Free (tempbuff);
1657 ====================
1660 Get the next character of a file
1661 ====================
1663 int FS_Getc (qfile_t* file)
1667 if (FS_Read (file, &c, 1) != 1)
1675 ====================
1678 Put a character back into the read buffer (only supports one character!)
1679 ====================
1681 int FS_UnGetc (qfile_t* file, unsigned char c)
1683 // If there's already a character waiting to be read
1684 if (file->ungetc != EOF)
1693 ====================
1696 Move the position index in a file
1697 ====================
1699 int FS_Seek (qfile_t* file, long offset, int whence)
1705 // Compute the file offset
1709 offset += file->position - file->buff_len + file->buff_ind;
1716 offset += file->real_length;
1722 if (offset < 0 || offset > (long) file->real_length)
1725 // If we have the data in our read buffer, we don't need to actually seek
1726 if (file->position - file->buff_len <= (size_t)offset &&
1727 (size_t)offset <= file->position)
1729 file->buff_ind = offset + file->buff_len - file->position;
1733 // Purge cached data
1736 // Unpacked or uncompressed files can seek directly
1737 if (! (file->flags & QFILE_FLAG_DEFLATED))
1739 if (lseek (file->handle, file->offset + offset, SEEK_SET) == -1)
1741 file->position = offset;
1745 // Seeking in compressed files is more a hack than anything else,
1746 // but we need to support it, so here we go.
1749 // If we have to go back in the file, we need to restart from the beginning
1750 if ((size_t)offset <= file->position)
1754 ztk->in_position = 0;
1756 lseek (file->handle, file->offset, SEEK_SET);
1758 // Reset the Zlib stream
1759 ztk->zstream.next_in = ztk->input;
1760 ztk->zstream.avail_in = 0;
1761 qz_inflateReset (&ztk->zstream);
1764 // We need a big buffer to force inflating into it directly
1765 buffersize = 2 * sizeof (file->buff);
1766 buffer = Mem_Alloc (tempmempool, buffersize);
1768 // Skip all data until we reach the requested offset
1769 while ((size_t)offset > file->position)
1771 size_t diff = offset - file->position;
1774 count = (diff > buffersize) ? buffersize : diff;
1775 len = FS_Read (file, buffer, count);
1789 ====================
1792 Give the current position in a file
1793 ====================
1795 long FS_Tell (qfile_t* file)
1797 return file->position - file->buff_len + file->buff_ind;
1802 ====================
1805 Erases any buffered input or output data
1806 ====================
1808 void FS_Purge (qfile_t* file)
1820 Filename are relative to the quake directory.
1821 Always appends a 0 byte.
1824 qbyte *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet)
1829 file = FS_Open (path, "rb", quiet, false);
1833 buf = Mem_Alloc (pool, fs_filesize + 1);
1834 buf[fs_filesize] = '\0';
1836 FS_Read (file, buf, fs_filesize);
1847 The filename will be prefixed by the current game directory
1850 qboolean FS_WriteFile (const char *filename, void *data, int len)
1854 file = FS_Open (filename, "wb", false, false);
1857 Con_Printf("FS_WriteFile: failed on %s\n", filename);
1861 Con_DPrintf("FS_WriteFile: %s\n", filename);
1862 FS_Write (file, data, len);
1869 =============================================================================
1871 OTHERS PUBLIC FUNCTIONS
1873 =============================================================================
1881 void FS_StripExtension (const char *in, char *out, size_t size_out)
1888 while (*in && size_out > 1)
1892 else if (*in == '/' || *in == '\\' || *in == ':')
1909 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
1913 // if path doesn't have a .EXT, append extension
1914 // (extension should include the .)
1915 src = path + strlen(path) - 1;
1917 while (*src != '/' && src != path)
1920 return; // it has an extension
1924 strlcat (path, extension, size_path);
1932 Look for a file in the packages and in the filesystem
1935 qboolean FS_FileExists (const char *filename)
1937 return (FS_FindFile (filename, NULL, true) != NULL);
1945 Look for a file in the filesystem only
1948 qboolean FS_SysFileExists (const char *path)
1953 // TODO: use another function instead, to avoid opening the file
1954 desc = open (path, O_RDONLY | O_BINARY);
1963 if (stat (path,&buf) == -1)
1970 void FS_mkdir (const char *path)
1983 Allocate and fill a search structure with information on matching filenames.
1986 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
1989 searchpath_t *searchpath;
1991 int i, basepathlength, numfiles, numchars;
1992 stringlist_t *dir, *dirfile, *liststart, *listcurrent, *listtemp;
1993 const char *slash, *backslash, *colon, *separator;
1995 char netpath[MAX_OSPATH];
1996 char temp[MAX_OSPATH];
1998 while(!strncmp(pattern, "./", 2))
2000 while(!strncmp(pattern, ".\\", 2))
2007 slash = strrchr(pattern, '/');
2008 backslash = strrchr(pattern, '\\');
2009 colon = strrchr(pattern, ':');
2010 separator = pattern;
2011 if (separator < slash)
2013 if (separator < backslash)
2014 separator = backslash;
2015 if (separator < colon)
2017 basepathlength = separator - pattern;
2018 basepath = Mem_Alloc (tempmempool, basepathlength + 1);
2020 memcpy(basepath, pattern, basepathlength);
2021 basepath[basepathlength] = 0;
2023 // search through the path, one element at a time
2024 for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
2026 // is the element a pak file?
2027 if (searchpath->pack)
2029 // look through all the pak file elements
2030 pak = searchpath->pack;
2031 for (i = 0;i < pak->numfiles;i++)
2033 strcpy(temp, pak->files[i].name);
2036 if (matchpattern(temp, (char *)pattern, true))
2038 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2039 if (!strcmp(listtemp->text, temp))
2041 if (listtemp == NULL)
2043 listcurrent = stringlistappend(listcurrent, temp);
2044 if (liststart == NULL)
2045 liststart = listcurrent;
2047 Con_DPrintf("SearchPackFile: %s : %s\n", pak->filename, temp);
2050 // strip off one path element at a time until empty
2051 // this way directories are added to the listing if they match the pattern
2052 slash = strrchr(temp, '/');
2053 backslash = strrchr(temp, '\\');
2054 colon = strrchr(temp, ':');
2056 if (separator < slash)
2058 if (separator < backslash)
2059 separator = backslash;
2060 if (separator < colon)
2062 *((char *)separator) = 0;
2068 // get a directory listing and look at each name
2069 dpsnprintf(netpath, sizeof (netpath), "%s/%s", searchpath->filename, basepath);
2070 if ((dir = listdirectory(netpath)))
2072 for (dirfile = dir;dirfile;dirfile = dirfile->next)
2074 dpsnprintf(temp, sizeof(temp), "%s/%s", basepath, dirfile->text);
2075 if (matchpattern(temp, (char *)pattern, true))
2077 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2078 if (!strcmp(listtemp->text, temp))
2080 if (listtemp == NULL)
2082 listcurrent = stringlistappend(listcurrent, temp);
2083 if (liststart == NULL)
2084 liststart = listcurrent;
2086 Con_DPrintf("SearchDirFile: %s\n", temp);
2097 liststart = stringlistsort(liststart);
2100 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2103 numchars += strlen(listtemp->text) + 1;
2105 search = Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
2106 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
2107 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
2108 search->numfilenames = numfiles;
2111 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
2113 search->filenames[numfiles] = search->filenamesbuffer + numchars;
2114 strcpy(search->filenames[numfiles], listtemp->text);
2116 numchars += strlen(listtemp->text) + 1;
2119 stringlistfree(liststart);
2126 void FS_FreeSearch(fssearch_t *search)
2131 extern int con_linewidth;
2132 int FS_ListDirectory(const char *pattern, int oneperline)
2143 search = FS_Search(pattern, true, true);
2146 numfiles = search->numfilenames;
2149 // FIXME: the names could be added to one column list and then
2150 // gradually shifted into the next column if they fit, and then the
2151 // next to make a compact variable width listing but it's a lot more
2153 // find width for columns
2155 for (i = 0;i < numfiles;i++)
2157 l = strlen(search->filenames[i]);
2158 if (columnwidth < l)
2161 // count the spacing character
2163 // calculate number of columns
2164 numcolumns = con_linewidth / columnwidth;
2165 // don't bother with the column printing if it's only one column
2166 if (numcolumns >= 2)
2168 numlines = (numfiles + numcolumns - 1) / numcolumns;
2169 for (i = 0;i < numlines;i++)
2172 for (k = 0;k < numcolumns;k++)
2174 l = i * numcolumns + k;
2177 name = search->filenames[l];
2178 for (j = 0;name[j] && j < (int)sizeof(linebuf) - 1;j++)
2179 linebuf[linebufpos++] = name[j];
2180 // space out name unless it's the last on the line
2181 if (k < (numcolumns - 1) && l < (numfiles - 1))
2182 for (;j < columnwidth && j < (int)sizeof(linebuf) - 1;j++)
2183 linebuf[linebufpos++] = ' ';
2186 linebuf[linebufpos] = 0;
2187 Con_Printf("%s\n", linebuf);
2194 for (i = 0;i < numfiles;i++)
2195 Con_Printf("%s\n", search->filenames[i]);
2196 FS_FreeSearch(search);
2200 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
2202 const char *pattern;
2205 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
2208 if (Cmd_Argc() == 2)
2209 pattern = Cmd_Argv(1);
2212 if (!FS_ListDirectory(pattern, oneperline))
2213 Con_Print("No files found.\n");
2218 FS_ListDirectoryCmd("dir", true);
2223 FS_ListDirectoryCmd("ls", false);