contrib/libarchive/libarchive/archive_read_extract.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: src/lib/libarchive/archive_read_extract.c,v 1.61 2008/05/26 17:00:22 kientzle Exp $");
  28
  29 #ifdef HAVE_SYS_TYPES_H
  30 #include <sys/types.h>
  31 #endif
  32 #ifdef HAVE_ERRNO_H
  33 #include <errno.h>
  34 #endif
  35 #ifdef HAVE_STDLIB_H
  36 #include <stdlib.h>
  37 #endif
  38 #ifdef HAVE_STRING_H
  39 #include <string.h>
  40 #endif
  41
  42 #include "archive.h"
  43 #include "archive_entry.h"
  44 #include "archive_private.h"
  45 #include "archive_read_private.h"
  46 #include "archive_write_disk_private.h"
  47
  48 struct extract {
  49         struct archive *ad; /* archive_write_disk object */
  50
  51         /* Progress function invoked during extract. */
  52         void                    (*extract_progress)(void *);
  53         void                     *extract_progress_user_data;
  54 };
  55
  56 static int      archive_read_extract_cleanup(struct archive_read *);
  57 static int      copy_data(struct archive *ar, struct archive *aw);
  58 static struct extract *get_extract(struct archive_read *);
  59
  60 static struct extract *
  61 get_extract(struct archive_read *a)
  62 {
  63         /* If we haven't initialized, do it now. */
  64         /* This also sets up a lot of global state. */
  65         if (a->extract == NULL) {
  66                 a->extract = (struct extract *)malloc(sizeof(*a->extract));
  67                 if (a->extract == NULL) {
  68                         archive_set_error(&a->archive, ENOMEM, "Can't extract");
  69                         return (NULL);
  70                 }
  71                 memset(a->extract, 0, sizeof(*a->extract));
  72                 a->extract->ad = archive_write_disk_new();
  73                 if (a->extract->ad == NULL) {
  74                         archive_set_error(&a->archive, ENOMEM, "Can't extract");
  75                         return (NULL);
  76                 }
  77                 archive_write_disk_set_standard_lookup(a->extract->ad);
  78                 a->cleanup_archive_extract = archive_read_extract_cleanup;
  79         }
  80         return (a->extract);
  81 }
  82
  83 int
  84 archive_read_extract(struct archive *_a, struct archive_entry *entry, int flags)
  85 {
  86         struct extract *extract;
  87
  88         extract = get_extract((struct archive_read *)_a);
  89         if (extract == NULL)
  90                 return (ARCHIVE_FATAL);
  91         archive_write_disk_set_options(extract->ad, flags);
  92         return (archive_read_extract2(_a, entry, extract->ad));
  93 }
  94
  95 int
  96 archive_read_extract2(struct archive *_a, struct archive_entry *entry,
  97     struct archive *ad)
  98 {
  99         struct archive_read *a = (struct archive_read *)_a;
 100         int r, r2;
 101
 102         /* Set up for this particular entry. */
 103         archive_write_disk_set_skip_file(ad,
 104             a->skip_file_dev, a->skip_file_ino);
 105         r = archive_write_header(ad, entry);
 106         if (r < ARCHIVE_WARN)
 107                 r = ARCHIVE_WARN;
 108         if (r != ARCHIVE_OK)
 109                 /* If _write_header failed, copy the error. */
 110                 archive_copy_error(&a->archive, ad);
 111         else if (archive_entry_size(entry) > 0)
 112                 /* Otherwise, pour data into the entry. */
 113                 r = copy_data(_a, ad);
 114         r2 = archive_write_finish_entry(ad);
 115         if (r2 < ARCHIVE_WARN)
 116                 r2 = ARCHIVE_WARN;
 117         /* Use the first message. */
 118         if (r2 != ARCHIVE_OK && r == ARCHIVE_OK)
 119                 archive_copy_error(&a->archive, ad);
 120         /* Use the worst error return. */
 121         if (r2 < r)
 122                 r = r2;
 123         return (r);
 124 }
 125
 126 void
 127 archive_read_extract_set_progress_callback(struct archive *_a,
 128     void (*progress_func)(void *), void *user_data)
 129 {
 130         struct archive_read *a = (struct archive_read *)_a;
 131         struct extract *extract = get_extract(a);
 132         if (extract != NULL) {
 133                 extract->extract_progress = progress_func;
 134                 extract->extract_progress_user_data = user_data;
 135         }
 136 }
 137
 138 static int
 139 copy_data(struct archive *ar, struct archive *aw)
 140 {
 141         off_t offset;
 142         const void *buff;
 143         struct extract *extract;
 144         size_t size;
 145         int r;
 146
 147         extract = get_extract((struct archive_read *)ar);
 148         for (;;) {
 149                 r = archive_read_data_block(ar, &buff, &size, &offset);
 150                 if (r == ARCHIVE_EOF)
 151                         return (ARCHIVE_OK);
 152                 if (r != ARCHIVE_OK)
 153                         return (r);
 154                 r = archive_write_data_block(aw, buff, size, offset);
 155                 if (r < ARCHIVE_WARN)
 156                         r = ARCHIVE_WARN;
 157                 if (r != ARCHIVE_OK) {
 158                         archive_set_error(ar, archive_errno(aw),
 159                             "%s", archive_error_string(aw));
 160                         return (r);
 161                 }
 162                 if (extract->extract_progress)
 163                         (extract->extract_progress)
 164                             (extract->extract_progress_user_data);
 165         }
 166 }
 167
 168 /*
 169  * Cleanup function for archive_extract.
 170  */
 171 static int
 172 archive_read_extract_cleanup(struct archive_read *a)
 173 {
 174         int ret = ARCHIVE_OK;
 175
 176 #if ARCHIVE_API_VERSION > 1
 177         ret =
 178 #endif
 179             archive_write_finish(a->extract->ad);
 180         free(a->extract);
 181         a->extract = NULL;
 182         return (ret);
 183 }