2
* Copyright (c) 2003-2007 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: head/lib/libarchive/archive_write.c 201099 2009-12-28 03:03:00Z kientzle $");
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.
37
#ifdef HAVE_SYS_WAIT_H
56
#include "archive_entry.h"
57
#include "archive_private.h"
58
#include "archive_write_private.h"
60
static struct archive_vtable *archive_write_vtable(void);
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);
68
static struct archive_vtable *
69
archive_write_vtable(void)
71
static struct archive_vtable av;
72
static int inited = 0;
75
av.archive_close = _archive_write_close;
76
av.archive_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;
85
* Allocate, initialize and return an archive object.
88
archive_write_new(void)
90
struct archive_write *a;
93
a = (struct archive_write *)malloc(sizeof(*a));
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();
101
* The value 10240 here matches the traditional tar default,
102
* but is otherwise arbitrary.
103
* TODO: Set the default block size from the format selected.
105
a->bytes_per_block = 10240;
106
a->bytes_in_last_block = -1; /* Default */
108
/* Initialize a block of nulls for padding purposes. */
109
a->null_length = 1024;
110
nulls = (unsigned char *)malloc(a->null_length);
115
memset(nulls, 0, a->null_length);
118
* Set default compression, but don't set a default format.
119
* Were we to set a default format here, we would force every
120
* client to link in support for that format, even if they didn't
123
archive_write_set_compression_none(&a->archive);
124
return (&a->archive);
128
* Set write options for the format. Returns 0 if successful.
131
archive_write_set_format_options(struct archive *_a, const char *s)
133
struct archive_write *a = (struct archive_write *)_a;
134
char key[64], val[64];
135
int len, r, ret = ARCHIVE_OK;
137
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
138
ARCHIVE_STATE_NEW, "archive_write_set_format_options");
139
archive_clear_error(&a->archive);
141
if (s == NULL || *s == '\0')
143
if (a->format_options == NULL)
144
/* This format does not support option. */
147
while ((len = __archive_parse_options(s, a->format_name,
148
sizeof(key), key, sizeof(val), val)) > 0) {
150
r = a->format_options(a, key, NULL);
152
r = a->format_options(a, key, val);
153
if (r == ARCHIVE_FATAL)
155
if (r < ARCHIVE_OK) { /* This key was not handled. */
156
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
157
"Unsupported option ``%s''", key);
163
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
164
"Malformed options string.");
165
return (ARCHIVE_WARN);
171
* Set write options for the compressor. Returns 0 if successful.
174
archive_write_set_compressor_options(struct archive *_a, const char *s)
176
struct archive_write *a = (struct archive_write *)_a;
177
char key[64], val[64];
179
int ret = ARCHIVE_OK;
181
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
182
ARCHIVE_STATE_NEW, "archive_write_set_compressor_options");
183
archive_clear_error(&a->archive);
185
if (s == NULL || *s == '\0')
187
if (a->compressor.options == NULL) {
188
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
189
"Unsupported option ``%s''", s);
190
/* This compressor does not support option. */
191
return (ARCHIVE_WARN);
194
while ((len = __archive_parse_options(s, a->archive.compression_name,
195
sizeof(key), key, sizeof(val), val)) > 0) {
197
r = a->compressor.options(a, key, NULL);
199
r = a->compressor.options(a, key, val);
200
if (r == ARCHIVE_FATAL)
202
if (r < ARCHIVE_OK) {
203
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
204
"Unsupported option ``%s''", key);
210
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
211
"Illegal format options.");
212
return (ARCHIVE_WARN);
218
* Set write options for the format and the compressor. Returns 0 if successful.
221
archive_write_set_options(struct archive *_a, const char *s)
225
r1 = archive_write_set_format_options(_a, s);
226
if (r1 < ARCHIVE_WARN)
228
r2 = archive_write_set_compressor_options(_a, s);
229
if (r2 < ARCHIVE_WARN)
231
if (r1 == ARCHIVE_WARN && r2 == ARCHIVE_WARN)
232
return (ARCHIVE_WARN);
237
* Set the block size. Returns 0 if successful.
240
archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
242
struct archive_write *a = (struct archive_write *)_a;
243
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
244
ARCHIVE_STATE_NEW, "archive_write_set_bytes_per_block");
245
a->bytes_per_block = bytes_per_block;
250
* Get the current block size. -1 if it has never been set.
253
archive_write_get_bytes_per_block(struct archive *_a)
255
struct archive_write *a = (struct archive_write *)_a;
256
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
257
ARCHIVE_STATE_ANY, "archive_write_get_bytes_per_block");
258
return (a->bytes_per_block);
262
* Set the size for the last block.
263
* Returns 0 if successful.
266
archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
268
struct archive_write *a = (struct archive_write *)_a;
269
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
270
ARCHIVE_STATE_ANY, "archive_write_set_bytes_in_last_block");
271
a->bytes_in_last_block = bytes;
276
* Return the value set above. -1 indicates it has not been set.
279
archive_write_get_bytes_in_last_block(struct archive *_a)
281
struct archive_write *a = (struct archive_write *)_a;
282
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
283
ARCHIVE_STATE_ANY, "archive_write_get_bytes_in_last_block");
284
return (a->bytes_in_last_block);
289
* dev/ino of a file to be rejected. Used to prevent adding
290
* an archive to itself recursively.
293
archive_write_set_skip_file(struct archive *_a, dev_t d, ino_t i)
295
struct archive_write *a = (struct archive_write *)_a;
296
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
297
ARCHIVE_STATE_ANY, "archive_write_set_skip_file");
298
a->skip_file_dev = d;
299
a->skip_file_ino = i;
305
* Open the archive using the current settings.
308
archive_write_open(struct archive *_a, void *client_data,
309
archive_open_callback *opener, archive_write_callback *writer,
310
archive_close_callback *closer)
312
struct archive_write *a = (struct archive_write *)_a;
315
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
316
ARCHIVE_STATE_NEW, "archive_write_open");
317
archive_clear_error(&a->archive);
318
a->archive.state = ARCHIVE_STATE_HEADER;
319
a->client_data = client_data;
320
a->client_writer = writer;
321
a->client_opener = opener;
322
a->client_closer = closer;
323
ret = (a->compressor.init)(a);
324
if (a->format_init && ret == ARCHIVE_OK)
325
ret = (a->format_init)(a);
331
* Close out the archive.
333
* Be careful: user might just call write_new and then write_finish.
334
* Don't assume we actually wrote anything or performed any non-trivial
338
_archive_write_close(struct archive *_a)
340
struct archive_write *a = (struct archive_write *)_a;
341
int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
343
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
344
ARCHIVE_STATE_ANY, "archive_write_close");
346
/* Finish the last entry. */
347
if (a->archive.state & ARCHIVE_STATE_DATA)
348
r = ((a->format_finish_entry)(a));
350
/* Finish off the archive. */
351
if (a->format_finish != NULL) {
352
r1 = (a->format_finish)(a);
357
/* Release format resources. */
358
if (a->format_destroy != NULL) {
359
r1 = (a->format_destroy)(a);
364
/* Finish the compression and close the stream. */
365
if (a->compressor.finish != NULL) {
366
r1 = (a->compressor.finish)(a);
371
/* Close out the client stream. */
372
if (a->client_closer != NULL) {
373
r1 = (a->client_closer)(&a->archive, a->client_data);
378
a->archive.state = ARCHIVE_STATE_CLOSED;
383
* Destroy the archive structure.
386
_archive_write_finish(struct archive *_a)
388
struct archive_write *a = (struct archive_write *)_a;
391
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
392
ARCHIVE_STATE_ANY, "archive_write_finish");
393
if (a->archive.state != ARCHIVE_STATE_CLOSED)
394
r = archive_write_close(&a->archive);
396
/* Release various dynamic buffers. */
397
free((void *)(uintptr_t)(const void *)a->nulls);
398
archive_string_free(&a->archive.error_string);
399
a->archive.magic = 0;
405
* Write the appropriate header.
408
_archive_write_header(struct archive *_a, struct archive_entry *entry)
410
struct archive_write *a = (struct archive_write *)_a;
413
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
414
ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
415
archive_clear_error(&a->archive);
417
/* In particular, "retry" and "fatal" get returned immediately. */
418
ret = archive_write_finish_entry(&a->archive);
419
if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
422
if (a->skip_file_dev != 0 &&
423
archive_entry_dev(entry) == a->skip_file_dev &&
424
a->skip_file_ino != 0 &&
425
archive_entry_ino64(entry) == a->skip_file_ino) {
426
archive_set_error(&a->archive, 0,
427
"Can't add archive to itself");
428
return (ARCHIVE_FAILED);
431
/* Format and write header. */
432
r2 = ((a->format_write_header)(a, entry));
436
a->archive.state = ARCHIVE_STATE_DATA;
441
_archive_write_finish_entry(struct archive *_a)
443
struct archive_write *a = (struct archive_write *)_a;
444
int ret = ARCHIVE_OK;
446
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
447
ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
448
"archive_write_finish_entry");
449
if (a->archive.state & ARCHIVE_STATE_DATA)
450
ret = (a->format_finish_entry)(a);
451
a->archive.state = ARCHIVE_STATE_HEADER;
456
* Note that the compressor is responsible for blocking.
459
_archive_write_data(struct archive *_a, const void *buff, size_t s)
461
struct archive_write *a = (struct archive_write *)_a;
462
__archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
463
ARCHIVE_STATE_DATA, "archive_write_data");
464
archive_clear_error(&a->archive);
465
return ((a->format_write_data)(a, buff, s));