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