]> git.xonotic.org Git - xonotic/darkplaces.git/blob - fs.c
image: Sanitize paths on *all* images rather than images loaded from Q3 shaders
[xonotic/darkplaces.git] / fs.c
1 /*
2         DarkPlaces file system
3
4         Copyright (C) 2003-2006 Mathieu Olivier
5
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.
10
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.
14
15         See the GNU General Public License for more details.
16
17         You should have received a copy of the GNU General Public License
18         along with this program; if not, write to:
19
20                 Free Software Foundation, Inc.
21                 59 Temple Place - Suite 330
22                 Boston, MA  02111-1307, USA
23 */
24
25 #include <limits.h>
26 #include <fcntl.h>
27
28 #ifdef WIN32
29 # include <direct.h>
30 # include <io.h>
31 # include <shlobj.h>
32 # include <sys/stat.h>
33 # include <share.h>
34 #else
35 # include <pwd.h>
36 # include <sys/stat.h>
37 # include <unistd.h>
38 #endif
39
40 #include "quakedef.h"
41
42 #if TARGET_OS_IPHONE
43 // include SDL for IPHONEOS code
44 # include <SDL.h>
45 #endif
46
47 #include "thread.h"
48
49 #include "fs.h"
50 #include "wad.h"
51
52 // Win32 requires us to add O_BINARY, but the other OSes don't have it
53 #ifndef O_BINARY
54 # define O_BINARY 0
55 #endif
56
57 // In case the system doesn't support the O_NONBLOCK flag
58 #ifndef O_NONBLOCK
59 # define O_NONBLOCK 0
60 #endif
61
62 // largefile support for Win32
63 #ifdef WIN32
64 #undef lseek
65 # define lseek _lseeki64
66 #endif
67
68 // suppress deprecated warnings
69 #if _MSC_VER >= 1400
70 # define read _read
71 # define write _write
72 # define close _close
73 # define unlink _unlink
74 # define dup _dup
75 #endif
76
77 #if USE_RWOPS
78 # include <SDL.h>
79 typedef SDL_RWops *filedesc_t;
80 # define FILEDESC_INVALID NULL
81 # define FILEDESC_ISVALID(fd) ((fd) != NULL)
82 # define FILEDESC_READ(fd,buf,count) ((fs_offset_t)SDL_RWread(fd, buf, 1, count))
83 # define FILEDESC_WRITE(fd,buf,count) ((fs_offset_t)SDL_RWwrite(fd, buf, 1, count))
84 # define FILEDESC_CLOSE SDL_RWclose
85 # define FILEDESC_SEEK SDL_RWseek
86 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
87         filedesc_t new_fd = SDL_RWFromFile(filename, "rb");
88         if (SDL_RWseek(new_fd, SDL_RWseek(fd, 0, RW_SEEK_CUR), RW_SEEK_SET) < 0) {
89                 SDL_RWclose(new_fd);
90                 return NULL;
91         }
92         return new_fd;
93 }
94 # define unlink(name) Con_DPrintf("Sorry, no unlink support when trying to unlink %s.\n", (name))
95 #else
96 typedef int filedesc_t;
97 # define FILEDESC_INVALID -1
98 # define FILEDESC_ISVALID(fd) ((fd) != -1)
99 # define FILEDESC_READ read
100 # define FILEDESC_WRITE write
101 # define FILEDESC_CLOSE close
102 # define FILEDESC_SEEK lseek
103 static filedesc_t FILEDESC_DUP(const char *filename, filedesc_t fd) {
104         return dup(fd);
105 }
106 #endif
107
108 /** \page fs File System
109
110 All of Quake's data access is through a hierchal file system, but the contents
111 of the file system can be transparently merged from several sources.
112
113 The "base directory" is the path to the directory holding the quake.exe and
114 all game directories.  The sys_* files pass this to host_init in
115 quakeparms_t->basedir.  This can be overridden with the "-basedir" command
116 line parm to allow code debugging in a different directory.  The base
117 directory is only used during filesystem initialization.
118
119 The "game directory" is the first tree on the search path and directory that
120 all generated files (savegames, screenshots, demos, config files) will be
121 saved to.  This can be overridden with the "-game" command line parameter.
122 The game directory can never be changed while quake is executing.  This is a
123 precaution against having a malicious server instruct clients to write files
124 over areas they shouldn't.
125
126 */
127
128
129 /*
130 =============================================================================
131
132 CONSTANTS
133
134 =============================================================================
135 */
136
137 // Magic numbers of a ZIP file (big-endian format)
138 #define ZIP_DATA_HEADER 0x504B0304  // "PK\3\4"
139 #define ZIP_CDIR_HEADER 0x504B0102  // "PK\1\2"
140 #define ZIP_END_HEADER  0x504B0506  // "PK\5\6"
141
142 // Other constants for ZIP files
143 #define ZIP_MAX_COMMENTS_SIZE           ((unsigned short)0xFFFF)
144 #define ZIP_END_CDIR_SIZE                       22
145 #define ZIP_CDIR_CHUNK_BASE_SIZE        46
146 #define ZIP_LOCAL_CHUNK_BASE_SIZE       30
147
148 #ifdef LINK_TO_ZLIB
149 #include <zlib.h>
150
151 #define qz_inflate inflate
152 #define qz_inflateEnd inflateEnd
153 #define qz_inflateInit2_ inflateInit2_
154 #define qz_inflateReset inflateReset
155 #define qz_deflateInit2_ deflateInit2_
156 #define qz_deflateEnd deflateEnd
157 #define qz_deflate deflate
158 #define Z_MEMLEVEL_DEFAULT 8
159 #else
160
161 // Zlib constants (from zlib.h)
162 #define Z_SYNC_FLUSH    2
163 #define MAX_WBITS               15
164 #define Z_OK                    0
165 #define Z_STREAM_END    1
166 #define Z_STREAM_ERROR  (-2)
167 #define Z_DATA_ERROR    (-3)
168 #define Z_MEM_ERROR     (-4)
169 #define Z_BUF_ERROR     (-5)
170 #define ZLIB_VERSION    "1.2.3"
171
172 #define Z_BINARY 0
173 #define Z_DEFLATED 8
174 #define Z_MEMLEVEL_DEFAULT 8
175
176 #define Z_NULL 0
177 #define Z_DEFAULT_COMPRESSION (-1)
178 #define Z_NO_FLUSH 0
179 #define Z_SYNC_FLUSH 2
180 #define Z_FULL_FLUSH 3
181 #define Z_FINISH 4
182
183 // Uncomment the following line if the zlib DLL you have still uses
184 // the 1.1.x series calling convention on Win32 (WINAPI)
185 //#define ZLIB_USES_WINAPI
186
187
188 /*
189 =============================================================================
190
191 TYPES
192
193 =============================================================================
194 */
195
196 /*! Zlib stream (from zlib.h)
197  * \warning: some pointers we don't use directly have
198  * been cast to "void*" for a matter of simplicity
199  */
200 typedef struct
201 {
202         unsigned char                   *next_in;       ///< next input byte
203         unsigned int    avail_in;       ///< number of bytes available at next_in
204         unsigned long   total_in;       ///< total nb of input bytes read so far
205
206         unsigned char                   *next_out;      ///< next output byte should be put there
207         unsigned int    avail_out;      ///< remaining free space at next_out
208         unsigned long   total_out;      ///< total nb of bytes output so far
209
210         char                    *msg;           ///< last error message, NULL if no error
211         void                    *state;         ///< not visible by applications
212
213         void                    *zalloc;        ///< used to allocate the internal state
214         void                    *zfree;         ///< used to free the internal state
215         void                    *opaque;        ///< private data object passed to zalloc and zfree
216
217         int                             data_type;      ///< best guess about the data type: ascii or binary
218         unsigned long   adler;          ///< adler32 value of the uncompressed data
219         unsigned long   reserved;       ///< reserved for future use
220 } z_stream;
221 #endif
222
223
224 /// inside a package (PAK or PK3)
225 #define QFILE_FLAG_PACKED (1 << 0)
226 /// file is compressed using the deflate algorithm (PK3 only)
227 #define QFILE_FLAG_DEFLATED (1 << 1)
228 /// file is actually already loaded data
229 #define QFILE_FLAG_DATA (1 << 2)
230 /// real file will be removed on close
231 #define QFILE_FLAG_REMOVE (1 << 3)
232
233 #define FILE_BUFF_SIZE 2048
234 typedef struct
235 {
236         z_stream        zstream;
237         size_t          comp_length;                    ///< length of the compressed file
238         size_t          in_ind, in_len;                 ///< input buffer current index and length
239         size_t          in_position;                    ///< position in the compressed file
240         unsigned char           input [FILE_BUFF_SIZE];
241 } ztoolkit_t;
242
243 struct qfile_s
244 {
245         int                             flags;
246         filedesc_t                      handle;                                 ///< file descriptor
247         fs_offset_t             real_length;                    ///< uncompressed file size (for files opened in "read" mode)
248         fs_offset_t             position;                               ///< current position in the file
249         fs_offset_t             offset;                                 ///< offset into the package (0 if external file)
250         int                             ungetc;                                 ///< single stored character from ungetc, cleared to EOF when read
251
252         // Contents buffer
253         fs_offset_t             buff_ind, buff_len;             ///< buffer current index and length
254         unsigned char                   buff [FILE_BUFF_SIZE];
255
256         ztoolkit_t*             ztk;    ///< For zipped files.
257
258         const unsigned char *data;      ///< For data files.
259
260         const char *filename; ///< Kept around for QFILE_FLAG_REMOVE, unused otherwise
261 };
262
263
264 // ------ PK3 files on disk ------ //
265
266 // You can get the complete ZIP format description from PKWARE website
267
268 typedef struct pk3_endOfCentralDir_s
269 {
270         unsigned int signature;
271         unsigned short disknum;
272         unsigned short cdir_disknum;    ///< number of the disk with the start of the central directory
273         unsigned short localentries;    ///< number of entries in the central directory on this disk
274         unsigned short nbentries;               ///< total number of entries in the central directory on this disk
275         unsigned int cdir_size;                 ///< size of the central directory
276         unsigned int cdir_offset;               ///< with respect to the starting disk number
277         unsigned short comment_size;
278         fs_offset_t prepended_garbage;
279 } pk3_endOfCentralDir_t;
280
281
282 // ------ PAK files on disk ------ //
283 typedef struct dpackfile_s
284 {
285         char name[56];
286         int filepos, filelen;
287 } dpackfile_t;
288
289 typedef struct dpackheader_s
290 {
291         char id[4];
292         int dirofs;
293         int dirlen;
294 } dpackheader_t;
295
296
297 /*! \name Packages in memory
298  * @{
299  */
300 /// the offset in packfile_t is the true contents offset
301 #define PACKFILE_FLAG_TRUEOFFS (1 << 0)
302 /// file compressed using the deflate algorithm
303 #define PACKFILE_FLAG_DEFLATED (1 << 1)
304 /// file is a symbolic link
305 #define PACKFILE_FLAG_SYMLINK (1 << 2)
306
307 typedef struct packfile_s
308 {
309         char name [MAX_QPATH];
310         int flags;
311         fs_offset_t offset;
312         fs_offset_t packsize;   ///< size in the package
313         fs_offset_t realsize;   ///< real file size (uncompressed)
314 } packfile_t;
315
316 typedef struct pack_s
317 {
318         char filename [MAX_OSPATH];
319         char shortname [MAX_QPATH];
320         filedesc_t handle;
321         int ignorecase;  ///< PK3 ignores case
322         int numfiles;
323         qbool vpack;
324         packfile_t *files;
325 } pack_t;
326 //@}
327
328 /// Search paths for files (including packages)
329 typedef struct searchpath_s
330 {
331         // only one of filename / pack will be used
332         char filename[MAX_OSPATH];
333         pack_t *pack;
334         struct searchpath_s *next;
335 } searchpath_t;
336
337
338 /*
339 =============================================================================
340
341 FUNCTION PROTOTYPES
342
343 =============================================================================
344 */
345
346 void FS_Dir_f(cmd_state_t *cmd);
347 void FS_Ls_f(cmd_state_t *cmd);
348 void FS_Which_f(cmd_state_t *cmd);
349
350 static searchpath_t *FS_FindFile (const char *name, int* index, qbool quiet);
351 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
352                                                                         fs_offset_t offset, fs_offset_t packsize,
353                                                                         fs_offset_t realsize, int flags);
354
355
356 /*
357 =============================================================================
358
359 VARIABLES
360
361 =============================================================================
362 */
363
364 mempool_t *fs_mempool;
365 void *fs_mutex = NULL;
366
367 searchpath_t *fs_searchpaths = NULL;
368 const char *const fs_checkgamedir_missing = "missing";
369
370 #define MAX_FILES_IN_PACK       65536
371
372 char fs_userdir[MAX_OSPATH];
373 char fs_gamedir[MAX_OSPATH];
374 char fs_basedir[MAX_OSPATH];
375 static pack_t *fs_selfpack = NULL;
376
377 // list of active game directories (empty if not running a mod)
378 int fs_numgamedirs = 0;
379 char fs_gamedirs[MAX_GAMEDIRS][MAX_QPATH];
380
381 // list of all gamedirs with modinfo.txt
382 gamedir_t *fs_all_gamedirs = NULL;
383 int fs_all_gamedirs_count = 0;
384
385 cvar_t scr_screenshot_name = {CF_CLIENT | CF_PERSISTENT, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
386 cvar_t fs_empty_files_in_pack_mark_deletions = {CF_CLIENT | CF_SERVER, "fs_empty_files_in_pack_mark_deletions", "0", "if enabled, empty files in a pak/pk3 count as not existing but cancel the search in further packs, effectively allowing patch pak/pk3 files to 'delete' files"};
387 cvar_t cvar_fs_gamedir = {CF_CLIENT | CF_SERVER | CF_READONLY | CF_PERSISTENT, "fs_gamedir", "", "the list of currently selected gamedirs (use the 'gamedir' command to change this)"};
388
389
390 /*
391 =============================================================================
392
393 PRIVATE FUNCTIONS - PK3 HANDLING
394
395 =============================================================================
396 */
397
398 #ifndef LINK_TO_ZLIB
399 // Functions exported from zlib
400 #if defined(WIN32) && defined(ZLIB_USES_WINAPI)
401 # define ZEXPORT WINAPI
402 #else
403 # define ZEXPORT
404 #endif
405
406 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
407 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
408 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
409 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
410 static int (ZEXPORT *qz_deflateInit2_) (z_stream* strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size);
411 static int (ZEXPORT *qz_deflateEnd) (z_stream* strm);
412 static int (ZEXPORT *qz_deflate) (z_stream* strm, int flush);
413 #endif
414
415 #define qz_inflateInit2(strm, windowBits) \
416         qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
417 #define qz_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
418         qz_deflateInit2_((strm), (level), (method), (windowBits), (memLevel), (strategy), ZLIB_VERSION, sizeof(z_stream))
419
420 #ifndef LINK_TO_ZLIB
421 //        qz_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
422
423 static dllfunction_t zlibfuncs[] =
424 {
425         {"inflate",                     (void **) &qz_inflate},
426         {"inflateEnd",          (void **) &qz_inflateEnd},
427         {"inflateInit2_",       (void **) &qz_inflateInit2_},
428         {"inflateReset",        (void **) &qz_inflateReset},
429         {"deflateInit2_",   (void **) &qz_deflateInit2_},
430         {"deflateEnd",      (void **) &qz_deflateEnd},
431         {"deflate",         (void **) &qz_deflate},
432         {NULL, NULL}
433 };
434
435 /// Handle for Zlib DLL
436 static dllhandle_t zlib_dll = NULL;
437 #endif
438
439 #ifdef WIN32
440 static HRESULT (WINAPI *qSHGetFolderPath) (HWND hwndOwner, int nFolder, HANDLE hToken, DWORD dwFlags, LPTSTR pszPath);
441 static dllfunction_t shfolderfuncs[] =
442 {
443         {"SHGetFolderPathA", (void **) &qSHGetFolderPath},
444         {NULL, NULL}
445 };
446 static const char* shfolderdllnames [] =
447 {
448         "shfolder.dll",  // IE 4, or Win NT and higher
449         NULL
450 };
451 static dllhandle_t shfolder_dll = NULL;
452
453 const GUID qFOLDERID_SavedGames = {0x4C5C32FF, 0xBB9D, 0x43b0, {0xB5, 0xB4, 0x2D, 0x72, 0xE5, 0x4E, 0xAA, 0xA4}}; 
454 #define qREFKNOWNFOLDERID const GUID *
455 #define qKF_FLAG_CREATE 0x8000
456 #define qKF_FLAG_NO_ALIAS 0x1000
457 static HRESULT (WINAPI *qSHGetKnownFolderPath) (qREFKNOWNFOLDERID rfid, DWORD dwFlags, HANDLE hToken, PWSTR *ppszPath);
458 static dllfunction_t shell32funcs[] =
459 {
460         {"SHGetKnownFolderPath", (void **) &qSHGetKnownFolderPath},
461         {NULL, NULL}
462 };
463 static const char* shell32dllnames [] =
464 {
465         "shell32.dll",  // Vista and higher
466         NULL
467 };
468 static dllhandle_t shell32_dll = NULL;
469
470 static HRESULT (WINAPI *qCoInitializeEx)(LPVOID pvReserved, DWORD dwCoInit);
471 static void (WINAPI *qCoUninitialize)(void);
472 static void (WINAPI *qCoTaskMemFree)(LPVOID pv);
473 static dllfunction_t ole32funcs[] =
474 {
475         {"CoInitializeEx", (void **) &qCoInitializeEx},
476         {"CoUninitialize", (void **) &qCoUninitialize},
477         {"CoTaskMemFree", (void **) &qCoTaskMemFree},
478         {NULL, NULL}
479 };
480 static const char* ole32dllnames [] =
481 {
482         "ole32.dll", // 2000 and higher
483         NULL
484 };
485 static dllhandle_t ole32_dll = NULL;
486 #endif
487
488 /*
489 ====================
490 PK3_CloseLibrary
491
492 Unload the Zlib DLL
493 ====================
494 */
495 static void PK3_CloseLibrary (void)
496 {
497 #ifndef LINK_TO_ZLIB
498         Sys_FreeLibrary (&zlib_dll);
499 #endif
500 }
501
502
503 /*
504 ====================
505 PK3_OpenLibrary
506
507 Try to load the Zlib DLL
508 ====================
509 */
510 static qbool PK3_OpenLibrary (void)
511 {
512 #ifdef LINK_TO_ZLIB
513         return true;
514 #else
515         const char* dllnames [] =
516         {
517 #if defined(WIN32)
518 # ifdef ZLIB_USES_WINAPI
519                 "zlibwapi.dll",
520                 "zlib.dll",
521 # else
522                 "zlib1.dll",
523 # endif
524 #elif defined(MACOSX)
525                 "libz.dylib",
526 #else
527                 "libz.so.1",
528                 "libz.so",
529 #endif
530                 NULL
531         };
532
533         // Already loaded?
534         if (zlib_dll)
535                 return true;
536
537         // Load the DLL
538         return Sys_LoadDependency (dllnames, &zlib_dll, zlibfuncs);
539 #endif
540 }
541
542 /*
543 ====================
544 FS_HasZlib
545
546 See if zlib is available
547 ====================
548 */
549 qbool FS_HasZlib(void)
550 {
551 #ifdef LINK_TO_ZLIB
552         return true;
553 #else
554         PK3_OpenLibrary(); // to be safe
555         return (zlib_dll != 0);
556 #endif
557 }
558
559 /*
560 ====================
561 PK3_GetEndOfCentralDir
562
563 Extract the end of the central directory from a PK3 package
564 ====================
565 */
566 static qbool PK3_GetEndOfCentralDir (const char *packfile, filedesc_t packhandle, pk3_endOfCentralDir_t *eocd)
567 {
568         fs_offset_t filesize, maxsize;
569         unsigned char *buffer, *ptr;
570         int ind;
571
572         // Get the package size
573         filesize = FILEDESC_SEEK (packhandle, 0, SEEK_END);
574         if (filesize < ZIP_END_CDIR_SIZE)
575                 return false;
576
577         // Load the end of the file in memory
578         if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
579                 maxsize = filesize;
580         else
581                 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
582         buffer = (unsigned char *)Mem_Alloc (tempmempool, maxsize);
583         FILEDESC_SEEK (packhandle, filesize - maxsize, SEEK_SET);
584         if (FILEDESC_READ (packhandle, buffer, maxsize) != (fs_offset_t) maxsize)
585         {
586                 Mem_Free (buffer);
587                 return false;
588         }
589
590         // Look for the end of central dir signature around the end of the file
591         maxsize -= ZIP_END_CDIR_SIZE;
592         ptr = &buffer[maxsize];
593         ind = 0;
594         while (BuffBigLong (ptr) != ZIP_END_HEADER)
595         {
596                 if (ind == maxsize)
597                 {
598                         Mem_Free (buffer);
599                         return false;
600                 }
601
602                 ind++;
603                 ptr--;
604         }
605
606         memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
607         eocd->signature = LittleLong (eocd->signature);
608         eocd->disknum = LittleShort (eocd->disknum);
609         eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
610         eocd->localentries = LittleShort (eocd->localentries);
611         eocd->nbentries = LittleShort (eocd->nbentries);
612         eocd->cdir_size = LittleLong (eocd->cdir_size);
613         eocd->cdir_offset = LittleLong (eocd->cdir_offset);
614         eocd->comment_size = LittleShort (eocd->comment_size);
615         eocd->prepended_garbage = filesize - (ind + ZIP_END_CDIR_SIZE) - eocd->cdir_offset - eocd->cdir_size; // this detects "SFX" zip files
616         eocd->cdir_offset += eocd->prepended_garbage;
617
618         Mem_Free (buffer);
619
620         if (
621                         eocd->cdir_size > filesize ||
622                         eocd->cdir_offset >= filesize ||
623                         eocd->cdir_offset + eocd->cdir_size > filesize
624            )
625         {
626                 // Obviously invalid central directory.
627                 return false;
628         }
629
630         return true;
631 }
632
633
634 /*
635 ====================
636 PK3_BuildFileList
637
638 Extract the file list from a PK3 file
639 ====================
640 */
641 static int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
642 {
643         unsigned char *central_dir, *ptr;
644         unsigned int ind;
645         fs_offset_t remaining;
646
647         // Load the central directory in memory
648         central_dir = (unsigned char *)Mem_Alloc (tempmempool, eocd->cdir_size);
649         if (FILEDESC_SEEK (pack->handle, eocd->cdir_offset, SEEK_SET) == -1)
650         {
651                 Mem_Free (central_dir);
652                 return -1;
653         }
654         if(FILEDESC_READ (pack->handle, central_dir, eocd->cdir_size) != (fs_offset_t) eocd->cdir_size)
655         {
656                 Mem_Free (central_dir);
657                 return -1;
658         }
659
660         // Extract the files properties
661         // The parsing is done "by hand" because some fields have variable sizes and
662         // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
663         remaining = eocd->cdir_size;
664         pack->numfiles = 0;
665         ptr = central_dir;
666         for (ind = 0; ind < eocd->nbentries; ind++)
667         {
668                 fs_offset_t namesize, count;
669
670                 // Checking the remaining size
671                 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
672                 {
673                         Mem_Free (central_dir);
674                         return -1;
675                 }
676                 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
677
678                 // Check header
679                 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
680                 {
681                         Mem_Free (central_dir);
682                         return -1;
683                 }
684
685                 namesize = BuffLittleShort (&ptr[28]);  // filename length
686
687                 // Check encryption, compression, and attributes
688                 // 1st uint8  : general purpose bit flag
689                 //    Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
690                 //
691                 // LadyHavoc: bit 3 would be a problem if we were scanning the archive
692                 // but is not a problem in the central directory where the values are
693                 // always real.
694                 //
695                 // bit 3 seems to always be set by the standard Mac OSX zip maker
696                 //
697                 // 2nd uint8 : external file attributes
698                 //    Check bits 3 (file is a directory) and 5 (file is a volume (?))
699                 if ((ptr[8] & 0x21) == 0 && (ptr[38] & 0x18) == 0)
700                 {
701                         // Still enough bytes for the name?
702                         if (namesize < 0 || remaining < namesize || namesize >= (int)sizeof (*pack->files))
703                         {
704                                 Mem_Free (central_dir);
705                                 return -1;
706                         }
707
708                         // WinZip doesn't use the "directory" attribute, so we need to check the name directly
709                         if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
710                         {
711                                 char filename [sizeof (pack->files[0].name)];
712                                 fs_offset_t offset, packsize, realsize;
713                                 int flags;
714
715                                 // Extract the name (strip it if necessary)
716                                 namesize = min(namesize, (int)sizeof (filename) - 1);
717                                 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
718                                 filename[namesize] = '\0';
719
720                                 if (BuffLittleShort (&ptr[10]))
721                                         flags = PACKFILE_FLAG_DEFLATED;
722                                 else
723                                         flags = 0;
724                                 offset = (unsigned int)(BuffLittleLong (&ptr[42]) + eocd->prepended_garbage);
725                                 packsize = (unsigned int)BuffLittleLong (&ptr[20]);
726                                 realsize = (unsigned int)BuffLittleLong (&ptr[24]);
727
728                                 switch(ptr[5]) // C_VERSION_MADE_BY_1
729                                 {
730                                         case 3: // UNIX_
731                                         case 2: // VMS_
732                                         case 16: // BEOS_
733                                                 if((BuffLittleShort(&ptr[40]) & 0120000) == 0120000)
734                                                         // can't use S_ISLNK here, as this has to compile on non-UNIX too
735                                                         flags |= PACKFILE_FLAG_SYMLINK;
736                                                 break;
737                                 }
738
739                                 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
740                         }
741                 }
742
743                 // Skip the name, additionnal field, and comment
744                 // 1er uint16 : extra field length
745                 // 2eme uint16 : file comment length
746                 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
747                 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
748                 remaining -= count;
749         }
750
751         // If the package is empty, central_dir is NULL here
752         if (central_dir != NULL)
753                 Mem_Free (central_dir);
754         return pack->numfiles;
755 }
756
757
758 /*
759 ====================
760 FS_LoadPackPK3
761
762 Create a package entry associated with a PK3 file
763 ====================
764 */
765 static pack_t *FS_LoadPackPK3FromFD (const char *packfile, filedesc_t packhandle, qbool silent)
766 {
767         pk3_endOfCentralDir_t eocd;
768         pack_t *pack;
769         int real_nb_files;
770
771         if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
772         {
773                 if(!silent)
774                         Con_Printf ("%s is not a PK3 file\n", packfile);
775                 FILEDESC_CLOSE(packhandle);
776                 return NULL;
777         }
778
779         // Multi-volume ZIP archives are NOT allowed
780         if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
781         {
782                 Con_Printf ("%s is a multi-volume ZIP archive\n", packfile);
783                 FILEDESC_CLOSE(packhandle);
784                 return NULL;
785         }
786
787         // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
788         // since eocd.nbentries is an unsigned 16 bits integer
789 #if MAX_FILES_IN_PACK < 65535
790         if (eocd.nbentries > MAX_FILES_IN_PACK)
791         {
792                 Con_Printf ("%s contains too many files (%hu)\n", packfile, eocd.nbentries);
793                 FILEDESC_CLOSE(packhandle);
794                 return NULL;
795         }
796 #endif
797
798         // Create a package structure in memory
799         pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
800         pack->ignorecase = true; // PK3 ignores case
801         strlcpy (pack->filename, packfile, sizeof (pack->filename));
802         pack->handle = packhandle;
803         pack->numfiles = eocd.nbentries;
804         pack->files = (packfile_t *)Mem_Alloc(fs_mempool, eocd.nbentries * sizeof(packfile_t));
805
806         real_nb_files = PK3_BuildFileList (pack, &eocd);
807         if (real_nb_files < 0)
808         {
809                 Con_Printf ("%s is not a valid PK3 file\n", packfile);
810                 FILEDESC_CLOSE(pack->handle);
811                 Mem_Free(pack);
812                 return NULL;
813         }
814
815         Con_DPrintf("Added packfile %s (%i files)\n", packfile, real_nb_files);
816         return pack;
817 }
818
819 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qbool nonblocking);
820 static pack_t *FS_LoadPackPK3 (const char *packfile)
821 {
822         filedesc_t packhandle;
823         packhandle = FS_SysOpenFiledesc (packfile, "rb", false);
824         if (!FILEDESC_ISVALID(packhandle))
825                 return NULL;
826         return FS_LoadPackPK3FromFD(packfile, packhandle, false);
827 }
828
829
830 /*
831 ====================
832 PK3_GetTrueFileOffset
833
834 Find where the true file data offset is
835 ====================
836 */
837 static qbool PK3_GetTrueFileOffset (packfile_t *pfile, pack_t *pack)
838 {
839         unsigned char buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
840         fs_offset_t count;
841
842         // Already found?
843         if (pfile->flags & PACKFILE_FLAG_TRUEOFFS)
844                 return true;
845
846         // Load the local file description
847         if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
848         {
849                 Con_Printf ("Can't seek in package %s\n", pack->filename);
850                 return false;
851         }
852         count = FILEDESC_READ (pack->handle, buffer, ZIP_LOCAL_CHUNK_BASE_SIZE);
853         if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
854         {
855                 Con_Printf ("Can't retrieve file %s in package %s\n", pfile->name, pack->filename);
856                 return false;
857         }
858
859         // Skip name and extra field
860         pfile->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
861
862         pfile->flags |= PACKFILE_FLAG_TRUEOFFS;
863         return true;
864 }
865
866
867 /*
868 =============================================================================
869
870 OTHER PRIVATE FUNCTIONS
871
872 =============================================================================
873 */
874
875
876 /*
877 ====================
878 FS_AddFileToPack
879
880 Add a file to the list of files contained into a package
881 ====================
882 */
883 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
884                                                                          fs_offset_t offset, fs_offset_t packsize,
885                                                                          fs_offset_t realsize, int flags)
886 {
887         int (*strcmp_funct) (const char* str1, const char* str2);
888         int left, right, middle;
889         packfile_t *pfile;
890
891         strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
892
893         // Look for the slot we should put that file into (binary search)
894         left = 0;
895         right = pack->numfiles - 1;
896         while (left <= right)
897         {
898                 int diff;
899
900                 middle = (left + right) / 2;
901                 diff = strcmp_funct (pack->files[middle].name, name);
902
903                 // If we found the file, there's a problem
904                 if (!diff)
905                         Con_Printf ("Package %s contains the file %s several times\n", pack->filename, name);
906
907                 // If we're too far in the list
908                 if (diff > 0)
909                         right = middle - 1;
910                 else
911                         left = middle + 1;
912         }
913
914         // We have to move the right of the list by one slot to free the one we need
915         pfile = &pack->files[left];
916         memmove (pfile + 1, pfile, (pack->numfiles - left) * sizeof (*pfile));
917         pack->numfiles++;
918
919         strlcpy (pfile->name, name, sizeof (pfile->name));
920         pfile->offset = offset;
921         pfile->packsize = packsize;
922         pfile->realsize = realsize;
923         pfile->flags = flags;
924
925         return pfile;
926 }
927
928
929 static void FS_mkdir (const char *path)
930 {
931         if(Sys_CheckParm("-readonly"))
932                 return;
933
934 #if WIN32
935         if (_mkdir (path) == -1)
936 #else
937         if (mkdir (path, 0777) == -1)
938 #endif
939         {
940                 // No logging for this. The only caller is FS_CreatePath (which
941                 // calls it in ways that will intentionally produce EEXIST),
942                 // and its own callers always use the directory afterwards and
943                 // thus will detect failure that way.
944         }
945 }
946
947
948 /*
949 ============
950 FS_CreatePath
951
952 Only used for FS_OpenRealFile.
953 ============
954 */
955 void FS_CreatePath (char *path)
956 {
957         char *ofs, save;
958
959         for (ofs = path+1 ; *ofs ; ofs++)
960         {
961                 if (*ofs == '/' || *ofs == '\\')
962                 {
963                         // create the directory
964                         save = *ofs;
965                         *ofs = 0;
966                         FS_mkdir (path);
967                         *ofs = save;
968                 }
969         }
970 }
971
972
973 /*
974 ============
975 FS_Path_f
976
977 ============
978 */
979 static void FS_Path_f(cmd_state_t *cmd)
980 {
981         searchpath_t *s;
982
983         Con_Print("Current search path:\n");
984         for (s=fs_searchpaths ; s ; s=s->next)
985         {
986                 if (s->pack)
987                 {
988                         if(s->pack->vpack)
989                                 Con_Printf("%sdir (virtual pack)\n", s->pack->filename);
990                         else
991                                 Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
992                 }
993                 else
994                         Con_Printf("%s\n", s->filename);
995         }
996 }
997
998
999 /*
1000 =================
1001 FS_LoadPackPAK
1002 =================
1003 */
1004 /*! Takes an explicit (not game tree related) path to a pak file.
1005  *Loads the header and directory, adding the files at the beginning
1006  *of the list so they override previous pack files.
1007  */
1008 static pack_t *FS_LoadPackPAK (const char *packfile)
1009 {
1010         dpackheader_t header;
1011         int i, numpackfiles;
1012         filedesc_t packhandle;
1013         pack_t *pack;
1014         dpackfile_t *info;
1015
1016         packhandle = FS_SysOpenFiledesc(packfile, "rb", false);
1017         if (!FILEDESC_ISVALID(packhandle))
1018                 return NULL;
1019         if(FILEDESC_READ (packhandle, (void *)&header, sizeof(header)) != sizeof(header))
1020         {
1021                 Con_Printf ("%s is not a packfile\n", packfile);
1022                 FILEDESC_CLOSE(packhandle);
1023                 return NULL;
1024         }
1025         if (memcmp(header.id, "PACK", 4))
1026         {
1027                 Con_Printf ("%s is not a packfile\n", packfile);
1028                 FILEDESC_CLOSE(packhandle);
1029                 return NULL;
1030         }
1031         header.dirofs = LittleLong (header.dirofs);
1032         header.dirlen = LittleLong (header.dirlen);
1033
1034         if (header.dirlen % sizeof(dpackfile_t))
1035         {
1036                 Con_Printf ("%s has an invalid directory size\n", packfile);
1037                 FILEDESC_CLOSE(packhandle);
1038                 return NULL;
1039         }
1040
1041         numpackfiles = header.dirlen / sizeof(dpackfile_t);
1042
1043         if (numpackfiles < 0 || numpackfiles > MAX_FILES_IN_PACK)
1044         {
1045                 Con_Printf ("%s has %i files\n", packfile, numpackfiles);
1046                 FILEDESC_CLOSE(packhandle);
1047                 return NULL;
1048         }
1049
1050         info = (dpackfile_t *)Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
1051         FILEDESC_SEEK (packhandle, header.dirofs, SEEK_SET);
1052         if(header.dirlen != FILEDESC_READ (packhandle, (void *)info, header.dirlen))
1053         {
1054                 Con_Printf("%s is an incomplete PAK, not loading\n", packfile);
1055                 Mem_Free(info);
1056                 FILEDESC_CLOSE(packhandle);
1057                 return NULL;
1058         }
1059
1060         pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1061         pack->ignorecase = true; // PAK is sensitive in Quake1 but insensitive in Quake2
1062         strlcpy (pack->filename, packfile, sizeof (pack->filename));
1063         pack->handle = packhandle;
1064         pack->numfiles = 0;
1065         pack->files = (packfile_t *)Mem_Alloc(fs_mempool, numpackfiles * sizeof(packfile_t));
1066
1067         // parse the directory
1068         for (i = 0;i < numpackfiles;i++)
1069         {
1070                 fs_offset_t offset = (unsigned int)LittleLong (info[i].filepos);
1071                 fs_offset_t size = (unsigned int)LittleLong (info[i].filelen);
1072
1073                 // Ensure a zero terminated file name (required by format).
1074                 info[i].name[sizeof(info[i].name) - 1] = 0;
1075
1076                 FS_AddFileToPack (info[i].name, pack, offset, size, size, PACKFILE_FLAG_TRUEOFFS);
1077         }
1078
1079         Mem_Free(info);
1080
1081         Con_DPrintf("Added packfile %s (%i files)\n", packfile, numpackfiles);
1082         return pack;
1083 }
1084
1085 /*
1086 ====================
1087 FS_LoadPackVirtual
1088
1089 Create a package entry associated with a directory file
1090 ====================
1091 */
1092 static pack_t *FS_LoadPackVirtual (const char *dirname)
1093 {
1094         pack_t *pack;
1095         pack = (pack_t *)Mem_Alloc(fs_mempool, sizeof (pack_t));
1096         pack->vpack = true;
1097         pack->ignorecase = false;
1098         strlcpy (pack->filename, dirname, sizeof(pack->filename));
1099         pack->handle = FILEDESC_INVALID;
1100         pack->numfiles = -1;
1101         pack->files = NULL;
1102         Con_DPrintf("Added packfile %s (virtual pack)\n", dirname);
1103         return pack;
1104 }
1105
1106 /*
1107 ================
1108 FS_AddPack_Fullpath
1109 ================
1110 */
1111 /*! Adds the given pack to the search path.
1112  * The pack type is autodetected by the file extension.
1113  *
1114  * Returns true if the file was successfully added to the
1115  * search path or if it was already included.
1116  *
1117  * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1118  * plain directories.
1119  *
1120  */
1121 static qbool FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qbool *already_loaded, qbool keep_plain_dirs)
1122 {
1123         searchpath_t *search;
1124         pack_t *pak = NULL;
1125         const char *ext = FS_FileExtension(pakfile);
1126         size_t l;
1127
1128         for(search = fs_searchpaths; search; search = search->next)
1129         {
1130                 if(search->pack && !strcasecmp(search->pack->filename, pakfile))
1131                 {
1132                         if(already_loaded)
1133                                 *already_loaded = true;
1134                         return true; // already loaded
1135                 }
1136         }
1137
1138         if(already_loaded)
1139                 *already_loaded = false;
1140
1141         if(!strcasecmp(ext, "pk3dir"))
1142                 pak = FS_LoadPackVirtual (pakfile);
1143         else if(!strcasecmp(ext, "pak"))
1144                 pak = FS_LoadPackPAK (pakfile);
1145         else if(!strcasecmp(ext, "pk3"))
1146                 pak = FS_LoadPackPK3 (pakfile);
1147         else if(!strcasecmp(ext, "obb")) // android apk expansion
1148                 pak = FS_LoadPackPK3 (pakfile);
1149         else
1150                 Con_Printf("\"%s\" does not have a pack extension\n", pakfile);
1151
1152         if(pak)
1153         {
1154                 strlcpy(pak->shortname, shortname, sizeof(pak->shortname));
1155
1156                 //Con_DPrintf("  Registered pack with short name %s\n", shortname);
1157                 if(keep_plain_dirs)
1158                 {
1159                         // find the first item whose next one is a pack or NULL
1160                         searchpath_t *insertion_point = 0;
1161                         if(fs_searchpaths && !fs_searchpaths->pack)
1162                         {
1163                                 insertion_point = fs_searchpaths;
1164                                 for(;;)
1165                                 {
1166                                         if(!insertion_point->next)
1167                                                 break;
1168                                         if(insertion_point->next->pack)
1169                                                 break;
1170                                         insertion_point = insertion_point->next;
1171                                 }
1172                         }
1173                         // If insertion_point is NULL, this means that either there is no
1174                         // item in the list yet, or that the very first item is a pack. In
1175                         // that case, we want to insert at the beginning...
1176                         if(!insertion_point)
1177                         {
1178                                 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1179                                 search->next = fs_searchpaths;
1180                                 fs_searchpaths = search;
1181                         }
1182                         else
1183                         // otherwise we want to append directly after insertion_point.
1184                         {
1185                                 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1186                                 search->next = insertion_point->next;
1187                                 insertion_point->next = search;
1188                         }
1189                 }
1190                 else
1191                 {
1192                         search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1193                         search->next = fs_searchpaths;
1194                         fs_searchpaths = search;
1195                 }
1196                 search->pack = pak;
1197                 if(pak->vpack)
1198                 {
1199                         dpsnprintf(search->filename, sizeof(search->filename), "%s/", pakfile);
1200                         // if shortname ends with "pk3dir", strip that suffix to make it just "pk3"
1201                         // same goes for the name inside the pack structure
1202                         l = strlen(pak->shortname);
1203                         if(l >= 7)
1204                                 if(!strcasecmp(pak->shortname + l - 7, ".pk3dir"))
1205                                         pak->shortname[l - 3] = 0;
1206                         l = strlen(pak->filename);
1207                         if(l >= 7)
1208                                 if(!strcasecmp(pak->filename + l - 7, ".pk3dir"))
1209                                         pak->filename[l - 3] = 0;
1210                 }
1211                 return true;
1212         }
1213         else
1214         {
1215                 Con_Printf(CON_ERROR "unable to load pak \"%s\"\n", pakfile);
1216                 return false;
1217         }
1218 }
1219
1220
1221 /*
1222 ================
1223 FS_AddPack
1224 ================
1225 */
1226 /*! Adds the given pack to the search path and searches for it in the game path.
1227  * The pack type is autodetected by the file extension.
1228  *
1229  * Returns true if the file was successfully added to the
1230  * search path or if it was already included.
1231  *
1232  * If keep_plain_dirs is set, the pack will be added AFTER the first sequence of
1233  * plain directories.
1234  */
1235 qbool FS_AddPack(const char *pakfile, qbool *already_loaded, qbool keep_plain_dirs)
1236 {
1237         char fullpath[MAX_OSPATH];
1238         int index;
1239         searchpath_t *search;
1240
1241         if(already_loaded)
1242                 *already_loaded = false;
1243
1244         // then find the real name...
1245         search = FS_FindFile(pakfile, &index, true);
1246         if(!search || search->pack)
1247         {
1248                 Con_Printf("could not find pak \"%s\"\n", pakfile);
1249                 return false;
1250         }
1251
1252         dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, pakfile);
1253
1254         return FS_AddPack_Fullpath(fullpath, pakfile, already_loaded, keep_plain_dirs);
1255 }
1256
1257
1258 /*
1259 ================
1260 FS_AddGameDirectory
1261
1262 Sets fs_gamedir, adds the directory to the head of the path,
1263 then loads and adds pak1.pak pak2.pak ...
1264 ================
1265 */
1266 static void FS_AddGameDirectory (const char *dir)
1267 {
1268         int i;
1269         stringlist_t list;
1270         searchpath_t *search;
1271
1272         strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
1273
1274         stringlistinit(&list);
1275         listdirectory(&list, "", dir);
1276         stringlistsort(&list, false);
1277
1278         // add any PAK package in the directory
1279         for (i = 0;i < list.numstrings;i++)
1280         {
1281                 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pak"))
1282                 {
1283                         FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1284                 }
1285         }
1286
1287         // add any PK3 package in the directory
1288         for (i = 0;i < list.numstrings;i++)
1289         {
1290                 if (!strcasecmp(FS_FileExtension(list.strings[i]), "pk3") || !strcasecmp(FS_FileExtension(list.strings[i]), "obb") || !strcasecmp(FS_FileExtension(list.strings[i]), "pk3dir"))
1291                 {
1292                         FS_AddPack_Fullpath(list.strings[i], list.strings[i] + strlen(dir), NULL, false);
1293                 }
1294         }
1295
1296         stringlistfreecontents(&list);
1297
1298         // Add the directory to the search path
1299         // (unpacked files have the priority over packed files)
1300         search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1301         strlcpy (search->filename, dir, sizeof (search->filename));
1302         search->next = fs_searchpaths;
1303         fs_searchpaths = search;
1304 }
1305
1306
1307 /*
1308 ================
1309 FS_AddGameHierarchy
1310 ================
1311 */
1312 static void FS_AddGameHierarchy (const char *dir)
1313 {
1314         char vabuf[1024];
1315         // Add the common game directory
1316         FS_AddGameDirectory (va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, dir));
1317
1318         if (*fs_userdir)
1319                 FS_AddGameDirectory(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, dir));
1320 }
1321
1322
1323 /*
1324 ============
1325 FS_FileExtension
1326 ============
1327 */
1328 const char *FS_FileExtension (const char *in)
1329 {
1330         const char *separator, *backslash, *colon, *dot;
1331
1332         separator = strrchr(in, '/');
1333         backslash = strrchr(in, '\\');
1334         if (!separator || separator < backslash)
1335                 separator = backslash;
1336         colon = strrchr(in, ':');
1337         if (!separator || separator < colon)
1338                 separator = colon;
1339
1340         dot = strrchr(in, '.');
1341         if (dot == NULL || (separator && (dot < separator)))
1342                 return "";
1343
1344         return dot + 1;
1345 }
1346
1347
1348 /*
1349 ============
1350 FS_FileWithoutPath
1351 ============
1352 */
1353 const char *FS_FileWithoutPath (const char *in)
1354 {
1355         const char *separator, *backslash, *colon;
1356
1357         separator = strrchr(in, '/');
1358         backslash = strrchr(in, '\\');
1359         if (!separator || separator < backslash)
1360                 separator = backslash;
1361         colon = strrchr(in, ':');
1362         if (!separator || separator < colon)
1363                 separator = colon;
1364         return separator ? separator + 1 : in;
1365 }
1366
1367
1368 /*
1369 ================
1370 FS_ClearSearchPath
1371 ================
1372 */
1373 static void FS_ClearSearchPath (void)
1374 {
1375         // unload all packs and directory information, close all pack files
1376         // (if a qfile is still reading a pack it won't be harmed because it used
1377         //  dup() to get its own handle already)
1378         while (fs_searchpaths)
1379         {
1380                 searchpath_t *search = fs_searchpaths;
1381                 fs_searchpaths = search->next;
1382                 if (search->pack && search->pack != fs_selfpack)
1383                 {
1384                         if(!search->pack->vpack)
1385                         {
1386                                 // close the file
1387                                 FILEDESC_CLOSE(search->pack->handle);
1388                                 // free any memory associated with it
1389                                 if (search->pack->files)
1390                                         Mem_Free(search->pack->files);
1391                         }
1392                         Mem_Free(search->pack);
1393                 }
1394                 Mem_Free(search);
1395         }
1396 }
1397
1398 static void FS_AddSelfPack(void)
1399 {
1400         if(fs_selfpack)
1401         {
1402                 searchpath_t *search;
1403                 search = (searchpath_t *)Mem_Alloc(fs_mempool, sizeof(searchpath_t));
1404                 search->next = fs_searchpaths;
1405                 search->pack = fs_selfpack;
1406                 fs_searchpaths = search;
1407         }
1408 }
1409
1410
1411 /*
1412 ================
1413 FS_Rescan
1414 ================
1415 */
1416 void FS_Rescan (void)
1417 {
1418         int i;
1419         qbool fs_modified = false;
1420         qbool reset = false;
1421         char gamedirbuf[MAX_INPUTLINE];
1422         char vabuf[1024];
1423
1424         if (fs_searchpaths)
1425                 reset = true;
1426         FS_ClearSearchPath();
1427
1428         // automatically activate gamemode for the gamedirs specified
1429         if (reset)
1430                 COM_ChangeGameTypeForGameDirs();
1431
1432         // add the game-specific paths
1433         // gamedirname1 (typically id1)
1434         FS_AddGameHierarchy (gamedirname1);
1435         // update the com_modname (used for server info)
1436         if (gamedirname2 && gamedirname2[0])
1437                 strlcpy(com_modname, gamedirname2, sizeof(com_modname));
1438         else
1439                 strlcpy(com_modname, gamedirname1, sizeof(com_modname));
1440
1441         // add the game-specific path, if any
1442         // (only used for mission packs and the like, which should set fs_modified)
1443         if (gamedirname2 && gamedirname2[0])
1444         {
1445                 fs_modified = true;
1446                 FS_AddGameHierarchy (gamedirname2);
1447         }
1448
1449         // -game <gamedir>
1450         // Adds basedir/gamedir as an override game
1451         // LadyHavoc: now supports multiple -game directories
1452         // set the com_modname (reported in server info)
1453         *gamedirbuf = 0;
1454         for (i = 0;i < fs_numgamedirs;i++)
1455         {
1456                 fs_modified = true;
1457                 FS_AddGameHierarchy (fs_gamedirs[i]);
1458                 // update the com_modname (used server info)
1459                 strlcpy (com_modname, fs_gamedirs[i], sizeof (com_modname));
1460                 if(i)
1461                         strlcat(gamedirbuf, va(vabuf, sizeof(vabuf), " %s", fs_gamedirs[i]), sizeof(gamedirbuf));
1462                 else
1463                         strlcpy(gamedirbuf, fs_gamedirs[i], sizeof(gamedirbuf));
1464         }
1465         Cvar_SetQuick(&cvar_fs_gamedir, gamedirbuf); // so QC or console code can query it
1466
1467         // add back the selfpack as new first item
1468         FS_AddSelfPack();
1469
1470         // set the default screenshot name to either the mod name or the
1471         // gamemode screenshot name
1472         if (strcmp(com_modname, gamedirname1))
1473                 Cvar_SetQuick (&scr_screenshot_name, com_modname);
1474         else
1475                 Cvar_SetQuick (&scr_screenshot_name, gamescreenshotname);
1476         
1477         if((i = Sys_CheckParm("-modname")) && i < sys.argc - 1)
1478                 strlcpy(com_modname, sys.argv[i+1], sizeof(com_modname));
1479
1480         // If "-condebug" is in the command line, remove the previous log file
1481         if (Sys_CheckParm ("-condebug") != 0)
1482                 unlink (va(vabuf, sizeof(vabuf), "%s/qconsole.log", fs_gamedir));
1483
1484         // look for the pop.lmp file and set registered to true if it is found
1485         if (FS_FileExists("gfx/pop.lmp"))
1486                 Cvar_SetValueQuick(&registered, 1);
1487         switch(gamemode)
1488         {
1489         case GAME_NORMAL:
1490         case GAME_HIPNOTIC:
1491         case GAME_ROGUE:
1492                 if (!registered.integer)
1493                 {
1494                         if (fs_modified)
1495                                 Con_Print("Playing shareware version, with modification.\nwarning: most mods require full quake data.\n");
1496                         else
1497                                 Con_Print("Playing shareware version.\n");
1498                 }
1499                 else
1500                         Con_Print("Playing registered version.\n");
1501                 break;
1502         case GAME_STEELSTORM:
1503                 if (registered.integer)
1504                         Con_Print("Playing registered version.\n");
1505                 else
1506                         Con_Print("Playing shareware version.\n");
1507                 break;
1508         default:
1509                 break;
1510         }
1511
1512         // unload all wads so that future queries will return the new data
1513         W_UnloadAll();
1514 }
1515
1516 static void FS_Rescan_f(cmd_state_t *cmd)
1517 {
1518         FS_Rescan();
1519 }
1520
1521 /*
1522 ================
1523 FS_ChangeGameDirs
1524 ================
1525 */
1526 extern qbool vid_opened;
1527 qbool FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qbool complain, qbool failmissing)
1528 {
1529         int i;
1530         const char *p;
1531
1532         if (fs_numgamedirs == numgamedirs)
1533         {
1534                 for (i = 0;i < numgamedirs;i++)
1535                         if (strcasecmp(fs_gamedirs[i], gamedirs[i]))
1536                                 break;
1537                 if (i == numgamedirs)
1538                         return true; // already using this set of gamedirs, do nothing
1539         }
1540
1541         if (numgamedirs > MAX_GAMEDIRS)
1542         {
1543                 if (complain)
1544                         Con_Printf("That is too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1545                 return false; // too many gamedirs
1546         }
1547
1548         for (i = 0;i < numgamedirs;i++)
1549         {
1550                 // if string is nasty, reject it
1551                 p = FS_CheckGameDir(gamedirs[i]);
1552                 if(!p)
1553                 {
1554                         if (complain)
1555                                 Con_Printf("Nasty gamedir name rejected: %s\n", gamedirs[i]);
1556                         return false; // nasty gamedirs
1557                 }
1558                 if(p == fs_checkgamedir_missing && failmissing)
1559                 {
1560                         if (complain)
1561                                 Con_Printf("Gamedir missing: %s%s/\n", fs_basedir, gamedirs[i]);
1562                         return false; // missing gamedirs
1563                 }
1564         }
1565
1566         Host_SaveConfig();
1567
1568         fs_numgamedirs = numgamedirs;
1569         for (i = 0;i < fs_numgamedirs;i++)
1570                 strlcpy(fs_gamedirs[i], gamedirs[i], sizeof(fs_gamedirs[i]));
1571
1572         // reinitialize filesystem to detect the new paks
1573         FS_Rescan();
1574
1575         if (cls.demoplayback)
1576         {
1577                 CL_Disconnect_f(cmd_client);
1578                 cls.demonum = 0;
1579         }
1580
1581         // unload all sounds so they will be reloaded from the new files as needed
1582         S_UnloadAllSounds_f(cmd_client);
1583
1584         // restart the video subsystem after the config is executed
1585         Cbuf_InsertText(cmd_client, "\nloadconfig\nvid_restart\n\n");
1586
1587         return true;
1588 }
1589
1590 /*
1591 ================
1592 FS_GameDir_f
1593 ================
1594 */
1595 static void FS_GameDir_f(cmd_state_t *cmd)
1596 {
1597         int i;
1598         int numgamedirs;
1599         char gamedirs[MAX_GAMEDIRS][MAX_QPATH];
1600
1601         if (Cmd_Argc(cmd) < 2)
1602         {
1603                 Con_Printf("gamedirs active:");
1604                 for (i = 0;i < fs_numgamedirs;i++)
1605                         Con_Printf(" %s", fs_gamedirs[i]);
1606                 Con_Printf("\n");
1607                 return;
1608         }
1609
1610         numgamedirs = Cmd_Argc(cmd) - 1;
1611         if (numgamedirs > MAX_GAMEDIRS)
1612         {
1613                 Con_Printf("Too many gamedirs (%i > %i)\n", numgamedirs, MAX_GAMEDIRS);
1614                 return;
1615         }
1616
1617         for (i = 0;i < numgamedirs;i++)
1618                 strlcpy(gamedirs[i], Cmd_Argv(cmd, i+1), sizeof(gamedirs[i]));
1619
1620         if ((cls.state == ca_connected && !cls.demoplayback) || sv.active)
1621         {
1622                 // actually, changing during game would work fine, but would be stupid
1623                 Con_Printf("Can not change gamedir while client is connected or server is running!\n");
1624                 return;
1625         }
1626
1627         // halt demo playback to close the file
1628         CL_Disconnect();
1629
1630         FS_ChangeGameDirs(numgamedirs, gamedirs, true, true);
1631 }
1632
1633 static const char *FS_SysCheckGameDir(const char *gamedir, char *buf, size_t buflength)
1634 {
1635         qbool success;
1636         qfile_t *f;
1637         stringlist_t list;
1638         fs_offset_t n;
1639         char vabuf[1024];
1640
1641         stringlistinit(&list);
1642         listdirectory(&list, gamedir, "");
1643         success = list.numstrings > 0;
1644         stringlistfreecontents(&list);
1645
1646         if(success)
1647         {
1648                 f = FS_SysOpen(va(vabuf, sizeof(vabuf), "%smodinfo.txt", gamedir), "r", false);
1649                 if(f)
1650                 {
1651                         n = FS_Read (f, buf, buflength - 1);
1652                         if(n >= 0)
1653                                 buf[n] = 0;
1654                         else
1655                                 *buf = 0;
1656                         FS_Close(f);
1657                 }
1658                 else
1659                         *buf = 0;
1660                 return buf;
1661         }
1662
1663         return NULL;
1664 }
1665
1666 /*
1667 ================
1668 FS_CheckGameDir
1669 ================
1670 */
1671 const char *FS_CheckGameDir(const char *gamedir)
1672 {
1673         const char *ret;
1674         static char buf[8192];
1675         char vabuf[1024];
1676
1677         if (FS_CheckNastyPath(gamedir, true))
1678                 return NULL;
1679
1680         ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_userdir, gamedir), buf, sizeof(buf));
1681         if(ret)
1682         {
1683                 if(!*ret)
1684                 {
1685                         // get description from basedir
1686                         ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1687                         if(ret)
1688                                 return ret;
1689                         return "";
1690                 }
1691                 return ret;
1692         }
1693
1694         ret = FS_SysCheckGameDir(va(vabuf, sizeof(vabuf), "%s%s/", fs_basedir, gamedir), buf, sizeof(buf));
1695         if(ret)
1696                 return ret;
1697         
1698         return fs_checkgamedir_missing;
1699 }
1700
1701 static void FS_ListGameDirs(void)
1702 {
1703         stringlist_t list, list2;
1704         int i;
1705         const char *info;
1706         char vabuf[1024];
1707
1708         fs_all_gamedirs_count = 0;
1709         if(fs_all_gamedirs)
1710                 Mem_Free(fs_all_gamedirs);
1711
1712         stringlistinit(&list);
1713         listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_basedir), "");
1714         listdirectory(&list, va(vabuf, sizeof(vabuf), "%s/", fs_userdir), "");
1715         stringlistsort(&list, false);
1716
1717         stringlistinit(&list2);
1718         for(i = 0; i < list.numstrings; ++i)
1719         {
1720                 if(i)
1721                         if(!strcmp(list.strings[i-1], list.strings[i]))
1722                                 continue;
1723                 info = FS_CheckGameDir(list.strings[i]);
1724                 if(!info)
1725                         continue;
1726                 if(info == fs_checkgamedir_missing)
1727                         continue;
1728                 if(!*info)
1729                         continue;
1730                 stringlistappend(&list2, list.strings[i]); 
1731         }
1732         stringlistfreecontents(&list);
1733
1734         fs_all_gamedirs = (gamedir_t *)Mem_Alloc(fs_mempool, list2.numstrings * sizeof(*fs_all_gamedirs));
1735         for(i = 0; i < list2.numstrings; ++i)
1736         {
1737                 info = FS_CheckGameDir(list2.strings[i]);
1738                 // all this cannot happen any more, but better be safe than sorry
1739                 if(!info)
1740                         continue;
1741                 if(info == fs_checkgamedir_missing)
1742                         continue;
1743                 if(!*info)
1744                         continue;
1745                 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].name, list2.strings[i], sizeof(fs_all_gamedirs[fs_all_gamedirs_count].name));
1746                 strlcpy(fs_all_gamedirs[fs_all_gamedirs_count].description, info, sizeof(fs_all_gamedirs[fs_all_gamedirs_count].description));
1747                 ++fs_all_gamedirs_count;
1748         }
1749 }
1750
1751 /*
1752 #ifdef WIN32
1753 #pragma comment(lib, "shell32.lib")
1754 #include <ShlObj.h>
1755 #endif
1756 */
1757
1758 static void COM_InsertFlags(const char *buf) {
1759         const char *p;
1760         char *q;
1761         const char **new_argv;
1762         int i = 0;
1763         int args_left = 256;
1764         new_argv = (const char **)Mem_Alloc(fs_mempool, sizeof(*sys.argv) * (sys.argc + args_left + 2));
1765         if(sys.argc == 0)
1766                 new_argv[0] = "dummy";  // Can't really happen.
1767         else
1768                 new_argv[0] = sys.argv[0];
1769         ++i;
1770         p = buf;
1771         while(COM_ParseToken_Console(&p))
1772         {
1773                 size_t sz = strlen(com_token) + 1; // shut up clang
1774                 if(i > args_left)
1775                         break;
1776                 q = (char *)Mem_Alloc(fs_mempool, sz);
1777                 strlcpy(q, com_token, sz);
1778                 new_argv[i] = q;
1779                 ++i;
1780         }
1781         // Now: i <= args_left + 1.
1782         if (sys.argc >= 1)
1783         {
1784                 memcpy((char *)(&new_argv[i]), &sys.argv[1], sizeof(*sys.argv) * (sys.argc - 1));
1785                 i += sys.argc - 1;
1786         }
1787         // Now: i <= args_left + (sys.argc || 1).
1788         new_argv[i] = NULL;
1789         sys.argv = new_argv;
1790         sys.argc = i;
1791 }
1792
1793 static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t userdirsize)
1794 {
1795 #if defined(__IPHONEOS__)
1796         if (userdirmode == USERDIRMODE_HOME)
1797         {
1798                 // fs_basedir is "" by default, to utilize this you can simply add your gamedir to the Resources in xcode
1799                 // fs_userdir stores configurations to the Documents folder of the app
1800                 strlcpy(userdir, "../Documents/", MAX_OSPATH);
1801                 return 1;
1802         }
1803         return -1;
1804
1805 #elif defined(WIN32)
1806         char *homedir;
1807 #if _MSC_VER >= 1400
1808         size_t homedirlen;
1809 #endif
1810         TCHAR mydocsdir[MAX_PATH + 1];
1811         wchar_t *savedgamesdirw;
1812         char savedgamesdir[MAX_OSPATH];
1813         int fd;
1814         char vabuf[1024];
1815
1816         userdir[0] = 0;
1817         switch(userdirmode)
1818         {
1819         default:
1820                 return -1;
1821         case USERDIRMODE_NOHOME:
1822                 strlcpy(userdir, fs_basedir, userdirsize);
1823                 break;
1824         case USERDIRMODE_MYGAMES:
1825                 if (!shfolder_dll)
1826                         Sys_LoadDependency(shfolderdllnames, &shfolder_dll, shfolderfuncs);
1827                 mydocsdir[0] = 0;
1828                 if (qSHGetFolderPath && qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)
1829                 {
1830                         dpsnprintf(userdir, userdirsize, "%s/My Games/%s/", mydocsdir, gameuserdirname);
1831                         break;
1832                 }
1833 #if _MSC_VER >= 1400
1834                 _dupenv_s(&homedir, &homedirlen, "USERPROFILE");
1835                 if(homedir)
1836                 {
1837                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1838                         free(homedir);
1839                         break;
1840                 }
1841 #else
1842                 homedir = getenv("USERPROFILE");
1843                 if(homedir)
1844                 {
1845                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1846                         break;
1847                 }
1848 #endif
1849                 return -1;
1850         case USERDIRMODE_SAVEDGAMES:
1851                 if (!shell32_dll)
1852                         Sys_LoadDependency(shell32dllnames, &shell32_dll, shell32funcs);
1853                 if (!ole32_dll)
1854                         Sys_LoadDependency(ole32dllnames, &ole32_dll, ole32funcs);
1855                 if (qSHGetKnownFolderPath && qCoInitializeEx && qCoTaskMemFree && qCoUninitialize)
1856                 {
1857                         savedgamesdir[0] = 0;
1858                         qCoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
1859 /*
1860 #ifdef __cplusplus
1861                         if (SHGetKnownFolderPath(FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1862 #else
1863                         if (SHGetKnownFolderPath(&FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1864 #endif
1865 */
1866                         if (qSHGetKnownFolderPath(&qFOLDERID_SavedGames, qKF_FLAG_CREATE | qKF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1867                         {
1868                                 memset(savedgamesdir, 0, sizeof(savedgamesdir));
1869 #if _MSC_VER >= 1400
1870                                 wcstombs_s(NULL, savedgamesdir, sizeof(savedgamesdir), savedgamesdirw, sizeof(savedgamesdir)-1);
1871 #else
1872                                 wcstombs(savedgamesdir, savedgamesdirw, sizeof(savedgamesdir)-1);
1873 #endif
1874                                 qCoTaskMemFree(savedgamesdirw);
1875                         }
1876                         qCoUninitialize();
1877                         if (savedgamesdir[0])
1878                         {
1879                                 dpsnprintf(userdir, userdirsize, "%s/%s/", savedgamesdir, gameuserdirname);
1880                                 break;
1881                         }
1882                 }
1883                 return -1;
1884         }
1885 #else
1886         int fd;
1887         char *homedir;
1888         char vabuf[1024];
1889         userdir[0] = 0;
1890         switch(userdirmode)
1891         {
1892         default:
1893                 return -1;
1894         case USERDIRMODE_NOHOME:
1895                 strlcpy(userdir, fs_basedir, userdirsize);
1896                 break;
1897         case USERDIRMODE_HOME:
1898                 homedir = getenv("HOME");
1899                 if(homedir)
1900                 {
1901                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1902                         break;
1903                 }
1904                 return -1;
1905         case USERDIRMODE_SAVEDGAMES:
1906                 homedir = getenv("HOME");
1907                 if(homedir)
1908                 {
1909 #ifdef MACOSX
1910                         dpsnprintf(userdir, userdirsize, "%s/Library/Application Support/%s/", homedir, gameuserdirname);
1911 #else
1912                         // the XDG say some files would need to go in:
1913                         // XDG_CONFIG_HOME (or ~/.config/%s/)
1914                         // XDG_DATA_HOME (or ~/.local/share/%s/)
1915                         // XDG_CACHE_HOME (or ~/.cache/%s/)
1916                         // and also search the following global locations if defined:
1917                         // XDG_CONFIG_DIRS (normally /etc/xdg/%s/)
1918                         // XDG_DATA_DIRS (normally /usr/share/%s/)
1919                         // this would be too complicated...
1920                         return -1;
1921 #endif
1922                         break;
1923                 }
1924                 return -1;
1925         }
1926 #endif
1927
1928
1929 #if !defined(__IPHONEOS__)
1930
1931 #ifdef WIN32
1932         // historical behavior...
1933         if (userdirmode == USERDIRMODE_NOHOME && strcmp(gamedirname1, "id1"))
1934                 return 0; // don't bother checking if the basedir folder is writable, it's annoying...  unless it is Quake on Windows where NOHOME is the default preferred and we have to check for an error case
1935 #endif
1936
1937         // see if we can write to this path (note: won't create path)
1938 #ifdef WIN32
1939         // no access() here, we must try to open the file for appending
1940         fd = FS_SysOpenFiledesc(va(vabuf, sizeof(vabuf), "%s%s/config.cfg", userdir, gamedirname1), "a", false);
1941         if(fd >= 0)
1942                 FILEDESC_CLOSE(fd);
1943 #else
1944         // on Unix, we don't need to ACTUALLY attempt to open the file
1945         if(access(va(vabuf, sizeof(vabuf), "%s%s/", userdir, gamedirname1), W_OK | X_OK) >= 0)
1946                 fd = 1;
1947         else
1948                 fd = -1;
1949 #endif
1950         if(fd >= 0)
1951         {
1952                 return 1; // good choice - the path exists and is writable
1953         }
1954         else
1955         {
1956                 if (userdirmode == USERDIRMODE_NOHOME)
1957                         return -1; // path usually already exists, we lack permissions
1958                 else
1959                         return 0; // probably good - failed to write but maybe we need to create path
1960         }
1961 #endif
1962 }
1963
1964 void FS_Init_Commands(void)
1965 {
1966         Cvar_RegisterVariable (&scr_screenshot_name);
1967         Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
1968         Cvar_RegisterVariable (&cvar_fs_gamedir);
1969
1970         Cmd_AddCommand(CF_SHARED, "gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
1971         Cmd_AddCommand(CF_SHARED, "fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
1972         Cmd_AddCommand(CF_SHARED, "path", FS_Path_f, "print searchpath (game directories and archives)");
1973         Cmd_AddCommand(CF_SHARED, "dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
1974         Cmd_AddCommand(CF_SHARED, "ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
1975         Cmd_AddCommand(CF_SHARED, "which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
1976 }
1977
1978 static void FS_Init_Dir (void)
1979 {
1980         const char *p;
1981         int i;
1982
1983         *fs_basedir = 0;
1984         *fs_userdir = 0;
1985         *fs_gamedir = 0;
1986
1987         // -basedir <path>
1988         // Overrides the system supplied base directory (under GAMENAME)
1989 // 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)
1990         i = Sys_CheckParm ("-basedir");
1991         if (i && i < sys.argc-1)
1992         {
1993                 strlcpy (fs_basedir, sys.argv[i+1], sizeof (fs_basedir));
1994                 i = (int)strlen (fs_basedir);
1995                 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
1996                         fs_basedir[i-1] = 0;
1997         }
1998         else
1999         {
2000 // If the base directory is explicitly defined by the compilation process
2001 #ifdef DP_FS_BASEDIR
2002                 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
2003 #elif defined(__ANDROID__)
2004                 dpsnprintf(fs_basedir, sizeof(fs_basedir), "/sdcard/%s/", gameuserdirname);
2005 #elif defined(MACOSX)
2006                 // FIXME: is there a better way to find the directory outside the .app, without using Objective-C?
2007                 if (strstr(sys.argv[0], ".app/"))
2008                 {
2009                         char *split;
2010                         strlcpy(fs_basedir, sys.argv[0], sizeof(fs_basedir));
2011                         split = strstr(fs_basedir, ".app/");
2012                         if (split)
2013                         {
2014                                 struct stat statresult;
2015                                 char vabuf[1024];
2016                                 // truncate to just after the .app/
2017                                 split[5] = 0;
2018                                 // see if gamedir exists in Resources
2019                                 if (stat(va(vabuf, sizeof(vabuf), "%s/Contents/Resources/%s", fs_basedir, gamedirname1), &statresult) == 0)
2020                                 {
2021                                         // found gamedir inside Resources, use it
2022                                         strlcat(fs_basedir, "Contents/Resources/", sizeof(fs_basedir));
2023                                 }
2024                                 else
2025                                 {
2026                                         // no gamedir found in Resources, gamedir is probably
2027                                         // outside the .app, remove .app part of path
2028                                         while (split > fs_basedir && *split != '/')
2029                                                 split--;
2030                                         *split = 0;
2031                                 }
2032                         }
2033                 }
2034 #endif
2035         }
2036
2037         // make sure the appending of a path separator won't create an unterminated string
2038         memset(fs_basedir + sizeof(fs_basedir) - 2, 0, 2);
2039         // add a path separator to the end of the basedir if it lacks one
2040         if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
2041                 strlcat(fs_basedir, "/", sizeof(fs_basedir));
2042
2043         // Add the personal game directory
2044         if((i = Sys_CheckParm("-userdir")) && i < sys.argc - 1)
2045                 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", sys.argv[i+1]);
2046         else if (Sys_CheckParm("-nohome"))
2047                 *fs_userdir = 0; // user wants roaming installation, no userdir
2048         else
2049         {
2050 #ifdef DP_FS_USERDIR
2051                 strlcpy(fs_userdir, DP_FS_USERDIR, sizeof(fs_userdir));
2052 #else
2053                 int dirmode;
2054                 int highestuserdirmode = USERDIRMODE_COUNT - 1;
2055                 int preferreduserdirmode = USERDIRMODE_COUNT - 1;
2056                 int userdirstatus[USERDIRMODE_COUNT];
2057 # ifdef WIN32
2058                 // historical behavior...
2059                 if (!strcmp(gamedirname1, "id1"))
2060                         preferreduserdirmode = USERDIRMODE_NOHOME;
2061 # endif
2062                 // check what limitations the user wants to impose
2063                 if (Sys_CheckParm("-home")) preferreduserdirmode = USERDIRMODE_HOME;
2064                 if (Sys_CheckParm("-mygames")) preferreduserdirmode = USERDIRMODE_MYGAMES;
2065                 if (Sys_CheckParm("-savedgames")) preferreduserdirmode = USERDIRMODE_SAVEDGAMES;
2066                 // gather the status of the possible userdirs
2067                 for (dirmode = 0;dirmode < USERDIRMODE_COUNT;dirmode++)
2068                 {
2069                         userdirstatus[dirmode] = FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2070                         if (userdirstatus[dirmode] == 1)
2071                                 Con_DPrintf("userdir %i = %s (writable)\n", dirmode, fs_userdir);
2072                         else if (userdirstatus[dirmode] == 0)
2073                                 Con_DPrintf("userdir %i = %s (not writable or does not exist)\n", dirmode, fs_userdir);
2074                         else
2075                                 Con_DPrintf("userdir %i (not applicable)\n", dirmode);
2076                 }
2077                 // some games may prefer writing to basedir, but if write fails we
2078                 // have to search for a real userdir...
2079                 if (preferreduserdirmode == 0 && userdirstatus[0] < 1)
2080                         preferreduserdirmode = highestuserdirmode;
2081                 // check for an existing userdir and continue using it if possible...
2082                 for (dirmode = USERDIRMODE_COUNT - 1;dirmode > 0;dirmode--)
2083                         if (userdirstatus[dirmode] == 1)
2084                                 break;
2085                 // if no existing userdir found, make a new one...
2086                 if (dirmode == 0 && preferreduserdirmode > 0)
2087                         for (dirmode = preferreduserdirmode;dirmode > 0;dirmode--)
2088                                 if (userdirstatus[dirmode] >= 0)
2089                                         break;
2090                 // and finally, we picked one...
2091                 FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2092                 Con_DPrintf("userdir %i is the winner\n", dirmode);
2093 #endif
2094         }
2095
2096         // if userdir equal to basedir, clear it to avoid confusion later
2097         if (!strcmp(fs_basedir, fs_userdir))
2098                 fs_userdir[0] = 0;
2099
2100         FS_ListGameDirs();
2101
2102         p = FS_CheckGameDir(gamedirname1);
2103         if(!p || p == fs_checkgamedir_missing)
2104                 Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
2105
2106         if(gamedirname2)
2107         {
2108                 p = FS_CheckGameDir(gamedirname2);
2109                 if(!p || p == fs_checkgamedir_missing)
2110                         Con_Printf(CON_WARN "WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
2111         }
2112
2113         // -game <gamedir>
2114         // Adds basedir/gamedir as an override game
2115         // LadyHavoc: now supports multiple -game directories
2116         for (i = 1;i < sys.argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
2117         {
2118                 if (!sys.argv[i])
2119                         continue;
2120                 if (!strcmp (sys.argv[i], "-game") && i < sys.argc-1)
2121                 {
2122                         i++;
2123                         p = FS_CheckGameDir(sys.argv[i]);
2124                         if(!p)
2125                                 Con_Printf("WARNING: Nasty -game name rejected: %s\n", sys.argv[i]);
2126                         if(p == fs_checkgamedir_missing)
2127                                 Con_Printf(CON_WARN "WARNING: -game %s%s/ not found!\n", fs_basedir, sys.argv[i]);
2128                         // add the gamedir to the list of active gamedirs
2129                         strlcpy (fs_gamedirs[fs_numgamedirs], sys.argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
2130                         fs_numgamedirs++;
2131                 }
2132         }
2133
2134         // generate the searchpath
2135         FS_Rescan();
2136
2137         if (Thread_HasThreads())
2138                 fs_mutex = Thread_CreateMutex();
2139 }
2140
2141 /*
2142 ================
2143 FS_Init_SelfPack
2144 ================
2145 */
2146 void FS_Init_SelfPack (void)
2147 {
2148         char *buf;
2149
2150         // Load darkplaces.opt from the FS.
2151         if (!Sys_CheckParm("-noopt"))
2152         {
2153                 buf = (char *) FS_SysLoadFile("darkplaces.opt", tempmempool, true, NULL);
2154                 if(buf)
2155                 {
2156                         COM_InsertFlags(buf);
2157                         Mem_Free(buf);
2158                 }
2159         }
2160
2161 #ifndef USE_RWOPS
2162         // Provide the SelfPack.
2163         if (!Sys_CheckParm("-noselfpack") && sys.selffd >= 0)
2164         {
2165                 fs_selfpack = FS_LoadPackPK3FromFD(sys.argv[0], sys.selffd, true);
2166                 if(fs_selfpack)
2167                 {
2168                         FS_AddSelfPack();
2169                         if (!Sys_CheckParm("-noopt"))
2170                         {
2171                                 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
2172                                 if(buf)
2173                                 {
2174                                         COM_InsertFlags(buf);
2175                                         Mem_Free(buf);
2176                                 }
2177                         }
2178                 }
2179         }
2180 #endif
2181 }
2182
2183 /*
2184 ================
2185 FS_Init
2186 ================
2187 */
2188
2189 void FS_Init(void)
2190 {
2191         fs_mempool = Mem_AllocPool("file management", 0, NULL);
2192
2193         FS_Init_Commands();
2194
2195         PK3_OpenLibrary ();
2196
2197         // initialize the self-pack (must be before COM_InitGameType as it may add command line options)
2198         FS_Init_SelfPack();
2199
2200         // detect gamemode from commandline options or executable name
2201         COM_InitGameType();
2202
2203         FS_Init_Dir();
2204 }
2205
2206 /*
2207 ================
2208 FS_Shutdown
2209 ================
2210 */
2211 void FS_Shutdown (void)
2212 {
2213         // close all pack files and such
2214         // (hopefully there aren't any other open files, but they'll be cleaned up
2215         //  by the OS anyway)
2216         FS_ClearSearchPath();
2217         Mem_FreePool (&fs_mempool);
2218         PK3_CloseLibrary ();
2219
2220 #ifdef WIN32
2221         Sys_FreeLibrary (&shfolder_dll);
2222         Sys_FreeLibrary (&shell32_dll);
2223         Sys_FreeLibrary (&ole32_dll);
2224 #endif
2225
2226         if (fs_mutex)
2227                 Thread_DestroyMutex(fs_mutex);
2228 }
2229
2230 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qbool nonblocking)
2231 {
2232         filedesc_t handle = FILEDESC_INVALID;
2233         int mod, opt;
2234         unsigned int ind;
2235         qbool dolock = false;
2236
2237         // Parse the mode string
2238         switch (mode[0])
2239         {
2240                 case 'r':
2241                         mod = O_RDONLY;
2242                         opt = 0;
2243                         break;
2244                 case 'w':
2245                         mod = O_WRONLY;
2246                         opt = O_CREAT | O_TRUNC;
2247                         break;
2248                 case 'a':
2249                         mod = O_WRONLY;
2250                         opt = O_CREAT | O_APPEND;
2251                         break;
2252                 default:
2253                         Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
2254                         return FILEDESC_INVALID;
2255         }
2256         for (ind = 1; mode[ind] != '\0'; ind++)
2257         {
2258                 switch (mode[ind])
2259                 {
2260                         case '+':
2261                                 mod = O_RDWR;
2262                                 break;
2263                         case 'b':
2264                                 opt |= O_BINARY;
2265                                 break;
2266                         case 'l':
2267                                 dolock = true;
2268                                 break;
2269                         default:
2270                                 Con_Printf(CON_ERROR "FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
2271                                                         filepath, mode, mode[ind]);
2272                 }
2273         }
2274
2275         if (nonblocking)
2276                 opt |= O_NONBLOCK;
2277
2278         if(Sys_CheckParm("-readonly") && mod != O_RDONLY)
2279                 return FILEDESC_INVALID;
2280
2281 #if USE_RWOPS
2282         if (dolock)
2283                 return FILEDESC_INVALID;
2284         handle = SDL_RWFromFile(filepath, mode);
2285 #else
2286 # ifdef WIN32
2287 #  if _MSC_VER >= 1400
2288         _sopen_s(&handle, filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2289 #  else
2290         handle = _sopen (filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2291 #  endif
2292 # else
2293         handle = open (filepath, mod | opt, 0666);
2294         if(handle >= 0 && dolock)
2295         {
2296                 struct flock l;
2297                 l.l_type = ((mod == O_RDONLY) ? F_RDLCK : F_WRLCK);
2298                 l.l_whence = SEEK_SET;
2299                 l.l_start = 0;
2300                 l.l_len = 0;
2301                 if(fcntl(handle, F_SETLK, &l) == -1)
2302                 {
2303                         FILEDESC_CLOSE(handle);
2304                         handle = -1;
2305                 }
2306         }
2307 # endif
2308 #endif
2309
2310         return handle;
2311 }
2312
2313 int FS_SysOpenFD(const char *filepath, const char *mode, qbool nonblocking)
2314 {
2315 #ifdef USE_RWOPS
2316         return -1;
2317 #else
2318         return FS_SysOpenFiledesc(filepath, mode, nonblocking);
2319 #endif
2320 }
2321
2322 /*
2323 ====================
2324 FS_SysOpen
2325
2326 Internal function used to create a qfile_t and open the relevant non-packed file on disk
2327 ====================
2328 */
2329 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qbool nonblocking)
2330 {
2331         qfile_t* file;
2332
2333         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2334         file->ungetc = EOF;
2335         file->handle = FS_SysOpenFiledesc(filepath, mode, nonblocking);
2336         if (!FILEDESC_ISVALID(file->handle))
2337         {
2338                 Mem_Free (file);
2339                 return NULL;
2340         }
2341
2342         file->filename = Mem_strdup(fs_mempool, filepath);
2343
2344         file->real_length = FILEDESC_SEEK (file->handle, 0, SEEK_END);
2345
2346         // For files opened in append mode, we start at the end of the file
2347         if (mode[0] == 'a')
2348                 file->position = file->real_length;
2349         else
2350                 FILEDESC_SEEK (file->handle, 0, SEEK_SET);
2351
2352         return file;
2353 }
2354
2355
2356 /*
2357 ===========
2358 FS_OpenPackedFile
2359
2360 Open a packed file using its package file descriptor
2361 ===========
2362 */
2363 static qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
2364 {
2365         packfile_t *pfile;
2366         filedesc_t dup_handle;
2367         qfile_t* file;
2368
2369         pfile = &pack->files[pack_ind];
2370
2371         // If we don't have the true offset, get it now
2372         if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
2373                 if (!PK3_GetTrueFileOffset (pfile, pack))
2374                         return NULL;
2375
2376 #ifndef LINK_TO_ZLIB
2377         // No Zlib DLL = no compressed files
2378         if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2379         {
2380                 Con_Printf(CON_WARN "WARNING: can't open the compressed file %s\n"
2381                                         "You need the Zlib DLL to use compressed files\n",
2382                                         pfile->name);
2383                 return NULL;
2384         }
2385 #endif
2386
2387         // LadyHavoc: FILEDESC_SEEK affects all duplicates of a handle so we do it before
2388         // the dup() call to avoid having to close the dup_handle on error here
2389         if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
2390         {
2391                 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %08x%08x)\n",
2392                                         pfile->name, pack->filename, (unsigned int)(pfile->offset >> 32), (unsigned int)(pfile->offset));
2393                 return NULL;
2394         }
2395
2396         dup_handle = FILEDESC_DUP (pack->filename, pack->handle);
2397         if (!FILEDESC_ISVALID(dup_handle))
2398         {
2399                 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2400                 return NULL;
2401         }
2402
2403         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2404         memset (file, 0, sizeof (*file));
2405         file->handle = dup_handle;
2406         file->flags = QFILE_FLAG_PACKED;
2407         file->real_length = pfile->realsize;
2408         file->offset = pfile->offset;
2409         file->position = 0;
2410         file->ungetc = EOF;
2411
2412         if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2413         {
2414                 ztoolkit_t *ztk;
2415
2416                 file->flags |= QFILE_FLAG_DEFLATED;
2417
2418                 // We need some more variables
2419                 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2420
2421                 ztk->comp_length = pfile->packsize;
2422
2423                 // Initialize zlib stream
2424                 ztk->zstream.next_in = ztk->input;
2425                 ztk->zstream.avail_in = 0;
2426
2427                 /* From Zlib's "unzip.c":
2428                  *
2429                  * windowBits is passed < 0 to tell that there is no zlib header.
2430                  * Note that in this case inflate *requires* an extra "dummy" byte
2431                  * after the compressed stream in order to complete decompression and
2432                  * return Z_STREAM_END.
2433                  * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2434                  * size of both compressed and uncompressed data
2435                  */
2436                 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2437                 {
2438                         Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2439                         FILEDESC_CLOSE(dup_handle);
2440                         Mem_Free(file);
2441                         return NULL;
2442                 }
2443
2444                 ztk->zstream.next_out = file->buff;
2445                 ztk->zstream.avail_out = sizeof (file->buff);
2446
2447                 file->ztk = ztk;
2448         }
2449
2450         return file;
2451 }
2452
2453 /*
2454 ====================
2455 FS_CheckNastyPath
2456
2457 Return true if the path should be rejected due to one of the following:
2458 1: path elements that are non-portable
2459 2: path elements that would allow access to files outside the game directory,
2460    or are just not a good idea for a mod to be using.
2461 ====================
2462 */
2463 int FS_CheckNastyPath (const char *path, qbool isgamedir)
2464 {
2465         // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2466         if (!path[0])
2467                 return 2;
2468
2469         // Windows: don't allow \ in filenames (windows-only), period.
2470         // (on Windows \ is a directory separator, but / is also supported)
2471         if (strstr(path, "\\"))
2472                 return 1; // non-portable
2473
2474         // Mac: don't allow Mac-only filenames - : is a directory separator
2475         // instead of /, but we rely on / working already, so there's no reason to
2476         // support a Mac-only path
2477         // Amiga and Windows: : tries to go to root of drive
2478         if (strstr(path, ":"))
2479                 return 1; // non-portable attempt to go to root of drive
2480
2481         // Amiga: // is parent directory
2482         if (strstr(path, "//"))
2483                 return 1; // non-portable attempt to go to parent directory
2484
2485         // all: don't allow going to parent directory (../ or /../)
2486         if (strstr(path, ".."))
2487                 return 2; // attempt to go outside the game directory
2488
2489         // Windows and UNIXes: don't allow absolute paths
2490         if (path[0] == '/')
2491                 return 2; // attempt to go outside the game directory
2492
2493         // all: don't allow . character immediately before a slash, this catches all imaginable cases of ./, ../, .../, etc
2494         if (strstr(path, "./"))
2495                 return 2; // possible attempt to go outside the game directory
2496
2497         // all: forbid trailing slash on gamedir
2498         if (isgamedir && path[strlen(path)-1] == '/')
2499                 return 2;
2500
2501         // all: forbid leading dot on any filename for any reason
2502         if (strstr(path, "/."))
2503                 return 2; // attempt to go outside the game directory
2504
2505         // after all these checks we're pretty sure it's a / separated filename
2506         // and won't do much if any harm
2507         return false;
2508 }
2509
2510 /*
2511 ====================
2512 FS_SanitizePath
2513
2514 Sanitize path (replace non-portable characters 
2515 with portable ones in-place, etc)
2516 ====================
2517 */
2518 void FS_SanitizePath(char *path)
2519 {
2520         int i, size;
2521
2522         for(i = 0, size = strlen(path); i < size; i++)
2523         {
2524                 if(path[i] == '\\')
2525                         path[i] = '/';
2526         }
2527 }
2528
2529 /*
2530 ====================
2531 FS_FindFile
2532
2533 Look for a file in the packages and in the filesystem
2534
2535 Return the searchpath where the file was found (or NULL)
2536 and the file index in the package if relevant
2537 ====================
2538 */
2539 static searchpath_t *FS_FindFile (const char *name, int* index, qbool quiet)
2540 {
2541         searchpath_t *search;
2542         pack_t *pak;
2543
2544         // search through the path, one element at a time
2545         for (search = fs_searchpaths;search;search = search->next)
2546         {
2547                 // is the element a pak file?
2548                 if (search->pack && !search->pack->vpack)
2549                 {
2550                         int (*strcmp_funct) (const char* str1, const char* str2);
2551                         int left, right, middle;
2552
2553                         pak = search->pack;
2554                         strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2555
2556                         // Look for the file (binary search)
2557                         left = 0;
2558                         right = pak->numfiles - 1;
2559                         while (left <= right)
2560                         {
2561                                 int diff;
2562
2563                                 middle = (left + right) / 2;
2564                                 diff = strcmp_funct (pak->files[middle].name, name);
2565
2566                                 // Found it
2567                                 if (!diff)
2568                                 {
2569                                         if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2570                                         {
2571                                                 // yes, but the first one is empty so we treat it as not being there
2572                                                 if (!quiet && developer_extra.integer)
2573                                                         Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2574
2575                                                 if (index != NULL)
2576                                                         *index = -1;
2577                                                 return NULL;
2578                                         }
2579
2580                                         if (!quiet && developer_extra.integer)
2581                                                 Con_DPrintf("FS_FindFile: %s in %s\n",
2582                                                                         pak->files[middle].name, pak->filename);
2583
2584                                         if (index != NULL)
2585                                                 *index = middle;
2586                                         return search;
2587                                 }
2588
2589                                 // If we're too far in the list
2590                                 if (diff > 0)
2591                                         right = middle - 1;
2592                                 else
2593                                         left = middle + 1;
2594                         }
2595                 }
2596                 else
2597                 {
2598                         char netpath[MAX_OSPATH];
2599                         dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2600                         if (FS_SysFileExists (netpath))
2601                         {
2602                                 if (!quiet && developer_extra.integer)
2603                                         Con_DPrintf("FS_FindFile: %s\n", netpath);
2604
2605                                 if (index != NULL)
2606                                         *index = -1;
2607                                 return search;
2608                         }
2609                 }
2610         }
2611
2612         if (!quiet && developer_extra.integer)
2613                 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2614
2615         if (index != NULL)
2616                 *index = -1;
2617         return NULL;
2618 }
2619
2620
2621 /*
2622 ===========
2623 FS_OpenReadFile
2624
2625 Look for a file in the search paths and open it in read-only mode
2626 ===========
2627 */
2628 static qfile_t *FS_OpenReadFile (const char *filename, qbool quiet, qbool nonblocking, int symlinkLevels)
2629 {
2630         searchpath_t *search;
2631         int pack_ind;
2632
2633         search = FS_FindFile (filename, &pack_ind, quiet);
2634
2635         // Not found?
2636         if (search == NULL)
2637                 return NULL;
2638
2639         // Found in the filesystem?
2640         if (pack_ind < 0)
2641         {
2642                 // this works with vpacks, so we are fine
2643                 char path [MAX_OSPATH];
2644                 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2645                 return FS_SysOpen (path, "rb", nonblocking);
2646         }
2647
2648         // So, we found it in a package...
2649
2650         // Is it a PK3 symlink?
2651         // TODO also handle directory symlinks by parsing the whole structure...
2652         // but heck, file symlinks are good enough for now
2653         if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2654         {
2655                 if(symlinkLevels <= 0)
2656                 {
2657                         Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2658                         return NULL;
2659                 }
2660                 else
2661                 {
2662                         char linkbuf[MAX_QPATH];
2663                         fs_offset_t count;
2664                         qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2665                         const char *mergeslash;
2666                         char *mergestart;
2667
2668                         if(!linkfile)
2669                                 return NULL;
2670                         count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2671                         FS_Close(linkfile);
2672                         if(count < 0)
2673                                 return NULL;
2674                         linkbuf[count] = 0;
2675                         
2676                         // Now combine the paths...
2677                         mergeslash = strrchr(filename, '/');
2678                         mergestart = linkbuf;
2679                         if(!mergeslash)
2680                                 mergeslash = filename;
2681                         while(!strncmp(mergestart, "../", 3))
2682                         {
2683                                 mergestart += 3;
2684                                 while(mergeslash > filename)
2685                                 {
2686                                         --mergeslash;
2687                                         if(*mergeslash == '/')
2688                                                 break;
2689                                 }
2690                         }
2691                         // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2692                         if(mergeslash == filename)
2693                         {
2694                                 // Either mergeslash == filename, then we just replace the name (done below)
2695                         }
2696                         else
2697                         {
2698                                 // Or, we append the name after mergeslash;
2699                                 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2700                                 int spaceNeeded = mergeslash - filename + 1;
2701                                 int spaceRemoved = mergestart - linkbuf;
2702                                 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2703                                 {
2704                                         Con_DPrintf("symlink: too long path rejected\n");
2705                                         return NULL;
2706                                 }
2707                                 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2708                                 memcpy(linkbuf, filename, spaceNeeded);
2709                                 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2710                                 mergestart = linkbuf;
2711                         }
2712                         if (!quiet && developer_loading.integer)
2713                                 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2714                         if(FS_CheckNastyPath (mergestart, false))
2715                         {
2716                                 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2717                                 return NULL;
2718                         }
2719                         return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2720                 }
2721         }
2722
2723         return FS_OpenPackedFile (search->pack, pack_ind);
2724 }
2725
2726
2727 /*
2728 =============================================================================
2729
2730 MAIN PUBLIC FUNCTIONS
2731
2732 =============================================================================
2733 */
2734
2735 /*
2736 ====================
2737 FS_OpenRealFile
2738
2739 Open a file in the userpath. The syntax is the same as fopen
2740 Used for savegame scanning in menu, and all file writing.
2741 ====================
2742 */
2743 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qbool quiet)
2744 {
2745         char real_path [MAX_OSPATH];
2746
2747         if (FS_CheckNastyPath(filepath, false))
2748         {
2749                 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2750                 return NULL;
2751         }
2752
2753         dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2754
2755         // If the file is opened in "write", "append", or "read/write" mode,
2756         // create directories up to the file.
2757         if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2758                 FS_CreatePath (real_path);
2759         return FS_SysOpen (real_path, mode, false);
2760 }
2761
2762
2763 /*
2764 ====================
2765 FS_OpenVirtualFile
2766
2767 Open a file. The syntax is the same as fopen
2768 ====================
2769 */
2770 qfile_t* FS_OpenVirtualFile (const char* filepath, qbool quiet)
2771 {
2772         qfile_t *result = NULL;
2773         if (FS_CheckNastyPath(filepath, false))
2774         {
2775                 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2776                 return NULL;
2777         }
2778
2779         if (fs_mutex) Thread_LockMutex(fs_mutex);
2780         result = FS_OpenReadFile (filepath, quiet, false, 16);
2781         if (fs_mutex) Thread_UnlockMutex(fs_mutex);
2782         return result;
2783 }
2784
2785
2786 /*
2787 ====================
2788 FS_FileFromData
2789
2790 Open a file. The syntax is the same as fopen
2791 ====================
2792 */
2793 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qbool quiet)
2794 {
2795         qfile_t* file;
2796         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2797         memset (file, 0, sizeof (*file));
2798         file->flags = QFILE_FLAG_DATA;
2799         file->ungetc = EOF;
2800         file->real_length = size;
2801         file->data = data;
2802         return file;
2803 }
2804
2805 /*
2806 ====================
2807 FS_Close
2808
2809 Close a file
2810 ====================
2811 */
2812 int FS_Close (qfile_t* file)
2813 {
2814         if(file->flags & QFILE_FLAG_DATA)
2815         {
2816                 Mem_Free(file);
2817                 return 0;
2818         }
2819
2820         if (FILEDESC_CLOSE (file->handle))
2821                 return EOF;
2822
2823         if (file->filename)
2824         {
2825                 if (file->flags & QFILE_FLAG_REMOVE)
2826                 {
2827                         if (remove(file->filename) == -1)
2828                         {
2829                                 // No need to report this. If removing a just
2830                                 // written file failed, this most likely means
2831                                 // someone else deleted it first - which we
2832                                 // like.
2833                         }
2834                 }
2835
2836                 Mem_Free((void *) file->filename);
2837         }
2838
2839         if (file->ztk)
2840         {
2841                 qz_inflateEnd (&file->ztk->zstream);
2842                 Mem_Free (file->ztk);
2843         }
2844
2845         Mem_Free (file);
2846         return 0;
2847 }
2848
2849 void FS_RemoveOnClose(qfile_t* file)
2850 {
2851         file->flags |= QFILE_FLAG_REMOVE;
2852 }
2853
2854 /*
2855 ====================
2856 FS_Write
2857
2858 Write "datasize" bytes into a file
2859 ====================
2860 */
2861 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2862 {
2863         fs_offset_t written = 0;
2864
2865         // If necessary, seek to the exact file position we're supposed to be
2866         if (file->buff_ind != file->buff_len)
2867         {
2868                 if (FILEDESC_SEEK (file->handle, file->buff_ind - file->buff_len, SEEK_CUR) == -1)
2869                 {
2870                         Con_Printf(CON_WARN "WARNING: could not seek in %s.\n", file->filename);
2871                 }
2872         }
2873
2874         // Purge cached data
2875         FS_Purge (file);
2876
2877         // Write the buffer and update the position
2878         // LadyHavoc: to hush a warning about passing size_t to an unsigned int parameter on Win64 we do this as multiple writes if the size would be too big for an integer (we never write that big in one go, but it's a theory)
2879         while (written < (fs_offset_t)datasize)
2880         {
2881                 // figure out how much to write in one chunk
2882                 fs_offset_t maxchunk = 1<<30; // 1 GiB
2883                 int chunk = (int)min((fs_offset_t)datasize - written, maxchunk);
2884                 int result = (int)FILEDESC_WRITE (file->handle, (const unsigned char *)data + written, chunk);
2885                 // if at least some was written, add it to our accumulator
2886                 if (result > 0)
2887                         written += result;
2888                 // if the result is not what we expected, consider the write to be incomplete
2889                 if (result != chunk)
2890                         break;
2891         }
2892         file->position = FILEDESC_SEEK (file->handle, 0, SEEK_CUR);
2893         if (file->real_length < file->position)
2894                 file->real_length = file->position;
2895
2896         // note that this will never be less than 0 even if the write failed
2897         return written;
2898 }
2899
2900
2901 /*
2902 ====================
2903 FS_Read
2904
2905 Read up to "buffersize" bytes from a file
2906 ====================
2907 */
2908 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2909 {
2910         fs_offset_t count, done;
2911
2912         if (buffersize == 0 || !buffer)
2913                 return 0;
2914
2915         // Get rid of the ungetc character
2916         if (file->ungetc != EOF)
2917         {
2918                 ((char*)buffer)[0] = file->ungetc;
2919                 buffersize--;
2920                 file->ungetc = EOF;
2921                 done = 1;
2922         }
2923         else
2924                 done = 0;
2925
2926         if(file->flags & QFILE_FLAG_DATA)
2927         {
2928                 size_t left = file->real_length - file->position;
2929                 if(buffersize > left)
2930                         buffersize = left;
2931                 memcpy(buffer, file->data + file->position, buffersize);
2932                 file->position += buffersize;
2933                 return buffersize;
2934         }
2935
2936         // First, we copy as many bytes as we can from "buff"
2937         if (file->buff_ind < file->buff_len)
2938         {
2939                 count = file->buff_len - file->buff_ind;
2940                 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2941                 done += count;
2942                 memcpy (buffer, &file->buff[file->buff_ind], count);
2943                 file->buff_ind += count;
2944
2945                 buffersize -= count;
2946                 if (buffersize == 0)
2947                         return done;
2948         }
2949
2950         // NOTE: at this point, the read buffer is always empty
2951
2952         // If the file isn't compressed
2953         if (! (file->flags & QFILE_FLAG_DEFLATED))
2954         {
2955                 fs_offset_t nb;
2956
2957                 // We must take care to not read after the end of the file
2958                 count = file->real_length - file->position;
2959
2960                 // If we have a lot of data to get, put them directly into "buffer"
2961                 if (buffersize > sizeof (file->buff) / 2)
2962                 {
2963                         if (count > (fs_offset_t)buffersize)
2964                                 count = (fs_offset_t)buffersize;
2965                         if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2966                         {
2967                                 // Seek failed. When reading from a pipe, and
2968                                 // the caller never called FS_Seek, this still
2969                                 // works fine.  So no reporting this error.
2970                         }
2971                         nb = FILEDESC_READ (file->handle, &((unsigned char*)buffer)[done], count);
2972                         if (nb > 0)
2973                         {
2974                                 done += nb;
2975                                 file->position += nb;
2976
2977                                 // Purge cached data
2978                                 FS_Purge (file);
2979                         }
2980                 }
2981                 else
2982                 {
2983                         if (count > (fs_offset_t)sizeof (file->buff))
2984                                 count = (fs_offset_t)sizeof (file->buff);
2985                         if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2986                         {
2987                                 // Seek failed. When reading from a pipe, and
2988                                 // the caller never called FS_Seek, this still
2989                                 // works fine.  So no reporting this error.
2990                         }
2991                         nb = FILEDESC_READ (file->handle, file->buff, count);
2992                         if (nb > 0)
2993                         {
2994                                 file->buff_len = nb;
2995                                 file->position += nb;
2996
2997                                 // Copy the requested data in "buffer" (as much as we can)
2998                                 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2999                                 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3000                                 file->buff_ind = count;
3001                                 done += count;
3002                         }
3003                 }
3004
3005                 return done;
3006         }
3007
3008         // If the file is compressed, it's more complicated...
3009         // We cycle through a few operations until we have read enough data
3010         while (buffersize > 0)
3011         {
3012                 ztoolkit_t *ztk = file->ztk;
3013                 int error;
3014
3015                 // NOTE: at this point, the read buffer is always empty
3016
3017                 // If "input" is also empty, we need to refill it
3018                 if (ztk->in_ind == ztk->in_len)
3019                 {
3020                         // If we are at the end of the file
3021                         if (file->position == file->real_length)
3022                                 return done;
3023
3024                         count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
3025                         if (count > (fs_offset_t)sizeof (ztk->input))
3026                                 count = (fs_offset_t)sizeof (ztk->input);
3027                         FILEDESC_SEEK (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
3028                         if (FILEDESC_READ (file->handle, ztk->input, count) != count)
3029                         {
3030                                 Con_Printf ("FS_Read: unexpected end of file\n");
3031                                 break;
3032                         }
3033
3034                         ztk->in_ind = 0;
3035                         ztk->in_len = count;
3036                         ztk->in_position += count;
3037                 }
3038
3039                 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
3040                 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
3041
3042                 // Now that we are sure we have compressed data available, we need to determine
3043                 // if it's better to inflate it in "file->buff" or directly in "buffer"
3044
3045                 // Inflate the data in "file->buff"
3046                 if (buffersize < sizeof (file->buff) / 2)
3047                 {
3048                         ztk->zstream.next_out = file->buff;
3049                         ztk->zstream.avail_out = sizeof (file->buff);
3050                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3051                         if (error != Z_OK && error != Z_STREAM_END)
3052                         {
3053                                 Con_Printf ("FS_Read: Can't inflate file\n");
3054                                 break;
3055                         }
3056                         ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3057
3058                         file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
3059                         file->position += file->buff_len;
3060
3061                         // Copy the requested data in "buffer" (as much as we can)
3062                         count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3063                         memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3064                         file->buff_ind = count;
3065                 }
3066
3067                 // Else, we inflate directly in "buffer"
3068                 else
3069                 {
3070                         ztk->zstream.next_out = &((unsigned char*)buffer)[done];
3071                         ztk->zstream.avail_out = (unsigned int)buffersize;
3072                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3073                         if (error != Z_OK && error != Z_STREAM_END)
3074                         {
3075                                 Con_Printf ("FS_Read: Can't inflate file\n");
3076                                 break;
3077                         }
3078                         ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3079
3080                         // How much data did it inflate?
3081                         count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
3082                         file->position += count;
3083
3084                         // Purge cached data
3085                         FS_Purge (file);
3086                 }
3087
3088                 done += count;
3089                 buffersize -= count;
3090         }
3091
3092         return done;
3093 }
3094
3095
3096 /*
3097 ====================
3098 FS_Print
3099
3100 Print a string into a file
3101 ====================
3102 */
3103 int FS_Print (qfile_t* file, const char *msg)
3104 {
3105         return (int)FS_Write (file, msg, strlen (msg));
3106 }
3107
3108 /*
3109 ====================
3110 FS_Printf
3111
3112 Print a string into a file
3113 ====================
3114 */
3115 int FS_Printf(qfile_t* file, const char* format, ...)
3116 {
3117         int result;
3118         va_list args;
3119
3120         va_start (args, format);
3121         result = FS_VPrintf (file, format, args);
3122         va_end (args);
3123
3124         return result;
3125 }
3126
3127
3128 /*
3129 ====================
3130 FS_VPrintf
3131
3132 Print a string into a file
3133 ====================
3134 */
3135 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
3136 {
3137         int len;
3138         fs_offset_t buff_size = MAX_INPUTLINE;
3139         char *tempbuff;
3140
3141         for (;;)
3142         {
3143                 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
3144                 len = dpvsnprintf (tempbuff, buff_size, format, ap);
3145                 if (len >= 0 && len < buff_size)
3146                         break;
3147                 Mem_Free (tempbuff);
3148                 buff_size *= 2;
3149         }
3150
3151         len = FILEDESC_WRITE (file->handle, tempbuff, len);
3152         Mem_Free (tempbuff);
3153
3154         return len;
3155 }
3156
3157
3158 /*
3159 ====================
3160 FS_Getc
3161
3162 Get the next character of a file
3163 ====================
3164 */
3165 int FS_Getc (qfile_t* file)
3166 {
3167         unsigned char c;
3168
3169         if (FS_Read (file, &c, 1) != 1)
3170                 return EOF;
3171
3172         return c;
3173 }
3174
3175
3176 /*
3177 ====================
3178 FS_UnGetc
3179
3180 Put a character back into the read buffer (only supports one character!)
3181 ====================
3182 */
3183 int FS_UnGetc (qfile_t* file, unsigned char c)
3184 {
3185         // If there's already a character waiting to be read
3186         if (file->ungetc != EOF)
3187                 return EOF;
3188
3189         file->ungetc = c;
3190         return c;
3191 }
3192
3193
3194 /*
3195 ====================
3196 FS_Seek
3197
3198 Move the position index in a file
3199 ====================
3200 */
3201 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
3202 {
3203         ztoolkit_t *ztk;
3204         unsigned char* buffer;
3205         fs_offset_t buffersize;
3206
3207         // Compute the file offset
3208         switch (whence)
3209         {
3210                 case SEEK_CUR:
3211                         offset += file->position - file->buff_len + file->buff_ind;
3212                         break;
3213
3214                 case SEEK_SET:
3215                         break;
3216
3217                 case SEEK_END:
3218                         offset += file->real_length;
3219                         break;
3220
3221                 default:
3222                         return -1;
3223         }
3224         if (offset < 0 || offset > file->real_length)
3225                 return -1;
3226
3227         if(file->flags & QFILE_FLAG_DATA)
3228         {
3229                 file->position = offset;
3230                 return 0;
3231         }
3232
3233         // If we have the data in our read buffer, we don't need to actually seek
3234         if (file->position - file->buff_len <= offset && offset <= file->position)
3235         {
3236                 file->buff_ind = offset + file->buff_len - file->position;
3237                 return 0;
3238         }
3239
3240         // Purge cached data
3241         FS_Purge (file);
3242
3243         // Unpacked or uncompressed files can seek directly
3244         if (! (file->flags & QFILE_FLAG_DEFLATED))
3245         {
3246                 if (FILEDESC_SEEK (file->handle, file->offset + offset, SEEK_SET) == -1)
3247                         return -1;
3248                 file->position = offset;
3249                 return 0;
3250         }
3251
3252         // Seeking in compressed files is more a hack than anything else,
3253         // but we need to support it, so here we go.
3254         ztk = file->ztk;
3255
3256         // If we have to go back in the file, we need to restart from the beginning
3257         if (offset <= file->position)
3258         {
3259                 ztk->in_ind = 0;
3260                 ztk->in_len = 0;
3261                 ztk->in_position = 0;
3262                 file->position = 0;
3263                 if (FILEDESC_SEEK (file->handle, file->offset, SEEK_SET) == -1)
3264                         Con_Printf("IMPOSSIBLE: couldn't seek in already opened pk3 file.\n");
3265
3266                 // Reset the Zlib stream
3267                 ztk->zstream.next_in = ztk->input;
3268                 ztk->zstream.avail_in = 0;
3269                 qz_inflateReset (&ztk->zstream);
3270         }
3271
3272         // We need a big buffer to force inflating into it directly
3273         buffersize = 2 * sizeof (file->buff);
3274         buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
3275
3276         // Skip all data until we reach the requested offset
3277         while (offset > (file->position - file->buff_len + file->buff_ind))
3278         {
3279                 fs_offset_t diff = offset - (file->position - file->buff_len + file->buff_ind);
3280                 fs_offset_t count, len;
3281
3282                 count = (diff > buffersize) ? buffersize : diff;
3283                 len = FS_Read (file, buffer, count);
3284                 if (len != count)
3285                 {
3286                         Mem_Free (buffer);
3287                         return -1;
3288                 }
3289         }
3290
3291         Mem_Free (buffer);
3292         return 0;
3293 }
3294
3295
3296 /*
3297 ====================
3298 FS_Tell
3299
3300 Give the current position in a file
3301 ====================
3302 */
3303 fs_offset_t FS_Tell (qfile_t* file)
3304 {
3305         return file->position - file->buff_len + file->buff_ind;
3306 }
3307
3308
3309 /*
3310 ====================
3311 FS_FileSize
3312
3313 Give the total size of a file
3314 ====================
3315 */
3316 fs_offset_t FS_FileSize (qfile_t* file)
3317 {
3318         return file->real_length;
3319 }
3320
3321
3322 /*
3323 ====================
3324 FS_Purge
3325
3326 Erases any buffered input or output data
3327 ====================
3328 */
3329 void FS_Purge (qfile_t* file)
3330 {
3331         file->buff_len = 0;
3332         file->buff_ind = 0;
3333         file->ungetc = EOF;
3334 }
3335
3336
3337 /*
3338 ============
3339 FS_LoadAndCloseQFile
3340
3341 Loads full content of a qfile_t and closes it.
3342 Always appends a 0 byte.
3343 ============
3344 */
3345 static unsigned char *FS_LoadAndCloseQFile (qfile_t *file, const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3346 {
3347         unsigned char *buf = NULL;
3348         fs_offset_t filesize = 0;
3349
3350         if (file)
3351         {
3352                 filesize = file->real_length;
3353                 if(filesize < 0)
3354                 {
3355                         Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
3356                         FS_Close(file);
3357                         return NULL;
3358                 }
3359
3360                 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
3361                 buf[filesize] = '\0';
3362                 FS_Read (file, buf, filesize);
3363                 FS_Close (file);
3364                 if (developer_loadfile.integer)
3365                         Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
3366         }
3367
3368         if (filesizepointer)
3369                 *filesizepointer = filesize;
3370         return buf;
3371 }
3372
3373
3374 /*
3375 ============
3376 FS_LoadFile
3377
3378 Filename are relative to the quake directory.
3379 Always appends a 0 byte.
3380 ============
3381 */
3382 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3383 {
3384         qfile_t *file = FS_OpenVirtualFile(path, quiet);
3385         return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3386 }
3387
3388
3389 /*
3390 ============
3391 FS_SysLoadFile
3392
3393 Filename are OS paths.
3394 Always appends a 0 byte.
3395 ============
3396 */
3397 unsigned char *FS_SysLoadFile (const char *path, mempool_t *pool, qbool quiet, fs_offset_t *filesizepointer)
3398 {
3399         qfile_t *file = FS_SysOpen(path, "rb", false);
3400         return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3401 }
3402
3403
3404 /*
3405 ============
3406 FS_WriteFile
3407
3408 The filename will be prefixed by the current game directory
3409 ============
3410 */
3411 qbool FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
3412 {
3413         qfile_t *file;
3414         size_t i;
3415         fs_offset_t lentotal;
3416
3417         file = FS_OpenRealFile(filename, "wb", false);
3418         if (!file)
3419         {
3420                 Con_Printf("FS_WriteFile: failed on %s\n", filename);
3421                 return false;
3422         }
3423
3424         lentotal = 0;
3425         for(i = 0; i < count; ++i)
3426                 lentotal += len[i];
3427         Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
3428         for(i = 0; i < count; ++i)
3429                 FS_Write (file, data[i], len[i]);
3430         FS_Close (file);
3431         return true;
3432 }
3433
3434 qbool FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
3435 {
3436         return FS_WriteFileInBlocks(filename, &data, &len, 1);
3437 }
3438
3439
3440 /*
3441 =============================================================================
3442
3443 OTHERS PUBLIC FUNCTIONS
3444
3445 =============================================================================
3446 */
3447
3448 /*
3449 ============
3450 FS_StripExtension
3451 ============
3452 */
3453 void FS_StripExtension (const char *in, char *out, size_t size_out)
3454 {
3455         char *last = NULL;
3456         char currentchar;
3457
3458         if (size_out == 0)
3459                 return;
3460
3461         while ((currentchar = *in) && size_out > 1)
3462         {
3463                 if (currentchar == '.')
3464                         last = out;
3465                 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3466                         last = NULL;
3467                 *out++ = currentchar;
3468                 in++;
3469                 size_out--;
3470         }
3471         if (last)
3472                 *last = 0;
3473         else
3474                 *out = 0;
3475 }
3476
3477
3478 /*
3479 ==================
3480 FS_DefaultExtension
3481 ==================
3482 */
3483 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3484 {
3485         const char *src;
3486
3487         // if path doesn't have a .EXT, append extension
3488         // (extension should include the .)
3489         src = path + strlen(path);
3490
3491         while (*src != '/' && src != path)
3492         {
3493                 if (*src == '.')
3494                         return;                 // it has an extension
3495                 src--;
3496         }
3497
3498         strlcat (path, extension, size_path);
3499 }
3500
3501
3502 /*
3503 ==================
3504 FS_FileType
3505
3506 Look for a file in the packages and in the filesystem
3507 ==================
3508 */
3509 int FS_FileType (const char *filename)
3510 {
3511         searchpath_t *search;
3512         char fullpath[MAX_OSPATH];
3513
3514         search = FS_FindFile (filename, NULL, true);
3515         if(!search)
3516                 return FS_FILETYPE_NONE;
3517
3518         if(search->pack && !search->pack->vpack)
3519                 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3520
3521         dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3522         return FS_SysFileType(fullpath);
3523 }
3524
3525
3526 /*
3527 ==================
3528 FS_FileExists
3529
3530 Look for a file in the packages and in the filesystem
3531 ==================
3532 */
3533 qbool FS_FileExists (const char *filename)
3534 {
3535         return (FS_FindFile (filename, NULL, true) != NULL);
3536 }
3537
3538
3539 /*
3540 ==================
3541 FS_SysFileExists
3542
3543 Look for a file in the filesystem only
3544 ==================
3545 */
3546 int FS_SysFileType (const char *path)
3547 {
3548 #if WIN32
3549 // Sajt - some older sdks are missing this define
3550 # ifndef INVALID_FILE_ATTRIBUTES
3551 #  define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3552 # endif
3553
3554         DWORD result = GetFileAttributes(path);
3555
3556         if(result == INVALID_FILE_ATTRIBUTES)
3557                 return FS_FILETYPE_NONE;
3558
3559         if(result & FILE_ATTRIBUTE_DIRECTORY)
3560                 return FS_FILETYPE_DIRECTORY;
3561
3562         return FS_FILETYPE_FILE;
3563 #else
3564         struct stat buf;
3565
3566         if (stat (path,&buf) == -1)
3567                 return FS_FILETYPE_NONE;
3568
3569 #ifndef S_ISDIR
3570 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3571 #endif
3572         if(S_ISDIR(buf.st_mode))
3573                 return FS_FILETYPE_DIRECTORY;
3574
3575         return FS_FILETYPE_FILE;
3576 #endif
3577 }
3578
3579 qbool FS_SysFileExists (const char *path)
3580 {
3581         return FS_SysFileType (path) != FS_FILETYPE_NONE;
3582 }
3583
3584 /*
3585 ===========
3586 FS_Search
3587
3588 Allocate and fill a search structure with information on matching filenames.
3589 ===========
3590 */
3591 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet, const char *packfile)
3592 {
3593         fssearch_t *search;
3594         searchpath_t *searchpath;
3595         pack_t *pak;
3596         int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3597         stringlist_t resultlist;
3598         stringlist_t dirlist;
3599         stringlist_t matchedSet, foundSet;
3600         const char *start, *slash, *backslash, *colon, *separator;
3601         char *basepath;
3602
3603         for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3604                 ;
3605
3606         if (i > 0)
3607         {
3608                 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3609                 return NULL;
3610         }
3611
3612         stringlistinit(&resultlist);
3613         stringlistinit(&dirlist);
3614         search = NULL;
3615         slash = strrchr(pattern, '/');
3616         backslash = strrchr(pattern, '\\');
3617         colon = strrchr(pattern, ':');
3618         separator = max(slash, backslash);
3619         separator = max(separator, colon);
3620         basepathlength = separator ? (separator + 1 - pattern) : 0;
3621         basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3622         if (basepathlength)
3623                 memcpy(basepath, pattern, basepathlength);
3624         basepath[basepathlength] = 0;
3625
3626         // search through the path, one element at a time
3627         for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3628         {
3629                 // is the element a pak file?
3630                 if (searchpath->pack && !searchpath->pack->vpack)
3631                 {
3632                         // look through all the pak file elements
3633                         pak = searchpath->pack;
3634                         if(packfile)
3635                         {
3636                                 if(strcmp(packfile, pak->shortname))
3637                                         continue;
3638                         }
3639                         for (i = 0;i < pak->numfiles;i++)
3640                         {
3641                                 char temp[MAX_OSPATH];
3642                                 strlcpy(temp, pak->files[i].name, sizeof(temp));
3643                                 while (temp[0])
3644                                 {
3645                                         if (matchpattern(temp, (char *)pattern, true))
3646                                         {
3647                                                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3648                                                         if (!strcmp(resultlist.strings[resultlistindex], temp))
3649                                                                 break;
3650                                                 if (resultlistindex == resultlist.numstrings)
3651                                                 {
3652                                                         stringlistappend(&resultlist, temp);
3653                                                         if (!quiet && developer_loading.integer)
3654                                                                 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3655                                                 }
3656                                         }
3657                                         // strip off one path element at a time until empty
3658                                         // this way directories are added to the listing if they match the pattern
3659                                         slash = strrchr(temp, '/');
3660                                         backslash = strrchr(temp, '\\');
3661                                         colon = strrchr(temp, ':');
3662                                         separator = temp;
3663                                         if (separator < slash)
3664                                                 separator = slash;
3665                                         if (separator < backslash)
3666                                                 separator = backslash;
3667                                         if (separator < colon)
3668                                                 separator = colon;
3669                                         *((char *)separator) = 0;
3670                                 }
3671                         }
3672                 }
3673                 else
3674                 {
3675                         if(packfile)
3676                                 continue;
3677
3678                         start = pattern;
3679
3680                         stringlistinit(&matchedSet);
3681                         stringlistinit(&foundSet);
3682                         // add a first entry to the set
3683                         stringlistappend(&matchedSet, "");
3684                         // iterate through pattern's path
3685                         while (*start)
3686                         {
3687                                 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3688                                 char subpath[MAX_OSPATH];
3689                                 char subpattern[MAX_OSPATH];
3690
3691                                 // find the next wildcard
3692                                 wildcard = strchr(start, '?');
3693                                 asterisk = strchr(start, '*');
3694                                 if (asterisk && (!wildcard || asterisk < wildcard))
3695                                 {
3696                                         wildcard = asterisk;
3697                                 }
3698
3699                                 if (wildcard)
3700                                 {
3701                                         nextseparator = strchr( wildcard, '/' );
3702                                 }
3703                                 else
3704                                 {
3705                                         nextseparator = NULL;
3706                                 }
3707
3708                                 if( !nextseparator ) {
3709                                         nextseparator = start + strlen( start );
3710                                 }
3711
3712                                 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3713                                 // copy everything up except nextseperator
3714                                 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3715                                 // find the last '/' before the wildcard
3716                                 prevseparator = strrchr( subpattern, '/' );
3717                                 if (!prevseparator)
3718                                         prevseparator = subpattern;
3719                                 else
3720                                         prevseparator++;
3721                                 // copy everything from start to the previous including the '/' (before the wildcard)
3722                                 // everything up to start is already included in the path of matchedSet's entries
3723                                 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3724
3725                                 // for each entry in matchedSet try to open the subdirectories specified in subpath
3726                                 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3727                                         char temp[MAX_OSPATH];
3728                                         strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3729                                         strlcat( temp, subpath, sizeof(temp) );
3730                                         listdirectory( &foundSet, searchpath->filename, temp );
3731                                 }
3732                                 if( dirlistindex == 0 ) {
3733                                         break;
3734                                 }
3735                                 // reset the current result set
3736                                 stringlistfreecontents( &matchedSet );
3737                                 // match against the pattern
3738                                 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3739                                         const char *direntry = foundSet.strings[ dirlistindex ];
3740                                         if (matchpattern(direntry, subpattern, true)) {
3741                                                 stringlistappend( &matchedSet, direntry );
3742                                         }
3743                                 }
3744                                 stringlistfreecontents( &foundSet );
3745
3746                                 start = nextseparator;
3747                         }
3748
3749                         for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3750                         {
3751                                 const char *matchtemp = matchedSet.strings[dirlistindex];
3752                                 if (matchpattern(matchtemp, (char *)pattern, true))
3753                                 {
3754                                         for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3755                                                 if (!strcmp(resultlist.strings[resultlistindex], matchtemp))
3756                                                         break;
3757                                         if (resultlistindex == resultlist.numstrings)
3758                                         {
3759                                                 stringlistappend(&resultlist, matchtemp);
3760                                                 if (!quiet && developer_loading.integer)
3761                                                         Con_Printf("SearchDirFile: %s\n", matchtemp);
3762                                         }
3763                                 }
3764                         }
3765                         stringlistfreecontents( &matchedSet );
3766                 }
3767         }
3768
3769         if (resultlist.numstrings)
3770         {
3771                 stringlistsort(&resultlist, true);
3772                 numfiles = resultlist.numstrings;
3773                 numchars = 0;
3774                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3775                         numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3776                 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3777                 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3778                 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3779                 search->numfilenames = (int)numfiles;
3780                 numfiles = 0;
3781                 numchars = 0;
3782                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3783                 {
3784                         size_t textlen;
3785                         search->filenames[numfiles] = search->filenamesbuffer + numchars;
3786                         textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3787                         memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3788                         numfiles++;
3789                         numchars += (int)textlen;
3790                 }
3791         }
3792         stringlistfreecontents(&resultlist);
3793
3794         Mem_Free(basepath);
3795         return search;
3796 }
3797
3798 void FS_FreeSearch(fssearch_t *search)
3799 {
3800         Z_Free(search);
3801 }
3802
3803 extern int con_linewidth;
3804 static int FS_ListDirectory(const char *pattern, int oneperline)
3805 {
3806         int numfiles;
3807         int numcolumns;
3808         int numlines;
3809         int columnwidth;
3810         int linebufpos;
3811         int i, j, k, l;
3812         const char *name;
3813         char linebuf[MAX_INPUTLINE];
3814         fssearch_t *search;
3815         search = FS_Search(pattern, true, true, NULL);
3816         if (!search)
3817                 return 0;
3818         numfiles = search->numfilenames;
3819         if (!oneperline)
3820         {
3821                 // FIXME: the names could be added to one column list and then
3822                 // gradually shifted into the next column if they fit, and then the
3823                 // next to make a compact variable width listing but it's a lot more
3824                 // complicated...
3825                 // find width for columns
3826                 columnwidth = 0;
3827                 for (i = 0;i < numfiles;i++)
3828                 {
3829                         l = (int)strlen(search->filenames[i]);
3830                         if (columnwidth < l)
3831                                 columnwidth = l;
3832                 }
3833                 // count the spacing character
3834                 columnwidth++;
3835                 // calculate number of columns
3836                 numcolumns = con_linewidth / columnwidth;
3837                 // don't bother with the column printing if it's only one column
3838                 if (numcolumns >= 2)
3839                 {
3840                         numlines = (numfiles + numcolumns - 1) / numcolumns;
3841                         for (i = 0;i < numlines;i++)
3842                         {
3843                                 linebufpos = 0;
3844                                 for (k = 0;k < numcolumns;k++)
3845                                 {
3846                                         l = i * numcolumns + k;
3847                                         if (l < numfiles)
3848                                         {
3849                                                 name = search->filenames[l];
3850                                                 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3851                                                         linebuf[linebufpos++] = name[j];
3852                                                 // space out name unless it's the last on the line
3853                                                 if (k + 1 < numcolumns && l + 1 < numfiles)
3854                                                         for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3855                                                                 linebuf[linebufpos++] = ' ';
3856                                         }
3857                                 }
3858                                 linebuf[linebufpos] = 0;
3859                                 Con_Printf("%s\n", linebuf);
3860                         }
3861                 }
3862                 else
3863                         oneperline = true;
3864         }
3865         if (oneperline)
3866                 for (i = 0;i < numfiles;i++)
3867                         Con_Printf("%s\n", search->filenames[i]);
3868         FS_FreeSearch(search);
3869         return (int)numfiles;
3870 }
3871
3872 static void FS_ListDirectoryCmd (cmd_state_t *cmd, const char* cmdname, int oneperline)
3873 {
3874         const char *pattern;
3875         if (Cmd_Argc(cmd) >= 3)
3876         {
3877                 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3878                 return;
3879         }
3880         if (Cmd_Argc(cmd) == 2)
3881                 pattern = Cmd_Argv(cmd, 1);
3882         else
3883                 pattern = "*";
3884         if (!FS_ListDirectory(pattern, oneperline))
3885                 Con_Print("No files found.\n");
3886 }
3887
3888 void FS_Dir_f(cmd_state_t *cmd)
3889 {
3890         FS_ListDirectoryCmd(cmd, "dir", true);
3891 }
3892
3893 void FS_Ls_f(cmd_state_t *cmd)
3894 {
3895         FS_ListDirectoryCmd(cmd, "ls", false);
3896 }
3897
3898 void FS_Which_f(cmd_state_t *cmd)
3899 {
3900         const char *filename;
3901         int index;
3902         searchpath_t *sp;
3903         if (Cmd_Argc(cmd) != 2)
3904         {
3905                 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(cmd, 0));
3906                 return;
3907         }  
3908         filename = Cmd_Argv(cmd, 1);
3909         sp = FS_FindFile(filename, &index, true);
3910         if (!sp) {
3911                 Con_Printf("%s isn't anywhere\n", filename);
3912                 return;
3913         }
3914         if (sp->pack)
3915         {
3916                 if(sp->pack->vpack)
3917                         Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3918                 else
3919                         Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3920         }
3921         else
3922                 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3923 }
3924
3925
3926 const char *FS_WhichPack(const char *filename)
3927 {
3928         int index;
3929         searchpath_t *sp = FS_FindFile(filename, &index, true);
3930         if(sp && sp->pack)
3931                 return sp->pack->shortname;
3932         else if(sp)
3933                 return "";
3934         else
3935                 return 0;
3936 }
3937
3938 /*
3939 ====================
3940 FS_IsRegisteredQuakePack
3941
3942 Look for a proof of purchase file file in the requested package
3943
3944 If it is found, this file should NOT be downloaded.
3945 ====================
3946 */
3947 qbool FS_IsRegisteredQuakePack(const char *name)
3948 {
3949         searchpath_t *search;
3950         pack_t *pak;
3951
3952         // search through the path, one element at a time
3953         for (search = fs_searchpaths;search;search = search->next)
3954         {
3955                 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3956                         // TODO do we want to support vpacks in here too?
3957                 {
3958                         int (*strcmp_funct) (const char* str1, const char* str2);
3959                         int left, right, middle;
3960
3961                         pak = search->pack;
3962                         strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3963
3964                         // Look for the file (binary search)
3965                         left = 0;
3966                         right = pak->numfiles - 1;
3967                         while (left <= right)
3968                         {
3969                                 int diff;
3970
3971                                 middle = (left + right) / 2;
3972                                 diff = strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3973
3974                                 // Found it
3975                                 if (!diff)
3976                                         return true;
3977
3978                                 // If we're too far in the list
3979                                 if (diff > 0)
3980                                         right = middle - 1;
3981                                 else
3982                                         left = middle + 1;
3983                         }
3984
3985                         // we found the requested pack but it is not registered quake
3986                         return false;
3987                 }
3988         }
3989
3990         return false;
3991 }
3992
3993 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3994 {
3995         int crc = -1;
3996         unsigned char *filedata;
3997         fs_offset_t filesize;
3998         if (filesizepointer)
3999                 *filesizepointer = 0;
4000         if (!filename || !*filename)
4001                 return crc;
4002         filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
4003         if (filedata)
4004         {
4005                 if (filesizepointer)
4006                         *filesizepointer = filesize;
4007                 crc = CRC_Block(filedata, filesize);
4008                 Mem_Free(filedata);
4009         }
4010         return crc;
4011 }
4012
4013 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
4014 {
4015         z_stream strm;
4016         unsigned char *out = NULL;
4017         unsigned char *tmp;
4018
4019         *deflated_size = 0;
4020 #ifndef LINK_TO_ZLIB
4021         if(!zlib_dll)
4022                 return NULL;
4023 #endif
4024
4025         memset(&strm, 0, sizeof(strm));
4026         strm.zalloc = Z_NULL;
4027         strm.zfree = Z_NULL;
4028         strm.opaque = Z_NULL;
4029
4030         if(level < 0)
4031                 level = Z_DEFAULT_COMPRESSION;
4032
4033         if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
4034         {
4035                 Con_Printf("FS_Deflate: deflate init error!\n");
4036                 return NULL;
4037         }
4038
4039         strm.next_in = (unsigned char*)data;
4040         strm.avail_in = (unsigned int)size;
4041
4042         tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
4043         if(!tmp)
4044         {
4045                 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
4046                 qz_deflateEnd(&strm);
4047                 return NULL;
4048         }
4049
4050         strm.next_out = tmp;
4051         strm.avail_out = (unsigned int)size;
4052
4053         if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
4054         {
4055                 Con_Printf("FS_Deflate: deflate failed!\n");
4056                 qz_deflateEnd(&strm);
4057                 Mem_Free(tmp);
4058                 return NULL;
4059         }
4060         
4061         if(qz_deflateEnd(&strm) != Z_OK)
4062         {
4063                 Con_Printf("FS_Deflate: deflateEnd failed\n");
4064                 Mem_Free(tmp);
4065                 return NULL;
4066         }
4067
4068         if(strm.total_out >= size)
4069         {
4070                 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
4071                 Mem_Free(tmp);
4072                 return NULL;
4073         }
4074
4075         out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
4076         if(!out)
4077         {
4078                 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
4079                 Mem_Free(tmp);
4080                 return NULL;
4081         }
4082
4083         *deflated_size = (size_t)strm.total_out;
4084
4085         memcpy(out, tmp, strm.total_out);
4086         Mem_Free(tmp);
4087         
4088         return out;
4089 }
4090
4091 static void AssertBufsize(sizebuf_t *buf, int length)
4092 {
4093         if(buf->cursize + length > buf->maxsize)
4094         {
4095                 int oldsize = buf->maxsize;
4096                 unsigned char *olddata;
4097                 olddata = buf->data;
4098                 buf->maxsize += length;
4099                 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
4100                 if(olddata)
4101                 {
4102                         memcpy(buf->data, olddata, oldsize);
4103                         Mem_Free(olddata);
4104                 }
4105         }
4106 }
4107
4108 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
4109 {
4110         int ret;
4111         z_stream strm;
4112         unsigned char *out = NULL;
4113         unsigned char tmp[2048];
4114         unsigned int have;
4115         sizebuf_t outbuf;
4116
4117         *inflated_size = 0;
4118 #ifndef LINK_TO_ZLIB
4119         if(!zlib_dll)
4120                 return NULL;
4121 #endif
4122
4123         memset(&outbuf, 0, sizeof(outbuf));
4124         outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
4125         outbuf.maxsize = sizeof(tmp);
4126
4127         memset(&strm, 0, sizeof(strm));
4128         strm.zalloc = Z_NULL;
4129         strm.zfree = Z_NULL;
4130         strm.opaque = Z_NULL;
4131
4132         if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
4133         {
4134                 Con_Printf("FS_Inflate: inflate init error!\n");
4135                 Mem_Free(outbuf.data);
4136                 return NULL;
4137         }
4138
4139         strm.next_in = (unsigned char*)data;
4140         strm.avail_in = (unsigned int)size;
4141
4142         do
4143         {
4144                 strm.next_out = tmp;
4145                 strm.avail_out = sizeof(tmp);
4146                 ret = qz_inflate(&strm, Z_NO_FLUSH);
4147                 // it either returns Z_OK on progress, Z_STREAM_END on end
4148                 // or an error code
4149                 switch(ret)
4150                 {
4151                         case Z_STREAM_END:
4152                         case Z_OK:
4153                                 break;
4154                                 
4155                         case Z_STREAM_ERROR:
4156                                 Con_Print("FS_Inflate: stream error!\n");
4157                                 break;
4158                         case Z_DATA_ERROR:
4159                                 Con_Print("FS_Inflate: data error!\n");
4160                                 break;
4161                         case Z_MEM_ERROR:
4162                                 Con_Print("FS_Inflate: mem error!\n");
4163                                 break;
4164                         case Z_BUF_ERROR:
4165                                 Con_Print("FS_Inflate: buf error!\n");
4166                                 break;
4167                         default:
4168                                 Con_Print("FS_Inflate: unknown error!\n");
4169                                 break;
4170                                 
4171                 }
4172                 if(ret != Z_OK && ret != Z_STREAM_END)
4173                 {
4174                         Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
4175                         Mem_Free(outbuf.data);
4176                         qz_inflateEnd(&strm);
4177                         return NULL;
4178                 }
4179                 have = sizeof(tmp) - strm.avail_out;
4180                 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
4181                 SZ_Write(&outbuf, tmp, have);
4182         } while(ret != Z_STREAM_END);
4183
4184         qz_inflateEnd(&strm);
4185
4186         out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
4187         if(!out)
4188         {
4189                 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
4190                 Mem_Free(outbuf.data);
4191                 return NULL;
4192         }
4193
4194         memcpy(out, outbuf.data, outbuf.cursize);
4195         Mem_Free(outbuf.data);
4196
4197         *inflated_size = (size_t)outbuf.cursize;
4198         
4199         return out;
4200 }