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"
28 __FBSDID("$FreeBSD$");
48 #include "archive_private.h"
49 #include "archive_read_private.h"
51 #if defined(HAVE_BZLIB_H) && defined(BZ_CONFIG_ERROR)
55 size_t out_block_size;
56 char valid; /* True = decompressor is initialized */
57 char eof; /* True = found end of compressed data. */
61 static ssize_t bzip2_filter_read(struct archive_read_filter *, const void **);
62 static int bzip2_filter_close(struct archive_read_filter *);
66 * Note that we can detect bzip2 archives even if we can't decompress
67 * them. (In fact, we like detecting them because we can give better
68 * error messages.) So the bid framework here gets compiled even
69 * if bzlib is unavailable.
71 static int bzip2_reader_bid(struct archive_read_filter_bidder *, struct archive_read_filter *);
72 static int bzip2_reader_init(struct archive_read_filter *);
73 static int bzip2_reader_free(struct archive_read_filter_bidder *);
75 #if ARCHIVE_VERSION_NUMBER < 4000000
76 /* Deprecated; remove in libarchive 4.0 */
78 archive_read_support_compression_bzip2(struct archive *a)
80 return archive_read_support_filter_bzip2(a);
85 archive_read_support_filter_bzip2(struct archive *_a)
87 struct archive_read *a = (struct archive_read *)_a;
88 struct archive_read_filter_bidder *reader;
90 archive_check_magic(_a, ARCHIVE_READ_MAGIC,
91 ARCHIVE_STATE_NEW, "archive_read_support_filter_bzip2");
93 if (__archive_read_get_bidder(a, &reader) != ARCHIVE_OK)
94 return (ARCHIVE_FATAL);
97 reader->name = "bzip2";
98 reader->bid = bzip2_reader_bid;
99 reader->init = bzip2_reader_init;
100 reader->options = NULL;
101 reader->free = bzip2_reader_free;
102 #if defined(HAVE_BZLIB_H) && defined(BZ_CONFIG_ERROR)
105 archive_set_error(_a, ARCHIVE_ERRNO_MISC,
106 "Using external bzip2 program");
107 return (ARCHIVE_WARN);
112 bzip2_reader_free(struct archive_read_filter_bidder *self){
113 (void)self; /* UNUSED */
118 * Test whether we can handle this data.
120 * This logic returns zero if any part of the signature fails. It
121 * also tries to Do The Right Thing if a very short buffer prevents us
122 * from verifying as much as we would like.
125 bzip2_reader_bid(struct archive_read_filter_bidder *self, struct archive_read_filter *filter)
127 const unsigned char *buffer;
131 (void)self; /* UNUSED */
133 /* Minimal bzip2 archive is 14 bytes. */
134 buffer = __archive_read_filter_ahead(filter, 14, &avail);
138 /* First three bytes must be "BZh" */
140 if (memcmp(buffer, "BZh", 3) != 0)
144 /* Next follows a compression flag which must be an ASCII digit. */
145 if (buffer[3] < '1' || buffer[3] > '9')
149 /* After BZh[1-9], there must be either a data block
150 * which begins with 0x314159265359 or an end-of-data
151 * marker of 0x177245385090. */
152 if (memcmp(buffer + 4, "\x31\x41\x59\x26\x53\x59", 6) == 0)
154 else if (memcmp(buffer + 4, "\x17\x72\x45\x38\x50\x90", 6) == 0)
159 return (bits_checked);
162 #if !defined(HAVE_BZLIB_H) || !defined(BZ_CONFIG_ERROR)
165 * If we don't have the library on this system, we can't actually do the
166 * decompression. We can, however, still detect compressed archives
167 * and emit a useful message.
170 bzip2_reader_init(struct archive_read_filter *self)
174 r = __archive_read_program(self, "bzip2 -d");
175 /* Note: We set the format here even if __archive_read_program()
176 * above fails. We do, after all, know what the format is
177 * even if we weren't able to read it. */
178 self->code = ARCHIVE_FILTER_BZIP2;
179 self->name = "bzip2";
187 * Setup the callbacks.
190 bzip2_reader_init(struct archive_read_filter *self)
192 static const size_t out_block_size = 64 * 1024;
194 struct private_data *state;
196 self->code = ARCHIVE_FILTER_BZIP2;
197 self->name = "bzip2";
199 state = (struct private_data *)calloc(sizeof(*state), 1);
200 out_block = (unsigned char *)malloc(out_block_size);
201 if (state == NULL || out_block == NULL) {
202 archive_set_error(&self->archive->archive, ENOMEM,
203 "Can't allocate data for bzip2 decompression");
206 return (ARCHIVE_FATAL);
210 state->out_block_size = out_block_size;
211 state->out_block = out_block;
212 self->read = bzip2_filter_read;
213 self->skip = NULL; /* not supported */
214 self->close = bzip2_filter_close;
220 * Return the next block of decompressed data.
223 bzip2_filter_read(struct archive_read_filter *self, const void **p)
225 struct private_data *state;
227 const char *read_buf;
230 state = (struct private_data *)self->data;
237 /* Empty our output buffer. */
238 state->stream.next_out = state->out_block;
239 state->stream.avail_out = state->out_block_size;
241 /* Try to fill the output buffer. */
244 if (bzip2_reader_bid(self->bidder, self->upstream) == 0) {
246 *p = state->out_block;
247 decompressed = state->stream.next_out
249 return (decompressed);
251 /* Initialize compression library. */
252 ret = BZ2_bzDecompressInit(&(state->stream),
253 0 /* library verbosity */,
254 0 /* don't use low-mem algorithm */);
256 /* If init fails, try low-memory algorithm instead. */
257 if (ret == BZ_MEM_ERROR)
258 ret = BZ2_bzDecompressInit(&(state->stream),
259 0 /* library verbosity */,
260 1 /* do use low-mem algo */);
263 const char *detail = NULL;
264 int err = ARCHIVE_ERRNO_MISC;
267 detail = "invalid setup parameter";
271 detail = "out of memory";
273 case BZ_CONFIG_ERROR:
274 detail = "mis-compiled library";
277 archive_set_error(&self->archive->archive, err,
278 "Internal error initializing decompressor%s%s",
279 detail == NULL ? "" : ": ",
281 return (ARCHIVE_FATAL);
286 /* stream.next_in is really const, but bzlib
287 * doesn't declare it so. <sigh> */
289 __archive_read_filter_ahead(self->upstream, 1, &ret);
290 if (read_buf == NULL) {
291 archive_set_error(&self->archive->archive,
293 "truncated bzip2 input");
294 return (ARCHIVE_FATAL);
296 state->stream.next_in = (char *)(uintptr_t)read_buf;
297 state->stream.avail_in = ret;
298 /* There is no more data, return whatever we have. */
301 *p = state->out_block;
302 decompressed = state->stream.next_out
304 return (decompressed);
307 /* Decompress as much as we can in one pass. */
308 ret = BZ2_bzDecompress(&(state->stream));
309 __archive_read_filter_consume(self->upstream,
310 state->stream.next_in - read_buf);
313 case BZ_STREAM_END: /* Found end of stream. */
314 switch (BZ2_bzDecompressEnd(&(state->stream))) {
318 archive_set_error(&(self->archive->archive),
320 "Failed to clean up decompressor");
321 return (ARCHIVE_FATAL);
325 case BZ_OK: /* Decompressor made some progress. */
326 /* If we filled our buffer, update stats and return. */
327 if (state->stream.avail_out == 0) {
328 *p = state->out_block;
329 decompressed = state->stream.next_out
331 return (decompressed);
334 default: /* Return an error. */
335 archive_set_error(&self->archive->archive,
336 ARCHIVE_ERRNO_MISC, "bzip decompression failed");
337 return (ARCHIVE_FATAL);
343 * Clean up the decompressor.
346 bzip2_filter_close(struct archive_read_filter *self)
348 struct private_data *state;
349 int ret = ARCHIVE_OK;
351 state = (struct private_data *)self->data;
354 switch (BZ2_bzDecompressEnd(&state->stream)) {
358 archive_set_error(&self->archive->archive,
360 "Failed to clean up decompressor");
366 free(state->out_block);
371 #endif /* HAVE_BZLIB_H && BZ_CONFIG_ERROR */