zip-reader: Better hide implementation details from clients.
[pspp] / src / libpspp / zip-reader.c
index 00758c5faae19bf957343af185466b89c000a1dd..92a67649fdae6b44f9025c42d2153207256fcd4b 100644 (file)
@@ -16,7 +16,7 @@
 
 #include <config.h>
 
-
+#include <inttypes.h>
 #include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -30,8 +30,6 @@
 #include <byteswap.h>
 #include <crc.h>
 
-#include "inflate.h"
-
 #include "str.h"
 
 #include "zip-reader.h"
 #define _(msgid) gettext (msgid)
 #define N_(msgid) (msgid)
 
-
-static bool find_eocd (FILE *fp, off_t *off);
-
-static int
-stored_read (struct zip_member *zm, void *buf, size_t n)
+struct zip_member
 {
-  return fread (buf, 1, n, zm->fp);
-}
+  FILE *fp;                   /* The stream from which the data is read */
+  uint32_t offset;            /* Starting offset in file. */
+  uint32_t comp_size;         /* Length of member file data, in bytes. */
+  uint32_t ucomp_size;        /* Uncompressed length of member file data, in bytes. */
+  uint32_t expected_crc;      /* CRC-32 of member file data.. */
+  char *name;                 /* Name of member file. */
+  uint32_t crc;
+  const struct decompressor *decompressor;
 
-static bool
-stored_init (struct zip_member *zm UNUSED)
-{
-  return true;
-}
+  size_t bytes_unread;       /* Number of bytes left in the member available for reading */
+  int ref_cnt;
+  struct string *errmsgs;    /* A string to hold error messages.
+                               This string is NOT owned by this object. */
+  void *aux;
+};
 
-static void
-stored_finish (struct zip_member *zm UNUSED)
+struct decompressor
 {
-  /* Nothing required */
-}
-
+  bool (*init) (struct zip_member *);
+  int  (*read) (struct zip_member *, void *, size_t);
+  void (*finish) (struct zip_member *);
+};
+static const struct decompressor stored_decompressor;
+static const struct decompressor inflate_decompressor;
 
-static struct decompressor decompressors[n_COMPRESSION] = 
-  {
-    {stored_init, stored_read, stored_finish},
-    {inflate_init, inflate_read, inflate_finish}
-  };
+static bool find_eocd (FILE *fp, off_t *off);
 
-static enum compression
-comp_code (struct zip_member *zm, uint16_t c)
+static const struct decompressor *
+get_decompressor (struct zip_member *zm, uint16_t c)
 {
-  enum compression which;
+  assert (zm->errmsgs);
   switch (c)
     {
     case 0:
-      which = COMPRESSION_STORED;
-      break;
+      return &stored_decompressor;
+
     case 8:
-      which = COMPRESSION_INFLATE;
-      break;
+      return &inflate_decompressor;
+
     default:
-      ds_put_format (zm->errs, _("Unsupported compression type (%d)"), c);
-      which = n_COMPRESSION;
-      break;
+      ds_put_format (zm->errmsgs, _("Unsupported compression type (%d)"), c);
+      return NULL;
     }
-  return which;
 }
 
 
@@ -103,7 +100,7 @@ struct zip_reader
 void
 zip_member_finish (struct zip_member *zm)
 {
-  ds_clear (zm->errs);
+  ds_clear (zm->errmsgs);
   /*  Probably not useful, because we would have to read right to the end of the member
   if (zm->expected_crc != zm->crc)
     {
@@ -120,7 +117,7 @@ void
 zip_reader_destroy (struct zip_reader *zr)
 {
   int i;
-  if (zr == NULL) 
+  if (zr == NULL)
     return;
 
   fclose (zr->fr);
@@ -154,7 +151,7 @@ static bool get_bytes (FILE *f, void *x, size_t n) WARN_UNUSED_RESULT;
 
 /* Read N bytes from F, storing the result in X */
 static bool
-get_bytes (FILE *f, void *x, size_t n) 
+get_bytes (FILE *f, void *x, size_t n)
 {
   return (n == fread (x, 1, n, f));
 }
@@ -208,7 +205,7 @@ check_magic (FILE *f, uint32_t expected, struct string *err)
   if ((expected != magic))
     {
       ds_put_format (err,
-                    _("Corrupt file at 0x%llx: Expected %"PRIx32"; got %"PRIx32), 
+                    _("Corrupt file at 0x%llx: Expected %"PRIx32"; got %"PRIx32),
                     (long long int) ftello (f) - sizeof (uint32_t), expected, magic);
 
       return false;
@@ -224,12 +221,12 @@ zip_member_read (struct zip_member *zm, void *buf, size_t bytes)
 {
   int bytes_read = 0;
 
-  ds_clear (zm->errs);
+  ds_clear (zm->errmsgs);
 
   if ( bytes > zm->bytes_unread)
     bytes = zm->bytes_unread;
 
-  bytes_read  = decompressors[zm->compression].read (zm, buf, bytes);
+  bytes_read  = zm->decompressor->read (zm, buf, bytes);
   if ( bytes_read < 0)
     return bytes_read;
 
@@ -244,7 +241,7 @@ zip_member_read (struct zip_member *zm, void *buf, size_t bytes)
 /*
   Read a local file header from ZR and add it to ZR's internal array.
   Returns a pointer to the member read.  This pointer belongs to ZR.
-  If the caller wishes to control it, she should ref it with 
+  If the caller wishes to control it, she should ref it with
   zip_member_ref.
 */
 static struct zip_member *
@@ -254,12 +251,13 @@ zip_header_read_next (struct zip_reader *zr)
 
   uint16_t v, nlen, extralen;
   uint16_t gp, time, date;
-  
+
   uint16_t clen, diskstart, iattr;
   uint32_t eattr;
   uint16_t comp_type;
 
   ds_clear (zr->errs);
+  zm->errmsgs = zr->errs;
 
   if ( ! check_magic (zr->fr, MAGIC_SOCD, zr->errs))
     return NULL;
@@ -270,7 +268,8 @@ zip_header_read_next (struct zip_reader *zr)
   if (! get_u16 (zr->fr, &gp)) return NULL;
   if (! get_u16 (zr->fr, &comp_type)) return NULL;
 
-  zm->compression = comp_code (zm, comp_type);
+  zm->decompressor = get_decompressor (zm, comp_type);
+  if (! zm->decompressor) return NULL;
 
   if (! get_u16 (zr->fr, &time)) return NULL;
   if (! get_u16 (zr->fr, &date)) return NULL;
@@ -289,12 +288,12 @@ zip_header_read_next (struct zip_reader *zr)
   if (! get_bytes (zr->fr, zm->name, nlen)) return NULL;
 
   skip_bytes (zr->fr, extralen);
-  
+
   zr->members[zr->nm++] = zm;
 
   zm->fp = fopen (zr->filename, "rb");
   zm->ref_cnt = 1;
-  zm->errs = zr->errs;
+
 
   return zm;
 }
@@ -354,7 +353,7 @@ zip_reader_create (const char *filename, struct string *errs)
       free (zr);
       return NULL;
     }
-  
+
   if (! get_u16 (zr->fr, &disknum)) return NULL;
   if (! get_u16 (zr->fr, &disknum)) return NULL;
 
@@ -376,7 +375,7 @@ zip_reader_create (const char *filename, struct string *errs)
   zr->members = xcalloc (zr->n_members, sizeof (*zr->members));
   memset (zr->members, 0, zr->n_members * sizeof (*zr->members));
 
-  zr->filename = strdup (filename);
+  zr->filename = xstrdup (filename);
 
   return zr;
 }
@@ -390,7 +389,7 @@ zip_member_open (struct zip_reader *zr, const char *member)
   uint16_t v, nlen, extra_len;
   uint16_t gp, comp_type, time, date;
   uint32_t ucomp_size, comp_size;
-  
+
   uint32_t crc;
   bool new_member = false;
   char *name = NULL;
@@ -415,14 +414,14 @@ zip_member_open (struct zip_reader *zr, const char *member)
     else
       zm = NULL;
   }
-  
+
   if ( zm == NULL)
     return NULL;
 
   if ( 0 != fseeko (zm->fp, zm->offset, SEEK_SET))
     {
       const char *mm = strerror (errno);
-      ds_put_format (zm->errs, _("Failed to seek to start of member `%s': %s"), zm->name, mm);
+      ds_put_format (zm->errmsgs, _("Failed to seek to start of member `%s': %s"), zm->name, mm);
       return NULL;
     }
 
@@ -434,7 +433,8 @@ zip_member_open (struct zip_reader *zr, const char *member)
   if (! get_u16 (zm->fp, &v)) return NULL;
   if (! get_u16 (zm->fp, &gp)) return NULL;
   if (! get_u16 (zm->fp, &comp_type)) return NULL;
-  zm->compression = comp_code (zm, comp_type);
+  zm->decompressor = get_decompressor (zm, comp_type);
+  if (! zm->decompressor) return NULL;
   if (! get_u16 (zm->fp, &time)) return NULL;
   if (! get_u16 (zm->fp, &date)) return NULL;
   if (! get_u32 (zm->fp, &crc)) return NULL;
@@ -452,7 +452,7 @@ zip_member_open (struct zip_reader *zr, const char *member)
 
   if (strcmp (name, zm->name) != 0)
     {
-      ds_put_format (zm->errs,
+      ds_put_format (zm->errmsgs,
                     _("Name mismatch in zip archive. Central directory says `%s'; local file header says `%s'"),
                     zm->name, name);
       free (name);
@@ -463,11 +463,11 @@ zip_member_open (struct zip_reader *zr, const char *member)
   free (name);
 
   zm->bytes_unread = zm->ucomp_size;
-  
+
   if ( !new_member)
-    decompressors[zm->compression].finish (zm);
+    zm->decompressor->finish (zm);
 
-  if (!decompressors[zm->compression].init (zm) )
+  if (!zm->decompressor->init (zm) )
     return NULL;
 
   return zm;
@@ -490,7 +490,7 @@ zip_member_unref (struct zip_member *zm)
 
   if (--zm->ref_cnt == 0)
     {
-      decompressors[zm->compression].finish (zm);
+      zm->decompressor->finish (zm);
       if (zm->fp)
        fclose (zm->fp);
       free (zm->name);
@@ -515,7 +515,7 @@ find_eocd (FILE *fp, off_t *off)
   const uint32_t magic = MAGIC_EOCD;
   bool found = false;
 
-  /* The magic cannot be more than 22 bytes from the end of the file, 
+  /* The magic cannot be more than 22 bytes from the end of the file,
      because that is the minimum length of the EndOfCentralDirectory
      record.
    */
@@ -525,7 +525,7 @@ find_eocd (FILE *fp, off_t *off)
     }
   start = ftello (fp);
   stop = start + sizeof (magic);
-  do 
+  do
     {
       found = probe_magic (fp, magic, start, stop, off);
       /* FIXME: For extra confidence lookup the directory start record here*/
@@ -572,7 +572,7 @@ probe_magic (FILE *fp, uint32_t magic, off_t start, off_t stop, off_t *off)
        state++;
       else
        state = 0;
-      
+
       if ( state == 4)
        {
          *off = ftello (fp) - 4;
@@ -586,4 +586,147 @@ probe_magic (FILE *fp, uint32_t magic, off_t start, off_t stop, off_t *off)
 
   return false;
 }
+\f
+/* Null decompressor. */
+
+static int
+stored_read (struct zip_member *zm, void *buf, size_t n)
+{
+  return fread (buf, 1, n, zm->fp);
+}
+
+static bool
+stored_init (struct zip_member *zm UNUSED)
+{
+  return true;
+}
+
+static void
+stored_finish (struct zip_member *zm UNUSED)
+{
+  /* Nothing required */
+}
+
+static const struct decompressor stored_decompressor =
+  {stored_init, stored_read, stored_finish};
+\f
+/* Inflate decompressor. */
+
+#undef crc32
+#include <zlib.h>
+
+#define UCOMPSIZE 4096
+
+struct inflator
+{
+  z_stream zss;
+  int state;
+  unsigned char ucomp[UCOMPSIZE];
+  size_t bytes_uncomp;
+  size_t ucomp_bytes_read;
+
+  /* Two bitfields as defined by RFC1950 */
+  uint16_t cmf_flg ;
+};
+
+static void
+inflate_finish (struct zip_member *zm)
+{
+  struct inflator *inf = zm->aux;
+
+  inflateEnd (&inf->zss);
+
+  free (inf);
+}
+
+static bool
+inflate_init (struct zip_member *zm)
+{
+  int r;
+  struct inflator *inf = xzalloc (sizeof *inf);
+
+  uint16_t flg = 0 ;
+  uint16_t cmf = 0x8; /* Always 8 for inflate */
+
+  const uint16_t cinfo = 7;  /* log_2(Window size) - 8 */
+
+  cmf |= cinfo << 4;     /* Put cinfo into the high nibble */
+
+  /* make these into a 16 bit word */
+  inf->cmf_flg = (cmf << 8 ) | flg;
+
+  /* Set the check bits */
+  inf->cmf_flg += 31 - (inf->cmf_flg % 31);
+  assert (inf->cmf_flg % 31 == 0);
+
+  inf->zss.next_in = Z_NULL;
+  inf->zss.avail_in = 0;
+  inf->zss.zalloc = Z_NULL;
+  inf->zss.zfree  = Z_NULL;
+  inf->zss.opaque = Z_NULL;
+  r = inflateInit (&inf->zss);
+
+  if ( Z_OK != r)
+    {
+      ds_put_format (zm->errmsgs, _("Cannot initialize inflator: %s"), zError (r));
+      return false;
+    }
+
+  zm->aux = inf;
+
+  return true;
+}
+
+static int
+inflate_read (struct zip_member *zm, void *buf, size_t n)
+{
+  int r;
+  struct inflator *inf = zm->aux;
+
+  if (inf->zss.avail_in == 0)
+    {
+      int bytes_read;
+      int bytes_to_read;
+      int pad = 0;
+
+      if ( inf->state == 0)
+       {
+         inf->ucomp[1] = inf->cmf_flg ;
+         inf->ucomp[0] = inf->cmf_flg >> 8 ;
+
+         pad = 2;
+         inf->state++;
+       }
+
+      bytes_to_read = zm->comp_size - inf->ucomp_bytes_read;
+
+      if (bytes_to_read == 0)
+       return 0;
+
+      if (bytes_to_read > UCOMPSIZE)
+       bytes_to_read = UCOMPSIZE;
+
+      bytes_read = fread (inf->ucomp + pad, 1, bytes_to_read - pad, zm->fp);
+
+      inf->ucomp_bytes_read += bytes_read;
+
+      inf->zss.avail_in = bytes_read + pad;
+      inf->zss.next_in = inf->ucomp;
+    }
+  inf->zss.avail_out = n;
+  inf->zss.next_out = buf;
+
+  r = inflate (&inf->zss, Z_NO_FLUSH);
+  if ( Z_OK == r)
+    {
+      return n - inf->zss.avail_out;
+    }
+
+  ds_put_format (zm->errmsgs, _("Error inflating: %s"), zError (r));
+
+  return -1;
+}
+
+static const struct decompressor inflate_decompressor =
+  {inflate_init, inflate_read, inflate_finish};