tools/quake3/common/vfs.c

   1 /*
   2 Copyright (c) 2001, Loki software, inc.
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without modification,
   6 are permitted provided that the following conditions are met:
   7
   8 Redistributions of source code must retain the above copyright notice, this list
   9 of conditions and the following disclaimer.
  10
  11 Redistributions in binary form must reproduce the above copyright notice, this
  12 list of conditions and the following disclaimer in the documentation and/or
  13 other materials provided with the distribution.
  14
  15 Neither the name of Loki software nor the names of its contributors may be used
  16 to endorse or promote products derived from this software without specific prior
  17 written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
  23 DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 //
  32 // Rules:
  33 //
  34 // - Directories should be searched in the following order: ~/.q3a/baseq3,
  35 //   install dir (/usr/local/games/quake3/baseq3) and cd_path (/mnt/cdrom/baseq3).
  36 //
  37 // - Pak files are searched first inside the directories.
  38 // - Case insensitive.
  39 // - Unix-style slashes (/) (windows is backwards .. everyone knows that)
  40 //
  41 // Leonardo Zide (leo@lokigames.com)
  42 //
  43
  44 #include <stdio.h>
  45
  46 #if defined (__linux__) || defined (__APPLE__)
  47 #include <dirent.h>
  48 #include <unistd.h>
  49 #else
  50 #include <wtypes.h>
  51 #include <io.h>
  52 #define R_OK 04
  53 #define S_ISDIR(mode) (mode & _S_IFDIR)
  54 #define PATH_MAX 260
  55 #endif
  56
  57 #include <string.h>
  58 #include <stdlib.h>
  59 #include <sys/stat.h>
  60
  61 #include "cmdlib.h"
  62 #include "mathlib.h"
  63 #include <glib.h>
  64 #include "inout.h"
  65 #include "vfs.h"
  66 #include "unzip.h"
  67
  68 typedef struct
  69 {
  70   char*   name;
  71   unz_s   zipinfo;
  72   unzFile zipfile;
  73   guint32   size;
  74 } VFS_PAKFILE;
  75
  76 // =============================================================================
  77 // Global variables
  78
  79 static GSList*  g_unzFiles;
  80 static GSList*  g_pakFiles;
  81 static char     g_strDirs[VFS_MAXDIRS][PATH_MAX];
  82 static int      g_numDirs;
  83 static gboolean g_bUsePak = TRUE;
  84
  85 // =============================================================================
  86 // Static functions
  87
  88 static void vfsAddSlash (char *str)
  89 {
  90   int n = strlen (str);
  91   if (n > 0)
  92   {
  93     if (str[n-1] != '\\' && str[n-1] != '/')
  94       strcat (str, "/");
  95   }
  96 }
  97
  98 static void vfsFixDOSName (char *src)
  99 {
 100   if (src == NULL)
 101     return;
 102
 103   while (*src)
 104   {
 105     if (*src == '\\')
 106       *src = '/';
 107     src++;
 108   }
 109 }
 110
 111 //!\todo Define globally or use heap-allocated string.
 112 #define NAME_MAX 255
 113
 114 static void vfsInitPakFile (const char *filename)
 115 {
 116   unz_global_info gi;
 117   unzFile uf;
 118   guint32 i;
 119   int err;
 120
 121   uf = unzOpen (filename);
 122   if (uf == NULL)
 123     return;
 124
 125   g_unzFiles = g_slist_append (g_unzFiles, uf);
 126
 127   err = unzGetGlobalInfo (uf,&gi);
 128   if (err != UNZ_OK)
 129     return;
 130   unzGoToFirstFile(uf);
 131
 132   for (i = 0; i < gi.number_entry; i++)
 133   {
 134     char filename_inzip[NAME_MAX];
 135     unz_file_info file_info;
 136     VFS_PAKFILE* file;
 137
 138     err = unzGetCurrentFileInfo (uf, &file_info, filename_inzip, sizeof(filename_inzip), NULL, 0, NULL, 0);
 139     if (err != UNZ_OK)
 140       break;
 141
 142     file = (VFS_PAKFILE*)safe_malloc (sizeof (VFS_PAKFILE));
 143     g_pakFiles = g_slist_append (g_pakFiles, file);
 144
 145     vfsFixDOSName (filename_inzip);
 146     g_strdown (filename_inzip);
 147
 148     file->name = strdup (filename_inzip);
 149     file->size = file_info.uncompressed_size;
 150     file->zipfile = uf;
 151     memcpy (&file->zipinfo, uf, sizeof (unz_s));
 152
 153     if ((i+1) < gi.number_entry)
 154     {
 155       err = unzGoToNextFile(uf);
 156       if (err!=UNZ_OK)
 157         break;
 158     }
 159   }
 160 }
 161
 162 // =============================================================================
 163 // Global functions
 164
 165 // reads all pak files from a dir
 166 void vfsInitDirectory (const char *path)
 167 {
 168   char filename[PATH_MAX];
 169   char *dirlist;
 170   GDir *dir;
 171
 172   if (g_numDirs == (VFS_MAXDIRS-1))
 173     return;
 174
 175   Sys_Printf ("VFS Init: %s\n", path);
 176
 177   strcpy (g_strDirs[g_numDirs], path);
 178   vfsFixDOSName (g_strDirs[g_numDirs]);
 179   vfsAddSlash (g_strDirs[g_numDirs]);
 180   g_numDirs++;
 181
 182   if (g_bUsePak)
 183   {
 184     dir = g_dir_open (path, 0, NULL);
 185
 186     if (dir != NULL)
 187     {
 188       while (1)
 189       {
 190         const char* name = g_dir_read_name(dir);
 191         if(name == NULL)
 192           break;
 193
 194         dirlist = g_strdup(name);
 195
 196         {
 197           char *ext = strrchr (dirlist, '.');
 198
 199           if(ext && !Q_stricmp(ext, ".pk3dir"))
 200           {
 201             if (g_numDirs == (VFS_MAXDIRS-1))
 202               continue;
 203             snprintf(g_strDirs[g_numDirs], PATH_MAX, "%s/%s", path, name);
 204             g_strDirs[g_numDirs][PATH_MAX] = '\0';
 205             vfsFixDOSName (g_strDirs[g_numDirs]);
 206             vfsAddSlash (g_strDirs[g_numDirs]);
 207             ++g_numDirs;
 208           }
 209
 210           if ((ext == NULL) || (Q_stricmp (ext, ".pk3") != 0))
 211             continue;
 212         }
 213
 214         sprintf (filename, "%s/%s", path, dirlist);
 215         vfsInitPakFile (filename);
 216
 217         g_free(dirlist);
 218       }
 219       g_dir_close (dir);
 220     }
 221   }
 222 }
 223
 224 // frees all memory that we allocated
 225 void vfsShutdown ()
 226 {
 227   while (g_unzFiles)
 228   {
 229     unzClose ((unzFile)g_unzFiles->data);
 230     g_unzFiles = g_slist_remove (g_unzFiles, g_unzFiles->data);
 231   }
 232
 233   while (g_pakFiles)
 234   {
 235     VFS_PAKFILE* file = (VFS_PAKFILE*)g_pakFiles->data;
 236     free (file->name);
 237     free (file);
 238     g_pakFiles = g_slist_remove (g_pakFiles, file);
 239   }
 240 }
 241
 242 // return the number of files that match
 243 int vfsGetFileCount (const char *filename)
 244 {
 245   int i, count = 0;
 246   char fixed[NAME_MAX], tmp[NAME_MAX];
 247   GSList *lst;
 248
 249   strcpy (fixed, filename);
 250   vfsFixDOSName (fixed);
 251   g_strdown (fixed);
 252
 253   for (lst = g_pakFiles; lst != NULL; lst = g_slist_next (lst))
 254   {
 255     VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
 256
 257     if (strcmp (file->name, fixed) == 0)
 258       count++;
 259   }
 260
 261   for (i = 0; i < g_numDirs; i++)
 262   {
 263     strcpy (tmp, g_strDirs[i]);
 264     strcat (tmp, fixed);
 265     if (access (tmp, R_OK) == 0)
 266       count++;
 267   }
 268
 269   return count;
 270 }
 271
 272 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
 273 int vfsLoadFile (const char *filename, void **bufferptr, int index)
 274 {
 275   int i, count = 0;
 276   char tmp[NAME_MAX], fixed[NAME_MAX];
 277   GSList *lst;
 278
 279   // filename is a full path
 280   if (index == -1)
 281   {
 282     long len;
 283     FILE *f;
 284
 285     f = fopen (filename, "rb");
 286     if (f == NULL)
 287       return -1;
 288
 289     fseek (f, 0, SEEK_END);
 290     len = ftell (f);
 291     rewind (f);
 292
 293     *bufferptr = safe_malloc (len+1);
 294     if (*bufferptr == NULL)
 295       return -1;
 296
 297     fread (*bufferptr, 1, len, f);
 298     fclose (f);
 299
 300     // we need to end the buffer with a 0
 301     ((char*) (*bufferptr))[len] = 0;
 302
 303     return len;
 304   }
 305
 306   *bufferptr = NULL;
 307   strcpy (fixed, filename);
 308   vfsFixDOSName (fixed);
 309   g_strdown (fixed);
 310
 311   for (i = 0; i < g_numDirs; i++)
 312   {
 313     strcpy (tmp, g_strDirs[i]);
 314     strcat (tmp, filename);
 315     if (access (tmp, R_OK) == 0)
 316     {
 317       if (count == index)
 318       {
 319         long len;
 320         FILE *f;
 321
 322         f = fopen (tmp, "rb");
 323         if (f == NULL)
 324           return -1;
 325
 326         fseek (f, 0, SEEK_END);
 327         len = ftell (f);
 328         rewind (f);
 329
 330         *bufferptr = safe_malloc (len+1);
 331         if (*bufferptr == NULL)
 332           return -1;
 333
 334         fread (*bufferptr, 1, len, f);
 335         fclose (f);
 336
 337         // we need to end the buffer with a 0
 338         ((char*) (*bufferptr))[len] = 0;
 339
 340         return len;
 341       }
 342
 343       count++;
 344     }
 345   }
 346
 347   for (lst = g_pakFiles; lst != NULL; lst = g_slist_next (lst))
 348   {
 349     VFS_PAKFILE* file = (VFS_PAKFILE*)lst->data;
 350
 351     if (strcmp (file->name, fixed) != 0)
 352       continue;
 353
 354     if (count == index)
 355     {
 356       memcpy (file->zipfile, &file->zipinfo, sizeof (unz_s));
 357
 358       if (unzOpenCurrentFile (file->zipfile) != UNZ_OK)
 359         return -1;
 360
 361       *bufferptr = safe_malloc (file->size+1);
 362       // we need to end the buffer with a 0
 363       ((char*) (*bufferptr))[file->size] = 0;
 364
 365       i = unzReadCurrentFile (file->zipfile , *bufferptr, file->size);
 366       unzCloseCurrentFile (file->zipfile);
 367       if (i < 0)
 368         return -1;
 369       else
 370         return file->size;
 371     }
 372
 373     count++;
 374   }
 375
 376   return -1;
 377 }