lib/libarchive/archive_read_open_file.c

   1 /*-
   2  * Copyright (c) 2003-2007 Tim Kientzle
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "archive_platform.h"
  27 __FBSDID("$FreeBSD$");
  28
  29 #ifdef HAVE_SYS_STAT_H
  30 #include <sys/stat.h>
  31 #endif
  32 #ifdef HAVE_ERRNO_H
  33 #include <errno.h>
  34 #endif
  35 #ifdef HAVE_FCNTL_H
  36 #include <fcntl.h>
  37 #endif
  38 #ifdef HAVE_STDLIB_H
  39 #include <stdlib.h>
  40 #endif
  41 #ifdef HAVE_STRING_H
  42 #include <string.h>
  43 #endif
  44 #ifdef HAVE_UNISTD_H
  45 #include <unistd.h>
  46 #endif
  47
  48 #include "archive.h"
  49
  50 struct read_FILE_data {
  51         FILE    *f;
  52         size_t   block_size;
  53         void    *buffer;
  54         char     can_skip;
  55 };
  56
  57 static int      file_close(struct archive *, void *);
  58 static ssize_t  file_read(struct archive *, void *, const void **buff);
  59 #if ARCHIVE_API_VERSION < 2
  60 static ssize_t  file_skip(struct archive *, void *, size_t request);
  61 #else
  62 static off_t    file_skip(struct archive *, void *, off_t request);
  63 #endif
  64
  65 int
  66 archive_read_open_FILE(struct archive *a, FILE *f)
  67 {
  68         struct stat st;
  69         struct read_FILE_data *mine;
  70         size_t block_size = 128 * 1024;
  71         void *b;
  72
  73         archive_clear_error(a);
  74         mine = (struct read_FILE_data *)malloc(sizeof(*mine));
  75         b = malloc(block_size);
  76         if (mine == NULL || b == NULL) {
  77                 archive_set_error(a, ENOMEM, "No memory");
  78                 free(mine);
  79                 free(b);
  80                 return (ARCHIVE_FATAL);
  81         }
  82         mine->block_size = block_size;
  83         mine->buffer = b;
  84         mine->f = f;
  85         /*
  86          * If we can't fstat() the file, it may just be that it's not
  87          * a file.  (FILE * objects can wrap many kinds of I/O
  88          * streams, some of which don't support fileno()).)
  89          */
  90         if (fstat(fileno(mine->f), &st) == 0 && S_ISREG(st.st_mode)) {
  91                 archive_read_extract_set_skip_file(a, st.st_dev, st.st_ino);
  92                 /* Enable the seek optimization only for regular files. */
  93                 mine->can_skip = 1;
  94         } else
  95                 mine->can_skip = 0;
  96
  97         return (archive_read_open2(a, mine, NULL, file_read,
  98                     file_skip, file_close));
  99 }
 100
 101 static ssize_t
 102 file_read(struct archive *a, void *client_data, const void **buff)
 103 {
 104         struct read_FILE_data *mine = (struct read_FILE_data *)client_data;
 105         ssize_t bytes_read;
 106
 107         *buff = mine->buffer;
 108         bytes_read = fread(mine->buffer, 1, mine->block_size, mine->f);
 109         if (bytes_read < 0) {
 110                 archive_set_error(a, errno, "Error reading file");
 111         }
 112         return (bytes_read);
 113 }
 114
 115 #if ARCHIVE_API_VERSION < 2
 116 static ssize_t
 117 file_skip(struct archive *a, void *client_data, size_t request)
 118 #else
 119 static off_t
 120 file_skip(struct archive *a, void *client_data, off_t request)
 121 #endif
 122 {
 123         struct read_FILE_data *mine = (struct read_FILE_data *)client_data;
 124
 125         (void)a; /* UNUSED */
 126
 127         /*
 128          * If we can't skip, return 0 as the amount we did step and
 129          * the caller will work around by reading and discarding.
 130          */
 131         if (!mine->can_skip)
 132                 return (0);
 133         if (request == 0)
 134                 return (0);
 135
 136 #if HAVE_FSEEKO
 137         if (fseeko(mine->f, request, SEEK_CUR) != 0)
 138 #else
 139         if (fseek(mine->f, request, SEEK_CUR) != 0)
 140 #endif
 141         {
 142                 mine->can_skip = 0;
 143                 return (0);
 144         }
 145         return (request);
 146 }
 147
 148 static int
 149 file_close(struct archive *a, void *client_data)
 150 {
 151         struct read_FILE_data *mine = (struct read_FILE_data *)client_data;
 152
 153         (void)a; /* UNUSED */
 154         if (mine->buffer != NULL)
 155                 free(mine->buffer);
 156         free(mine);
 157         return (ARCHIVE_OK);
 158 }