contrib/libarchive-2.0/libarchive/archive_write.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_write.c,v 1.25 2007/03/11 10:29:52 kientzle Exp $");
  28
  29 /*
  30  * This file contains the "essential" portions of the write API, that
  31  * is, stuff that will essentially always be used by any client that
  32  * actually needs to write a archive.  Optional pieces have been, as
  33  * far as possible, separated out into separate files to reduce
  34  * needlessly bloating statically-linked clients.
  35  */
  36
  37 #ifdef HAVE_SYS_WAIT_H
  38 #include <sys/wait.h>
  39 #endif
  40 #ifdef HAVE_LIMITS_H
  41 #include <limits.h>
  42 #endif
  43 #include <stdio.h>
  44 #ifdef HAVE_STDLIB_H
  45 #include <stdlib.h>
  46 #endif
  47 #ifdef HAVE_STRING_H
  48 #include <string.h>
  49 #endif
  50 #include <time.h>
  51 #ifdef HAVE_UNISTD_H
  52 #include <unistd.h>
  53 #endif
  54
  55 #include "archive.h"
  56 #include "archive_entry.h"
  57 #include "archive_private.h"
  58 #include "archive_write_private.h"
  59
  60 static struct archive_vtable *archive_write_vtable(void);
  61
  62 static int      _archive_write_close(struct archive *);
  63 static int      _archive_write_finish(struct archive *);
  64 static int      _archive_write_header(struct archive *, struct archive_entry *);
  65 static int      _archive_write_finish_entry(struct archive *);
  66 static ssize_t  _archive_write_data(struct archive *, const void *, size_t);
  67
  68 static struct archive_vtable *
  69 archive_write_vtable(void)
  70 {
  71         static struct archive_vtable av;
  72         static int inited = 0;
  73
  74         if (!inited) {
  75                 av.archive_write_close = _archive_write_close;
  76                 av.archive_write_finish = _archive_write_finish;
  77                 av.archive_write_header = _archive_write_header;
  78                 av.archive_write_finish_entry = _archive_write_finish_entry;
  79                 av.archive_write_data = _archive_write_data;
  80         }
  81         return (&av);
  82 }
  83
  84 /*
  85  * Allocate, initialize and return an archive object.
  86  */
  87 struct archive *
  88 archive_write_new(void)
  89 {
  90         struct archive_write *a;
  91         unsigned char *nulls;
  92
  93         a = (struct archive_write *)malloc(sizeof(*a));
  94         if (a == NULL)
  95                 return (NULL);
  96         memset(a, 0, sizeof(*a));
  97         a->archive.magic = ARCHIVE_WRITE_MAGIC;
  98         a->archive.state = ARCHIVE_STATE_NEW;
  99         a->archive.vtable = archive_write_vtable();
 100         a->bytes_per_block = ARCHIVE_DEFAULT_BYTES_PER_BLOCK;
 101         a->bytes_in_last_block = -1;    /* Default */
 102         a->pformat_data = &(a->format_data);
 103
 104         /* Initialize a block of nulls for padding purposes. */
 105         a->null_length = 1024;
 106         nulls = (unsigned char *)malloc(a->null_length);
 107         if (nulls == NULL) {
 108                 free(a);
 109                 return (NULL);
 110         }
 111         memset(nulls, 0, a->null_length);
 112         a->nulls = nulls;
 113         /*
 114          * Set default compression, but don't set a default format.
 115          * Were we to set a default format here, we would force every
 116          * client to link in support for that format, even if they didn't
 117          * ever use it.
 118          */
 119         archive_write_set_compression_none(&a->archive);
 120         return (&a->archive);
 121 }
 122
 123 /*
 124  * Set the block size.  Returns 0 if successful.
 125  */
 126 int
 127 archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
 128 {
 129         struct archive_write *a = (struct archive_write *)_a;
 130         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 131             ARCHIVE_STATE_NEW, "archive_write_set_bytes_per_block");
 132         a->bytes_per_block = bytes_per_block;
 133         return (ARCHIVE_OK);
 134 }
 135
 136 /*
 137  * Get the current block size.  -1 if it has never been set.
 138  */
 139 int
 140 archive_write_get_bytes_per_block(struct archive *_a)
 141 {
 142         struct archive_write *a = (struct archive_write *)_a;
 143         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 144             ARCHIVE_STATE_ANY, "archive_write_get_bytes_per_block");
 145         return (a->bytes_per_block);
 146 }
 147
 148 /*
 149  * Set the size for the last block.
 150  * Returns 0 if successful.
 151  */
 152 int
 153 archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
 154 {
 155         struct archive_write *a = (struct archive_write *)_a;
 156         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 157             ARCHIVE_STATE_ANY, "archive_write_set_bytes_in_last_block");
 158         a->bytes_in_last_block = bytes;
 159         return (ARCHIVE_OK);
 160 }
 161
 162 /*
 163  * Return the value set above.  -1 indicates it has not been set.
 164  */
 165 int
 166 archive_write_get_bytes_in_last_block(struct archive *_a)
 167 {
 168         struct archive_write *a = (struct archive_write *)_a;
 169         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 170             ARCHIVE_STATE_ANY, "archive_write_get_bytes_in_last_block");
 171         return (a->bytes_in_last_block);
 172 }
 173
 174
 175 /*
 176  * dev/ino of a file to be rejected.  Used to prevent adding
 177  * an archive to itself recursively.
 178  */
 179 int
 180 archive_write_set_skip_file(struct archive *_a, dev_t d, ino_t i)
 181 {
 182         struct archive_write *a = (struct archive_write *)_a;
 183         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 184             ARCHIVE_STATE_ANY, "archive_write_set_skip_file");
 185         a->skip_file_dev = d;
 186         a->skip_file_ino = i;
 187         return (ARCHIVE_OK);
 188 }
 189
 190
 191 /*
 192  * Open the archive using the current settings.
 193  */
 194 int
 195 archive_write_open(struct archive *_a, void *client_data,
 196     archive_open_callback *opener, archive_write_callback *writer,
 197     archive_close_callback *closer)
 198 {
 199         struct archive_write *a = (struct archive_write *)_a;
 200         int ret;
 201
 202         ret = ARCHIVE_OK;
 203         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 204             ARCHIVE_STATE_NEW, "archive_write_open");
 205         archive_clear_error(&a->archive);
 206         a->archive.state = ARCHIVE_STATE_HEADER;
 207         a->client_data = client_data;
 208         a->client_writer = writer;
 209         a->client_opener = opener;
 210         a->client_closer = closer;
 211         ret = (a->compression_init)(a);
 212         if (a->format_init && ret == ARCHIVE_OK)
 213                 ret = (a->format_init)(a);
 214         return (ret);
 215 }
 216
 217
 218 /*
 219  * Close out the archive.
 220  *
 221  * Be careful: user might just call write_new and then write_finish.
 222  * Don't assume we actually wrote anything or performed any non-trivial
 223  * initialization.
 224  */
 225 static int
 226 _archive_write_close(struct archive *_a)
 227 {
 228         struct archive_write *a = (struct archive_write *)_a;
 229         int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
 230
 231         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 232             ARCHIVE_STATE_ANY, "archive_write_close");
 233
 234         /* Finish the last entry. */
 235         if (a->archive.state & ARCHIVE_STATE_DATA)
 236                 r = ((a->format_finish_entry)(a));
 237
 238         /* Finish off the archive. */
 239         if (a->format_finish != NULL) {
 240                 r1 = (a->format_finish)(a);
 241                 if (r1 < r)
 242                         r = r1;
 243         }
 244
 245         /* Release resources. */
 246         if (a->format_destroy != NULL) {
 247                 r1 = (a->format_destroy)(a);
 248                 if (r1 < r)
 249                         r = r1;
 250         }
 251
 252         /* Finish the compression and close the stream. */
 253         if (a->compression_finish != NULL) {
 254                 r1 = (a->compression_finish)(a);
 255                 if (r1 < r)
 256                         r = r1;
 257         }
 258
 259         a->archive.state = ARCHIVE_STATE_CLOSED;
 260         return (r);
 261 }
 262
 263 /*
 264  * Destroy the archive structure.
 265  */
 266 static int
 267 _archive_write_finish(struct archive *_a)
 268 {
 269         struct archive_write *a = (struct archive_write *)_a;
 270         int r = ARCHIVE_OK;
 271
 272         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 273             ARCHIVE_STATE_ANY, "archive_write_finish");
 274         if (a->archive.state != ARCHIVE_STATE_CLOSED)
 275                 r = archive_write_close(&a->archive);
 276
 277         /* Release various dynamic buffers. */
 278         free((void *)(uintptr_t)(const void *)a->nulls);
 279         archive_string_free(&a->archive.error_string);
 280         a->archive.magic = 0;
 281         free(a);
 282         return (r);
 283 }
 284
 285 /*
 286  * Write the appropriate header.
 287  */
 288 static int
 289 _archive_write_header(struct archive *_a, struct archive_entry *entry)
 290 {
 291         struct archive_write *a = (struct archive_write *)_a;
 292         int ret, r2;
 293
 294         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 295             ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
 296         archive_clear_error(&a->archive);
 297
 298         /* In particular, "retry" and "fatal" get returned immediately. */
 299         ret = archive_write_finish_entry(&a->archive);
 300         if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
 301                 return (ret);
 302
 303         if (a->skip_file_dev != 0 &&
 304             archive_entry_dev(entry) == a->skip_file_dev &&
 305             a->skip_file_ino != 0 &&
 306             archive_entry_ino(entry) == a->skip_file_ino) {
 307                 archive_set_error(&a->archive, 0,
 308                     "Can't add archive to itself");
 309                 return (ARCHIVE_FAILED);
 310         }
 311
 312         /* Format and write header. */
 313         r2 = ((a->format_write_header)(a, entry));
 314         if (r2 < ret)
 315                 ret = r2;
 316
 317         a->archive.state = ARCHIVE_STATE_DATA;
 318         return (ret);
 319 }
 320
 321 static int
 322 _archive_write_finish_entry(struct archive *_a)
 323 {
 324         struct archive_write *a = (struct archive_write *)_a;
 325         int ret = ARCHIVE_OK;
 326
 327         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 328             ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
 329             "archive_write_finish_entry");
 330         if (a->archive.state & ARCHIVE_STATE_DATA)
 331                 ret = (a->format_finish_entry)(a);
 332         a->archive.state = ARCHIVE_STATE_HEADER;
 333         return (ret);
 334 }
 335
 336 /*
 337  * Note that the compressor is responsible for blocking.
 338  */
 339 static ssize_t
 340 _archive_write_data(struct archive *_a, const void *buff, size_t s)
 341 {
 342         struct archive_write *a = (struct archive_write *)_a;
 343         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 344             ARCHIVE_STATE_DATA, "archive_write_data");
 345         archive_clear_error(&a->archive);
 346         return ((a->format_write_data)(a, buff, s));
 347 }