]> git.xonotic.org Git - xonotic/darkplaces.git/blob - fs.c
Fix client version of ambientsound, a buffer position check and a typo. Add missing...
[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         qboolean 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, qboolean 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 = {CVAR_CLIENT | CVAR_NORESETTODEFAULTS, "scr_screenshot_name","dp", "prefix name for saved screenshots (changes based on -game commandline, as well as which game mode is running; the date is encoded using strftime escapes)"};
386 cvar_t fs_empty_files_in_pack_mark_deletions = {CVAR_CLIENT | CVAR_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 = {CVAR_CLIENT | CVAR_SERVER | CVAR_READONLY | CVAR_NORESETTODEFAULTS, "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_UnloadLibrary (&zlib_dll);
499 #endif
500 }
501
502
503 /*
504 ====================
505 PK3_OpenLibrary
506
507 Try to load the Zlib DLL
508 ====================
509 */
510 static qboolean 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_LoadLibrary (dllnames, &zlib_dll, zlibfuncs);
539 #endif
540 }
541
542 /*
543 ====================
544 FS_HasZlib
545
546 See if zlib is available
547 ====================
548 */
549 qboolean 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 qboolean 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, qboolean 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, qboolean 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 qboolean 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(COM_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 qboolean FS_AddPack_Fullpath(const char *pakfile, const char *shortname, qboolean *already_loaded, qboolean 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_Errorf("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 qboolean FS_AddPack(const char *pakfile, qboolean *already_loaded, qboolean 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         qboolean fs_modified = false;
1420         qboolean 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 = COM_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 (COM_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 qboolean vid_opened;
1527 qboolean FS_ChangeGameDirs(int numgamedirs, char gamedirs[][MAX_QPATH], qboolean complain, qboolean 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         qboolean 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 /*
1794 ================
1795 FS_Init_SelfPack
1796 ================
1797 */
1798 void FS_Init_SelfPack (void)
1799 {
1800         char *buf;
1801
1802         PK3_OpenLibrary ();
1803         fs_mempool = Mem_AllocPool("file management", 0, NULL);
1804
1805         // Load darkplaces.opt from the FS.
1806         if (!COM_CheckParm("-noopt"))
1807         {
1808                 buf = (char *) FS_SysLoadFile("darkplaces.opt", tempmempool, true, NULL);
1809                 if(buf)
1810                 {
1811                         COM_InsertFlags(buf);
1812                         Mem_Free(buf);
1813                 }
1814         }
1815
1816 #ifndef USE_RWOPS
1817         // Provide the SelfPack.
1818         if (!COM_CheckParm("-noselfpack") && sys.selffd >= 0)
1819         {
1820                 fs_selfpack = FS_LoadPackPK3FromFD(sys.argv[0], sys.selffd, true);
1821                 if(fs_selfpack)
1822                 {
1823                         FS_AddSelfPack();
1824                         if (!COM_CheckParm("-noopt"))
1825                         {
1826                                 buf = (char *) FS_LoadFile("darkplaces.opt", tempmempool, true, NULL);
1827                                 if(buf)
1828                                 {
1829                                         COM_InsertFlags(buf);
1830                                         Mem_Free(buf);
1831                                 }
1832                         }
1833                 }
1834         }
1835 #endif
1836 }
1837
1838 static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t userdirsize)
1839 {
1840 #if defined(__IPHONEOS__)
1841         if (userdirmode == USERDIRMODE_HOME)
1842         {
1843                 // fs_basedir is "" by default, to utilize this you can simply add your gamedir to the Resources in xcode
1844                 // fs_userdir stores configurations to the Documents folder of the app
1845                 strlcpy(userdir, "../Documents/", MAX_OSPATH);
1846                 return 1;
1847         }
1848         return -1;
1849
1850 #elif defined(WIN32)
1851         char *homedir;
1852 #if _MSC_VER >= 1400
1853         size_t homedirlen;
1854 #endif
1855         TCHAR mydocsdir[MAX_PATH + 1];
1856         wchar_t *savedgamesdirw;
1857         char savedgamesdir[MAX_OSPATH];
1858         int fd;
1859         char vabuf[1024];
1860
1861         userdir[0] = 0;
1862         switch(userdirmode)
1863         {
1864         default:
1865                 return -1;
1866         case USERDIRMODE_NOHOME:
1867                 strlcpy(userdir, fs_basedir, userdirsize);
1868                 break;
1869         case USERDIRMODE_MYGAMES:
1870                 if (!shfolder_dll)
1871                         Sys_LoadLibrary(shfolderdllnames, &shfolder_dll, shfolderfuncs);
1872                 mydocsdir[0] = 0;
1873                 if (qSHGetFolderPath && qSHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, mydocsdir) == S_OK)
1874                 {
1875                         dpsnprintf(userdir, userdirsize, "%s/My Games/%s/", mydocsdir, gameuserdirname);
1876                         break;
1877                 }
1878 #if _MSC_VER >= 1400
1879                 _dupenv_s(&homedir, &homedirlen, "USERPROFILE");
1880                 if(homedir)
1881                 {
1882                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1883                         free(homedir);
1884                         break;
1885                 }
1886 #else
1887                 homedir = getenv("USERPROFILE");
1888                 if(homedir)
1889                 {
1890                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1891                         break;
1892                 }
1893 #endif
1894                 return -1;
1895         case USERDIRMODE_SAVEDGAMES:
1896                 if (!shell32_dll)
1897                         Sys_LoadLibrary(shell32dllnames, &shell32_dll, shell32funcs);
1898                 if (!ole32_dll)
1899                         Sys_LoadLibrary(ole32dllnames, &ole32_dll, ole32funcs);
1900                 if (qSHGetKnownFolderPath && qCoInitializeEx && qCoTaskMemFree && qCoUninitialize)
1901                 {
1902                         savedgamesdir[0] = 0;
1903                         qCoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
1904 /*
1905 #ifdef __cplusplus
1906                         if (SHGetKnownFolderPath(FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1907 #else
1908                         if (SHGetKnownFolderPath(&FOLDERID_SavedGames, KF_FLAG_CREATE | KF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1909 #endif
1910 */
1911                         if (qSHGetKnownFolderPath(&qFOLDERID_SavedGames, qKF_FLAG_CREATE | qKF_FLAG_NO_ALIAS, NULL, &savedgamesdirw) == S_OK)
1912                         {
1913                                 memset(savedgamesdir, 0, sizeof(savedgamesdir));
1914 #if _MSC_VER >= 1400
1915                                 wcstombs_s(NULL, savedgamesdir, sizeof(savedgamesdir), savedgamesdirw, sizeof(savedgamesdir)-1);
1916 #else
1917                                 wcstombs(savedgamesdir, savedgamesdirw, sizeof(savedgamesdir)-1);
1918 #endif
1919                                 qCoTaskMemFree(savedgamesdirw);
1920                         }
1921                         qCoUninitialize();
1922                         if (savedgamesdir[0])
1923                         {
1924                                 dpsnprintf(userdir, userdirsize, "%s/%s/", savedgamesdir, gameuserdirname);
1925                                 break;
1926                         }
1927                 }
1928                 return -1;
1929         }
1930 #else
1931         int fd;
1932         char *homedir;
1933         char vabuf[1024];
1934         userdir[0] = 0;
1935         switch(userdirmode)
1936         {
1937         default:
1938                 return -1;
1939         case USERDIRMODE_NOHOME:
1940                 strlcpy(userdir, fs_basedir, userdirsize);
1941                 break;
1942         case USERDIRMODE_HOME:
1943                 homedir = getenv("HOME");
1944                 if(homedir)
1945                 {
1946                         dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
1947                         break;
1948                 }
1949                 return -1;
1950         case USERDIRMODE_SAVEDGAMES:
1951                 homedir = getenv("HOME");
1952                 if(homedir)
1953                 {
1954 #ifdef MACOSX
1955                         dpsnprintf(userdir, userdirsize, "%s/Library/Application Support/%s/", homedir, gameuserdirname);
1956 #else
1957                         // the XDG say some files would need to go in:
1958                         // XDG_CONFIG_HOME (or ~/.config/%s/)
1959                         // XDG_DATA_HOME (or ~/.local/share/%s/)
1960                         // XDG_CACHE_HOME (or ~/.cache/%s/)
1961                         // and also search the following global locations if defined:
1962                         // XDG_CONFIG_DIRS (normally /etc/xdg/%s/)
1963                         // XDG_DATA_DIRS (normally /usr/share/%s/)
1964                         // this would be too complicated...
1965                         return -1;
1966 #endif
1967                         break;
1968                 }
1969                 return -1;
1970         }
1971 #endif
1972
1973
1974 #if !defined(__IPHONEOS__)
1975
1976 #ifdef WIN32
1977         // historical behavior...
1978         if (userdirmode == USERDIRMODE_NOHOME && strcmp(gamedirname1, "id1"))
1979                 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
1980 #endif
1981
1982         // see if we can write to this path (note: won't create path)
1983 #ifdef WIN32
1984         // no access() here, we must try to open the file for appending
1985         fd = FS_SysOpenFiledesc(va(vabuf, sizeof(vabuf), "%s%s/config.cfg", userdir, gamedirname1), "a", false);
1986         if(fd >= 0)
1987                 FILEDESC_CLOSE(fd);
1988 #else
1989         // on Unix, we don't need to ACTUALLY attempt to open the file
1990         if(access(va(vabuf, sizeof(vabuf), "%s%s/", userdir, gamedirname1), W_OK | X_OK) >= 0)
1991                 fd = 1;
1992         else
1993                 fd = -1;
1994 #endif
1995         if(fd >= 0)
1996         {
1997                 return 1; // good choice - the path exists and is writable
1998         }
1999         else
2000         {
2001                 if (userdirmode == USERDIRMODE_NOHOME)
2002                         return -1; // path usually already exists, we lack permissions
2003                 else
2004                         return 0; // probably good - failed to write but maybe we need to create path
2005         }
2006 #endif
2007 }
2008
2009 /*
2010 ================
2011 FS_Init
2012 ================
2013 */
2014 void FS_Init (void)
2015 {
2016         const char *p;
2017         int i;
2018
2019         *fs_basedir = 0;
2020         *fs_userdir = 0;
2021         *fs_gamedir = 0;
2022
2023         // -basedir <path>
2024         // Overrides the system supplied base directory (under GAMENAME)
2025 // 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)
2026         i = COM_CheckParm ("-basedir");
2027         if (i && i < sys.argc-1)
2028         {
2029                 strlcpy (fs_basedir, sys.argv[i+1], sizeof (fs_basedir));
2030                 i = (int)strlen (fs_basedir);
2031                 if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
2032                         fs_basedir[i-1] = 0;
2033         }
2034         else
2035         {
2036 // If the base directory is explicitly defined by the compilation process
2037 #ifdef DP_FS_BASEDIR
2038                 strlcpy(fs_basedir, DP_FS_BASEDIR, sizeof(fs_basedir));
2039 #elif defined(__ANDROID__)
2040                 dpsnprintf(fs_basedir, sizeof(fs_basedir), "/sdcard/%s/", gameuserdirname);
2041 #elif defined(MACOSX)
2042                 // FIXME: is there a better way to find the directory outside the .app, without using Objective-C?
2043                 if (strstr(sys.argv[0], ".app/"))
2044                 {
2045                         char *split;
2046                         strlcpy(fs_basedir, sys.argv[0], sizeof(fs_basedir));
2047                         split = strstr(fs_basedir, ".app/");
2048                         if (split)
2049                         {
2050                                 struct stat statresult;
2051                                 char vabuf[1024];
2052                                 // truncate to just after the .app/
2053                                 split[5] = 0;
2054                                 // see if gamedir exists in Resources
2055                                 if (stat(va(vabuf, sizeof(vabuf), "%s/Contents/Resources/%s", fs_basedir, gamedirname1), &statresult) == 0)
2056                                 {
2057                                         // found gamedir inside Resources, use it
2058                                         strlcat(fs_basedir, "Contents/Resources/", sizeof(fs_basedir));
2059                                 }
2060                                 else
2061                                 {
2062                                         // no gamedir found in Resources, gamedir is probably
2063                                         // outside the .app, remove .app part of path
2064                                         while (split > fs_basedir && *split != '/')
2065                                                 split--;
2066                                         *split = 0;
2067                                 }
2068                         }
2069                 }
2070 #endif
2071         }
2072
2073         // make sure the appending of a path separator won't create an unterminated string
2074         memset(fs_basedir + sizeof(fs_basedir) - 2, 0, 2);
2075         // add a path separator to the end of the basedir if it lacks one
2076         if (fs_basedir[0] && fs_basedir[strlen(fs_basedir) - 1] != '/' && fs_basedir[strlen(fs_basedir) - 1] != '\\')
2077                 strlcat(fs_basedir, "/", sizeof(fs_basedir));
2078
2079         // Add the personal game directory
2080         if((i = COM_CheckParm("-userdir")) && i < sys.argc - 1)
2081                 dpsnprintf(fs_userdir, sizeof(fs_userdir), "%s/", sys.argv[i+1]);
2082         else if (COM_CheckParm("-nohome"))
2083                 *fs_userdir = 0; // user wants roaming installation, no userdir
2084         else
2085         {
2086 #ifdef DP_FS_USERDIR
2087                 strlcpy(fs_userdir, DP_FS_USERDIR, sizeof(fs_userdir));
2088 #else
2089                 int dirmode;
2090                 int highestuserdirmode = USERDIRMODE_COUNT - 1;
2091                 int preferreduserdirmode = USERDIRMODE_COUNT - 1;
2092                 int userdirstatus[USERDIRMODE_COUNT];
2093 # ifdef WIN32
2094                 // historical behavior...
2095                 if (!strcmp(gamedirname1, "id1"))
2096                         preferreduserdirmode = USERDIRMODE_NOHOME;
2097 # endif
2098                 // check what limitations the user wants to impose
2099                 if (COM_CheckParm("-home")) preferreduserdirmode = USERDIRMODE_HOME;
2100                 if (COM_CheckParm("-mygames")) preferreduserdirmode = USERDIRMODE_MYGAMES;
2101                 if (COM_CheckParm("-savedgames")) preferreduserdirmode = USERDIRMODE_SAVEDGAMES;
2102                 // gather the status of the possible userdirs
2103                 for (dirmode = 0;dirmode < USERDIRMODE_COUNT;dirmode++)
2104                 {
2105                         userdirstatus[dirmode] = FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2106                         if (userdirstatus[dirmode] == 1)
2107                                 Con_DPrintf("userdir %i = %s (writable)\n", dirmode, fs_userdir);
2108                         else if (userdirstatus[dirmode] == 0)
2109                                 Con_DPrintf("userdir %i = %s (not writable or does not exist)\n", dirmode, fs_userdir);
2110                         else
2111                                 Con_DPrintf("userdir %i (not applicable)\n", dirmode);
2112                 }
2113                 // some games may prefer writing to basedir, but if write fails we
2114                 // have to search for a real userdir...
2115                 if (preferreduserdirmode == 0 && userdirstatus[0] < 1)
2116                         preferreduserdirmode = highestuserdirmode;
2117                 // check for an existing userdir and continue using it if possible...
2118                 for (dirmode = USERDIRMODE_COUNT - 1;dirmode > 0;dirmode--)
2119                         if (userdirstatus[dirmode] == 1)
2120                                 break;
2121                 // if no existing userdir found, make a new one...
2122                 if (dirmode == 0 && preferreduserdirmode > 0)
2123                         for (dirmode = preferreduserdirmode;dirmode > 0;dirmode--)
2124                                 if (userdirstatus[dirmode] >= 0)
2125                                         break;
2126                 // and finally, we picked one...
2127                 FS_ChooseUserDir((userdirmode_t)dirmode, fs_userdir, sizeof(fs_userdir));
2128                 Con_DPrintf("userdir %i is the winner\n", dirmode);
2129 #endif
2130         }
2131
2132         // if userdir equal to basedir, clear it to avoid confusion later
2133         if (!strcmp(fs_basedir, fs_userdir))
2134                 fs_userdir[0] = 0;
2135
2136         FS_ListGameDirs();
2137
2138         p = FS_CheckGameDir(gamedirname1);
2139         if(!p || p == fs_checkgamedir_missing)
2140                 Con_Warnf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname1);
2141
2142         if(gamedirname2)
2143         {
2144                 p = FS_CheckGameDir(gamedirname2);
2145                 if(!p || p == fs_checkgamedir_missing)
2146                         Con_Warnf("WARNING: base gamedir %s%s/ not found!\n", fs_basedir, gamedirname2);
2147         }
2148
2149         // -game <gamedir>
2150         // Adds basedir/gamedir as an override game
2151         // LadyHavoc: now supports multiple -game directories
2152         for (i = 1;i < sys.argc && fs_numgamedirs < MAX_GAMEDIRS;i++)
2153         {
2154                 if (!sys.argv[i])
2155                         continue;
2156                 if (!strcmp (sys.argv[i], "-game") && i < sys.argc-1)
2157                 {
2158                         i++;
2159                         p = FS_CheckGameDir(sys.argv[i]);
2160                         if(!p)
2161                                 Sys_Error("Nasty -game name rejected: %s", sys.argv[i]);
2162                         if(p == fs_checkgamedir_missing)
2163                                 Con_Warnf("WARNING: -game %s%s/ not found!\n", fs_basedir, sys.argv[i]);
2164                         // add the gamedir to the list of active gamedirs
2165                         strlcpy (fs_gamedirs[fs_numgamedirs], sys.argv[i], sizeof(fs_gamedirs[fs_numgamedirs]));
2166                         fs_numgamedirs++;
2167                 }
2168         }
2169
2170         // generate the searchpath
2171         FS_Rescan();
2172
2173         if (Thread_HasThreads())
2174                 fs_mutex = Thread_CreateMutex();
2175 }
2176
2177 void FS_Init_Commands(void)
2178 {
2179         Cvar_RegisterVariable (&scr_screenshot_name);
2180         Cvar_RegisterVariable (&fs_empty_files_in_pack_mark_deletions);
2181         Cvar_RegisterVariable (&cvar_fs_gamedir);
2182
2183         Cmd_AddCommand(CMD_SHARED, "gamedir", FS_GameDir_f, "changes active gamedir list (can take multiple arguments), not including base directory (example usage: gamedir ctf)");
2184         Cmd_AddCommand(CMD_SHARED, "fs_rescan", FS_Rescan_f, "rescans filesystem for new pack archives and any other changes");
2185         Cmd_AddCommand(CMD_SHARED, "path", FS_Path_f, "print searchpath (game directories and archives)");
2186         Cmd_AddCommand(CMD_SHARED, "dir", FS_Dir_f, "list files in searchpath matching an * filename pattern, one per line");
2187         Cmd_AddCommand(CMD_SHARED, "ls", FS_Ls_f, "list files in searchpath matching an * filename pattern, multiple per line");
2188         Cmd_AddCommand(CMD_SHARED, "which", FS_Which_f, "accepts a file name as argument and reports where the file is taken from");
2189 }
2190
2191 /*
2192 ================
2193 FS_Shutdown
2194 ================
2195 */
2196 void FS_Shutdown (void)
2197 {
2198         // close all pack files and such
2199         // (hopefully there aren't any other open files, but they'll be cleaned up
2200         //  by the OS anyway)
2201         FS_ClearSearchPath();
2202         Mem_FreePool (&fs_mempool);
2203         PK3_CloseLibrary ();
2204
2205 #ifdef WIN32
2206         Sys_UnloadLibrary (&shfolder_dll);
2207         Sys_UnloadLibrary (&shell32_dll);
2208         Sys_UnloadLibrary (&ole32_dll);
2209 #endif
2210
2211         if (fs_mutex)
2212                 Thread_DestroyMutex(fs_mutex);
2213 }
2214
2215 static filedesc_t FS_SysOpenFiledesc(const char *filepath, const char *mode, qboolean nonblocking)
2216 {
2217         filedesc_t handle = FILEDESC_INVALID;
2218         int mod, opt;
2219         unsigned int ind;
2220         qboolean dolock = false;
2221
2222         // Parse the mode string
2223         switch (mode[0])
2224         {
2225                 case 'r':
2226                         mod = O_RDONLY;
2227                         opt = 0;
2228                         break;
2229                 case 'w':
2230                         mod = O_WRONLY;
2231                         opt = O_CREAT | O_TRUNC;
2232                         break;
2233                 case 'a':
2234                         mod = O_WRONLY;
2235                         opt = O_CREAT | O_APPEND;
2236                         break;
2237                 default:
2238                         Con_Errorf ("FS_SysOpen(%s, %s): invalid mode\n", filepath, mode);
2239                         return FILEDESC_INVALID;
2240         }
2241         for (ind = 1; mode[ind] != '\0'; ind++)
2242         {
2243                 switch (mode[ind])
2244                 {
2245                         case '+':
2246                                 mod = O_RDWR;
2247                                 break;
2248                         case 'b':
2249                                 opt |= O_BINARY;
2250                                 break;
2251                         case 'l':
2252                                 dolock = true;
2253                                 break;
2254                         default:
2255                                 Con_Errorf ("FS_SysOpen(%s, %s): unknown character in mode (%c)\n",
2256                                                         filepath, mode, mode[ind]);
2257                 }
2258         }
2259
2260         if (nonblocking)
2261                 opt |= O_NONBLOCK;
2262
2263         if(COM_CheckParm("-readonly") && mod != O_RDONLY)
2264                 return FILEDESC_INVALID;
2265
2266 #if USE_RWOPS
2267         if (dolock)
2268                 return FILEDESC_INVALID;
2269         handle = SDL_RWFromFile(filepath, mode);
2270 #else
2271 # ifdef WIN32
2272 #  if _MSC_VER >= 1400
2273         _sopen_s(&handle, filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2274 #  else
2275         handle = _sopen (filepath, mod | opt, (dolock ? ((mod == O_RDONLY) ? _SH_DENYRD : _SH_DENYRW) : _SH_DENYNO), _S_IREAD | _S_IWRITE);
2276 #  endif
2277 # else
2278         handle = open (filepath, mod | opt, 0666);
2279         if(handle >= 0 && dolock)
2280         {
2281                 struct flock l;
2282                 l.l_type = ((mod == O_RDONLY) ? F_RDLCK : F_WRLCK);
2283                 l.l_whence = SEEK_SET;
2284                 l.l_start = 0;
2285                 l.l_len = 0;
2286                 if(fcntl(handle, F_SETLK, &l) == -1)
2287                 {
2288                         FILEDESC_CLOSE(handle);
2289                         handle = -1;
2290                 }
2291         }
2292 # endif
2293 #endif
2294
2295         return handle;
2296 }
2297
2298 int FS_SysOpenFD(const char *filepath, const char *mode, qboolean nonblocking)
2299 {
2300 #ifdef USE_RWOPS
2301         return -1;
2302 #else
2303         return FS_SysOpenFiledesc(filepath, mode, nonblocking);
2304 #endif
2305 }
2306
2307 /*
2308 ====================
2309 FS_SysOpen
2310
2311 Internal function used to create a qfile_t and open the relevant non-packed file on disk
2312 ====================
2313 */
2314 qfile_t* FS_SysOpen (const char* filepath, const char* mode, qboolean nonblocking)
2315 {
2316         qfile_t* file;
2317
2318         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2319         file->ungetc = EOF;
2320         file->handle = FS_SysOpenFiledesc(filepath, mode, nonblocking);
2321         if (!FILEDESC_ISVALID(file->handle))
2322         {
2323                 Mem_Free (file);
2324                 return NULL;
2325         }
2326
2327         file->filename = Mem_strdup(fs_mempool, filepath);
2328
2329         file->real_length = FILEDESC_SEEK (file->handle, 0, SEEK_END);
2330
2331         // For files opened in append mode, we start at the end of the file
2332         if (mode[0] == 'a')
2333                 file->position = file->real_length;
2334         else
2335                 FILEDESC_SEEK (file->handle, 0, SEEK_SET);
2336
2337         return file;
2338 }
2339
2340
2341 /*
2342 ===========
2343 FS_OpenPackedFile
2344
2345 Open a packed file using its package file descriptor
2346 ===========
2347 */
2348 static qfile_t *FS_OpenPackedFile (pack_t* pack, int pack_ind)
2349 {
2350         packfile_t *pfile;
2351         filedesc_t dup_handle;
2352         qfile_t* file;
2353
2354         pfile = &pack->files[pack_ind];
2355
2356         // If we don't have the true offset, get it now
2357         if (! (pfile->flags & PACKFILE_FLAG_TRUEOFFS))
2358                 if (!PK3_GetTrueFileOffset (pfile, pack))
2359                         return NULL;
2360
2361 #ifndef LINK_TO_ZLIB
2362         // No Zlib DLL = no compressed files
2363         if (!zlib_dll && (pfile->flags & PACKFILE_FLAG_DEFLATED))
2364         {
2365                 Con_Warnf("WARNING: can't open the compressed file %s\n"
2366                                         "You need the Zlib DLL to use compressed files\n",
2367                                         pfile->name);
2368                 return NULL;
2369         }
2370 #endif
2371
2372         // LadyHavoc: FILEDESC_SEEK affects all duplicates of a handle so we do it before
2373         // the dup() call to avoid having to close the dup_handle on error here
2374         if (FILEDESC_SEEK (pack->handle, pfile->offset, SEEK_SET) == -1)
2375         {
2376                 Con_Printf ("FS_OpenPackedFile: can't lseek to %s in %s (offset: %08x%08x)\n",
2377                                         pfile->name, pack->filename, (unsigned int)(pfile->offset >> 32), (unsigned int)(pfile->offset));
2378                 return NULL;
2379         }
2380
2381         dup_handle = FILEDESC_DUP (pack->filename, pack->handle);
2382         if (!FILEDESC_ISVALID(dup_handle))
2383         {
2384                 Con_Printf ("FS_OpenPackedFile: can't dup package's handle (pack: %s)\n", pack->filename);
2385                 return NULL;
2386         }
2387
2388         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2389         memset (file, 0, sizeof (*file));
2390         file->handle = dup_handle;
2391         file->flags = QFILE_FLAG_PACKED;
2392         file->real_length = pfile->realsize;
2393         file->offset = pfile->offset;
2394         file->position = 0;
2395         file->ungetc = EOF;
2396
2397         if (pfile->flags & PACKFILE_FLAG_DEFLATED)
2398         {
2399                 ztoolkit_t *ztk;
2400
2401                 file->flags |= QFILE_FLAG_DEFLATED;
2402
2403                 // We need some more variables
2404                 ztk = (ztoolkit_t *)Mem_Alloc (fs_mempool, sizeof (*ztk));
2405
2406                 ztk->comp_length = pfile->packsize;
2407
2408                 // Initialize zlib stream
2409                 ztk->zstream.next_in = ztk->input;
2410                 ztk->zstream.avail_in = 0;
2411
2412                 /* From Zlib's "unzip.c":
2413                  *
2414                  * windowBits is passed < 0 to tell that there is no zlib header.
2415                  * Note that in this case inflate *requires* an extra "dummy" byte
2416                  * after the compressed stream in order to complete decompression and
2417                  * return Z_STREAM_END.
2418                  * In unzip, i don't wait absolutely Z_STREAM_END because I known the
2419                  * size of both compressed and uncompressed data
2420                  */
2421                 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
2422                 {
2423                         Con_Printf ("FS_OpenPackedFile: inflate init error (file: %s)\n", pfile->name);
2424                         FILEDESC_CLOSE(dup_handle);
2425                         Mem_Free(file);
2426                         return NULL;
2427                 }
2428
2429                 ztk->zstream.next_out = file->buff;
2430                 ztk->zstream.avail_out = sizeof (file->buff);
2431
2432                 file->ztk = ztk;
2433         }
2434
2435         return file;
2436 }
2437
2438 /*
2439 ====================
2440 FS_CheckNastyPath
2441
2442 Return true if the path should be rejected due to one of the following:
2443 1: path elements that are non-portable
2444 2: path elements that would allow access to files outside the game directory,
2445    or are just not a good idea for a mod to be using.
2446 ====================
2447 */
2448 int FS_CheckNastyPath (const char *path, qboolean isgamedir)
2449 {
2450         // all: never allow an empty path, as for gamedir it would access the parent directory and a non-gamedir path it is just useless
2451         if (!path[0])
2452                 return 2;
2453
2454         // Windows: don't allow \ in filenames (windows-only), period.
2455         // (on Windows \ is a directory separator, but / is also supported)
2456         if (strstr(path, "\\"))
2457                 return 1; // non-portable
2458
2459         // Mac: don't allow Mac-only filenames - : is a directory separator
2460         // instead of /, but we rely on / working already, so there's no reason to
2461         // support a Mac-only path
2462         // Amiga and Windows: : tries to go to root of drive
2463         if (strstr(path, ":"))
2464                 return 1; // non-portable attempt to go to root of drive
2465
2466         // Amiga: // is parent directory
2467         if (strstr(path, "//"))
2468                 return 1; // non-portable attempt to go to parent directory
2469
2470         // all: don't allow going to parent directory (../ or /../)
2471         if (strstr(path, ".."))
2472                 return 2; // attempt to go outside the game directory
2473
2474         // Windows and UNIXes: don't allow absolute paths
2475         if (path[0] == '/')
2476                 return 2; // attempt to go outside the game directory
2477
2478         // all: don't allow . character immediately before a slash, this catches all imaginable cases of ./, ../, .../, etc
2479         if (strstr(path, "./"))
2480                 return 2; // possible attempt to go outside the game directory
2481
2482         // all: forbid trailing slash on gamedir
2483         if (isgamedir && path[strlen(path)-1] == '/')
2484                 return 2;
2485
2486         // all: forbid leading dot on any filename for any reason
2487         if (strstr(path, "/."))
2488                 return 2; // attempt to go outside the game directory
2489
2490         // after all these checks we're pretty sure it's a / separated filename
2491         // and won't do much if any harm
2492         return false;
2493 }
2494
2495
2496 /*
2497 ====================
2498 FS_FindFile
2499
2500 Look for a file in the packages and in the filesystem
2501
2502 Return the searchpath where the file was found (or NULL)
2503 and the file index in the package if relevant
2504 ====================
2505 */
2506 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
2507 {
2508         searchpath_t *search;
2509         pack_t *pak;
2510
2511         // search through the path, one element at a time
2512         for (search = fs_searchpaths;search;search = search->next)
2513         {
2514                 // is the element a pak file?
2515                 if (search->pack && !search->pack->vpack)
2516                 {
2517                         int (*strcmp_funct) (const char* str1, const char* str2);
2518                         int left, right, middle;
2519
2520                         pak = search->pack;
2521                         strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
2522
2523                         // Look for the file (binary search)
2524                         left = 0;
2525                         right = pak->numfiles - 1;
2526                         while (left <= right)
2527                         {
2528                                 int diff;
2529
2530                                 middle = (left + right) / 2;
2531                                 diff = strcmp_funct (pak->files[middle].name, name);
2532
2533                                 // Found it
2534                                 if (!diff)
2535                                 {
2536                                         if (fs_empty_files_in_pack_mark_deletions.integer && pak->files[middle].realsize == 0)
2537                                         {
2538                                                 // yes, but the first one is empty so we treat it as not being there
2539                                                 if (!quiet && developer_extra.integer)
2540                                                         Con_DPrintf("FS_FindFile: %s is marked as deleted\n", name);
2541
2542                                                 if (index != NULL)
2543                                                         *index = -1;
2544                                                 return NULL;
2545                                         }
2546
2547                                         if (!quiet && developer_extra.integer)
2548                                                 Con_DPrintf("FS_FindFile: %s in %s\n",
2549                                                                         pak->files[middle].name, pak->filename);
2550
2551                                         if (index != NULL)
2552                                                 *index = middle;
2553                                         return search;
2554                                 }
2555
2556                                 // If we're too far in the list
2557                                 if (diff > 0)
2558                                         right = middle - 1;
2559                                 else
2560                                         left = middle + 1;
2561                         }
2562                 }
2563                 else
2564                 {
2565                         char netpath[MAX_OSPATH];
2566                         dpsnprintf(netpath, sizeof(netpath), "%s%s", search->filename, name);
2567                         if (FS_SysFileExists (netpath))
2568                         {
2569                                 if (!quiet && developer_extra.integer)
2570                                         Con_DPrintf("FS_FindFile: %s\n", netpath);
2571
2572                                 if (index != NULL)
2573                                         *index = -1;
2574                                 return search;
2575                         }
2576                 }
2577         }
2578
2579         if (!quiet && developer_extra.integer)
2580                 Con_DPrintf("FS_FindFile: can't find %s\n", name);
2581
2582         if (index != NULL)
2583                 *index = -1;
2584         return NULL;
2585 }
2586
2587
2588 /*
2589 ===========
2590 FS_OpenReadFile
2591
2592 Look for a file in the search paths and open it in read-only mode
2593 ===========
2594 */
2595 static qfile_t *FS_OpenReadFile (const char *filename, qboolean quiet, qboolean nonblocking, int symlinkLevels)
2596 {
2597         searchpath_t *search;
2598         int pack_ind;
2599
2600         search = FS_FindFile (filename, &pack_ind, quiet);
2601
2602         // Not found?
2603         if (search == NULL)
2604                 return NULL;
2605
2606         // Found in the filesystem?
2607         if (pack_ind < 0)
2608         {
2609                 // this works with vpacks, so we are fine
2610                 char path [MAX_OSPATH];
2611                 dpsnprintf (path, sizeof (path), "%s%s", search->filename, filename);
2612                 return FS_SysOpen (path, "rb", nonblocking);
2613         }
2614
2615         // So, we found it in a package...
2616
2617         // Is it a PK3 symlink?
2618         // TODO also handle directory symlinks by parsing the whole structure...
2619         // but heck, file symlinks are good enough for now
2620         if(search->pack->files[pack_ind].flags & PACKFILE_FLAG_SYMLINK)
2621         {
2622                 if(symlinkLevels <= 0)
2623                 {
2624                         Con_Printf("symlink: %s: too many levels of symbolic links\n", filename);
2625                         return NULL;
2626                 }
2627                 else
2628                 {
2629                         char linkbuf[MAX_QPATH];
2630                         fs_offset_t count;
2631                         qfile_t *linkfile = FS_OpenPackedFile (search->pack, pack_ind);
2632                         const char *mergeslash;
2633                         char *mergestart;
2634
2635                         if(!linkfile)
2636                                 return NULL;
2637                         count = FS_Read(linkfile, linkbuf, sizeof(linkbuf) - 1);
2638                         FS_Close(linkfile);
2639                         if(count < 0)
2640                                 return NULL;
2641                         linkbuf[count] = 0;
2642                         
2643                         // Now combine the paths...
2644                         mergeslash = strrchr(filename, '/');
2645                         mergestart = linkbuf;
2646                         if(!mergeslash)
2647                                 mergeslash = filename;
2648                         while(!strncmp(mergestart, "../", 3))
2649                         {
2650                                 mergestart += 3;
2651                                 while(mergeslash > filename)
2652                                 {
2653                                         --mergeslash;
2654                                         if(*mergeslash == '/')
2655                                                 break;
2656                                 }
2657                         }
2658                         // Now, mergestart will point to the path to be appended, and mergeslash points to where it should be appended
2659                         if(mergeslash == filename)
2660                         {
2661                                 // Either mergeslash == filename, then we just replace the name (done below)
2662                         }
2663                         else
2664                         {
2665                                 // Or, we append the name after mergeslash;
2666                                 // or rather, we can also shift the linkbuf so we can put everything up to and including mergeslash first
2667                                 int spaceNeeded = mergeslash - filename + 1;
2668                                 int spaceRemoved = mergestart - linkbuf;
2669                                 if(count - spaceRemoved + spaceNeeded >= MAX_QPATH)
2670                                 {
2671                                         Con_DPrintf("symlink: too long path rejected\n");
2672                                         return NULL;
2673                                 }
2674                                 memmove(linkbuf + spaceNeeded, linkbuf + spaceRemoved, count - spaceRemoved);
2675                                 memcpy(linkbuf, filename, spaceNeeded);
2676                                 linkbuf[count - spaceRemoved + spaceNeeded] = 0;
2677                                 mergestart = linkbuf;
2678                         }
2679                         if (!quiet && developer_loading.integer)
2680                                 Con_DPrintf("symlink: %s -> %s\n", filename, mergestart);
2681                         if(FS_CheckNastyPath (mergestart, false))
2682                         {
2683                                 Con_DPrintf("symlink: nasty path %s rejected\n", mergestart);
2684                                 return NULL;
2685                         }
2686                         return FS_OpenReadFile(mergestart, quiet, nonblocking, symlinkLevels - 1);
2687                 }
2688         }
2689
2690         return FS_OpenPackedFile (search->pack, pack_ind);
2691 }
2692
2693
2694 /*
2695 =============================================================================
2696
2697 MAIN PUBLIC FUNCTIONS
2698
2699 =============================================================================
2700 */
2701
2702 /*
2703 ====================
2704 FS_OpenRealFile
2705
2706 Open a file in the userpath. The syntax is the same as fopen
2707 Used for savegame scanning in menu, and all file writing.
2708 ====================
2709 */
2710 qfile_t* FS_OpenRealFile (const char* filepath, const char* mode, qboolean quiet)
2711 {
2712         char real_path [MAX_OSPATH];
2713
2714         if (FS_CheckNastyPath(filepath, false))
2715         {
2716                 Con_Printf("FS_OpenRealFile(\"%s\", \"%s\", %s): nasty filename rejected\n", filepath, mode, quiet ? "true" : "false");
2717                 return NULL;
2718         }
2719
2720         dpsnprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath); // this is never a vpack
2721
2722         // If the file is opened in "write", "append", or "read/write" mode,
2723         // create directories up to the file.
2724         if (mode[0] == 'w' || mode[0] == 'a' || strchr (mode, '+'))
2725                 FS_CreatePath (real_path);
2726         return FS_SysOpen (real_path, mode, false);
2727 }
2728
2729
2730 /*
2731 ====================
2732 FS_OpenVirtualFile
2733
2734 Open a file. The syntax is the same as fopen
2735 ====================
2736 */
2737 qfile_t* FS_OpenVirtualFile (const char* filepath, qboolean quiet)
2738 {
2739         qfile_t *result = NULL;
2740         if (FS_CheckNastyPath(filepath, false))
2741         {
2742                 Con_Printf("FS_OpenVirtualFile(\"%s\", %s): nasty filename rejected\n", filepath, quiet ? "true" : "false");
2743                 return NULL;
2744         }
2745
2746         if (fs_mutex) Thread_LockMutex(fs_mutex);
2747         result = FS_OpenReadFile (filepath, quiet, false, 16);
2748         if (fs_mutex) Thread_UnlockMutex(fs_mutex);
2749         return result;
2750 }
2751
2752
2753 /*
2754 ====================
2755 FS_FileFromData
2756
2757 Open a file. The syntax is the same as fopen
2758 ====================
2759 */
2760 qfile_t* FS_FileFromData (const unsigned char *data, const size_t size, qboolean quiet)
2761 {
2762         qfile_t* file;
2763         file = (qfile_t *)Mem_Alloc (fs_mempool, sizeof (*file));
2764         memset (file, 0, sizeof (*file));
2765         file->flags = QFILE_FLAG_DATA;
2766         file->ungetc = EOF;
2767         file->real_length = size;
2768         file->data = data;
2769         return file;
2770 }
2771
2772 /*
2773 ====================
2774 FS_Close
2775
2776 Close a file
2777 ====================
2778 */
2779 int FS_Close (qfile_t* file)
2780 {
2781         if(file->flags & QFILE_FLAG_DATA)
2782         {
2783                 Mem_Free(file);
2784                 return 0;
2785         }
2786
2787         if (FILEDESC_CLOSE (file->handle))
2788                 return EOF;
2789
2790         if (file->filename)
2791         {
2792                 if (file->flags & QFILE_FLAG_REMOVE)
2793                 {
2794                         if (remove(file->filename) == -1)
2795                         {
2796                                 // No need to report this. If removing a just
2797                                 // written file failed, this most likely means
2798                                 // someone else deleted it first - which we
2799                                 // like.
2800                         }
2801                 }
2802
2803                 Mem_Free((void *) file->filename);
2804         }
2805
2806         if (file->ztk)
2807         {
2808                 qz_inflateEnd (&file->ztk->zstream);
2809                 Mem_Free (file->ztk);
2810         }
2811
2812         Mem_Free (file);
2813         return 0;
2814 }
2815
2816 void FS_RemoveOnClose(qfile_t* file)
2817 {
2818         file->flags |= QFILE_FLAG_REMOVE;
2819 }
2820
2821 /*
2822 ====================
2823 FS_Write
2824
2825 Write "datasize" bytes into a file
2826 ====================
2827 */
2828 fs_offset_t FS_Write (qfile_t* file, const void* data, size_t datasize)
2829 {
2830         fs_offset_t written = 0;
2831
2832         // If necessary, seek to the exact file position we're supposed to be
2833         if (file->buff_ind != file->buff_len)
2834         {
2835                 if (FILEDESC_SEEK (file->handle, file->buff_ind - file->buff_len, SEEK_CUR) == -1)
2836                 {
2837                         Con_Warnf("WARNING: could not seek in %s.\n", file->filename);
2838                 }
2839         }
2840
2841         // Purge cached data
2842         FS_Purge (file);
2843
2844         // Write the buffer and update the position
2845         // 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)
2846         while (written < (fs_offset_t)datasize)
2847         {
2848                 // figure out how much to write in one chunk
2849                 fs_offset_t maxchunk = 1<<30; // 1 GiB
2850                 int chunk = (int)min((fs_offset_t)datasize - written, maxchunk);
2851                 int result = (int)FILEDESC_WRITE (file->handle, (const unsigned char *)data + written, chunk);
2852                 // if at least some was written, add it to our accumulator
2853                 if (result > 0)
2854                         written += result;
2855                 // if the result is not what we expected, consider the write to be incomplete
2856                 if (result != chunk)
2857                         break;
2858         }
2859         file->position = FILEDESC_SEEK (file->handle, 0, SEEK_CUR);
2860         if (file->real_length < file->position)
2861                 file->real_length = file->position;
2862
2863         // note that this will never be less than 0 even if the write failed
2864         return written;
2865 }
2866
2867
2868 /*
2869 ====================
2870 FS_Read
2871
2872 Read up to "buffersize" bytes from a file
2873 ====================
2874 */
2875 fs_offset_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
2876 {
2877         fs_offset_t count, done;
2878
2879         if (buffersize == 0)
2880                 return 0;
2881
2882         // Get rid of the ungetc character
2883         if (file->ungetc != EOF)
2884         {
2885                 ((char*)buffer)[0] = file->ungetc;
2886                 buffersize--;
2887                 file->ungetc = EOF;
2888                 done = 1;
2889         }
2890         else
2891                 done = 0;
2892
2893         if(file->flags & QFILE_FLAG_DATA)
2894         {
2895                 size_t left = file->real_length - file->position;
2896                 if(buffersize > left)
2897                         buffersize = left;
2898                 memcpy(buffer, file->data + file->position, buffersize);
2899                 file->position += buffersize;
2900                 return buffersize;
2901         }
2902
2903         // First, we copy as many bytes as we can from "buff"
2904         if (file->buff_ind < file->buff_len)
2905         {
2906                 count = file->buff_len - file->buff_ind;
2907                 count = ((fs_offset_t)buffersize > count) ? count : (fs_offset_t)buffersize;
2908                 done += count;
2909                 memcpy (buffer, &file->buff[file->buff_ind], count);
2910                 file->buff_ind += count;
2911
2912                 buffersize -= count;
2913                 if (buffersize == 0)
2914                         return done;
2915         }
2916
2917         // NOTE: at this point, the read buffer is always empty
2918
2919         // If the file isn't compressed
2920         if (! (file->flags & QFILE_FLAG_DEFLATED))
2921         {
2922                 fs_offset_t nb;
2923
2924                 // We must take care to not read after the end of the file
2925                 count = file->real_length - file->position;
2926
2927                 // If we have a lot of data to get, put them directly into "buffer"
2928                 if (buffersize > sizeof (file->buff) / 2)
2929                 {
2930                         if (count > (fs_offset_t)buffersize)
2931                                 count = (fs_offset_t)buffersize;
2932                         if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2933                         {
2934                                 // Seek failed. When reading from a pipe, and
2935                                 // the caller never called FS_Seek, this still
2936                                 // works fine.  So no reporting this error.
2937                         }
2938                         nb = FILEDESC_READ (file->handle, &((unsigned char*)buffer)[done], count);
2939                         if (nb > 0)
2940                         {
2941                                 done += nb;
2942                                 file->position += nb;
2943
2944                                 // Purge cached data
2945                                 FS_Purge (file);
2946                         }
2947                 }
2948                 else
2949                 {
2950                         if (count > (fs_offset_t)sizeof (file->buff))
2951                                 count = (fs_offset_t)sizeof (file->buff);
2952                         if (FILEDESC_SEEK (file->handle, file->offset + file->position, SEEK_SET) == -1)
2953                         {
2954                                 // Seek failed. When reading from a pipe, and
2955                                 // the caller never called FS_Seek, this still
2956                                 // works fine.  So no reporting this error.
2957                         }
2958                         nb = FILEDESC_READ (file->handle, file->buff, count);
2959                         if (nb > 0)
2960                         {
2961                                 file->buff_len = nb;
2962                                 file->position += nb;
2963
2964                                 // Copy the requested data in "buffer" (as much as we can)
2965                                 count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
2966                                 memcpy (&((unsigned char*)buffer)[done], file->buff, count);
2967                                 file->buff_ind = count;
2968                                 done += count;
2969                         }
2970                 }
2971
2972                 return done;
2973         }
2974
2975         // If the file is compressed, it's more complicated...
2976         // We cycle through a few operations until we have read enough data
2977         while (buffersize > 0)
2978         {
2979                 ztoolkit_t *ztk = file->ztk;
2980                 int error;
2981
2982                 // NOTE: at this point, the read buffer is always empty
2983
2984                 // If "input" is also empty, we need to refill it
2985                 if (ztk->in_ind == ztk->in_len)
2986                 {
2987                         // If we are at the end of the file
2988                         if (file->position == file->real_length)
2989                                 return done;
2990
2991                         count = (fs_offset_t)(ztk->comp_length - ztk->in_position);
2992                         if (count > (fs_offset_t)sizeof (ztk->input))
2993                                 count = (fs_offset_t)sizeof (ztk->input);
2994                         FILEDESC_SEEK (file->handle, file->offset + (fs_offset_t)ztk->in_position, SEEK_SET);
2995                         if (FILEDESC_READ (file->handle, ztk->input, count) != count)
2996                         {
2997                                 Con_Printf ("FS_Read: unexpected end of file\n");
2998                                 break;
2999                         }
3000
3001                         ztk->in_ind = 0;
3002                         ztk->in_len = count;
3003                         ztk->in_position += count;
3004                 }
3005
3006                 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
3007                 ztk->zstream.avail_in = (unsigned int)(ztk->in_len - ztk->in_ind);
3008
3009                 // Now that we are sure we have compressed data available, we need to determine
3010                 // if it's better to inflate it in "file->buff" or directly in "buffer"
3011
3012                 // Inflate the data in "file->buff"
3013                 if (buffersize < sizeof (file->buff) / 2)
3014                 {
3015                         ztk->zstream.next_out = file->buff;
3016                         ztk->zstream.avail_out = sizeof (file->buff);
3017                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3018                         if (error != Z_OK && error != Z_STREAM_END)
3019                         {
3020                                 Con_Printf ("FS_Read: Can't inflate file\n");
3021                                 break;
3022                         }
3023                         ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3024
3025                         file->buff_len = (fs_offset_t)sizeof (file->buff) - ztk->zstream.avail_out;
3026                         file->position += file->buff_len;
3027
3028                         // Copy the requested data in "buffer" (as much as we can)
3029                         count = (fs_offset_t)buffersize > file->buff_len ? file->buff_len : (fs_offset_t)buffersize;
3030                         memcpy (&((unsigned char*)buffer)[done], file->buff, count);
3031                         file->buff_ind = count;
3032                 }
3033
3034                 // Else, we inflate directly in "buffer"
3035                 else
3036                 {
3037                         ztk->zstream.next_out = &((unsigned char*)buffer)[done];
3038                         ztk->zstream.avail_out = (unsigned int)buffersize;
3039                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
3040                         if (error != Z_OK && error != Z_STREAM_END)
3041                         {
3042                                 Con_Printf ("FS_Read: Can't inflate file\n");
3043                                 break;
3044                         }
3045                         ztk->in_ind = ztk->in_len - ztk->zstream.avail_in;
3046
3047                         // How much data did it inflate?
3048                         count = (fs_offset_t)(buffersize - ztk->zstream.avail_out);
3049                         file->position += count;
3050
3051                         // Purge cached data
3052                         FS_Purge (file);
3053                 }
3054
3055                 done += count;
3056                 buffersize -= count;
3057         }
3058
3059         return done;
3060 }
3061
3062
3063 /*
3064 ====================
3065 FS_Print
3066
3067 Print a string into a file
3068 ====================
3069 */
3070 int FS_Print (qfile_t* file, const char *msg)
3071 {
3072         return (int)FS_Write (file, msg, strlen (msg));
3073 }
3074
3075 /*
3076 ====================
3077 FS_Printf
3078
3079 Print a string into a file
3080 ====================
3081 */
3082 int FS_Printf(qfile_t* file, const char* format, ...)
3083 {
3084         int result;
3085         va_list args;
3086
3087         va_start (args, format);
3088         result = FS_VPrintf (file, format, args);
3089         va_end (args);
3090
3091         return result;
3092 }
3093
3094
3095 /*
3096 ====================
3097 FS_VPrintf
3098
3099 Print a string into a file
3100 ====================
3101 */
3102 int FS_VPrintf (qfile_t* file, const char* format, va_list ap)
3103 {
3104         int len;
3105         fs_offset_t buff_size = MAX_INPUTLINE;
3106         char *tempbuff;
3107
3108         for (;;)
3109         {
3110                 tempbuff = (char *)Mem_Alloc (tempmempool, buff_size);
3111                 len = dpvsnprintf (tempbuff, buff_size, format, ap);
3112                 if (len >= 0 && len < buff_size)
3113                         break;
3114                 Mem_Free (tempbuff);
3115                 buff_size *= 2;
3116         }
3117
3118         len = FILEDESC_WRITE (file->handle, tempbuff, len);
3119         Mem_Free (tempbuff);
3120
3121         return len;
3122 }
3123
3124
3125 /*
3126 ====================
3127 FS_Getc
3128
3129 Get the next character of a file
3130 ====================
3131 */
3132 int FS_Getc (qfile_t* file)
3133 {
3134         unsigned char c;
3135
3136         if (FS_Read (file, &c, 1) != 1)
3137                 return EOF;
3138
3139         return c;
3140 }
3141
3142
3143 /*
3144 ====================
3145 FS_UnGetc
3146
3147 Put a character back into the read buffer (only supports one character!)
3148 ====================
3149 */
3150 int FS_UnGetc (qfile_t* file, unsigned char c)
3151 {
3152         // If there's already a character waiting to be read
3153         if (file->ungetc != EOF)
3154                 return EOF;
3155
3156         file->ungetc = c;
3157         return c;
3158 }
3159
3160
3161 /*
3162 ====================
3163 FS_Seek
3164
3165 Move the position index in a file
3166 ====================
3167 */
3168 int FS_Seek (qfile_t* file, fs_offset_t offset, int whence)
3169 {
3170         ztoolkit_t *ztk;
3171         unsigned char* buffer;
3172         fs_offset_t buffersize;
3173
3174         // Compute the file offset
3175         switch (whence)
3176         {
3177                 case SEEK_CUR:
3178                         offset += file->position - file->buff_len + file->buff_ind;
3179                         break;
3180
3181                 case SEEK_SET:
3182                         break;
3183
3184                 case SEEK_END:
3185                         offset += file->real_length;
3186                         break;
3187
3188                 default:
3189                         return -1;
3190         }
3191         if (offset < 0 || offset > file->real_length)
3192                 return -1;
3193
3194         if(file->flags & QFILE_FLAG_DATA)
3195         {
3196                 file->position = offset;
3197                 return 0;
3198         }
3199
3200         // If we have the data in our read buffer, we don't need to actually seek
3201         if (file->position - file->buff_len <= offset && offset <= file->position)
3202         {
3203                 file->buff_ind = offset + file->buff_len - file->position;
3204                 return 0;
3205         }
3206
3207         // Purge cached data
3208         FS_Purge (file);
3209
3210         // Unpacked or uncompressed files can seek directly
3211         if (! (file->flags & QFILE_FLAG_DEFLATED))
3212         {
3213                 if (FILEDESC_SEEK (file->handle, file->offset + offset, SEEK_SET) == -1)
3214                         return -1;
3215                 file->position = offset;
3216                 return 0;
3217         }
3218
3219         // Seeking in compressed files is more a hack than anything else,
3220         // but we need to support it, so here we go.
3221         ztk = file->ztk;
3222
3223         // If we have to go back in the file, we need to restart from the beginning
3224         if (offset <= file->position)
3225         {
3226                 ztk->in_ind = 0;
3227                 ztk->in_len = 0;
3228                 ztk->in_position = 0;
3229                 file->position = 0;
3230                 if (FILEDESC_SEEK (file->handle, file->offset, SEEK_SET) == -1)
3231                         Con_Printf("IMPOSSIBLE: couldn't seek in already opened pk3 file.\n");
3232
3233                 // Reset the Zlib stream
3234                 ztk->zstream.next_in = ztk->input;
3235                 ztk->zstream.avail_in = 0;
3236                 qz_inflateReset (&ztk->zstream);
3237         }
3238
3239         // We need a big buffer to force inflating into it directly
3240         buffersize = 2 * sizeof (file->buff);
3241         buffer = (unsigned char *)Mem_Alloc (tempmempool, buffersize);
3242
3243         // Skip all data until we reach the requested offset
3244         while (offset > (file->position - file->buff_len + file->buff_ind))
3245         {
3246                 fs_offset_t diff = offset - (file->position - file->buff_len + file->buff_ind);
3247                 fs_offset_t count, len;
3248
3249                 count = (diff > buffersize) ? buffersize : diff;
3250                 len = FS_Read (file, buffer, count);
3251                 if (len != count)
3252                 {
3253                         Mem_Free (buffer);
3254                         return -1;
3255                 }
3256         }
3257
3258         Mem_Free (buffer);
3259         return 0;
3260 }
3261
3262
3263 /*
3264 ====================
3265 FS_Tell
3266
3267 Give the current position in a file
3268 ====================
3269 */
3270 fs_offset_t FS_Tell (qfile_t* file)
3271 {
3272         return file->position - file->buff_len + file->buff_ind;
3273 }
3274
3275
3276 /*
3277 ====================
3278 FS_FileSize
3279
3280 Give the total size of a file
3281 ====================
3282 */
3283 fs_offset_t FS_FileSize (qfile_t* file)
3284 {
3285         return file->real_length;
3286 }
3287
3288
3289 /*
3290 ====================
3291 FS_Purge
3292
3293 Erases any buffered input or output data
3294 ====================
3295 */
3296 void FS_Purge (qfile_t* file)
3297 {
3298         file->buff_len = 0;
3299         file->buff_ind = 0;
3300         file->ungetc = EOF;
3301 }
3302
3303
3304 /*
3305 ============
3306 FS_LoadAndCloseQFile
3307
3308 Loads full content of a qfile_t and closes it.
3309 Always appends a 0 byte.
3310 ============
3311 */
3312 static unsigned char *FS_LoadAndCloseQFile (qfile_t *file, const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3313 {
3314         unsigned char *buf = NULL;
3315         fs_offset_t filesize = 0;
3316
3317         if (file)
3318         {
3319                 filesize = file->real_length;
3320                 if(filesize < 0)
3321                 {
3322                         Con_Printf("FS_LoadFile(\"%s\", pool, %s, filesizepointer): trying to open a non-regular file\n", path, quiet ? "true" : "false");
3323                         FS_Close(file);
3324                         return NULL;
3325                 }
3326
3327                 buf = (unsigned char *)Mem_Alloc (pool, filesize + 1);
3328                 buf[filesize] = '\0';
3329                 FS_Read (file, buf, filesize);
3330                 FS_Close (file);
3331                 if (developer_loadfile.integer)
3332                         Con_Printf("loaded file \"%s\" (%u bytes)\n", path, (unsigned int)filesize);
3333         }
3334
3335         if (filesizepointer)
3336                 *filesizepointer = filesize;
3337         return buf;
3338 }
3339
3340
3341 /*
3342 ============
3343 FS_LoadFile
3344
3345 Filename are relative to the quake directory.
3346 Always appends a 0 byte.
3347 ============
3348 */
3349 unsigned char *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3350 {
3351         qfile_t *file = FS_OpenVirtualFile(path, quiet);
3352         return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3353 }
3354
3355
3356 /*
3357 ============
3358 FS_SysLoadFile
3359
3360 Filename are OS paths.
3361 Always appends a 0 byte.
3362 ============
3363 */
3364 unsigned char *FS_SysLoadFile (const char *path, mempool_t *pool, qboolean quiet, fs_offset_t *filesizepointer)
3365 {
3366         qfile_t *file = FS_SysOpen(path, "rb", false);
3367         return FS_LoadAndCloseQFile(file, path, pool, quiet, filesizepointer);
3368 }
3369
3370
3371 /*
3372 ============
3373 FS_WriteFile
3374
3375 The filename will be prefixed by the current game directory
3376 ============
3377 */
3378 qboolean FS_WriteFileInBlocks (const char *filename, const void *const *data, const fs_offset_t *len, size_t count)
3379 {
3380         qfile_t *file;
3381         size_t i;
3382         fs_offset_t lentotal;
3383
3384         file = FS_OpenRealFile(filename, "wb", false);
3385         if (!file)
3386         {
3387                 Con_Printf("FS_WriteFile: failed on %s\n", filename);
3388                 return false;
3389         }
3390
3391         lentotal = 0;
3392         for(i = 0; i < count; ++i)
3393                 lentotal += len[i];
3394         Con_DPrintf("FS_WriteFile: %s (%u bytes)\n", filename, (unsigned int)lentotal);
3395         for(i = 0; i < count; ++i)
3396                 FS_Write (file, data[i], len[i]);
3397         FS_Close (file);
3398         return true;
3399 }
3400
3401 qboolean FS_WriteFile (const char *filename, const void *data, fs_offset_t len)
3402 {
3403         return FS_WriteFileInBlocks(filename, &data, &len, 1);
3404 }
3405
3406
3407 /*
3408 =============================================================================
3409
3410 OTHERS PUBLIC FUNCTIONS
3411
3412 =============================================================================
3413 */
3414
3415 /*
3416 ============
3417 FS_StripExtension
3418 ============
3419 */
3420 void FS_StripExtension (const char *in, char *out, size_t size_out)
3421 {
3422         char *last = NULL;
3423         char currentchar;
3424
3425         if (size_out == 0)
3426                 return;
3427
3428         while ((currentchar = *in) && size_out > 1)
3429         {
3430                 if (currentchar == '.')
3431                         last = out;
3432                 else if (currentchar == '/' || currentchar == '\\' || currentchar == ':')
3433                         last = NULL;
3434                 *out++ = currentchar;
3435                 in++;
3436                 size_out--;
3437         }
3438         if (last)
3439                 *last = 0;
3440         else
3441                 *out = 0;
3442 }
3443
3444
3445 /*
3446 ==================
3447 FS_DefaultExtension
3448 ==================
3449 */
3450 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
3451 {
3452         const char *src;
3453
3454         // if path doesn't have a .EXT, append extension
3455         // (extension should include the .)
3456         src = path + strlen(path);
3457
3458         while (*src != '/' && src != path)
3459         {
3460                 if (*src == '.')
3461                         return;                 // it has an extension
3462                 src--;
3463         }
3464
3465         strlcat (path, extension, size_path);
3466 }
3467
3468
3469 /*
3470 ==================
3471 FS_FileType
3472
3473 Look for a file in the packages and in the filesystem
3474 ==================
3475 */
3476 int FS_FileType (const char *filename)
3477 {
3478         searchpath_t *search;
3479         char fullpath[MAX_OSPATH];
3480
3481         search = FS_FindFile (filename, NULL, true);
3482         if(!search)
3483                 return FS_FILETYPE_NONE;
3484
3485         if(search->pack && !search->pack->vpack)
3486                 return FS_FILETYPE_FILE; // TODO can't check directories in paks yet, maybe later
3487
3488         dpsnprintf(fullpath, sizeof(fullpath), "%s%s", search->filename, filename);
3489         return FS_SysFileType(fullpath);
3490 }
3491
3492
3493 /*
3494 ==================
3495 FS_FileExists
3496
3497 Look for a file in the packages and in the filesystem
3498 ==================
3499 */
3500 qboolean FS_FileExists (const char *filename)
3501 {
3502         return (FS_FindFile (filename, NULL, true) != NULL);
3503 }
3504
3505
3506 /*
3507 ==================
3508 FS_SysFileExists
3509
3510 Look for a file in the filesystem only
3511 ==================
3512 */
3513 int FS_SysFileType (const char *path)
3514 {
3515 #if WIN32
3516 // Sajt - some older sdks are missing this define
3517 # ifndef INVALID_FILE_ATTRIBUTES
3518 #  define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
3519 # endif
3520
3521         DWORD result = GetFileAttributes(path);
3522
3523         if(result == INVALID_FILE_ATTRIBUTES)
3524                 return FS_FILETYPE_NONE;
3525
3526         if(result & FILE_ATTRIBUTE_DIRECTORY)
3527                 return FS_FILETYPE_DIRECTORY;
3528
3529         return FS_FILETYPE_FILE;
3530 #else
3531         struct stat buf;
3532
3533         if (stat (path,&buf) == -1)
3534                 return FS_FILETYPE_NONE;
3535
3536 #ifndef S_ISDIR
3537 #define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
3538 #endif
3539         if(S_ISDIR(buf.st_mode))
3540                 return FS_FILETYPE_DIRECTORY;
3541
3542         return FS_FILETYPE_FILE;
3543 #endif
3544 }
3545
3546 qboolean FS_SysFileExists (const char *path)
3547 {
3548         return FS_SysFileType (path) != FS_FILETYPE_NONE;
3549 }
3550
3551 /*
3552 ===========
3553 FS_Search
3554
3555 Allocate and fill a search structure with information on matching filenames.
3556 ===========
3557 */
3558 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
3559 {
3560         fssearch_t *search;
3561         searchpath_t *searchpath;
3562         pack_t *pak;
3563         int i, basepathlength, numfiles, numchars, resultlistindex, dirlistindex;
3564         stringlist_t resultlist;
3565         stringlist_t dirlist;
3566         const char *slash, *backslash, *colon, *separator;
3567         char *basepath;
3568
3569         for (i = 0;pattern[i] == '.' || pattern[i] == ':' || pattern[i] == '/' || pattern[i] == '\\';i++)
3570                 ;
3571
3572         if (i > 0)
3573         {
3574                 Con_Printf("Don't use punctuation at the beginning of a search pattern!\n");
3575                 return NULL;
3576         }
3577
3578         stringlistinit(&resultlist);
3579         stringlistinit(&dirlist);
3580         search = NULL;
3581         slash = strrchr(pattern, '/');
3582         backslash = strrchr(pattern, '\\');
3583         colon = strrchr(pattern, ':');
3584         separator = max(slash, backslash);
3585         separator = max(separator, colon);
3586         basepathlength = separator ? (separator + 1 - pattern) : 0;
3587         basepath = (char *)Mem_Alloc (tempmempool, basepathlength + 1);
3588         if (basepathlength)
3589                 memcpy(basepath, pattern, basepathlength);
3590         basepath[basepathlength] = 0;
3591
3592         // search through the path, one element at a time
3593         for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
3594         {
3595                 // is the element a pak file?
3596                 if (searchpath->pack && !searchpath->pack->vpack)
3597                 {
3598                         // look through all the pak file elements
3599                         pak = searchpath->pack;
3600                         for (i = 0;i < pak->numfiles;i++)
3601                         {
3602                                 char temp[MAX_OSPATH];
3603                                 strlcpy(temp, pak->files[i].name, sizeof(temp));
3604                                 while (temp[0])
3605                                 {
3606                                         if (matchpattern(temp, (char *)pattern, true))
3607                                         {
3608                                                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3609                                                         if (!strcmp(resultlist.strings[resultlistindex], temp))
3610                                                                 break;
3611                                                 if (resultlistindex == resultlist.numstrings)
3612                                                 {
3613                                                         stringlistappend(&resultlist, temp);
3614                                                         if (!quiet && developer_loading.integer)
3615                                                                 Con_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
3616                                                 }
3617                                         }
3618                                         // strip off one path element at a time until empty
3619                                         // this way directories are added to the listing if they match the pattern
3620                                         slash = strrchr(temp, '/');
3621                                         backslash = strrchr(temp, '\\');
3622                                         colon = strrchr(temp, ':');
3623                                         separator = temp;
3624                                         if (separator < slash)
3625                                                 separator = slash;
3626                                         if (separator < backslash)
3627                                                 separator = backslash;
3628                                         if (separator < colon)
3629                                                 separator = colon;
3630                                         *((char *)separator) = 0;
3631                                 }
3632                         }
3633                 }
3634                 else
3635                 {
3636                         stringlist_t matchedSet, foundSet;
3637                         const char *start = pattern;
3638
3639                         stringlistinit(&matchedSet);
3640                         stringlistinit(&foundSet);
3641                         // add a first entry to the set
3642                         stringlistappend(&matchedSet, "");
3643                         // iterate through pattern's path
3644                         while (*start)
3645                         {
3646                                 const char *asterisk, *wildcard, *nextseparator, *prevseparator;
3647                                 char subpath[MAX_OSPATH];
3648                                 char subpattern[MAX_OSPATH];
3649
3650                                 // find the next wildcard
3651                                 wildcard = strchr(start, '?');
3652                                 asterisk = strchr(start, '*');
3653                                 if (asterisk && (!wildcard || asterisk < wildcard))
3654                                 {
3655                                         wildcard = asterisk;
3656                                 }
3657
3658                                 if (wildcard)
3659                                 {
3660                                         nextseparator = strchr( wildcard, '/' );
3661                                 }
3662                                 else
3663                                 {
3664                                         nextseparator = NULL;
3665                                 }
3666
3667                                 if( !nextseparator ) {
3668                                         nextseparator = start + strlen( start );
3669                                 }
3670
3671                                 // prevseparator points past the '/' right before the wildcard and nextseparator at the one following it (or at the end of the string)
3672                                 // copy everything up except nextseperator
3673                                 strlcpy(subpattern, pattern, min(sizeof(subpattern), (size_t) (nextseparator - pattern + 1)));
3674                                 // find the last '/' before the wildcard
3675                                 prevseparator = strrchr( subpattern, '/' );
3676                                 if (!prevseparator)
3677                                         prevseparator = subpattern;
3678                                 else
3679                                         prevseparator++;
3680                                 // copy everything from start to the previous including the '/' (before the wildcard)
3681                                 // everything up to start is already included in the path of matchedSet's entries
3682                                 strlcpy(subpath, start, min(sizeof(subpath), (size_t) ((prevseparator - subpattern) - (start - pattern) + 1)));
3683
3684                                 // for each entry in matchedSet try to open the subdirectories specified in subpath
3685                                 for( dirlistindex = 0 ; dirlistindex < matchedSet.numstrings ; dirlistindex++ ) {
3686                                         char temp[MAX_OSPATH];
3687                                         strlcpy( temp, matchedSet.strings[ dirlistindex ], sizeof(temp) );
3688                                         strlcat( temp, subpath, sizeof(temp) );
3689                                         listdirectory( &foundSet, searchpath->filename, temp );
3690                                 }
3691                                 if( dirlistindex == 0 ) {
3692                                         break;
3693                                 }
3694                                 // reset the current result set
3695                                 stringlistfreecontents( &matchedSet );
3696                                 // match against the pattern
3697                                 for( dirlistindex = 0 ; dirlistindex < foundSet.numstrings ; dirlistindex++ ) {
3698                                         const char *direntry = foundSet.strings[ dirlistindex ];
3699                                         if (matchpattern(direntry, subpattern, true)) {
3700                                                 stringlistappend( &matchedSet, direntry );
3701                                         }
3702                                 }
3703                                 stringlistfreecontents( &foundSet );
3704
3705                                 start = nextseparator;
3706                         }
3707
3708                         for (dirlistindex = 0;dirlistindex < matchedSet.numstrings;dirlistindex++)
3709                         {
3710                                 const char *matchtemp = matchedSet.strings[dirlistindex];
3711                                 if (matchpattern(matchtemp, (char *)pattern, true))
3712                                 {
3713                                         for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3714                                                 if (!strcmp(resultlist.strings[resultlistindex], matchtemp))
3715                                                         break;
3716                                         if (resultlistindex == resultlist.numstrings)
3717                                         {
3718                                                 stringlistappend(&resultlist, matchtemp);
3719                                                 if (!quiet && developer_loading.integer)
3720                                                         Con_Printf("SearchDirFile: %s\n", matchtemp);
3721                                         }
3722                                 }
3723                         }
3724                         stringlistfreecontents( &matchedSet );
3725                 }
3726         }
3727
3728         if (resultlist.numstrings)
3729         {
3730                 stringlistsort(&resultlist, true);
3731                 numfiles = resultlist.numstrings;
3732                 numchars = 0;
3733                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3734                         numchars += (int)strlen(resultlist.strings[resultlistindex]) + 1;
3735                 search = (fssearch_t *)Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
3736                 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
3737                 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
3738                 search->numfilenames = (int)numfiles;
3739                 numfiles = 0;
3740                 numchars = 0;
3741                 for (resultlistindex = 0;resultlistindex < resultlist.numstrings;resultlistindex++)
3742                 {
3743                         size_t textlen;
3744                         search->filenames[numfiles] = search->filenamesbuffer + numchars;
3745                         textlen = strlen(resultlist.strings[resultlistindex]) + 1;
3746                         memcpy(search->filenames[numfiles], resultlist.strings[resultlistindex], textlen);
3747                         numfiles++;
3748                         numchars += (int)textlen;
3749                 }
3750         }
3751         stringlistfreecontents(&resultlist);
3752
3753         Mem_Free(basepath);
3754         return search;
3755 }
3756
3757 void FS_FreeSearch(fssearch_t *search)
3758 {
3759         Z_Free(search);
3760 }
3761
3762 extern int con_linewidth;
3763 static int FS_ListDirectory(const char *pattern, int oneperline)
3764 {
3765         int numfiles;
3766         int numcolumns;
3767         int numlines;
3768         int columnwidth;
3769         int linebufpos;
3770         int i, j, k, l;
3771         const char *name;
3772         char linebuf[MAX_INPUTLINE];
3773         fssearch_t *search;
3774         search = FS_Search(pattern, true, true);
3775         if (!search)
3776                 return 0;
3777         numfiles = search->numfilenames;
3778         if (!oneperline)
3779         {
3780                 // FIXME: the names could be added to one column list and then
3781                 // gradually shifted into the next column if they fit, and then the
3782                 // next to make a compact variable width listing but it's a lot more
3783                 // complicated...
3784                 // find width for columns
3785                 columnwidth = 0;
3786                 for (i = 0;i < numfiles;i++)
3787                 {
3788                         l = (int)strlen(search->filenames[i]);
3789                         if (columnwidth < l)
3790                                 columnwidth = l;
3791                 }
3792                 // count the spacing character
3793                 columnwidth++;
3794                 // calculate number of columns
3795                 numcolumns = con_linewidth / columnwidth;
3796                 // don't bother with the column printing if it's only one column
3797                 if (numcolumns >= 2)
3798                 {
3799                         numlines = (numfiles + numcolumns - 1) / numcolumns;
3800                         for (i = 0;i < numlines;i++)
3801                         {
3802                                 linebufpos = 0;
3803                                 for (k = 0;k < numcolumns;k++)
3804                                 {
3805                                         l = i * numcolumns + k;
3806                                         if (l < numfiles)
3807                                         {
3808                                                 name = search->filenames[l];
3809                                                 for (j = 0;name[j] && linebufpos + 1 < (int)sizeof(linebuf);j++)
3810                                                         linebuf[linebufpos++] = name[j];
3811                                                 // space out name unless it's the last on the line
3812                                                 if (k + 1 < numcolumns && l + 1 < numfiles)
3813                                                         for (;j < columnwidth && linebufpos + 1 < (int)sizeof(linebuf);j++)
3814                                                                 linebuf[linebufpos++] = ' ';
3815                                         }
3816                                 }
3817                                 linebuf[linebufpos] = 0;
3818                                 Con_Printf("%s\n", linebuf);
3819                         }
3820                 }
3821                 else
3822                         oneperline = true;
3823         }
3824         if (oneperline)
3825                 for (i = 0;i < numfiles;i++)
3826                         Con_Printf("%s\n", search->filenames[i]);
3827         FS_FreeSearch(search);
3828         return (int)numfiles;
3829 }
3830
3831 static void FS_ListDirectoryCmd (cmd_state_t *cmd, const char* cmdname, int oneperline)
3832 {
3833         const char *pattern;
3834         if (Cmd_Argc(cmd) >= 3)
3835         {
3836                 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
3837                 return;
3838         }
3839         if (Cmd_Argc(cmd) == 2)
3840                 pattern = Cmd_Argv(cmd, 1);
3841         else
3842                 pattern = "*";
3843         if (!FS_ListDirectory(pattern, oneperline))
3844                 Con_Print("No files found.\n");
3845 }
3846
3847 void FS_Dir_f(cmd_state_t *cmd)
3848 {
3849         FS_ListDirectoryCmd(cmd, "dir", true);
3850 }
3851
3852 void FS_Ls_f(cmd_state_t *cmd)
3853 {
3854         FS_ListDirectoryCmd(cmd, "ls", false);
3855 }
3856
3857 void FS_Which_f(cmd_state_t *cmd)
3858 {
3859         const char *filename;
3860         int index;
3861         searchpath_t *sp;
3862         if (Cmd_Argc(cmd) != 2)
3863         {
3864                 Con_Printf("usage:\n%s <file>\n", Cmd_Argv(cmd, 0));
3865                 return;
3866         }  
3867         filename = Cmd_Argv(cmd, 1);
3868         sp = FS_FindFile(filename, &index, true);
3869         if (!sp) {
3870                 Con_Printf("%s isn't anywhere\n", filename);
3871                 return;
3872         }
3873         if (sp->pack)
3874         {
3875                 if(sp->pack->vpack)
3876                         Con_Printf("%s is in virtual package %sdir\n", filename, sp->pack->shortname);
3877                 else
3878                         Con_Printf("%s is in package %s\n", filename, sp->pack->shortname);
3879         }
3880         else
3881                 Con_Printf("%s is file %s%s\n", filename, sp->filename, filename);
3882 }
3883
3884
3885 const char *FS_WhichPack(const char *filename)
3886 {
3887         int index;
3888         searchpath_t *sp = FS_FindFile(filename, &index, true);
3889         if(sp && sp->pack)
3890                 return sp->pack->shortname;
3891         else if(sp)
3892                 return "";
3893         else
3894                 return 0;
3895 }
3896
3897 /*
3898 ====================
3899 FS_IsRegisteredQuakePack
3900
3901 Look for a proof of purchase file file in the requested package
3902
3903 If it is found, this file should NOT be downloaded.
3904 ====================
3905 */
3906 qboolean FS_IsRegisteredQuakePack(const char *name)
3907 {
3908         searchpath_t *search;
3909         pack_t *pak;
3910
3911         // search through the path, one element at a time
3912         for (search = fs_searchpaths;search;search = search->next)
3913         {
3914                 if (search->pack && !search->pack->vpack && !strcasecmp(FS_FileWithoutPath(search->filename), name))
3915                         // TODO do we want to support vpacks in here too?
3916                 {
3917                         int (*strcmp_funct) (const char* str1, const char* str2);
3918                         int left, right, middle;
3919
3920                         pak = search->pack;
3921                         strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
3922
3923                         // Look for the file (binary search)
3924                         left = 0;
3925                         right = pak->numfiles - 1;
3926                         while (left <= right)
3927                         {
3928                                 int diff;
3929
3930                                 middle = (left + right) / 2;
3931                                 diff = strcmp_funct (pak->files[middle].name, "gfx/pop.lmp");
3932
3933                                 // Found it
3934                                 if (!diff)
3935                                         return true;
3936
3937                                 // If we're too far in the list
3938                                 if (diff > 0)
3939                                         right = middle - 1;
3940                                 else
3941                                         left = middle + 1;
3942                         }
3943
3944                         // we found the requested pack but it is not registered quake
3945                         return false;
3946                 }
3947         }
3948
3949         return false;
3950 }
3951
3952 int FS_CRCFile(const char *filename, size_t *filesizepointer)
3953 {
3954         int crc = -1;
3955         unsigned char *filedata;
3956         fs_offset_t filesize;
3957         if (filesizepointer)
3958                 *filesizepointer = 0;
3959         if (!filename || !*filename)
3960                 return crc;
3961         filedata = FS_LoadFile(filename, tempmempool, true, &filesize);
3962         if (filedata)
3963         {
3964                 if (filesizepointer)
3965                         *filesizepointer = filesize;
3966                 crc = CRC_Block(filedata, filesize);
3967                 Mem_Free(filedata);
3968         }
3969         return crc;
3970 }
3971
3972 unsigned char *FS_Deflate(const unsigned char *data, size_t size, size_t *deflated_size, int level, mempool_t *mempool)
3973 {
3974         z_stream strm;
3975         unsigned char *out = NULL;
3976         unsigned char *tmp;
3977
3978         *deflated_size = 0;
3979 #ifndef LINK_TO_ZLIB
3980         if(!zlib_dll)
3981                 return NULL;
3982 #endif
3983
3984         memset(&strm, 0, sizeof(strm));
3985         strm.zalloc = Z_NULL;
3986         strm.zfree = Z_NULL;
3987         strm.opaque = Z_NULL;
3988
3989         if(level < 0)
3990                 level = Z_DEFAULT_COMPRESSION;
3991
3992         if(qz_deflateInit2(&strm, level, Z_DEFLATED, -MAX_WBITS, Z_MEMLEVEL_DEFAULT, Z_BINARY) != Z_OK)
3993         {
3994                 Con_Printf("FS_Deflate: deflate init error!\n");
3995                 return NULL;
3996         }
3997
3998         strm.next_in = (unsigned char*)data;
3999         strm.avail_in = (unsigned int)size;
4000
4001         tmp = (unsigned char *) Mem_Alloc(tempmempool, size);
4002         if(!tmp)
4003         {
4004                 Con_Printf("FS_Deflate: not enough memory in tempmempool!\n");
4005                 qz_deflateEnd(&strm);
4006                 return NULL;
4007         }
4008
4009         strm.next_out = tmp;
4010         strm.avail_out = (unsigned int)size;
4011
4012         if(qz_deflate(&strm, Z_FINISH) != Z_STREAM_END)
4013         {
4014                 Con_Printf("FS_Deflate: deflate failed!\n");
4015                 qz_deflateEnd(&strm);
4016                 Mem_Free(tmp);
4017                 return NULL;
4018         }
4019         
4020         if(qz_deflateEnd(&strm) != Z_OK)
4021         {
4022                 Con_Printf("FS_Deflate: deflateEnd failed\n");
4023                 Mem_Free(tmp);
4024                 return NULL;
4025         }
4026
4027         if(strm.total_out >= size)
4028         {
4029                 Con_Printf("FS_Deflate: deflate is useless on this data!\n");
4030                 Mem_Free(tmp);
4031                 return NULL;
4032         }
4033
4034         out = (unsigned char *) Mem_Alloc(mempool, strm.total_out);
4035         if(!out)
4036         {
4037                 Con_Printf("FS_Deflate: not enough memory in target mempool!\n");
4038                 Mem_Free(tmp);
4039                 return NULL;
4040         }
4041
4042         *deflated_size = (size_t)strm.total_out;
4043
4044         memcpy(out, tmp, strm.total_out);
4045         Mem_Free(tmp);
4046         
4047         return out;
4048 }
4049
4050 static void AssertBufsize(sizebuf_t *buf, int length)
4051 {
4052         if(buf->cursize + length > buf->maxsize)
4053         {
4054                 int oldsize = buf->maxsize;
4055                 unsigned char *olddata;
4056                 olddata = buf->data;
4057                 buf->maxsize += length;
4058                 buf->data = (unsigned char *) Mem_Alloc(tempmempool, buf->maxsize);
4059                 if(olddata)
4060                 {
4061                         memcpy(buf->data, olddata, oldsize);
4062                         Mem_Free(olddata);
4063                 }
4064         }
4065 }
4066
4067 unsigned char *FS_Inflate(const unsigned char *data, size_t size, size_t *inflated_size, mempool_t *mempool)
4068 {
4069         int ret;
4070         z_stream strm;
4071         unsigned char *out = NULL;
4072         unsigned char tmp[2048];
4073         unsigned int have;
4074         sizebuf_t outbuf;
4075
4076         *inflated_size = 0;
4077 #ifndef LINK_TO_ZLIB
4078         if(!zlib_dll)
4079                 return NULL;
4080 #endif
4081
4082         memset(&outbuf, 0, sizeof(outbuf));
4083         outbuf.data = (unsigned char *) Mem_Alloc(tempmempool, sizeof(tmp));
4084         outbuf.maxsize = sizeof(tmp);
4085
4086         memset(&strm, 0, sizeof(strm));
4087         strm.zalloc = Z_NULL;
4088         strm.zfree = Z_NULL;
4089         strm.opaque = Z_NULL;
4090
4091         if(qz_inflateInit2(&strm, -MAX_WBITS) != Z_OK)
4092         {
4093                 Con_Printf("FS_Inflate: inflate init error!\n");
4094                 Mem_Free(outbuf.data);
4095                 return NULL;
4096         }
4097
4098         strm.next_in = (unsigned char*)data;
4099         strm.avail_in = (unsigned int)size;
4100
4101         do
4102         {
4103                 strm.next_out = tmp;
4104                 strm.avail_out = sizeof(tmp);
4105                 ret = qz_inflate(&strm, Z_NO_FLUSH);
4106                 // it either returns Z_OK on progress, Z_STREAM_END on end
4107                 // or an error code
4108                 switch(ret)
4109                 {
4110                         case Z_STREAM_END:
4111                         case Z_OK:
4112                                 break;
4113                                 
4114                         case Z_STREAM_ERROR:
4115                                 Con_Print("FS_Inflate: stream error!\n");
4116                                 break;
4117                         case Z_DATA_ERROR:
4118                                 Con_Print("FS_Inflate: data error!\n");
4119                                 break;
4120                         case Z_MEM_ERROR:
4121                                 Con_Print("FS_Inflate: mem error!\n");
4122                                 break;
4123                         case Z_BUF_ERROR:
4124                                 Con_Print("FS_Inflate: buf error!\n");
4125                                 break;
4126                         default:
4127                                 Con_Print("FS_Inflate: unknown error!\n");
4128                                 break;
4129                                 
4130                 }
4131                 if(ret != Z_OK && ret != Z_STREAM_END)
4132                 {
4133                         Con_Printf("Error after inflating %u bytes\n", (unsigned)strm.total_in);
4134                         Mem_Free(outbuf.data);
4135                         qz_inflateEnd(&strm);
4136                         return NULL;
4137                 }
4138                 have = sizeof(tmp) - strm.avail_out;
4139                 AssertBufsize(&outbuf, max(have, sizeof(tmp)));
4140                 SZ_Write(&outbuf, tmp, have);
4141         } while(ret != Z_STREAM_END);
4142
4143         qz_inflateEnd(&strm);
4144
4145         out = (unsigned char *) Mem_Alloc(mempool, outbuf.cursize);
4146         if(!out)
4147         {
4148                 Con_Printf("FS_Inflate: not enough memory in target mempool!\n");
4149                 Mem_Free(outbuf.data);
4150                 return NULL;
4151         }
4152
4153         memcpy(out, outbuf.data, outbuf.cursize);
4154         Mem_Free(outbuf.data);
4155
4156         *inflated_size = (size_t)outbuf.cursize;
4157         
4158         return out;
4159 }