contrib/libarchive-2.1/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
 103         /* Initialize a block of nulls for padding purposes. */
 104         a->null_length = 1024;
 105         nulls = (unsigned char *)malloc(a->null_length);
 106         if (nulls == NULL) {
 107                 free(a);
 108                 return (NULL);
 109         }
 110         memset(nulls, 0, a->null_length);
 111         a->nulls = nulls;
 112         /*
 113          * Set default compression, but don't set a default format.
 114          * Were we to set a default format here, we would force every
 115          * client to link in support for that format, even if they didn't
 116          * ever use it.
 117          */
 118         archive_write_set_compression_none(&a->archive);
 119         return (&a->archive);
 120 }
 121
 122 /*
 123  * Set the block size.  Returns 0 if successful.
 124  */
 125 int
 126 archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
 127 {
 128         struct archive_write *a = (struct archive_write *)_a;
 129         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 130             ARCHIVE_STATE_NEW, "archive_write_set_bytes_per_block");
 131         a->bytes_per_block = bytes_per_block;
 132         return (ARCHIVE_OK);
 133 }
 134
 135 /*
 136  * Get the current block size.  -1 if it has never been set.
 137  */
 138 int
 139 archive_write_get_bytes_per_block(struct archive *_a)
 140 {
 141         struct archive_write *a = (struct archive_write *)_a;
 142         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 143             ARCHIVE_STATE_ANY, "archive_write_get_bytes_per_block");
 144         return (a->bytes_per_block);
 145 }
 146
 147 /*
 148  * Set the size for the last block.
 149  * Returns 0 if successful.
 150  */
 151 int
 152 archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
 153 {
 154         struct archive_write *a = (struct archive_write *)_a;
 155         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 156             ARCHIVE_STATE_ANY, "archive_write_set_bytes_in_last_block");
 157         a->bytes_in_last_block = bytes;
 158         return (ARCHIVE_OK);
 159 }
 160
 161 /*
 162  * Return the value set above.  -1 indicates it has not been set.
 163  */
 164 int
 165 archive_write_get_bytes_in_last_block(struct archive *_a)
 166 {
 167         struct archive_write *a = (struct archive_write *)_a;
 168         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 169             ARCHIVE_STATE_ANY, "archive_write_get_bytes_in_last_block");
 170         return (a->bytes_in_last_block);
 171 }
 172
 173
 174 /*
 175  * dev/ino of a file to be rejected.  Used to prevent adding
 176  * an archive to itself recursively.
 177  */
 178 int
 179 archive_write_set_skip_file(struct archive *_a, dev_t d, ino_t i)
 180 {
 181         struct archive_write *a = (struct archive_write *)_a;
 182         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 183             ARCHIVE_STATE_ANY, "archive_write_set_skip_file");
 184         a->skip_file_dev = d;
 185         a->skip_file_ino = i;
 186         return (ARCHIVE_OK);
 187 }
 188
 189
 190 /*
 191  * Open the archive using the current settings.
 192  */
 193 int
 194 archive_write_open(struct archive *_a, void *client_data,
 195     archive_open_callback *opener, archive_write_callback *writer,
 196     archive_close_callback *closer)
 197 {
 198         struct archive_write *a = (struct archive_write *)_a;
 199         int ret;
 200
 201         ret = ARCHIVE_OK;
 202         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 203             ARCHIVE_STATE_NEW, "archive_write_open");
 204         archive_clear_error(&a->archive);
 205         a->archive.state = ARCHIVE_STATE_HEADER;
 206         a->client_data = client_data;
 207         a->client_writer = writer;
 208         a->client_opener = opener;
 209         a->client_closer = closer;
 210         ret = (a->compressor.init)(a);
 211         if (a->format_init && ret == ARCHIVE_OK)
 212                 ret = (a->format_init)(a);
 213         return (ret);
 214 }
 215
 216
 217 /*
 218  * Close out the archive.
 219  *
 220  * Be careful: user might just call write_new and then write_finish.
 221  * Don't assume we actually wrote anything or performed any non-trivial
 222  * initialization.
 223  */
 224 static int
 225 _archive_write_close(struct archive *_a)
 226 {
 227         struct archive_write *a = (struct archive_write *)_a;
 228         int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
 229
 230         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 231             ARCHIVE_STATE_ANY, "archive_write_close");
 232
 233         /* Finish the last entry. */
 234         if (a->archive.state & ARCHIVE_STATE_DATA)
 235                 r = ((a->format_finish_entry)(a));
 236
 237         /* Finish off the archive. */
 238         if (a->format_finish != NULL) {
 239                 r1 = (a->format_finish)(a);
 240                 if (r1 < r)
 241                         r = r1;
 242         }
 243
 244         /* Release format resources. */
 245         if (a->format_destroy != NULL) {
 246                 r1 = (a->format_destroy)(a);
 247                 if (r1 < r)
 248                         r = r1;
 249         }
 250
 251         /* Finish the compression and close the stream. */
 252         if (a->compressor.finish != NULL) {
 253                 r1 = (a->compressor.finish)(a);
 254                 if (r1 < r)
 255                         r = r1;
 256         }
 257
 258         /* Close out the client stream. */
 259         if (a->client_closer != NULL) {
 260                 r1 = (a->client_closer)(&a->archive, a->client_data);
 261                 if (r1 < r)
 262                         r = r1;
 263         }
 264
 265         a->archive.state = ARCHIVE_STATE_CLOSED;
 266         return (r);
 267 }
 268
 269 /*
 270  * Destroy the archive structure.
 271  */
 272 static int
 273 _archive_write_finish(struct archive *_a)
 274 {
 275         struct archive_write *a = (struct archive_write *)_a;
 276         int r = ARCHIVE_OK;
 277
 278         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 279             ARCHIVE_STATE_ANY, "archive_write_finish");
 280         if (a->archive.state != ARCHIVE_STATE_CLOSED)
 281                 r = archive_write_close(&a->archive);
 282
 283         /* Release various dynamic buffers. */
 284         free((void *)(uintptr_t)(const void *)a->nulls);
 285         archive_string_free(&a->archive.error_string);
 286         a->archive.magic = 0;
 287         free(a);
 288         return (r);
 289 }
 290
 291 /*
 292  * Write the appropriate header.
 293  */
 294 static int
 295 _archive_write_header(struct archive *_a, struct archive_entry *entry)
 296 {
 297         struct archive_write *a = (struct archive_write *)_a;
 298         int ret, r2;
 299
 300         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 301             ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
 302         archive_clear_error(&a->archive);
 303
 304         /* In particular, "retry" and "fatal" get returned immediately. */
 305         ret = archive_write_finish_entry(&a->archive);
 306         if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
 307                 return (ret);
 308
 309         if (a->skip_file_dev != 0 &&
 310             archive_entry_dev(entry) == a->skip_file_dev &&
 311             a->skip_file_ino != 0 &&
 312             archive_entry_ino(entry) == a->skip_file_ino) {
 313                 archive_set_error(&a->archive, 0,
 314                     "Can't add archive to itself");
 315                 return (ARCHIVE_FAILED);
 316         }
 317
 318         /* Format and write header. */
 319         r2 = ((a->format_write_header)(a, entry));
 320         if (r2 < ret)
 321                 ret = r2;
 322
 323         a->archive.state = ARCHIVE_STATE_DATA;
 324         return (ret);
 325 }
 326
 327 static int
 328 _archive_write_finish_entry(struct archive *_a)
 329 {
 330         struct archive_write *a = (struct archive_write *)_a;
 331         int ret = ARCHIVE_OK;
 332
 333         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 334             ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
 335             "archive_write_finish_entry");
 336         if (a->archive.state & ARCHIVE_STATE_DATA)
 337                 ret = (a->format_finish_entry)(a);
 338         a->archive.state = ARCHIVE_STATE_HEADER;
 339         return (ret);
 340 }
 341
 342 /*
 343  * Note that the compressor is responsible for blocking.
 344  */
 345 static ssize_t
 346 _archive_write_data(struct archive *_a, const void *buff, size_t s)
 347 {
 348         struct archive_write *a = (struct archive_write *)_a;
 349         __archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
 350             ARCHIVE_STATE_DATA, "archive_write_data");
 351         archive_clear_error(&a->archive);
 352         return ((a->format_write_data)(a, buff, s));
 353 }