2 * Copyright (c) 2003-2010 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD$");
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 an archive. Optional pieces have been, as
33 * far as possible, separated out into separate files to reduce
34 * needlessly bloating statically-linked clients.
37 #ifdef HAVE_SYS_WAIT_H
59 #include "archive_entry.h"
60 #include "archive_private.h"
61 #include "archive_write_private.h"
63 static struct archive_vtable *archive_write_vtable(void);
65 static int _archive_filter_code(struct archive *, int);
66 static const char *_archive_filter_name(struct archive *, int);
67 static int64_t _archive_filter_bytes(struct archive *, int);
68 static int _archive_write_filter_count(struct archive *);
69 static int _archive_write_close(struct archive *);
70 static int _archive_write_free(struct archive *);
71 static int _archive_write_header(struct archive *, struct archive_entry *);
72 static int _archive_write_finish_entry(struct archive *);
73 static ssize_t _archive_write_data(struct archive *, const void *, size_t);
82 static struct archive_vtable *
83 archive_write_vtable(void)
85 static struct archive_vtable av;
86 static int inited = 0;
89 av.archive_close = _archive_write_close;
90 av.archive_filter_bytes = _archive_filter_bytes;
91 av.archive_filter_code = _archive_filter_code;
92 av.archive_filter_name = _archive_filter_name;
93 av.archive_filter_count = _archive_write_filter_count;
94 av.archive_free = _archive_write_free;
95 av.archive_write_header = _archive_write_header;
96 av.archive_write_finish_entry = _archive_write_finish_entry;
97 av.archive_write_data = _archive_write_data;
104 * Allocate, initialize and return an archive object.
107 archive_write_new(void)
109 struct archive_write *a;
110 unsigned char *nulls;
112 a = (struct archive_write *)calloc(1, sizeof(*a));
115 a->archive.magic = ARCHIVE_WRITE_MAGIC;
116 a->archive.state = ARCHIVE_STATE_NEW;
117 a->archive.vtable = archive_write_vtable();
119 * The value 10240 here matches the traditional tar default,
120 * but is otherwise arbitrary.
121 * TODO: Set the default block size from the format selected.
123 a->bytes_per_block = 10240;
124 a->bytes_in_last_block = -1; /* Default */
126 /* Initialize a block of nulls for padding purposes. */
127 a->null_length = 1024;
128 nulls = (unsigned char *)calloc(1, a->null_length);
134 return (&a->archive);
138 * Set the block size. Returns 0 if successful.
141 archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
143 struct archive_write *a = (struct archive_write *)_a;
144 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
145 ARCHIVE_STATE_NEW, "archive_write_set_bytes_per_block");
146 a->bytes_per_block = bytes_per_block;
151 * Get the current block size. -1 if it has never been set.
154 archive_write_get_bytes_per_block(struct archive *_a)
156 struct archive_write *a = (struct archive_write *)_a;
157 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
158 ARCHIVE_STATE_ANY, "archive_write_get_bytes_per_block");
159 return (a->bytes_per_block);
163 * Set the size for the last block.
164 * Returns 0 if successful.
167 archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
169 struct archive_write *a = (struct archive_write *)_a;
170 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
171 ARCHIVE_STATE_ANY, "archive_write_set_bytes_in_last_block");
172 a->bytes_in_last_block = bytes;
177 * Return the value set above. -1 indicates it has not been set.
180 archive_write_get_bytes_in_last_block(struct archive *_a)
182 struct archive_write *a = (struct archive_write *)_a;
183 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
184 ARCHIVE_STATE_ANY, "archive_write_get_bytes_in_last_block");
185 return (a->bytes_in_last_block);
189 * dev/ino of a file to be rejected. Used to prevent adding
190 * an archive to itself recursively.
193 archive_write_set_skip_file(struct archive *_a, la_int64_t d, la_int64_t i)
195 struct archive_write *a = (struct archive_write *)_a;
196 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
197 ARCHIVE_STATE_ANY, "archive_write_set_skip_file");
198 a->skip_file_set = 1;
199 a->skip_file_dev = d;
200 a->skip_file_ino = i;
205 * Allocate and return the next filter structure.
207 struct archive_write_filter *
208 __archive_write_allocate_filter(struct archive *_a)
210 struct archive_write *a = (struct archive_write *)_a;
211 struct archive_write_filter *f;
213 f = calloc(1, sizeof(*f));
215 f->state = ARCHIVE_WRITE_FILTER_STATE_NEW;
216 if (a->filter_first == NULL)
219 a->filter_last->next_filter = f;
225 * Write data to a particular filter.
228 __archive_write_filter(struct archive_write_filter *f,
229 const void *buff, size_t length)
232 /* Never write to non-open filters */
233 if (f->state != ARCHIVE_WRITE_FILTER_STATE_OPEN)
234 return(ARCHIVE_FATAL);
237 if (f->write == NULL)
238 /* If unset, a fatal error has already occurred, so this filter
239 * didn't open. We cannot write anything. */
240 return(ARCHIVE_FATAL);
241 r = (f->write)(f, buff, length);
242 f->bytes_written += length;
247 * Recursive function for opening the filter chain
248 * Last filter is opened first
251 __archive_write_open_filter(struct archive_write_filter *f)
256 if (f->next_filter != NULL)
257 ret = __archive_write_open_filter(f->next_filter);
258 if (ret != ARCHIVE_OK)
260 if (f->state != ARCHIVE_WRITE_FILTER_STATE_NEW)
261 return (ARCHIVE_FATAL);
262 if (f->open == NULL) {
263 f->state = ARCHIVE_WRITE_FILTER_STATE_OPEN;
267 if (ret == ARCHIVE_OK)
268 f->state = ARCHIVE_WRITE_FILTER_STATE_OPEN;
270 f->state = ARCHIVE_WRITE_FILTER_STATE_FATAL;
278 __archive_write_filters_open(struct archive_write *a)
280 return (__archive_write_open_filter(a->filter_first));
287 __archive_write_filters_close(struct archive_write *a)
289 struct archive_write_filter *f;
292 for (f = a->filter_first; f != NULL; f = f->next_filter) {
293 /* Do not close filters that are not open */
294 if (f->state == ARCHIVE_WRITE_FILTER_STATE_OPEN) {
295 if (f->close != NULL) {
296 ret1 = (f->close)(f);
299 if (ret1 == ARCHIVE_OK) {
301 ARCHIVE_WRITE_FILTER_STATE_CLOSED;
304 ARCHIVE_WRITE_FILTER_STATE_FATAL;
307 f->state = ARCHIVE_WRITE_FILTER_STATE_CLOSED;
314 __archive_write_output(struct archive_write *a, const void *buff, size_t length)
316 return (__archive_write_filter(a->filter_first, buff, length));
320 __archive_write_nulls(struct archive_write *a, size_t length)
326 size_t to_write = length < a->null_length ? length : a->null_length;
327 int r = __archive_write_output(a, a->nulls, to_write);
336 archive_write_client_open(struct archive_write_filter *f)
338 struct archive_write *a = (struct archive_write *)f->archive;
339 struct archive_none *state;
343 f->bytes_per_block = archive_write_get_bytes_per_block(f->archive);
344 f->bytes_in_last_block =
345 archive_write_get_bytes_in_last_block(f->archive);
346 buffer_size = f->bytes_per_block;
348 state = (struct archive_none *)calloc(1, sizeof(*state));
349 buffer = (char *)malloc(buffer_size);
350 if (state == NULL || buffer == NULL) {
353 archive_set_error(f->archive, ENOMEM,
354 "Can't allocate data for output buffering");
355 return (ARCHIVE_FATAL);
358 state->buffer_size = buffer_size;
359 state->buffer = buffer;
360 state->next = state->buffer;
361 state->avail = state->buffer_size;
364 if (a->client_opener == NULL)
366 return (a->client_opener(f->archive, a->client_data));
370 archive_write_client_write(struct archive_write_filter *f,
371 const void *_buff, size_t length)
373 struct archive_write *a = (struct archive_write *)f->archive;
374 struct archive_none *state = (struct archive_none *)f->data;
375 const char *buff = (const char *)_buff;
376 ssize_t remaining, to_copy;
377 ssize_t bytes_written;
382 * If there is no buffer for blocking, just pass the data
383 * straight through to the client write callback. In
384 * particular, this supports "no write delay" operation for
385 * special applications. Just set the block size to zero.
387 if (state->buffer_size == 0) {
388 while (remaining > 0) {
389 bytes_written = (a->client_writer)(&a->archive,
390 a->client_data, buff, remaining);
391 if (bytes_written <= 0)
392 return (ARCHIVE_FATAL);
393 remaining -= bytes_written;
394 buff += bytes_written;
399 /* If the copy buffer isn't empty, try to fill it. */
400 if (state->avail < state->buffer_size) {
401 /* If buffer is not empty... */
402 /* ... copy data into buffer ... */
403 to_copy = ((size_t)remaining > state->avail) ?
404 state->avail : (size_t)remaining;
405 memcpy(state->next, buff, to_copy);
406 state->next += to_copy;
407 state->avail -= to_copy;
409 remaining -= to_copy;
410 /* ... if it's full, write it out. */
411 if (state->avail == 0) {
412 char *p = state->buffer;
413 size_t to_write = state->buffer_size;
414 while (to_write > 0) {
415 bytes_written = (a->client_writer)(&a->archive,
416 a->client_data, p, to_write);
417 if (bytes_written <= 0)
418 return (ARCHIVE_FATAL);
419 if ((size_t)bytes_written > to_write) {
420 archive_set_error(&(a->archive),
421 -1, "write overrun");
422 return (ARCHIVE_FATAL);
425 to_write -= bytes_written;
427 state->next = state->buffer;
428 state->avail = state->buffer_size;
432 while ((size_t)remaining >= state->buffer_size) {
433 /* Write out full blocks directly to client. */
434 bytes_written = (a->client_writer)(&a->archive,
435 a->client_data, buff, state->buffer_size);
436 if (bytes_written <= 0)
437 return (ARCHIVE_FATAL);
438 buff += bytes_written;
439 remaining -= bytes_written;
443 /* Copy last bit into copy buffer. */
444 memcpy(state->next, buff, remaining);
445 state->next += remaining;
446 state->avail -= remaining;
452 archive_write_client_close(struct archive_write_filter *f)
454 struct archive_write *a = (struct archive_write *)f->archive;
455 struct archive_none *state = (struct archive_none *)f->data;
456 ssize_t block_length;
457 ssize_t target_block_length;
458 ssize_t bytes_written;
459 int ret = ARCHIVE_OK;
461 /* If there's pending data, pad and write the last block */
462 if (state->next != state->buffer) {
463 block_length = state->buffer_size - state->avail;
465 /* Tricky calculation to determine size of last block */
466 if (a->bytes_in_last_block <= 0)
467 /* Default or Zero: pad to full block */
468 target_block_length = a->bytes_per_block;
470 /* Round to next multiple of bytes_in_last_block. */
471 target_block_length = a->bytes_in_last_block *
472 ( (block_length + a->bytes_in_last_block - 1) /
473 a->bytes_in_last_block);
474 if (target_block_length > a->bytes_per_block)
475 target_block_length = a->bytes_per_block;
476 if (block_length < target_block_length) {
477 memset(state->next, 0,
478 target_block_length - block_length);
479 block_length = target_block_length;
481 bytes_written = (a->client_writer)(&a->archive,
482 a->client_data, state->buffer, block_length);
483 ret = bytes_written <= 0 ? ARCHIVE_FATAL : ARCHIVE_OK;
485 if (a->client_closer)
486 (*a->client_closer)(&a->archive, a->client_data);
489 /* Clear the close handler myself not to be called again. */
490 f->state = ARCHIVE_WRITE_FILTER_STATE_CLOSED;
491 a->client_data = NULL;
492 /* Clear passphrase. */
493 if (a->passphrase != NULL) {
494 memset(a->passphrase, 0, strlen(a->passphrase));
496 a->passphrase = NULL;
502 * Open the archive using the current settings.
505 archive_write_open(struct archive *_a, void *client_data,
506 archive_open_callback *opener, archive_write_callback *writer,
507 archive_close_callback *closer)
509 struct archive_write *a = (struct archive_write *)_a;
510 struct archive_write_filter *client_filter;
513 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
514 ARCHIVE_STATE_NEW, "archive_write_open");
515 archive_clear_error(&a->archive);
517 a->client_writer = writer;
518 a->client_opener = opener;
519 a->client_closer = closer;
520 a->client_data = client_data;
522 client_filter = __archive_write_allocate_filter(_a);
523 client_filter->open = archive_write_client_open;
524 client_filter->write = archive_write_client_write;
525 client_filter->close = archive_write_client_close;
527 ret = __archive_write_filters_open(a);
528 if (ret < ARCHIVE_WARN) {
529 r1 = __archive_write_filters_close(a);
530 __archive_write_filters_free(_a);
531 return (r1 < ret ? r1 : ret);
534 a->archive.state = ARCHIVE_STATE_HEADER;
536 ret = (a->format_init)(a);
541 * Close out the archive.
544 _archive_write_close(struct archive *_a)
546 struct archive_write *a = (struct archive_write *)_a;
547 int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
549 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
550 ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL,
551 "archive_write_close");
552 if (a->archive.state == ARCHIVE_STATE_NEW
553 || a->archive.state == ARCHIVE_STATE_CLOSED)
554 return (ARCHIVE_OK); /* Okay to close() when not open. */
556 archive_clear_error(&a->archive);
558 /* Finish the last entry if a finish callback is specified */
559 if (a->archive.state == ARCHIVE_STATE_DATA
560 && a->format_finish_entry != NULL)
561 r = ((a->format_finish_entry)(a));
563 /* Finish off the archive. */
564 /* TODO: have format closers invoke compression close. */
565 if (a->format_close != NULL) {
566 r1 = (a->format_close)(a);
571 /* Finish the compression and close the stream. */
572 r1 = __archive_write_filters_close(a);
576 if (a->archive.state != ARCHIVE_STATE_FATAL)
577 a->archive.state = ARCHIVE_STATE_CLOSED;
582 _archive_write_filter_count(struct archive *_a)
584 struct archive_write *a = (struct archive_write *)_a;
585 struct archive_write_filter *p = a->filter_first;
595 __archive_write_filters_free(struct archive *_a)
597 struct archive_write *a = (struct archive_write *)_a;
598 int r = ARCHIVE_OK, r1;
600 while (a->filter_first != NULL) {
601 struct archive_write_filter *next
602 = a->filter_first->next_filter;
603 if (a->filter_first->free != NULL) {
604 r1 = (*a->filter_first->free)(a->filter_first);
608 free(a->filter_first);
609 a->filter_first = next;
611 a->filter_last = NULL;
615 * Destroy the archive structure.
617 * Be careful: user might just call write_new and then write_free.
618 * Don't assume we actually wrote anything or performed any non-trivial
622 _archive_write_free(struct archive *_a)
624 struct archive_write *a = (struct archive_write *)_a;
625 int r = ARCHIVE_OK, r1;
629 /* It is okay to call free() in state FATAL. */
630 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
631 ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL, "archive_write_free");
632 if (a->archive.state != ARCHIVE_STATE_FATAL)
633 r = archive_write_close(&a->archive);
635 /* Release format resources. */
636 if (a->format_free != NULL) {
637 r1 = (a->format_free)(a);
642 __archive_write_filters_free(_a);
644 /* Release various dynamic buffers. */
645 free((void *)(uintptr_t)(const void *)a->nulls);
646 archive_string_free(&a->archive.error_string);
647 if (a->passphrase != NULL) {
648 /* A passphrase should be cleaned. */
649 memset(a->passphrase, 0, strlen(a->passphrase));
652 a->archive.magic = 0;
653 __archive_clean(&a->archive);
659 * Write the appropriate header.
662 _archive_write_header(struct archive *_a, struct archive_entry *entry)
664 struct archive_write *a = (struct archive_write *)_a;
667 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
668 ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
669 archive_clear_error(&a->archive);
671 if (a->format_write_header == NULL) {
672 archive_set_error(&(a->archive), -1,
673 "Format must be set before you can write to an archive.");
674 a->archive.state = ARCHIVE_STATE_FATAL;
675 return (ARCHIVE_FATAL);
678 /* In particular, "retry" and "fatal" get returned immediately. */
679 ret = archive_write_finish_entry(&a->archive);
680 if (ret == ARCHIVE_FATAL) {
681 a->archive.state = ARCHIVE_STATE_FATAL;
682 return (ARCHIVE_FATAL);
684 if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
687 if (a->skip_file_set &&
688 archive_entry_dev_is_set(entry) &&
689 archive_entry_ino_is_set(entry) &&
690 archive_entry_dev(entry) == (dev_t)a->skip_file_dev &&
691 archive_entry_ino64(entry) == a->skip_file_ino) {
692 archive_set_error(&a->archive, 0,
693 "Can't add archive to itself");
694 return (ARCHIVE_FAILED);
697 /* Format and write header. */
698 r2 = ((a->format_write_header)(a, entry));
699 if (r2 == ARCHIVE_FAILED) {
700 return (ARCHIVE_FAILED);
702 if (r2 == ARCHIVE_FATAL) {
703 a->archive.state = ARCHIVE_STATE_FATAL;
704 return (ARCHIVE_FATAL);
709 a->archive.state = ARCHIVE_STATE_DATA;
714 _archive_write_finish_entry(struct archive *_a)
716 struct archive_write *a = (struct archive_write *)_a;
717 int ret = ARCHIVE_OK;
719 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
720 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
721 "archive_write_finish_entry");
722 if (a->archive.state & ARCHIVE_STATE_DATA
723 && a->format_finish_entry != NULL)
724 ret = (a->format_finish_entry)(a);
725 a->archive.state = ARCHIVE_STATE_HEADER;
730 * Note that the compressor is responsible for blocking.
733 _archive_write_data(struct archive *_a, const void *buff, size_t s)
735 struct archive_write *a = (struct archive_write *)_a;
736 const size_t max_write = INT_MAX;
738 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
739 ARCHIVE_STATE_DATA, "archive_write_data");
740 /* In particular, this catches attempts to pass negative values. */
743 archive_clear_error(&a->archive);
744 return ((a->format_write_data)(a, buff, s));
747 static struct archive_write_filter *
748 filter_lookup(struct archive *_a, int n)
750 struct archive_write *a = (struct archive_write *)_a;
751 struct archive_write_filter *f = a->filter_first;
753 return a->filter_last;
756 while (n > 0 && f != NULL) {
764 _archive_filter_code(struct archive *_a, int n)
766 struct archive_write_filter *f = filter_lookup(_a, n);
767 return f == NULL ? -1 : f->code;
771 _archive_filter_name(struct archive *_a, int n)
773 struct archive_write_filter *f = filter_lookup(_a, n);
774 return f != NULL ? f->name : NULL;
778 _archive_filter_bytes(struct archive *_a, int n)
780 struct archive_write_filter *f = filter_lookup(_a, n);
781 return f == NULL ? -1 : f->bytes_written;