Switched to GPLv3.
[gnupg.git] / g10 / compress.c
1 /* compress.c - compress filter
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2003 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 /* Note that the code in compress-bz2.c is nearly identical to the
22    code here, so if you fix a bug here, look there to see if a
23    matching bug needs to be fixed.  I tried to have one set of
24    functions that could do ZIP, ZLIB, and BZIP2, but it became
25    dangerously unreadable with #ifdefs and if(algo) -dshaw */
26
27 #include <config.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <unistd.h>
32 #include <assert.h>
33 #include <errno.h>
34 #include <zlib.h>
35 #if defined(__riscos__) && defined(USE_ZLIBRISCOS)
36 # include "zlib-riscos.h"
37 #endif
38
39 #include "util.h"
40 #include "memory.h"
41 #include "packet.h"
42 #include "filter.h"
43 #include "main.h"
44 #include "options.h"
45
46 int compress_filter_bz2( void *opaque, int control,
47                          IOBUF a, byte *buf, size_t *ret_len);
48
49 static void
50 init_compress( compress_filter_context_t *zfx, z_stream *zs )
51 {
52     int rc;
53     int level;
54
55 #if defined(__riscos__) && defined(USE_ZLIBRISCOS)
56     static int zlib_initialized = 0;
57
58     if (!zlib_initialized)
59         zlib_initialized = riscos_load_module("ZLib", zlib_path, 1);
60 #endif
61
62     if( opt.compress_level >= 1 && opt.compress_level <= 9 )
63         level = opt.compress_level;
64     else if( opt.compress_level == -1 )
65         level = Z_DEFAULT_COMPRESSION;
66     else {
67         log_error("invalid compression level; using default level\n");
68         level = Z_DEFAULT_COMPRESSION;
69     }
70
71     if( (rc = zfx->algo == 1? deflateInit2( zs, level, Z_DEFLATED,
72                                             -13, 8, Z_DEFAULT_STRATEGY)
73                             : deflateInit( zs, level )
74                             ) != Z_OK ) {
75         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
76                                rc == Z_MEM_ERROR ? "out of core" :
77                                rc == Z_VERSION_ERROR ? "invalid lib version" :
78                                                        "unknown error" );
79     }
80
81     zfx->outbufsize = 8192;
82     zfx->outbuf = xmalloc( zfx->outbufsize );
83 }
84
85 static int
86 do_compress( compress_filter_context_t *zfx, z_stream *zs, int flush, IOBUF a )
87 {
88     int zrc;
89     unsigned n;
90
91     do {
92 #ifndef __riscos__
93         zs->next_out = zfx->outbuf;
94 #else /* __riscos__ */
95         zs->next_out = (Bytef *) zfx->outbuf;
96 #endif /* __riscos__ */
97         zs->avail_out = zfx->outbufsize;
98         if( DBG_FILTER )
99             log_debug("enter deflate: avail_in=%u, avail_out=%u, flush=%d\n",
100                     (unsigned)zs->avail_in, (unsigned)zs->avail_out, flush );
101         zrc = deflate( zs, flush );
102         if( zrc == Z_STREAM_END && flush == Z_FINISH )
103             ;
104         else if( zrc != Z_OK ) {
105             if( zs->msg )
106                 log_fatal("zlib deflate problem: %s\n", zs->msg );
107             else
108                 log_fatal("zlib deflate problem: rc=%d\n", zrc );
109         }
110         n = zfx->outbufsize - zs->avail_out;
111         if( DBG_FILTER )
112             log_debug("leave deflate: "
113                       "avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
114                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
115                                                (unsigned)n, zrc );
116
117         if( iobuf_write( a, zfx->outbuf, n ) ) {
118             log_debug("deflate: iobuf_write failed\n");
119             return G10ERR_WRITE_FILE;
120         }
121     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
122     return 0;
123 }
124
125 static void
126 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
127 {
128     int rc;
129
130     /****************
131      * PGP uses a windowsize of 13 bits. Using a negative value for
132      * it forces zlib not to expect a zlib header.  This is a
133      * undocumented feature Peter Gutmann told me about.
134      *    
135      * We must use 15 bits for the inflator because CryptoEx uses 15
136      * bits thus the output would get scrambled w/o error indication
137      * if we would use 13 bits.  For the uncompressing this does not
138      * matter at all.
139      */
140     if( (rc = zfx->algo == 1? inflateInit2( zs, -15)
141                             : inflateInit( zs )) != Z_OK ) {
142         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
143                                rc == Z_MEM_ERROR ? "out of core" :
144                                rc == Z_VERSION_ERROR ? "invalid lib version" :
145                                                        "unknown error" );
146     }
147
148     zfx->inbufsize = 2048;
149     zfx->inbuf = xmalloc( zfx->inbufsize );
150     zs->avail_in = 0;
151 }
152
153 static int
154 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
155                IOBUF a, size_t *ret_len )
156 {
157     int zrc;
158     int rc=0;
159     size_t n;
160     int nread, count;
161     int refill = !zs->avail_in;
162
163     if( DBG_FILTER )
164         log_debug("begin inflate: avail_in=%u, avail_out=%u, inbuf=%u\n",
165                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
166                 (unsigned)zfx->inbufsize );
167     do {
168         if( zs->avail_in < zfx->inbufsize && refill ) {
169             n = zs->avail_in;
170             if( !n )
171 #ifndef __riscos__
172                 zs->next_in = zfx->inbuf;
173 #else /* __riscos__ */
174                 zs->next_in = (Bytef *) zfx->inbuf;
175 #endif /* __riscos__ */
176             count = zfx->inbufsize - n;
177             nread = iobuf_read( a, zfx->inbuf + n, count );
178             if( nread == -1 ) nread = 0;
179             n += nread;
180             /* If we use the undocumented feature to suppress
181              * the zlib header, we have to give inflate an
182              * extra dummy byte to read */
183             if( nread < count && zfx->algo == 1 ) {
184                 *(zfx->inbuf + n) = 0xFF; /* is it really needed ? */
185                 zfx->algo1hack = 1;
186                 n++;
187             }
188             zs->avail_in = n;
189         }
190         refill = 1;
191         if( DBG_FILTER )
192             log_debug("enter inflate: avail_in=%u, avail_out=%u\n",
193                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
194 #ifdef Z_SYNC_FLUSH
195         zrc = inflate( zs, Z_SYNC_FLUSH );
196 #else
197         zrc = inflate( zs, Z_PARTIAL_FLUSH );
198 #endif
199         if( DBG_FILTER )
200             log_debug("leave inflate: avail_in=%u, avail_out=%u, zrc=%d\n",
201                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
202         if( zrc == Z_STREAM_END )
203             rc = -1; /* eof */
204         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
205             if( zs->msg )
206                 log_fatal("zlib inflate problem: %s\n", zs->msg );
207             else
208                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
209         }
210     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
211     *ret_len = zfx->outbufsize - zs->avail_out;
212     if( DBG_FILTER )
213         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
214     return rc;
215 }
216
217 static int
218 compress_filter( void *opaque, int control,
219                  IOBUF a, byte *buf, size_t *ret_len)
220 {
221     size_t size = *ret_len;
222     compress_filter_context_t *zfx = opaque;
223     z_stream *zs = zfx->opaque;
224     int rc=0;
225
226     if( control == IOBUFCTRL_UNDERFLOW ) {
227         if( !zfx->status ) {
228             zs = zfx->opaque = xmalloc_clear( sizeof *zs );
229             init_uncompress( zfx, zs );
230             zfx->status = 1;
231         }
232
233 #ifndef __riscos__
234         zs->next_out = buf;
235 #else /* __riscos__ */
236         zs->next_out = (Bytef *) buf;
237 #endif /* __riscos__ */
238         zs->avail_out = size;
239         zfx->outbufsize = size; /* needed only for calculation */
240         rc = do_uncompress( zfx, zs, a, ret_len );
241     }
242     else if( control == IOBUFCTRL_FLUSH ) {
243         if( !zfx->status ) {
244             PACKET pkt;
245             PKT_compressed cd;
246             if(zfx->algo != COMPRESS_ALGO_ZIP
247                && zfx->algo != COMPRESS_ALGO_ZLIB)
248               BUG();
249             memset( &cd, 0, sizeof cd );
250             cd.len = 0;
251             cd.algorithm = zfx->algo;
252             init_packet( &pkt );
253             pkt.pkttype = PKT_COMPRESSED;
254             pkt.pkt.compressed = &cd;
255             if( build_packet( a, &pkt ))
256                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
257             zs = zfx->opaque = xmalloc_clear( sizeof *zs );
258             init_compress( zfx, zs );
259             zfx->status = 2;
260         }
261
262 #ifndef __riscos__
263         zs->next_in = buf;
264 #else /* __riscos__ */
265         zs->next_in = (Bytef *) buf;
266 #endif /* __riscos__ */
267         zs->avail_in = size;
268         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
269     }
270     else if( control == IOBUFCTRL_FREE ) {
271         if( zfx->status == 1 ) {
272             inflateEnd(zs);
273             xfree(zs);
274             zfx->opaque = NULL;
275             xfree(zfx->outbuf); zfx->outbuf = NULL;
276         }
277         else if( zfx->status == 2 ) {
278 #ifndef __riscos__
279             zs->next_in = buf;
280 #else /* __riscos__ */
281             zs->next_in = (Bytef *) buf;
282 #endif /* __riscos__ */
283             zs->avail_in = 0;
284             do_compress( zfx, zs, Z_FINISH, a );
285             deflateEnd(zs);
286             xfree(zs);
287             zfx->opaque = NULL;
288             xfree(zfx->outbuf); zfx->outbuf = NULL;
289         }
290         if (zfx->release)
291           zfx->release (zfx);
292     }
293     else if( control == IOBUFCTRL_DESC )
294         *(char**)buf = "compress_filter";
295     return rc;
296 }
297
298
299 static void
300 release_context (compress_filter_context_t *ctx)
301 {
302   xfree (ctx);
303 }
304
305 /****************
306  * Handle a compressed packet
307  */
308 int
309 handle_compressed( void *procctx, PKT_compressed *cd,
310                    int (*callback)(IOBUF, void *), void *passthru )
311 {
312     compress_filter_context_t *cfx;
313     int rc;
314
315     if(check_compress_algo(cd->algorithm))
316       return G10ERR_COMPR_ALGO;
317     cfx = xmalloc_clear (sizeof *cfx);
318     cfx->release = release_context;
319     cfx->algo = cd->algorithm;
320     push_compress_filter(cd->buf,cfx,cd->algorithm);
321     if( callback )
322         rc = callback(cd->buf, passthru );
323     else
324         rc = proc_packets(procctx, cd->buf);
325     cd->buf = NULL;
326     return rc;
327 }
328
329 void
330 push_compress_filter(IOBUF out,compress_filter_context_t *zfx,int algo)
331 {
332   push_compress_filter2(out,zfx,algo,0);
333 }
334
335 void
336 push_compress_filter2(IOBUF out,compress_filter_context_t *zfx,
337                       int algo,int rel)
338 {
339   if(algo>=0)
340     zfx->algo=algo;
341   else
342     zfx->algo=DEFAULT_COMPRESS_ALGO;
343
344   switch(zfx->algo)
345     {
346     case COMPRESS_ALGO_NONE:
347       break;
348
349     case COMPRESS_ALGO_ZIP:
350     case COMPRESS_ALGO_ZLIB:
351       iobuf_push_filter2(out,compress_filter,zfx,rel);
352       break;
353
354 #ifdef HAVE_BZIP2
355     case COMPRESS_ALGO_BZIP2:
356       iobuf_push_filter2(out,compress_filter_bz2,zfx,rel);
357       break;
358 #endif
359
360     default:
361       BUG();
362     }
363 }