Switched to GPLv3.
[gnupg.git] / g10 / compress-bz2.c
1 /* compress.c - bzip2 compress filter
2  * Copyright (C) 2003, 2004 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <string.h>
22 #include <stdio.h> /* Early versions of bzlib (1.0) require stdio.h */
23 #include <bzlib.h>
24
25 #include "util.h"
26 #include "memory.h"
27 #include "packet.h"
28 #include "filter.h"
29 #include "main.h"
30 #include "options.h"
31
32 /* Note that the code in compress.c is nearly identical to the code
33    here, so if you fix a bug here, look there to see if a matching bug
34    needs to be fixed.  I tried to have one set of functions that could
35    do ZIP, ZLIB, and BZIP2, but it became dangerously unreadable with
36    #ifdefs and if(algo) -dshaw */
37
38 static void
39 init_compress( compress_filter_context_t *zfx, bz_stream *bzs )
40 {
41   int rc;
42   int level;
43
44   if( opt.bz2_compress_level >= 1 && opt.bz2_compress_level <= 9 )
45     level = opt.bz2_compress_level;
46   else if( opt.bz2_compress_level == -1 )
47     level = 6; /* no particular reason, but it seems reasonable */
48   else
49     {
50       log_error("invalid compression level; using default level\n");
51       level = 6;
52     }
53
54   if((rc=BZ2_bzCompressInit(bzs,level,0,0))!=BZ_OK)
55     log_fatal("bz2lib problem: %d\n",rc);
56
57   zfx->outbufsize = 8192;
58   zfx->outbuf = xmalloc( zfx->outbufsize );
59 }
60
61 static int
62 do_compress(compress_filter_context_t *zfx, bz_stream *bzs, int flush, IOBUF a)
63 {
64   int zrc;
65   unsigned n;
66
67   do
68     {
69       bzs->next_out = zfx->outbuf;
70       bzs->avail_out = zfx->outbufsize;
71       if( DBG_FILTER )
72         log_debug("enter bzCompress: avail_in=%u, avail_out=%u, flush=%d\n",
73                   (unsigned)bzs->avail_in, (unsigned)bzs->avail_out, flush );
74       zrc = BZ2_bzCompress( bzs, flush );
75       if( zrc == BZ_STREAM_END && flush == BZ_FINISH )
76         ;
77       else if( zrc != BZ_RUN_OK && zrc != BZ_FINISH_OK )
78         log_fatal("bz2lib deflate problem: rc=%d\n", zrc );
79
80       n = zfx->outbufsize - bzs->avail_out;
81       if( DBG_FILTER )
82         log_debug("leave bzCompress:"
83                   " avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
84                   (unsigned)bzs->avail_in, (unsigned)bzs->avail_out,
85                   (unsigned)n, zrc );
86
87       if( iobuf_write( a, zfx->outbuf, n ) )
88         {
89           log_debug("bzCompress: iobuf_write failed\n");
90           return G10ERR_WRITE_FILE;
91         }
92     }
93   while( bzs->avail_in || (flush == BZ_FINISH && zrc != BZ_STREAM_END) );
94
95   return 0;
96 }
97
98 static void
99 init_uncompress( compress_filter_context_t *zfx, bz_stream *bzs )
100 {
101   int rc;
102
103   if((rc=BZ2_bzDecompressInit(bzs,0,opt.bz2_decompress_lowmem))!=BZ_OK)
104     log_fatal("bz2lib problem: %d\n",rc);
105
106   zfx->inbufsize = 2048;
107   zfx->inbuf = xmalloc( zfx->inbufsize );
108   bzs->avail_in = 0;
109 }
110
111 static int
112 do_uncompress( compress_filter_context_t *zfx, bz_stream *bzs,
113                IOBUF a, size_t *ret_len )
114 {
115   int zrc;
116   int rc=0;
117   size_t n;
118   int nread, count;
119   int refill = !bzs->avail_in;
120
121   if( DBG_FILTER )
122     log_debug("begin bzDecompress: avail_in=%u, avail_out=%u, inbuf=%u\n",
123               (unsigned)bzs->avail_in, (unsigned)bzs->avail_out,
124               (unsigned)zfx->inbufsize );
125   do
126     {
127       if( bzs->avail_in < zfx->inbufsize && refill )
128         {
129           n = bzs->avail_in;
130           if( !n )
131             bzs->next_in = zfx->inbuf;
132           count = zfx->inbufsize - n;
133           nread = iobuf_read( a, zfx->inbuf + n, count );
134           if( nread == -1 ) nread = 0;
135           n += nread;
136           bzs->avail_in = n;
137         }
138
139       refill = 1;
140
141       if( DBG_FILTER )
142         log_debug("enter bzDecompress: avail_in=%u, avail_out=%u\n",
143                   (unsigned)bzs->avail_in, (unsigned)bzs->avail_out);
144
145       zrc=BZ2_bzDecompress(bzs);
146       if( DBG_FILTER )
147         log_debug("leave bzDecompress: avail_in=%u, avail_out=%u, zrc=%d\n",
148                   (unsigned)bzs->avail_in, (unsigned)bzs->avail_out, zrc);
149       if( zrc == BZ_STREAM_END )
150         rc = -1; /* eof */
151       else if( zrc != BZ_OK && zrc != BZ_PARAM_ERROR )
152         log_fatal("bz2lib inflate problem: rc=%d\n", zrc );
153     }
154   while( bzs->avail_out && zrc != BZ_STREAM_END && zrc != BZ_PARAM_ERROR );
155
156   /* I'm not completely happy with the two uses of BZ_PARAM_ERROR
157      here.  The corresponding zlib function is Z_BUF_ERROR, which
158      covers a narrower scope than BZ_PARAM_ERROR. -dshaw */
159
160   *ret_len = zfx->outbufsize - bzs->avail_out;
161   if( DBG_FILTER )
162     log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
163   return rc;
164 }
165
166 int
167 compress_filter_bz2( void *opaque, int control,
168                      IOBUF a, byte *buf, size_t *ret_len)
169 {
170   size_t size = *ret_len;
171   compress_filter_context_t *zfx = opaque;
172   bz_stream *bzs = zfx->opaque;
173   int rc=0;
174
175   if( control == IOBUFCTRL_UNDERFLOW )
176     {
177       if( !zfx->status )
178         {
179           bzs = zfx->opaque = xmalloc_clear( sizeof *bzs );
180           init_uncompress( zfx, bzs );
181           zfx->status = 1;
182         }
183
184       bzs->next_out = buf;
185       bzs->avail_out = size;
186       zfx->outbufsize = size; /* needed only for calculation */
187       rc = do_uncompress( zfx, bzs, a, ret_len );
188     }
189   else if( control == IOBUFCTRL_FLUSH )
190     {
191       if( !zfx->status )
192         {
193           PACKET pkt;
194           PKT_compressed cd;
195
196           if( zfx->algo != COMPRESS_ALGO_BZIP2 )
197             BUG();
198           memset( &cd, 0, sizeof cd );
199           cd.len = 0;
200           cd.algorithm = zfx->algo;
201           init_packet( &pkt );
202           pkt.pkttype = PKT_COMPRESSED;
203           pkt.pkt.compressed = &cd;
204           if( build_packet( a, &pkt ))
205             log_bug("build_packet(PKT_COMPRESSED) failed\n");
206           bzs = zfx->opaque = xmalloc_clear( sizeof *bzs );
207           init_compress( zfx, bzs );
208           zfx->status = 2;
209         }
210
211       bzs->next_in = buf;
212       bzs->avail_in = size;
213       rc = do_compress( zfx, bzs, BZ_RUN, a );
214     }
215   else if( control == IOBUFCTRL_FREE )
216     {
217       if( zfx->status == 1 )
218         {
219           BZ2_bzDecompressEnd(bzs);
220           xfree(bzs);
221           zfx->opaque = NULL;
222           xfree(zfx->outbuf); zfx->outbuf = NULL;
223         }
224       else if( zfx->status == 2 )
225         {
226           bzs->next_in = buf;
227           bzs->avail_in = 0;
228           do_compress( zfx, bzs, BZ_FINISH, a );
229           BZ2_bzCompressEnd(bzs);
230           xfree(bzs);
231           zfx->opaque = NULL;
232           xfree(zfx->outbuf); zfx->outbuf = NULL;
233         }
234       if (zfx->release)
235         zfx->release (zfx);
236     }
237   else if( control == IOBUFCTRL_DESC )
238     *(char**)buf = "compress_filter";
239   return rc;
240 }