src/lbx.c

   1 /*
   2  *  2ooM: The Master of Orion II Reverse Engineering Project
   3  *  Library for working with LBX archive files.
   4  *  Copyright (C) 2006-2010 Nick Bowler
   5  *
   6  *  This program is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (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.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #ifdef HAVE_CONFIG_H
  20 #       include "config.h"
  21 #endif
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <errno.h>
  27 #include <assert.h>
  28
  29 #include "pack.h"
  30 #include "misc.h"
  31 #include "lbx.h"
  32
  33 #define LBX_MAGIC    0x0000fead
  34 #define LBX_HDR_SIZE 8
  35
  36 int lbx_errno = 0;
  37
  38 struct lbx_state {
  39         char *name;
  40
  41         const struct lbx_file_ops *fops;
  42         int (*dtor)(void *handle);
  43         void *f;
  44
  45         struct lbx_file_state *last_file;
  46
  47         unsigned short nfiles;
  48         unsigned long offsets[];
  49 };
  50
  51 struct lbx_file_state {
  52         unsigned long base, limit, offset;
  53         struct lbx_state *lbx;
  54         int eof;
  55 };
  56
  57 static struct lbx_state *lbx_init(unsigned char hdr[static LBX_HDR_SIZE])
  58 {
  59         unsigned short nfiles  = unpack_16_le(hdr+0);
  60         unsigned long  magic   = unpack_32_le(hdr+2);
  61         unsigned short version = unpack_16_le(hdr+6);
  62         struct lbx_state *lbx;
  63
  64         if (magic != LBX_MAGIC) {
  65                 lbx_errno = -LBX_EMAGIC;
  66                 return NULL;
  67         }
  68
  69         lbx = malloc(sizeof *lbx + sizeof lbx->offsets[0] * (nfiles+1));
  70         if (!lbx) {
  71                 lbx_errno = -errno;
  72                 return NULL;
  73         }
  74
  75         *lbx = (struct lbx_state) {
  76                 .nfiles = nfiles,
  77         };
  78
  79         return lbx;
  80 }
  81
  82 static char *str_dup(const char *s)
  83 {
  84         char *buf;
  85
  86         buf = malloc(strlen(s)+1);
  87         if (buf)
  88                 strcpy(buf, s);
  89         return buf;
  90 }
  91
  92 struct lbx_state *lbx_open(void *f, const struct lbx_file_ops *fops,
  93                            int (*destructor)(void *), const char *name)
  94 {
  95         unsigned char hdr_buf[LBX_HDR_SIZE];
  96         struct lbx_state *lbx = NULL;
  97         char *dupname = NULL;
  98
  99         dupname = str_dup(name);
 100         if (!dupname) {
 101                 lbx_errno = -errno;
 102                 goto err;
 103         }
 104
 105         if (fops->read(hdr_buf, sizeof hdr_buf, f) != sizeof hdr_buf) {
 106                 lbx_errno = -errno;
 107                 goto err;
 108         }
 109
 110         lbx = lbx_init(hdr_buf);
 111         if (!lbx)
 112                 goto err;
 113
 114         lbx->name = dupname;
 115         lbx->dtor = destructor;
 116         lbx->fops = fops;
 117         lbx->f    = f;
 118
 119         for (unsigned i = 0; i <= lbx->nfiles; i++) {
 120                 unsigned char buf[4];
 121
 122                 if (fops->read(buf, sizeof buf, f) != sizeof buf) {
 123                         lbx_errno = -errno;
 124                         if (fops->eof(f))
 125                                 lbx_errno = LBX_EEOF;
 126                         goto err;
 127                 }
 128
 129                 lbx->offsets[i] = unpack_32_le(buf);
 130         }
 131
 132         return lbx;
 133 err:
 134         free(dupname);
 135         free(lbx);
 136         return NULL;
 137 }
 138
 139 static int file_close(void *f)
 140 {
 141         return fclose((FILE *)f);
 142 }
 143
 144 static int pipe_close(void *f)
 145 {
 146         struct lbx_pipe_state *p = f;
 147         int rc;
 148
 149         rc = fclose(p->f);
 150         free(p);
 151         return rc;
 152 }
 153
 154 static char *last_component(const char *name)
 155 {
 156         char *c;
 157
 158         /* TODO: Handle other path separators. */
 159         c = strrchr(name, '/');
 160         if (!c)
 161                 return (char *)name;
 162         return c+1;
 163 }
 164
 165 struct lbx_state *lbx_fopen(const char *file)
 166 {
 167         const char *name = last_component(file);
 168         struct lbx_pipe_state *p;
 169         FILE *f;
 170
 171         f = fopen(file, "rb");
 172         if (!f)
 173                 return NULL;
 174
 175         if (fseek(f, 0, SEEK_CUR) == 0)
 176                 return lbx_open(f, &lbx_default_fops, file_close, name);
 177
 178         p = malloc(sizeof *p);
 179         if (!p) {
 180                 fclose(f);
 181                 return NULL;
 182         }
 183
 184         *p = (struct lbx_pipe_state) { .f = f };
 185         return lbx_open(p, &lbx_pipe_fops, pipe_close, name);
 186 }
 187
 188 size_t lbx_numfiles(struct lbx_state *lbx)
 189 {
 190         return lbx->nfiles;
 191 }
 192
 193 int lbx_stat(struct lbx_state *lbx, size_t index, struct lbx_statbuf *buf)
 194 {
 195         static char str[256]; /* FIXME */
 196
 197         if (index >= lbx->nfiles) {
 198                 buf->name = NULL;
 199                 lbx_errno = LBX_ERANGE;
 200                 return -1;
 201         }
 202
 203         snprintf(str, sizeof str, "%s.%03zu", lbx->name, index);
 204         buf->name = str;
 205         buf->size = lbx->offsets[index+1] - lbx->offsets[index];
 206         return 0;
 207 }
 208
 209 int lbx_close(struct lbx_state *lbx)
 210 {
 211         int rc = 0;
 212
 213         if (lbx && lbx->dtor)
 214                 rc = lbx->dtor(lbx->f);
 215         free(lbx->name);
 216         free(lbx);
 217
 218         return rc;
 219 }
 220
 221 struct lbx_file_state *lbx_file_open(struct lbx_state *lbx, unsigned fileno)
 222 {
 223         struct lbx_file_state *state;
 224
 225         if (fileno >= lbx->nfiles) {
 226                 lbx_errno = LBX_ERANGE;
 227                 return NULL;
 228         }
 229
 230         lbx->last_file = NULL;
 231         if (lbx->fops->seek(lbx->f, lbx->offsets[fileno], SEEK_SET) != 0) {
 232                 lbx_errno = -errno;
 233                 return NULL;
 234         }
 235
 236         state = malloc(sizeof *state);
 237         if (!state) {
 238                 lbx_errno = -errno;
 239                 return NULL;
 240         }
 241
 242         *state = (struct lbx_file_state) {
 243                 .base  = lbx->offsets[fileno],
 244                 .limit = lbx->offsets[fileno+1] - lbx->offsets[fileno],
 245                 .lbx   = lbx,
 246         };
 247
 248         lbx->last_file = state;
 249         return state;
 250 }
 251
 252 size_t lbx_file_read(struct lbx_file_state *f, void *buf, size_t n)
 253 {
 254         const struct lbx_file_ops *fops = f->lbx->fops;
 255         size_t want = MIN(n, f->limit - f->offset);
 256         size_t rc;
 257
 258         if (f != f->lbx->last_file) {
 259                 f->lbx->last_file = NULL;
 260                 if (fops->seek(f->lbx->f, f->base + f->limit, SEEK_SET) != 0)
 261                         return 0;
 262                 f->lbx->last_file = f;
 263         }
 264
 265         rc = fops->read(buf, want, f->lbx->f);
 266         f->offset += rc;
 267
 268         if (want < n || (rc < want && fops->eof(f->lbx->f)))
 269                 f->eof = 1;
 270         return rc;
 271 }
 272
 273 int lbx_file_seek(struct lbx_file_state *f, long offset, int whence)
 274 {
 275         const struct lbx_file_ops *fops = f->lbx->fops;
 276         unsigned long pos;
 277
 278         switch (whence) {
 279         case SEEK_CUR:
 280                 pos = f->offset + offset;
 281                 break;
 282         case SEEK_SET:
 283                 pos = offset;
 284                 break;
 285         case SEEK_END:
 286                 pos = f->limit + offset;
 287                 break;
 288         }
 289
 290         if (pos > f->limit)
 291                 return -1;
 292
 293         f->lbx->last_file = NULL;
 294         if (fops->seek(f->lbx->f, f->base + pos, SEEK_SET) != 0)
 295                 return -1;
 296
 297         f->offset = pos;
 298         f->lbx->last_file = f;
 299         f->eof = 0;
 300
 301         return 0;
 302 }
 303
 304 long lbx_file_tell(struct lbx_file_state *f)
 305 {
 306         return f->offset;
 307 }
 308
 309 int lbx_file_eof(struct lbx_file_state *f)
 310 {
 311         return f->eof;
 312 }
 313
 314 void lbx_file_close(struct lbx_file_state *f)
 315 {
 316         if (f->lbx->last_file == f)
 317                 f->lbx->last_file = NULL;
 318         free(f);
 319 }
 320
 321 const char *lbx_strerror(void)
 322 {
 323         if (lbx_errno < 0)
 324                 return strerror(-lbx_errno);
 325
 326         switch (lbx_errno) {
 327         case LBX_ESUCCESS: return "Success";
 328         case LBX_EMAGIC:   return "Bad magic number";
 329         case LBX_EEOF:     return "Unexpected end-of-file";
 330         case LBX_ERANGE:   return "Index out of range";
 331         case LBX_EFORMAT:  return "Invalid file format";
 332         }
 333
 334         return "Unknown error";
 335 }