Factorized some code in the shared library loaders
[divverent/darkplaces.git] / fs.c
1 /*
2         DarkPlaces file system
3
4         Copyright (C) 2003 Mathieu Olivier
5         Copyright (C) 1999,2000  contributors of the QuakeForge project
6
7         This program is free software; you can redistribute it and/or
8         modify it under the terms of the GNU General Public License
9         as published by the Free Software Foundation; either version 2
10         of the License, or (at your option) any later version.
11
12         This program is distributed in the hope that it will be useful,
13         but WITHOUT ANY WARRANTY; without even the implied warranty of
14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15
16         See the GNU General Public License for more details.
17
18         You should have received a copy of the GNU General Public License
19         along with this program; if not, write to:
20
21                 Free Software Foundation, Inc.
22                 59 Temple Place - Suite 330
23                 Boston, MA  02111-1307, USA
24 */
25
26 #include "quakedef.h"
27
28 #include <stdlib.h>
29 #include <string.h>
30 #include <limits.h>
31 #include <fcntl.h>
32
33 #ifdef WIN32
34 # include <direct.h>
35 # include <io.h>
36 #else
37 # include <pwd.h>
38 # include <sys/stat.h>
39 # include <unistd.h>
40 #endif
41
42 #ifndef PATH_MAX
43 # define PATH_MAX 512
44 #endif
45
46 #include "fs.h"
47
48
49 /*
50
51 All of Quake's data access is through a hierchal file system, but the contents
52 of the file system can be transparently merged from several sources.
53
54 The "base directory" is the path to the directory holding the quake.exe and
55 all game directories.  The sys_* files pass this to host_init in
56 quakeparms_t->basedir.  This can be overridden with the "-basedir" command
57 line parm to allow code debugging in a different directory.  The base
58 directory is only used during filesystem initialization.
59
60 The "game directory" is the first tree on the search path and directory that
61 all generated files (savegames, screenshots, demos, config files) will be
62 saved to.  This can be overridden with the "-game" command line parameter.
63 The game directory can never be changed while quake is executing.  This is a
64 precacution against having a malicious server instruct clients to write files
65 over areas they shouldn't.
66
67 */
68
69
70 /*
71 =============================================================================
72
73 CONSTANTS
74
75 =============================================================================
76 */
77
78 // Magic numbers of a ZIP file (big-endian format)
79 #define ZIP_DATA_HEADER 0x504B0304  // "PK\3\4"
80 #define ZIP_CDIR_HEADER 0x504B0102  // "PK\1\2"
81 #define ZIP_END_HEADER  0x504B0506  // "PK\5\6"
82
83 // Other constants for ZIP files
84 #define ZIP_MAX_COMMENTS_SIZE           ((unsigned short)0xFFFF)
85 #define ZIP_END_CDIR_SIZE                       22
86 #define ZIP_CDIR_CHUNK_BASE_SIZE        46
87 #define ZIP_LOCAL_CHUNK_BASE_SIZE       30
88
89 // Zlib constants (from zlib.h)
90 #define Z_SYNC_FLUSH    2
91 #define MAX_WBITS               15
92 #define Z_OK                    0
93 #define Z_STREAM_END    1
94 #define ZLIB_VERSION    "1.1.4"
95
96
97 /*
98 =============================================================================
99
100 TYPES
101
102 =============================================================================
103 */
104
105 // Zlib stream (from zlib.h)
106 // Warning: some pointers we don't use directly have
107 // been cast to "void*" for a matter of simplicity
108 typedef struct
109 {
110         qbyte                   *next_in;       // next input byte
111         unsigned int    avail_in;       // number of bytes available at next_in
112         unsigned long   total_in;       // total nb of input bytes read so far
113
114         qbyte                   *next_out;      // next output byte should be put there
115         unsigned int    avail_out;      // remaining free space at next_out
116         unsigned long   total_out;      // total nb of bytes output so far
117
118         char                    *msg;           // last error message, NULL if no error
119         void                    *state;         // not visible by applications
120
121         void                    *zalloc;        // used to allocate the internal state
122         void                    *zfree;         // used to free the internal state
123         void                    *opaque;        // private data object passed to zalloc and zfree
124
125         int                             data_type;      // best guess about the data type: ascii or binary
126         unsigned long   adler;          // adler32 value of the uncompressed data
127         unsigned long   reserved;       // reserved for future use
128 } z_stream;
129
130
131 // Our own file structure on top of FILE
132 typedef enum
133 {
134         FS_FLAG_NONE            = 0,
135         FS_FLAG_PACKED          = (1 << 0),     // inside a package (PAK or PK3)
136         FS_FLAG_DEFLATED        = (1 << 1)      // file is compressed using the deflate algorithm (PK3 only)
137 } fs_flags_t;
138
139 #define ZBUFF_SIZE 1024
140 typedef struct
141 {
142         z_stream        zstream;
143         size_t          real_length;                    // length of the uncompressed file
144         size_t          in_ind, in_max;                 // input buffer index and counter
145         size_t          in_position;                    // position in the compressed file
146         size_t          out_ind, out_max;               // output buffer index and counter
147         size_t          out_position;                   // how many bytes did we uncompress until now?
148         qbyte           input [ZBUFF_SIZE];
149         qbyte           output [ZBUFF_SIZE];
150 } ztoolkit_t;
151
152 struct qfile_s
153 {
154         fs_flags_t      flags;
155         FILE*           stream;
156         size_t          length;         // file size on disk (PACKED only)
157         size_t          offset;         // offset into a package (PACKED only)
158         size_t          position;       // current position in the file (PACKED only)
159         ztoolkit_t*     z;                      // used for inflating (DEFLATED only)
160 };
161
162
163 // ------ PK3 files on disk ------ //
164
165 // You can get the complete ZIP format description from PKWARE website
166
167 typedef struct
168 {
169         unsigned int signature;
170         unsigned short disknum;
171         unsigned short cdir_disknum;    // number of the disk with the start of the central directory
172         unsigned short localentries;    // number of entries in the central directory on this disk
173         unsigned short nbentries;               // total number of entries in the central directory on this disk
174         unsigned int cdir_size;                 // size of the central directory
175         unsigned int cdir_offset;               // with respect to the starting disk number
176         unsigned short comment_size;
177 } pk3_endOfCentralDir_t;
178
179
180 // ------ PAK files on disk ------ //
181 typedef struct
182 {
183         char name[56];
184         int filepos, filelen;
185 } dpackfile_t;
186
187 typedef struct
188 {
189         char id[4];
190         int dirofs;
191         int dirlen;
192 } dpackheader_t;
193
194
195 // Packages in memory
196 typedef enum
197 {
198         FILE_FLAG_NONE          = 0,
199         FILE_FLAG_TRUEOFFS      = (1 << 0),     // the offset in packfile_t is the true contents offset
200         FILE_FLAG_DEFLATED      = (1 << 1)      // file compressed using the deflate algorithm
201 } file_flags_t;
202
203 typedef struct
204 {
205         char name [MAX_QPATH];
206         file_flags_t flags;
207         size_t offset;
208         size_t packsize;        // size in the package
209         size_t realsize;        // real file size (uncompressed)
210 } packfile_t;
211
212 typedef struct pack_s
213 {
214         char filename [MAX_OSPATH];
215         FILE *handle;
216         int ignorecase; // PK3 ignores case
217         int numfiles;
218         packfile_t *files;
219         mempool_t *mempool;
220         struct pack_s *next;
221 } pack_t;
222
223
224 // Search paths for files (including packages)
225 typedef struct searchpath_s
226 {
227         // only one of filename / pack will be used
228         char filename[MAX_OSPATH];
229         pack_t *pack;
230         struct searchpath_s *next;
231 } searchpath_t;
232
233
234 /*
235 =============================================================================
236
237 FUNCTION PROTOTYPES
238
239 =============================================================================
240 */
241
242 void FS_Dir_f(void);
243 void FS_Ls_f(void);
244
245 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
246                                                                          size_t offset, size_t packsize,
247                                                                          size_t realsize, file_flags_t flags);
248
249
250 /*
251 =============================================================================
252
253 VARIABLES
254
255 =============================================================================
256 */
257
258 mempool_t *fs_mempool;
259 mempool_t *pak_mempool;
260
261 int fs_filesize;
262
263 pack_t *packlist = NULL;
264
265 searchpath_t *fs_searchpaths;
266
267 #define MAX_FILES_IN_PACK       65536
268
269 char fs_gamedir[MAX_OSPATH];
270 char fs_basedir[MAX_OSPATH];
271
272 qboolean fs_modified;   // set true if using non-id files
273
274
275 /*
276 =============================================================================
277
278 PRIVATE FUNCTIONS - PK3 HANDLING
279
280 =============================================================================
281 */
282
283 // Functions exported from zlib
284 #ifdef WIN32
285 # define ZEXPORT WINAPI
286 #else
287 # define ZEXPORT
288 #endif
289
290 static int (ZEXPORT *qz_inflate) (z_stream* strm, int flush);
291 static int (ZEXPORT *qz_inflateEnd) (z_stream* strm);
292 static int (ZEXPORT *qz_inflateInit2_) (z_stream* strm, int windowBits, const char *version, int stream_size);
293 static int (ZEXPORT *qz_inflateReset) (z_stream* strm);
294
295 #define qz_inflateInit2(strm, windowBits) \
296         qz_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
297
298 static dllfunction_t zlibfuncs[] =
299 {
300         {"inflate",                     (void **) &qz_inflate},
301         {"inflateEnd",          (void **) &qz_inflateEnd},
302         {"inflateInit2_",       (void **) &qz_inflateInit2_},
303         {"inflateReset",        (void **) &qz_inflateReset},
304         {NULL, NULL}
305 };
306
307 // Handle for Zlib DLL
308 static dllhandle_t zlib_dll = NULL;
309
310
311 /*
312 ====================
313 PK3_CloseLibrary
314
315 Unload the Zlib DLL
316 ====================
317 */
318 void PK3_CloseLibrary (void)
319 {
320         Sys_UnloadLibrary (&zlib_dll);
321 }
322
323
324 /*
325 ====================
326 PK3_OpenLibrary
327
328 Try to load the Zlib DLL
329 ====================
330 */
331 qboolean PK3_OpenLibrary (void)
332 {
333         const char* dllname;
334
335         // Already loaded?
336         if (zlib_dll)
337                 return true;
338
339 #ifdef WIN32
340         dllname = "zlib.dll";
341 #else
342         dllname = "libz.so";
343 #endif
344
345         // Load the DLL
346         if (! Sys_LoadLibrary (dllname, &zlib_dll, zlibfuncs))
347         {
348                 Con_Printf ("Compressed files support disabled\n");
349                 return false;
350         }
351
352         Con_Printf ("Compressed files support enabled\n");
353         return true;
354 }
355
356
357 /*
358 ====================
359 PK3_GetEndOfCentralDir
360
361 Extract the end of the central directory from a PK3 package
362 ====================
363 */
364 qboolean PK3_GetEndOfCentralDir (const char *packfile, FILE *packhandle, pk3_endOfCentralDir_t *eocd)
365 {
366         long filesize, maxsize;
367         qbyte *buffer, *ptr;
368         int ind;
369
370         // Get the package size
371         fseek (packhandle, 0, SEEK_END);
372         filesize = ftell (packhandle);
373         if (filesize < ZIP_END_CDIR_SIZE)
374                 return false;
375
376         // Load the end of the file in memory
377         if (filesize < ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE)
378                 maxsize = filesize;
379         else
380                 maxsize = ZIP_MAX_COMMENTS_SIZE + ZIP_END_CDIR_SIZE;
381         buffer = Mem_Alloc (tempmempool, maxsize);
382         fseek (packhandle, filesize - maxsize, SEEK_SET);
383         if (fread (buffer, 1, maxsize, packhandle) != (unsigned long) maxsize)
384         {
385                 Mem_Free (buffer);
386                 return false;
387         }
388
389         // Look for the end of central dir signature around the end of the file
390         maxsize -= ZIP_END_CDIR_SIZE;
391         ptr = &buffer[maxsize];
392         ind = 0;
393         while (BuffBigLong (ptr) != ZIP_END_HEADER)
394         {
395                 if (ind == maxsize)
396                 {
397                         Mem_Free (buffer);
398                         return false;
399                 }
400
401                 ind++;
402                 ptr--;
403         }
404
405         memcpy (eocd, ptr, ZIP_END_CDIR_SIZE);
406         eocd->signature = LittleLong (eocd->signature);
407         eocd->disknum = LittleShort (eocd->disknum);
408         eocd->cdir_disknum = LittleShort (eocd->cdir_disknum);
409         eocd->localentries = LittleShort (eocd->localentries);
410         eocd->nbentries = LittleShort (eocd->nbentries);
411         eocd->cdir_size = LittleLong (eocd->cdir_size);
412         eocd->cdir_offset = LittleLong (eocd->cdir_offset);
413         eocd->comment_size = LittleShort (eocd->comment_size);
414
415         Mem_Free (buffer);
416
417         return true;
418 }
419
420
421 /*
422 ====================
423 PK3_BuildFileList
424
425 Extract the file list from a PK3 file
426 ====================
427 */
428 int PK3_BuildFileList (pack_t *pack, const pk3_endOfCentralDir_t *eocd)
429 {
430         qbyte *central_dir, *ptr;
431         unsigned int ind;
432         int remaining;
433
434         // Load the central directory in memory
435         central_dir = Mem_Alloc (tempmempool, eocd->cdir_size);
436         fseek (pack->handle, eocd->cdir_offset, SEEK_SET);
437         fread (central_dir, 1, eocd->cdir_size, pack->handle);
438
439         // Extract the files properties
440         // The parsing is done "by hand" because some fields have variable sizes and
441         // the constant part isn't 4-bytes aligned, which makes the use of structs difficult
442         remaining = eocd->cdir_size;
443         pack->numfiles = 0;
444         ptr = central_dir;
445         for (ind = 0; ind < eocd->nbentries; ind++)
446         {
447                 size_t namesize, count;
448
449                 // Checking the remaining size
450                 if (remaining < ZIP_CDIR_CHUNK_BASE_SIZE)
451                 {
452                         Mem_Free (central_dir);
453                         return -1;
454                 }
455                 remaining -= ZIP_CDIR_CHUNK_BASE_SIZE;
456
457                 // Check header
458                 if (BuffBigLong (ptr) != ZIP_CDIR_HEADER)
459                 {
460                         Mem_Free (central_dir);
461                         return -1;
462                 }
463
464                 namesize = BuffLittleShort (&ptr[28]);  // filename length
465
466                 // Check encryption, compression, and attributes
467                 // 1st uint8  : general purpose bit flag
468                 //    Check bits 0 (encryption), 3 (data descriptor after the file), and 5 (compressed patched data (?))
469                 // 2nd uint8 : external file attributes
470                 //    Check bits 3 (file is a directory) and 5 (file is a volume (?))
471                 if ((ptr[8] & 0x29) == 0 && (ptr[38] & 0x18) == 0)
472                 {
473                         // Still enough bytes for the name?
474                         if ((size_t) remaining < namesize || namesize >= sizeof (*pack->files))
475                         {
476                                 Mem_Free (central_dir);
477                                 return -1;
478                         }
479
480                         // WinZip doesn't use the "directory" attribute, so we need to check the name directly
481                         if (ptr[ZIP_CDIR_CHUNK_BASE_SIZE + namesize - 1] != '/')
482                         {
483                                 char filename [sizeof (pack->files[0].name)];
484                                 size_t offset, packsize, realsize;
485                                 file_flags_t flags;
486
487                                 // Extract the name (strip it if necessary)
488                                 if (namesize >= sizeof (filename))
489                                         namesize = sizeof (filename) - 1;
490                                 memcpy (filename, &ptr[ZIP_CDIR_CHUNK_BASE_SIZE], namesize);
491                                 filename[namesize] = '\0';
492
493                                 if (BuffLittleShort (&ptr[10]))
494                                         flags = FILE_FLAG_DEFLATED;
495                                 else
496                                         flags = 0;
497                                 offset = BuffLittleLong (&ptr[42]);
498                                 packsize = BuffLittleLong (&ptr[20]);
499                                 realsize = BuffLittleLong (&ptr[24]);
500                                 FS_AddFileToPack (filename, pack, offset, packsize, realsize, flags);
501                         }
502                 }
503
504                 // Skip the name, additionnal field, and comment
505                 // 1er uint16 : extra field length
506                 // 2eme uint16 : file comment length
507                 count = namesize + BuffLittleShort (&ptr[30]) + BuffLittleShort (&ptr[32]);
508                 ptr += ZIP_CDIR_CHUNK_BASE_SIZE + count;
509                 remaining -= count;
510         }
511
512         Mem_Free (central_dir);
513         return pack->numfiles;
514 }
515
516
517 /*
518 ====================
519 FS_LoadPackPK3
520
521 Create a package entry associated with a PK3 file
522 ====================
523 */
524 pack_t *FS_LoadPackPK3 (const char *packfile)
525 {
526         FILE *packhandle;
527         pk3_endOfCentralDir_t eocd;
528         pack_t *pack;
529         int real_nb_files;
530
531         packhandle = fopen (packfile, "rb");
532         if (!packhandle)
533                 return NULL;
534
535         if (! PK3_GetEndOfCentralDir (packfile, packhandle, &eocd))
536                 Sys_Error ("%s is not a PK3 file", packfile);
537
538         // Multi-volume ZIP archives are NOT allowed
539         if (eocd.disknum != 0 || eocd.cdir_disknum != 0)
540                 Sys_Error ("%s is a multi-volume ZIP archive", packfile);
541
542         // We only need to do this test if MAX_FILES_IN_PACK is lesser than 65535
543         // since eocd.nbentries is an unsigned 16 bits integer
544         #if MAX_FILES_IN_PACK < 65535
545         if (eocd.nbentries > MAX_FILES_IN_PACK)
546                 Sys_Error ("%s contains too many files (%hu)", packfile, eocd.nbentries);
547         #endif
548
549         // Create a package structure in memory
550         pack = Mem_Alloc (pak_mempool, sizeof (pack_t));
551         pack->ignorecase = true; // PK3 ignores case
552         strlcpy (pack->filename, packfile, sizeof (pack->filename));
553         pack->handle = packhandle;
554         pack->numfiles = eocd.nbentries;
555         pack->mempool = Mem_AllocPool (packfile);
556         pack->files = Mem_Alloc (pack->mempool, eocd.nbentries * sizeof(packfile_t));
557         pack->next = packlist;
558         packlist = pack;
559
560         real_nb_files = PK3_BuildFileList (pack, &eocd);
561         if (real_nb_files <= 0)
562                 Sys_Error ("%s is not a valid PK3 file", packfile);
563
564         Con_Printf("Added packfile %s (%i files)\n", packfile, real_nb_files);
565         return pack;
566 }
567
568
569 /*
570 ====================
571 PK3_GetTrueFileOffset
572
573 Find where the true file data offset is
574 ====================
575 */
576 void PK3_GetTrueFileOffset (packfile_t *file, pack_t *pack)
577 {
578         qbyte buffer [ZIP_LOCAL_CHUNK_BASE_SIZE];
579         size_t count;
580
581         // Already found?
582         if (file->flags & FILE_FLAG_TRUEOFFS)
583                 return;
584
585         // Load the local file description
586         fseek (pack->handle, file->offset, SEEK_SET);
587         count = fread (buffer, 1, ZIP_LOCAL_CHUNK_BASE_SIZE, pack->handle);
588         if (count != ZIP_LOCAL_CHUNK_BASE_SIZE || BuffBigLong (buffer) != ZIP_DATA_HEADER)
589                 Sys_Error ("Can't retrieve file %s in package %s", file->name, pack->filename);
590
591         // Skip name and extra field
592         file->offset += BuffLittleShort (&buffer[26]) + BuffLittleShort (&buffer[28]) + ZIP_LOCAL_CHUNK_BASE_SIZE;
593
594         file->flags |= FILE_FLAG_TRUEOFFS;
595 }
596
597
598 /*
599 =============================================================================
600
601 OTHER PRIVATE FUNCTIONS
602
603 =============================================================================
604 */
605
606
607 /*
608 ====================
609 FS_AddFileToPack
610
611 Add a file to the list of files contained into a package
612 ====================
613 */
614 static packfile_t* FS_AddFileToPack (const char* name, pack_t* pack,
615                                                                          size_t offset, size_t packsize,
616                                                                          size_t realsize, file_flags_t flags)
617 {
618         int (*strcmp_funct) (const char* str1, const char* str2);
619         size_t left, right, middle;
620         int diff;
621         packfile_t *file;
622
623         strcmp_funct = pack->ignorecase ? strcasecmp : strcmp;
624
625         // Look for the slot we should put that file into (binary search)
626         left = 0;
627         right = pack->numfiles;
628         while (left != right)
629         {
630                 middle = (left + right - 1) / 2;
631                 diff = strcmp_funct (pack->files[middle].name, name);
632
633                 // If we found the file, there's a problem
634                 if (!diff)
635                         Sys_Error ("Package %s contains several time the file %s\n",
636                                            pack->filename, name);
637
638                 // If we're too far in the list
639                 if (diff > 0)
640                         right = middle;
641                 else
642                         left = middle + 1;
643         }
644
645         // We have to move the right of the list by one slot to free the one we need
646         file = &pack->files[left];
647         memmove (file + 1, file, (pack->numfiles - left) * sizeof (*file));
648         pack->numfiles++;
649
650         strlcpy (file->name, name, sizeof (file->name));
651         file->offset = offset;
652         file->packsize = packsize;
653         file->realsize = realsize;
654         file->flags = flags;
655
656         return file;
657 }
658
659
660 /*
661 ============
662 FS_CreatePath
663
664 Only used for FS_Open.
665 ============
666 */
667 void FS_CreatePath (char *path)
668 {
669         char *ofs, save;
670
671         for (ofs = path+1 ; *ofs ; ofs++)
672         {
673                 if (*ofs == '/' || *ofs == '\\')
674                 {
675                         // create the directory
676                         save = *ofs;
677                         *ofs = 0;
678                         FS_mkdir (path);
679                         *ofs = save;
680                 }
681         }
682 }
683
684
685 /*
686 ============
687 FS_Path_f
688
689 ============
690 */
691 void FS_Path_f (void)
692 {
693         searchpath_t *s;
694
695         Con_Print("Current search path:\n");
696         for (s=fs_searchpaths ; s ; s=s->next)
697         {
698                 if (s->pack)
699                 {
700                         Con_Printf("%s (%i files)\n", s->pack->filename, s->pack->numfiles);
701                 }
702                 else
703                         Con_Printf("%s\n", s->filename);
704         }
705 }
706
707
708 /*
709 =================
710 FS_LoadPackPAK
711
712 Takes an explicit (not game tree related) path to a pak file.
713
714 Loads the header and directory, adding the files at the beginning
715 of the list so they override previous pack files.
716 =================
717 */
718 pack_t *FS_LoadPackPAK (const char *packfile)
719 {
720         dpackheader_t header;
721         int i, numpackfiles;
722         FILE *packhandle;
723         pack_t *pack;
724         dpackfile_t *info;      // temporary alloc, allowing huge pack directories
725
726         packhandle = fopen (packfile, "rb");
727         if (!packhandle)
728                 return NULL;
729
730         fread ((void *)&header, 1, sizeof(header), packhandle);
731         if (memcmp(header.id, "PACK", 4))
732                 Sys_Error ("%s is not a packfile", packfile);
733         header.dirofs = LittleLong (header.dirofs);
734         header.dirlen = LittleLong (header.dirlen);
735
736         if (header.dirlen % sizeof(dpackfile_t))
737                 Sys_Error ("%s has an invalid directory size", packfile);
738
739         numpackfiles = header.dirlen / sizeof(dpackfile_t);
740
741         if (numpackfiles > MAX_FILES_IN_PACK)
742                 Sys_Error ("%s has %i files", packfile, numpackfiles);
743
744         pack = Mem_Alloc(pak_mempool, sizeof (pack_t));
745         pack->ignorecase = false; // PAK is case sensitive
746         strlcpy (pack->filename, packfile, sizeof (pack->filename));
747         pack->handle = packhandle;
748         pack->numfiles = 0;
749         pack->mempool = Mem_AllocPool(packfile);
750         pack->files = Mem_Alloc(pack->mempool, numpackfiles * sizeof(packfile_t));
751         pack->next = packlist;
752         packlist = pack;
753
754         info = Mem_Alloc(tempmempool, sizeof(*info) * numpackfiles);
755         fseek (packhandle, header.dirofs, SEEK_SET);
756         fread ((void *)info, 1, header.dirlen, packhandle);
757
758         // parse the directory
759         for (i = 0;i < numpackfiles;i++)
760         {
761                 size_t offset = LittleLong (info[i].filepos);
762                 size_t size = LittleLong (info[i].filelen);
763
764                 FS_AddFileToPack (info[i].name, pack, offset, size, size, FILE_FLAG_TRUEOFFS);
765         }
766
767         Mem_Free(info);
768
769         Con_Printf("Added packfile %s (%i files)\n", packfile, numpackfiles);
770         return pack;
771 }
772
773
774 /*
775 ================
776 FS_AddGameDirectory
777
778 Sets fs_gamedir, adds the directory to the head of the path,
779 then loads and adds pak1.pak pak2.pak ...
780 ================
781 */
782 void FS_AddGameDirectory (char *dir)
783 {
784         stringlist_t *list, *current;
785         searchpath_t *search;
786         pack_t *pak;
787         char pakfile[MAX_OSPATH];
788
789         strlcpy (fs_gamedir, dir, sizeof (fs_gamedir));
790
791 #ifndef AKVERSION
792         // add the directory to the search path
793         search = Mem_Alloc(pak_mempool, sizeof(searchpath_t));
794         strlcpy (search->filename, dir, sizeof (search->filename));
795         search->next = fs_searchpaths;
796         fs_searchpaths = search;
797 #endif
798
799         list = listdirectory(dir);
800
801         // add any PAK package in the directory
802         for (current = list;current;current = current->next)
803         {
804                 if (matchpattern(current->text, "*.pak", true))
805                 {
806                         snprintf (pakfile, sizeof (pakfile), "%s/%s", dir, current->text);
807                         pak = FS_LoadPackPAK (pakfile);
808                         if (pak)
809                         {
810                                 search = Mem_Alloc(pak_mempool, sizeof(searchpath_t));
811                                 search->pack = pak;
812                                 search->next = fs_searchpaths;
813                                 fs_searchpaths = search;
814                         }
815                         else
816                                 Con_Printf("unable to load pak \"%s\"\n", pakfile);
817                 }
818         }
819
820         // add any PK3 package in the director
821         for (current = list;current;current = current->next)
822         {
823                 if (matchpattern(current->text, "*.pk3", true))
824                 {
825                         snprintf (pakfile, sizeof (pakfile), "%s/%s", dir, current->text);
826                         pak = FS_LoadPackPK3 (pakfile);
827                         if (pak)
828                         {
829                                 search = Mem_Alloc(pak_mempool, sizeof(searchpath_t));
830                                 search->pack = pak;
831                                 search->next = fs_searchpaths;
832                                 fs_searchpaths = search;
833                         }
834                         else
835                                 Con_Printf("unable to load pak \"%s\"\n", pakfile);
836                 }
837         }
838         freedirectory(list);
839
840 // Unpacked files have the priority over packed files if AKVERSION is defined
841 #ifdef AKVERSION
842         // add the directory to the search path
843         search = Mem_Alloc(pak_mempool, sizeof(searchpath_t));
844         strlcpy (search->filename, dir, sizeof (search->filename));
845         search->next = fs_searchpaths;
846         fs_searchpaths = search;
847 #endif
848 }
849
850
851 /*
852 ============
853 FS_FileExtension
854 ============
855 */
856 char *FS_FileExtension (const char *in)
857 {
858         static char exten[8];
859         const char *slash, *backslash, *colon, *dot, *separator;
860         int i;
861
862         slash = strrchr(in, '/');
863         backslash = strrchr(in, '\\');
864         colon = strrchr(in, ':');
865         dot = strrchr(in, '.');
866         separator = slash;
867         if (separator < backslash)
868                 separator = backslash;
869         if (separator < colon)
870                 separator = colon;
871         if (dot < separator)
872                 return "";
873         dot++;
874         for (i = 0;i < 7 && dot[i];i++)
875                 exten[i] = dot[i];
876         exten[i] = 0;
877         return exten;
878 }
879
880
881 /*
882 ================
883 FS_Init
884 ================
885 */
886 void FS_Init (void)
887 {
888         int i;
889         searchpath_t *search;
890
891         fs_mempool = Mem_AllocPool("file management");
892         pak_mempool = Mem_AllocPool("paks");
893
894         Cmd_AddCommand ("path", FS_Path_f);
895         Cmd_AddCommand ("dir", FS_Dir_f);
896         Cmd_AddCommand ("ls", FS_Ls_f);
897
898         strcpy(fs_basedir, ".");
899
900         PK3_OpenLibrary ();
901
902         // -basedir <path>
903         // Overrides the system supplied base directory (under GAMENAME)
904         i = COM_CheckParm ("-basedir");
905         if (i && i < com_argc-1)
906                 strlcpy (fs_basedir, com_argv[i+1], sizeof (fs_basedir));
907
908         i = strlen (fs_basedir);
909         if (i > 0 && (fs_basedir[i-1] == '\\' || fs_basedir[i-1] == '/'))
910                 fs_basedir[i-1] = 0;
911
912         // start up with GAMENAME by default (id1)
913         strlcpy (com_modname, GAMENAME, sizeof (com_modname));
914         FS_AddGameDirectory (va("%s/"GAMENAME, fs_basedir));
915         if (gamedirname[0])
916         {
917                 fs_modified = true;
918                 strlcpy (com_modname, gamedirname, sizeof (com_modname));
919                 FS_AddGameDirectory (va("%s/%s", fs_basedir, gamedirname));
920         }
921
922         // -game <gamedir>
923         // Adds basedir/gamedir as an override game
924         i = COM_CheckParm ("-game");
925         if (i && i < com_argc-1)
926         {
927                 fs_modified = true;
928                 strlcpy (com_modname, com_argv[i+1], sizeof (com_modname));
929                 FS_AddGameDirectory (va("%s/%s", fs_basedir, com_argv[i+1]));
930         }
931
932         // -path <dir or packfile> [<dir or packfile>] ...
933         // Fully specifies the exact search path, overriding the generated one
934         i = COM_CheckParm ("-path");
935         if (i)
936         {
937                 fs_modified = true;
938                 fs_searchpaths = NULL;
939                 while (++i < com_argc)
940                 {
941                         if (!com_argv[i] || com_argv[i][0] == '+' || com_argv[i][0] == '-')
942                                 break;
943
944                         search = Mem_Alloc(pak_mempool, sizeof(searchpath_t));
945                         if (!strcasecmp (FS_FileExtension(com_argv[i]), "pak"))
946                         {
947                                 search->pack = FS_LoadPackPAK (com_argv[i]);
948                                 if (!search->pack)
949                                         Sys_Error ("Couldn't load packfile: %s", com_argv[i]);
950                         }
951                         else if (!strcasecmp (FS_FileExtension (com_argv[i]), "pk3"))
952                         {
953                                 search->pack = FS_LoadPackPK3 (com_argv[i]);
954                                 if (!search->pack)
955                                         Sys_Error ("Couldn't load packfile: %s", com_argv[i]);
956                         }
957                         else
958                                 strlcpy (search->filename, com_argv[i], sizeof (search->filename));
959                         search->next = fs_searchpaths;
960                         fs_searchpaths = search;
961                 }
962         }
963 }
964
965
966 /*
967 ====================
968 FS_SysOpen
969
970 Internal function used to create a qfile_t and open the relevant file on disk
971 ====================
972 */
973 static qfile_t* FS_SysOpen (const char* filepath, const char* mode)
974 {
975         qfile_t* file;
976
977         file = Mem_Alloc (fs_mempool, sizeof (*file));
978         memset (file, 0, sizeof (*file));
979
980         file->stream = fopen (filepath, mode);
981         if (!file->stream)
982         {
983                 Mem_Free (file);
984                 return NULL;
985         }
986
987         return file;
988 }
989
990
991 /*
992 ===========
993 FS_OpenRead
994 ===========
995 */
996 qfile_t *FS_OpenRead (const char *path, int offs, int len)
997 {
998         qfile_t* file;
999
1000         file = FS_SysOpen (path, "rb");
1001         if (!file)
1002         {
1003                 Sys_Error ("Couldn't open %s", path);
1004                 return NULL;
1005         }
1006
1007         // Normal file
1008         if (offs < 0 || len < 0)
1009         {
1010                 // We set fs_filesize here for normal files
1011                 fseek (file->stream, 0, SEEK_END);
1012                 fs_filesize = ftell (file->stream);
1013                 fseek (file->stream, 0, SEEK_SET);
1014         }
1015         // Packed file
1016         else
1017         {
1018                 fseek (file->stream, offs, SEEK_SET);
1019
1020                 file->flags |= FS_FLAG_PACKED;
1021                 file->length = len;
1022                 file->offset = offs;
1023                 file->position = 0;
1024         }
1025
1026         return file;
1027 }
1028
1029
1030 /*
1031 ====================
1032 FS_FindFile
1033
1034 Look for a file in the packages and in the filesystem
1035
1036 Return the searchpath where the file was found (or NULL)
1037 and the file index in the package if relevant
1038 ====================
1039 */
1040 static searchpath_t *FS_FindFile (const char *name, int* index, qboolean quiet)
1041 {
1042         searchpath_t *search;
1043         pack_t *pak;
1044         int (*strcmp_funct) (const char* str1, const char* str2);
1045
1046         // search through the path, one element at a time
1047         for (search = fs_searchpaths;search;search = search->next)
1048         {
1049                 // is the element a pak file?
1050                 if (search->pack)
1051                 {
1052                         size_t left, right, middle;
1053
1054                         pak = search->pack;
1055                         strcmp_funct = pak->ignorecase ? strcasecmp : strcmp;
1056
1057                         // Look for the file (binary search)
1058                         left = 0;
1059                         right = pak->numfiles;
1060                         while (left != right)
1061                         {
1062                                 int diff;
1063
1064                                 middle = (left + right - 1) / 2;
1065                                 diff = strcmp_funct (pak->files[middle].name, name);
1066
1067                                 // Found it
1068                                 if (!diff)
1069                                 {
1070                                         if (!quiet)
1071                                                 Sys_Printf("FS_FindFile: %s in %s\n",
1072                                                                         pak->files[middle].name, pak->filename);
1073
1074                                         if (index != NULL)
1075                                                 *index = middle;
1076                                         return search;
1077                                 }
1078
1079                                 // If we're too far in the list
1080                                 if (diff > 0)
1081                                         right = middle;
1082                                 else
1083                                         left = middle + 1;
1084                         }
1085                 }
1086                 else
1087                 {
1088                         char netpath[MAX_OSPATH];
1089                         snprintf(netpath, sizeof(netpath), "%s/%s", search->filename, name);
1090                         if (FS_SysFileExists (netpath))
1091                         {
1092                                 if (!quiet)
1093                                         Sys_Printf("FS_FindFile: %s\n", netpath);
1094
1095                                 if (index != NULL)
1096                                         *index = -1;
1097                                 return search;
1098                         }
1099                 }
1100         }
1101
1102         if (!quiet)
1103                 Sys_Printf("FS_FindFile: can't find %s\n", name);
1104
1105         if (index != NULL)
1106                 *index = -1;
1107         return NULL;
1108 }
1109
1110
1111 /*
1112 ===========
1113 FS_FOpenFile
1114
1115 If the requested file is inside a packfile, a new qfile_t* will be opened
1116 into the file.
1117
1118 Sets fs_filesize
1119 ===========
1120 */
1121 qfile_t *FS_FOpenFile (const char *filename, qboolean quiet)
1122 {
1123         searchpath_t *search;
1124         packfile_t *packfile;
1125         int i;
1126         qfile_t *file;
1127
1128         search = FS_FindFile (filename, &i, quiet);
1129
1130         // Not found?
1131         if (search == NULL)
1132         {
1133                 fs_filesize = -1;
1134                 return NULL;
1135         }
1136
1137         // Found in the filesystem?
1138         if (i < 0)
1139         {
1140                 char netpath[MAX_OSPATH];
1141                 snprintf(netpath, sizeof(netpath), "%s/%s", search->filename, filename);
1142                 return FS_OpenRead(netpath, -1, -1);
1143         }
1144
1145         // So, we found it in a package...
1146         packfile = &search->pack->files[i];
1147
1148         // If we don't have the true offset, get it now
1149         if (! (packfile->flags & FILE_FLAG_TRUEOFFS))
1150                 PK3_GetTrueFileOffset (packfile, search->pack);
1151
1152         // No Zlib DLL = no compressed files
1153         if (!zlib_dll && (packfile->flags & FILE_FLAG_DEFLATED))
1154         {
1155                 Con_Printf("WARNING: can't open the compressed file %s\n"
1156                                         "You need the Zlib DLL to use compressed files\n",
1157                                         filename);
1158                 fs_filesize = -1;
1159                 return NULL;
1160         }
1161
1162         // open a new file in the pakfile
1163         file = FS_OpenRead (search->pack->filename, packfile->offset, packfile->packsize);
1164         fs_filesize = packfile->realsize;
1165
1166         if (packfile->flags & FILE_FLAG_DEFLATED)
1167         {
1168                 ztoolkit_t *ztk;
1169
1170                 file->flags |= FS_FLAG_DEFLATED;
1171
1172                 // We need some more variables
1173                 ztk = Mem_Alloc (fs_mempool, sizeof (*file->z));
1174
1175                 ztk->real_length = packfile->realsize;
1176
1177                 // Initialize zlib stream
1178                 ztk->zstream.next_in = ztk->input;
1179                 ztk->zstream.avail_in = 0;
1180
1181                 /* From Zlib's "unzip.c":
1182                  *
1183                  * windowBits is passed < 0 to tell that there is no zlib header.
1184                  * Note that in this case inflate *requires* an extra "dummy" byte
1185                  * after the compressed stream in order to complete decompression and
1186                  * return Z_STREAM_END.
1187                  * In unzip, i don't wait absolutely Z_STREAM_END because I known the
1188                  * size of both compressed and uncompressed data
1189                  */
1190                 if (qz_inflateInit2 (&ztk->zstream, -MAX_WBITS) != Z_OK)
1191                         Sys_Error ("inflate init error (file: %s)", filename);
1192
1193                 ztk->zstream.next_out = ztk->output;
1194                 ztk->zstream.avail_out = sizeof (ztk->output);
1195
1196                 file->z = ztk;
1197         }
1198
1199         return file;
1200 }
1201
1202
1203 /*
1204 =============================================================================
1205
1206 MAIN PUBLIC FUNCTIONS
1207
1208 =============================================================================
1209 */
1210
1211 /*
1212 ====================
1213 FS_Open
1214
1215 Open a file. The syntax is the same as fopen
1216 ====================
1217 */
1218 qfile_t* FS_Open (const char* filepath, const char* mode, qboolean quiet)
1219 {
1220         // If the file is opened in "write" or "append" mode
1221         if (strchr (mode, 'w') || strchr (mode, 'a'))
1222         {
1223                 char real_path [MAX_OSPATH];
1224
1225                 // Open the file on disk directly
1226                 snprintf (real_path, sizeof (real_path), "%s/%s", fs_gamedir, filepath);
1227
1228                 // Create directories up to the file
1229                 FS_CreatePath (real_path);
1230
1231                 return FS_SysOpen (real_path, mode);
1232         }
1233
1234         // Else, we look at the various search paths
1235         return FS_FOpenFile (filepath, quiet);
1236 }
1237
1238
1239 /*
1240 ====================
1241 FS_Close
1242
1243 Close a file
1244 ====================
1245 */
1246 int FS_Close (qfile_t* file)
1247 {
1248         if (fclose (file->stream))
1249                 return EOF;
1250
1251         if (file->z)
1252         {
1253                 qz_inflateEnd (&file->z->zstream);
1254                 Mem_Free (file->z);
1255         }
1256
1257         Mem_Free (file);
1258         return 0;
1259 }
1260
1261
1262 /*
1263 ====================
1264 FS_Write
1265
1266 Write "datasize" bytes into a file
1267 ====================
1268 */
1269 size_t FS_Write (qfile_t* file, const void* data, size_t datasize)
1270 {
1271         return fwrite (data, 1, datasize, file->stream);
1272 }
1273
1274
1275 /*
1276 ====================
1277 FS_Read
1278
1279 Read up to "buffersize" bytes from a file
1280 ====================
1281 */
1282 size_t FS_Read (qfile_t* file, void* buffer, size_t buffersize)
1283 {
1284         size_t count, nb;
1285         ztoolkit_t *ztk;
1286
1287         // Quick path for unpacked files
1288         if (! (file->flags & FS_FLAG_PACKED))
1289                 return fread (buffer, 1, buffersize, file->stream);
1290
1291         // If the file isn't compressed
1292         if (! (file->flags & FS_FLAG_DEFLATED))
1293         {
1294                 // We must take care to not read after the end of the file
1295                 count = file->length - file->position;
1296                 if (buffersize > count)
1297                         buffersize = count;
1298
1299                 nb = fread (buffer, 1, buffersize, file->stream);
1300
1301                 file->position += nb;
1302                 return nb;
1303         }
1304
1305         // If the file is compressed, it's more complicated...
1306         ztk = file->z;
1307
1308         // First, we copy as many bytes as we can from "output"
1309         if (ztk->out_ind < ztk->out_max)
1310         {
1311                 count = ztk->out_max - ztk->out_ind;
1312
1313                 nb = (buffersize > count) ? count : buffersize;
1314                 memcpy (buffer, &ztk->output[ztk->out_ind], nb);
1315                 ztk->out_ind += nb;
1316                 file->position += nb;
1317         }
1318         else
1319                 nb = 0;
1320
1321         // We cycle through a few operations until we have inflated enough data
1322         while (nb < buffersize)
1323         {
1324                 // NOTE: at this point, "output" should always be empty
1325
1326                 // If "input" is also empty, we need to fill it
1327                 if (ztk->in_ind == ztk->in_max)
1328                 {
1329                         size_t remain;
1330
1331                         // If we are at the end of the file
1332                         if (ztk->out_position == ztk->real_length)
1333                                 return nb;
1334
1335                         remain = file->length - ztk->in_position;
1336                         count = (remain > sizeof (ztk->input)) ? sizeof (ztk->input) : remain;
1337                         fread (ztk->input, 1, count, file->stream);
1338
1339                         // Update indexes and counters
1340                         ztk->in_ind = 0;
1341                         ztk->in_max = count;
1342                         ztk->in_position += count;
1343                 }
1344
1345                 // Now that we are sure we have compressed data available, we need to determine
1346                 // if it's better to inflate it in "output" or directly in "buffer" (we are in this
1347                 // case if we still need more bytes than "output" can contain)
1348
1349                 ztk->zstream.next_in = &ztk->input[ztk->in_ind];
1350                 ztk->zstream.avail_in = ztk->in_max - ztk->in_ind;
1351
1352                 // If output will be able to contain at least 1 more byte than the data we need
1353                 if (buffersize - nb < sizeof (ztk->output))
1354                 {
1355                         int error;
1356
1357                         // Inflate the data in "output"
1358                         ztk->zstream.next_out = ztk->output;
1359                         ztk->zstream.avail_out = sizeof (ztk->output);
1360                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1361                         if (error != Z_OK && error != Z_STREAM_END)
1362                                 Sys_Error ("Can't inflate file");
1363                         ztk->in_ind = ztk->in_max - ztk->zstream.avail_in;
1364                         ztk->out_max = sizeof (ztk->output) - ztk->zstream.avail_out;
1365                         ztk->out_position += ztk->out_max;
1366
1367                         // Copy the requested data in "buffer" (as much as we can)
1368                         count = (buffersize - nb > ztk->out_max) ? ztk->out_max : buffersize - nb;
1369                         memcpy (&((qbyte*)buffer)[nb], ztk->output, count);
1370                         ztk->out_ind = count;
1371                 }
1372
1373                 // Else, we inflate directly in "buffer"
1374                 else
1375                 {
1376                         int error;
1377
1378                         // Inflate the data in "buffer"
1379                         ztk->zstream.next_out = &((qbyte*)buffer)[nb];
1380                         ztk->zstream.avail_out = buffersize - nb;
1381                         error = qz_inflate (&ztk->zstream, Z_SYNC_FLUSH);
1382                         if (error != Z_OK && error != Z_STREAM_END)
1383                                 Sys_Error ("Can't inflate file");
1384                         ztk->in_ind = ztk->in_max - ztk->zstream.avail_in;
1385
1386                         // Invalidate the output data (for FS_Seek)
1387                         ztk->out_max = 0;
1388                         ztk->out_ind = 0;
1389
1390                         // How much data did it inflate?
1391                         count = buffersize - nb - ztk->zstream.avail_out;
1392                         ztk->out_position += count;
1393                 }
1394
1395                 nb += count;
1396                 file->position += count;
1397         }
1398
1399         return nb;
1400 }
1401
1402
1403 /*
1404 ====================
1405 FS_Flush
1406
1407 Flush the file output stream
1408 ====================
1409 */
1410 int FS_Flush (qfile_t* file)
1411 {
1412         return fflush (file->stream);
1413 }
1414
1415
1416 /*
1417 ====================
1418 FS_Print
1419
1420 Print a string into a file
1421 ====================
1422 */
1423 int FS_Print(qfile_t* file, const char *msg)
1424 {
1425         return FS_Write(file, msg, strlen(msg));
1426 }
1427
1428 /*
1429 ====================
1430 FS_Printf
1431
1432 Print a string into a file
1433 ====================
1434 */
1435 int FS_Printf(qfile_t* file, const char* format, ...)
1436 {
1437         int result;
1438         va_list args;
1439
1440         va_start (args, format);
1441         result = vfprintf (file->stream, format, args);
1442         va_end (args);
1443
1444         return result;
1445 }
1446
1447
1448 /*
1449 ====================
1450 FS_Getc
1451
1452 Get the next character of a file
1453 ====================
1454 */
1455 int FS_Getc (qfile_t* file)
1456 {
1457         char c;
1458
1459         if (FS_Read (file, &c, 1) != 1)
1460                 return EOF;
1461
1462         return c;
1463 }
1464
1465
1466 /*
1467 ====================
1468 FS_Seek
1469
1470 Move the position index in a file
1471 ====================
1472 */
1473 int FS_Seek (qfile_t* file, long offset, int whence)
1474 {
1475         // Quick path for unpacked files
1476         if (! (file->flags & FS_FLAG_PACKED))
1477                 return fseek (file->stream, offset, whence);
1478
1479         // Seeking in compressed files is more a hack than anything else,
1480         // but we need to support it, so here it is.
1481         if (file->flags & FS_FLAG_DEFLATED)
1482         {
1483                 ztoolkit_t *ztk = file->z;
1484                 qbyte buffer [sizeof (ztk->output)];  // it's big to force inflating into buffer directly
1485
1486                 switch (whence)
1487                 {
1488                         case SEEK_CUR:
1489                                 offset += file->position;
1490                                 break;
1491
1492                         case SEEK_SET:
1493                                 break;
1494
1495                         case SEEK_END:
1496                                 offset += ztk->real_length;
1497                                 break;
1498
1499                         default:
1500                                 return -1;
1501                 }
1502                 if (offset < 0 || offset > (long) ztk->real_length)
1503                         return -1;
1504
1505                 // If we need to go back in the file
1506                 if (offset <= (long) file->position)
1507                 {
1508                         // If we still have the data we need in the output buffer
1509                         if (file->position - offset <= ztk->out_ind)
1510                         {
1511                                 ztk->out_ind -= file->position - offset;
1512                                 file->position = offset;
1513                                 return 0;
1514                         }
1515
1516                         // Else, we restart from the beginning of the file
1517                         ztk->in_ind = 0;
1518                         ztk->in_max = 0;
1519                         ztk->in_position = 0;
1520                         ztk->out_ind = 0;
1521                         ztk->out_max = 0;
1522                         ztk->out_position = 0;
1523                         file->position = 0;
1524                         fseek (file->stream, file->offset, SEEK_SET);
1525
1526                         // Reset the Zlib stream
1527                         ztk->zstream.next_in = ztk->input;
1528                         ztk->zstream.avail_in = 0;
1529                         qz_inflateReset (&ztk->zstream);
1530                 }
1531
1532                 // Skip all data until we reach the requested offset
1533                 while ((long) file->position < offset)
1534                 {
1535                         size_t diff = offset - file->position;
1536                         size_t count, len;
1537
1538                         count = (diff > sizeof (buffer)) ? sizeof (buffer) : diff;
1539                         len = FS_Read (file, buffer, count);
1540                         if (len != count)
1541                                 return -1;
1542                 }
1543
1544                 return 0;
1545         }
1546
1547         // Packed files receive a special treatment too, because
1548         // we need to make sure it doesn't go outside of the file
1549         switch (whence)
1550         {
1551                 case SEEK_CUR:
1552                         offset += file->position;
1553                         break;
1554
1555                 case SEEK_SET:
1556                         break;
1557
1558                 case SEEK_END:
1559                         offset += file->length;
1560                         break;
1561
1562                 default:
1563                         return -1;
1564         }
1565         if (offset < 0 || offset > (long) file->length)
1566                 return -1;
1567
1568         if (fseek (file->stream, file->offset + offset, SEEK_SET) == -1)
1569                 return -1;
1570         file->position = offset;
1571         return 0;
1572 }
1573
1574
1575 /*
1576 ====================
1577 FS_Tell
1578
1579 Give the current position in a file
1580 ====================
1581 */
1582 long FS_Tell (qfile_t* file)
1583 {
1584         if (file->flags & FS_FLAG_PACKED)
1585                 return file->position;
1586
1587         return ftell (file->stream);
1588 }
1589
1590
1591 /*
1592 ====================
1593 FS_Gets
1594
1595 Extract a line from a file
1596 ====================
1597 */
1598 char* FS_Gets (qfile_t* file, char* buffer, int buffersize)
1599 {
1600         size_t ind;
1601
1602         // Quick path for unpacked files
1603         if (! (file->flags & FS_FLAG_PACKED))
1604                 return fgets (buffer, buffersize, file->stream);
1605
1606         for (ind = 0; ind < (size_t) buffersize - 1; ind++)
1607         {
1608                 int c = FS_Getc (file);
1609                 switch (c)
1610                 {
1611                         // End of file
1612                         case -1:
1613                                 if (!ind)
1614                                         return NULL;
1615
1616                                 buffer[ind] = '\0';
1617                                 return buffer;
1618
1619                         // End of line
1620                         case '\r':
1621                         case '\n':
1622                                 buffer[ind] = '\n';
1623                                 buffer[ind + 1] = '\0';
1624                                 return buffer;
1625
1626                         default:
1627                                 buffer[ind] = c;
1628                 }
1629
1630         }
1631
1632         buffer[buffersize - 1] = '\0';
1633         return buffer;
1634 }
1635
1636
1637 /*
1638 ==========
1639 FS_Getline
1640
1641 Dynamic length version of fgets. DO NOT free the buffer.
1642 ==========
1643 */
1644 char *FS_Getline (qfile_t *file)
1645 {
1646         static int  size = 256;
1647         static char *buf = 0;
1648         char        *t;
1649         int         len;
1650
1651         if (!buf)
1652                 buf = Mem_Alloc (fs_mempool, size);
1653
1654         if (!FS_Gets (file, buf, size))
1655                 return 0;
1656
1657         len = strlen (buf);
1658         while (buf[len - 1] != '\n' && buf[len - 1] != '\r')
1659         {
1660                 t = Mem_Alloc (fs_mempool, size + 256);
1661                 memcpy(t, buf, size);
1662                 Mem_Free(buf);
1663                 size += 256;
1664                 buf = t;
1665                 if (!FS_Gets (file, buf + len, size - len))
1666                         break;
1667                 len = strlen (buf);
1668         }
1669         while ((len = strlen(buf)) && (buf[len - 1] == '\n' || buf[len - 1] == '\r'))
1670                 buf[len - 1] = 0;
1671         return buf;
1672 }
1673
1674
1675 /*
1676 ====================
1677 FS_Eof
1678
1679 Extract a line from a file
1680 ====================
1681 */
1682 int FS_Eof (qfile_t* file)
1683 {
1684         if (file->flags & FS_FLAG_PACKED)
1685         {
1686                 if (file->flags & FS_FLAG_DEFLATED)
1687                         return (file->position == file->z->real_length);
1688
1689                 return (file->position == file->length);
1690         }
1691
1692         return feof (file->stream);
1693 }
1694
1695
1696 /*
1697 ============
1698 FS_LoadFile
1699
1700 Filename are relative to the quake directory.
1701 Always appends a 0 byte.
1702 ============
1703 */
1704 qbyte *FS_LoadFile (const char *path, mempool_t *pool, qboolean quiet)
1705 {
1706         qfile_t *h;
1707         qbyte *buf;
1708
1709         // look for it in the filesystem or pack files
1710         h = FS_Open (path, "rb", quiet);
1711         if (!h)
1712                 return NULL;
1713
1714         buf = Mem_Alloc(pool, fs_filesize+1);
1715         if (!buf)
1716                 Sys_Error ("FS_LoadFile: not enough available memory for %s (size %i)", path, fs_filesize);
1717
1718         ((qbyte *)buf)[fs_filesize] = 0;
1719
1720         FS_Read (h, buf, fs_filesize);
1721         FS_Close (h);
1722
1723         return buf;
1724 }
1725
1726
1727 /*
1728 ============
1729 FS_WriteFile
1730
1731 The filename will be prefixed by the current game directory
1732 ============
1733 */
1734 qboolean FS_WriteFile (const char *filename, void *data, int len)
1735 {
1736         qfile_t *handle;
1737
1738         handle = FS_Open (filename, "wb", false);
1739         if (!handle)
1740         {
1741                 Con_Printf("FS_WriteFile: failed on %s\n", filename);
1742                 return false;
1743         }
1744
1745         Con_DPrintf("FS_WriteFile: %s\n", filename);
1746         FS_Write (handle, data, len);
1747         FS_Close (handle);
1748         return true;
1749 }
1750
1751
1752 /*
1753 =============================================================================
1754
1755 OTHERS PUBLIC FUNCTIONS
1756
1757 =============================================================================
1758 */
1759
1760 /*
1761 ============
1762 FS_StripExtension
1763 ============
1764 */
1765 void FS_StripExtension (const char *in, char *out, size_t size_out)
1766 {
1767         char *last = NULL;
1768
1769         if (size_out == 0)
1770                 return;
1771
1772         while (*in && size_out > 1)
1773         {
1774                 if (*in == '.')
1775                         last = out;
1776                 else if (*in == '/' || *in == '\\' || *in == ':')
1777                         last = NULL;
1778                 *out++ = *in++;
1779                 size_out--;
1780         }
1781         if (last)
1782                 *last = 0;
1783         else
1784                 *out = 0;
1785 }
1786
1787
1788 /*
1789 ==================
1790 FS_DefaultExtension
1791 ==================
1792 */
1793 void FS_DefaultExtension (char *path, const char *extension, size_t size_path)
1794 {
1795         const char *src;
1796
1797         // if path doesn't have a .EXT, append extension
1798         // (extension should include the .)
1799         src = path + strlen(path) - 1;
1800
1801         while (*src != '/' && src != path)
1802         {
1803                 if (*src == '.')
1804                         return;                 // it has an extension
1805                 src--;
1806         }
1807
1808         strlcat (path, extension, size_path);
1809 }
1810
1811
1812 /*
1813 ==================
1814 FS_FileExists
1815
1816 Look for a file in the packages and in the filesystem
1817 ==================
1818 */
1819 qboolean FS_FileExists (const char *filename)
1820 {
1821         return (FS_FindFile (filename, NULL, true) != NULL);
1822 }
1823
1824
1825 /*
1826 ==================
1827 FS_SysFileExists
1828
1829 Look for a file in the filesystem only
1830 ==================
1831 */
1832 qboolean FS_SysFileExists (const char *path)
1833 {
1834 #if WIN32
1835         FILE *f;
1836
1837         f = fopen (path, "rb");
1838         if (f)
1839         {
1840                 fclose (f);
1841                 return true;
1842         }
1843
1844         return false;
1845 #else
1846         struct stat buf;
1847
1848         if (stat (path,&buf) == -1)
1849                 return false;
1850
1851         return true;
1852 #endif
1853 }
1854
1855 void FS_mkdir (const char *path)
1856 {
1857 #if WIN32
1858         _mkdir (path);
1859 #else
1860         mkdir (path, 0777);
1861 #endif
1862 }
1863
1864 /*
1865 ===========
1866 FS_Search
1867
1868 Allocate and fill a search structure with information on matching filenames.
1869 ===========
1870 */
1871 fssearch_t *FS_Search(const char *pattern, int caseinsensitive, int quiet)
1872 {
1873         fssearch_t *search;
1874         searchpath_t *searchpath;
1875         pack_t *pak;
1876         int i, basepathlength, numfiles, numchars;
1877         stringlist_t *dir, *dirfile, *liststart, *listcurrent, *listtemp;
1878         const char *slash, *backslash, *colon, *separator;
1879         char *basepath;
1880         char netpath[MAX_OSPATH];
1881         char temp[MAX_OSPATH];
1882
1883         while(!strncmp(pattern, "./", 2))
1884                 pattern += 2;
1885         while(!strncmp(pattern, ".\\", 2))
1886                 pattern += 2;
1887
1888         search = NULL;
1889         liststart = NULL;
1890         listcurrent = NULL;
1891         listtemp = NULL;
1892         slash = strrchr(pattern, '/');
1893         backslash = strrchr(pattern, '\\');
1894         colon = strrchr(pattern, ':');
1895         separator = pattern;
1896         if (separator < slash)
1897                 separator = slash;
1898         if (separator < backslash)
1899                 separator = backslash;
1900         if (separator < colon)
1901                 separator = colon;
1902         basepathlength = separator - pattern;
1903         basepath = Z_Malloc(basepathlength + 1);
1904         if (basepathlength)
1905                 memcpy(basepath, pattern, basepathlength);
1906         basepath[basepathlength] = 0;
1907
1908         // search through the path, one element at a time
1909         for (searchpath = fs_searchpaths;searchpath;searchpath = searchpath->next)
1910         {
1911                 // is the element a pak file?
1912                 if (searchpath->pack)
1913                 {
1914                         // look through all the pak file elements
1915                         pak = searchpath->pack;
1916                         for (i = 0;i < pak->numfiles;i++)
1917                         {
1918                                 strcpy(temp, pak->files[i].name);
1919                                 while (temp[0])
1920                                 {
1921                                         if (matchpattern(temp, (char *)pattern, true))
1922                                         {
1923                                                 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
1924                                                         if (!strcmp(listtemp->text, temp))
1925                                                                 break;
1926                                                 if (listtemp == NULL)
1927                                                 {
1928                                                         listcurrent = stringlistappend(listcurrent, temp);
1929                                                         if (liststart == NULL)
1930                                                                 liststart = listcurrent;
1931                                                         if (!quiet)
1932                                                                 Sys_Printf("SearchPackFile: %s : %s\n", pak->filename, temp);
1933                                                 }
1934                                         }
1935                                         // strip off one path element at a time until empty
1936                                         // this way directories are added to the listing if they match the pattern
1937                                         slash = strrchr(temp, '/');
1938                                         backslash = strrchr(temp, '\\');
1939                                         colon = strrchr(temp, ':');
1940                                         separator = temp;
1941                                         if (separator < slash)
1942                                                 separator = slash;
1943                                         if (separator < backslash)
1944                                                 separator = backslash;
1945                                         if (separator < colon)
1946                                                 separator = colon;
1947                                         *((char *)separator) = 0;
1948                                 }
1949                         }
1950                 }
1951                 else
1952                 {
1953                         // get a directory listing and look at each name
1954                         snprintf(netpath, sizeof (netpath), "%s/%s", searchpath->filename, basepath);
1955                         if ((dir = listdirectory(netpath)))
1956                         {
1957                                 for (dirfile = dir;dirfile;dirfile = dirfile->next)
1958                                 {
1959                                         snprintf(temp, sizeof(temp), "%s/%s", basepath, dirfile->text);
1960                                         if (matchpattern(temp, (char *)pattern, true))
1961                                         {
1962                                                 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
1963                                                         if (!strcmp(listtemp->text, temp))
1964                                                                 break;
1965                                                 if (listtemp == NULL)
1966                                                 {
1967                                                         listcurrent = stringlistappend(listcurrent, temp);
1968                                                         if (liststart == NULL)
1969                                                                 liststart = listcurrent;
1970                                                         if (!quiet)
1971                                                                 Sys_Printf("SearchDirFile: %s\n", temp);
1972                                                 }
1973                                         }
1974                                 }
1975                                 freedirectory(dir);
1976                         }
1977                 }
1978         }
1979
1980         if (liststart)
1981         {
1982                 liststart = stringlistsort(liststart);
1983                 numfiles = 0;
1984                 numchars = 0;
1985                 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
1986                 {
1987                         numfiles++;
1988                         numchars += strlen(listtemp->text) + 1;
1989                 }
1990                 search = Z_Malloc(sizeof(fssearch_t) + numchars + numfiles * sizeof(char *));
1991                 search->filenames = (char **)((char *)search + sizeof(fssearch_t));
1992                 search->filenamesbuffer = (char *)((char *)search + sizeof(fssearch_t) + numfiles * sizeof(char *));
1993                 search->numfilenames = numfiles;
1994                 numfiles = 0;
1995                 numchars = 0;
1996                 for (listtemp = liststart;listtemp;listtemp = listtemp->next)
1997                 {
1998                         search->filenames[numfiles] = search->filenamesbuffer + numchars;
1999                         strcpy(search->filenames[numfiles], listtemp->text);
2000                         numfiles++;
2001                         numchars += strlen(listtemp->text) + 1;
2002                 }
2003                 if (liststart)
2004                         stringlistfree(liststart);
2005         }
2006
2007         Z_Free(basepath);
2008         return search;
2009 }
2010
2011 void FS_FreeSearch(fssearch_t *search)
2012 {
2013         Z_Free(search);
2014 }
2015
2016 extern int con_linewidth;
2017 int FS_ListDirectory(const char *pattern, int oneperline)
2018 {
2019         int numfiles;
2020         int numcolumns;
2021         int numlines;
2022         int columnwidth;
2023         int linebufpos;
2024         int i, j, k, l;
2025         const char *name;
2026         char linebuf[4096];
2027         fssearch_t *search;
2028         search = FS_Search(pattern, true, false);
2029         if (!search)
2030                 return 0;
2031         numfiles = search->numfilenames;
2032         if (!oneperline)
2033         {
2034                 // FIXME: the names could be added to one column list and then
2035                 // gradually shifted into the next column if they fit, and then the
2036                 // next to make a compact variable width listing but it's a lot more
2037                 // complicated...
2038                 // find width for columns
2039                 columnwidth = 0;
2040                 for (i = 0;i < numfiles;i++)
2041                 {
2042                         l = strlen(search->filenames[i]);
2043                         if (columnwidth < l)
2044                                 columnwidth = l;
2045                 }
2046                 // count the spacing character
2047                 columnwidth++;
2048                 // calculate number of columns
2049                 numcolumns = con_linewidth / columnwidth;
2050                 // don't bother with the column printing if it's only one column
2051                 if (numcolumns >= 2)
2052                 {
2053                         numlines = (numfiles + numcolumns - 1) / numcolumns;
2054                         for (i = 0;i < numlines;i++)
2055                         {
2056                                 linebufpos = 0;
2057                                 for (k = 0;k < numcolumns;k++)
2058                                 {
2059                                         l = i * numcolumns + k;
2060                                         if (l < numfiles)
2061                                         {
2062                                                 name = search->filenames[l];
2063                                                 for (j = 0;name[j] && j < (int)sizeof(linebuf) - 1;j++)
2064                                                         linebuf[linebufpos++] = name[j];
2065                                                 // space out name unless it's the last on the line
2066                                                 if (k < (numcolumns - 1) && l < (numfiles - 1))
2067                                                         for (;j < columnwidth && j < (int)sizeof(linebuf) - 1;j++)
2068                                                                 linebuf[linebufpos++] = ' ';
2069                                         }
2070                                 }
2071                                 linebuf[linebufpos] = 0;
2072                                 Con_Printf("%s\n", linebuf);
2073                         }
2074                 }
2075                 else
2076                         oneperline = true;
2077         }
2078         if (oneperline)
2079                 for (i = 0;i < numfiles;i++)
2080                         Con_Printf("%s\n", search->filenames[i]);
2081         FS_FreeSearch(search);
2082         return numfiles;
2083 }
2084
2085 static void FS_ListDirectoryCmd (const char* cmdname, int oneperline)
2086 {
2087         const char *pattern;
2088         if (Cmd_Argc() > 3)
2089         {
2090                 Con_Printf("usage:\n%s [path/pattern]\n", cmdname);
2091                 return;
2092         }
2093         if (Cmd_Argc() == 2)
2094                 pattern = Cmd_Argv(1);
2095         else
2096                 pattern = "*";
2097         if (!FS_ListDirectory(pattern, oneperline))
2098                 Con_Print("No files found.\n");
2099 }
2100
2101 void FS_Dir_f(void)
2102 {
2103         FS_ListDirectoryCmd("dir", true);
2104 }
2105
2106 void FS_Ls_f(void)
2107 {
2108         FS_ListDirectoryCmd("ls", false);
2109 }
2110