Update head to match stable 1.0
[gnupg.git] / g10 / compress.c
1 /* compress.c - compress filter
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <unistd.h>
26 #include <assert.h>
27 #include <errno.h>
28 #include <zlib.h>
29
30 #include "util.h"
31 #include "memory.h"
32 #include "packet.h"
33 #include "filter.h"
34 #include "main.h"
35 #include "options.h"
36
37
38 static void
39 init_compress( compress_filter_context_t *zfx, z_stream *zs )
40 {
41     int rc;
42     int level;
43
44     if( opt.compress >= 0 && opt.compress <= 9 )
45         level = opt.compress;
46     else if( opt.compress == -1 )
47         level = Z_DEFAULT_COMPRESSION;
48     else if( opt.compress == 10 ) /* remove this ! */
49         level = 0;
50     else {
51         log_error("invalid compression level; using default level\n");
52         level = Z_DEFAULT_COMPRESSION;
53     }
54
55
56     if( (rc = zfx->algo == 1? deflateInit2( zs, level, Z_DEFLATED,
57                                             -13, 8, Z_DEFAULT_STRATEGY)
58                             : deflateInit( zs, level )
59                             ) != Z_OK ) {
60         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
61                                rc == Z_MEM_ERROR ? "out of core" :
62                                rc == Z_VERSION_ERROR ? "invalid lib version" :
63                                                        "unknown error" );
64     }
65
66     zfx->outbufsize = 8192;
67     zfx->outbuf = m_alloc( zfx->outbufsize );
68 }
69
70 static int
71 do_compress( compress_filter_context_t *zfx, z_stream *zs, int flush, IOBUF a )
72 {
73     int zrc;
74     unsigned n;
75
76     do {
77 #ifndef __riscos__
78         zs->next_out = zfx->outbuf;
79 #else /* __riscos__ */
80         zs->next_out = (Bytef *) zfx->outbuf;
81 #endif /* __riscos__ */
82         zs->avail_out = zfx->outbufsize;
83         if( DBG_FILTER )
84             log_debug("enter deflate: avail_in=%u, avail_out=%u, flush=%d\n",
85                     (unsigned)zs->avail_in, (unsigned)zs->avail_out, flush );
86         zrc = deflate( zs, flush );
87         if( zrc == Z_STREAM_END && flush == Z_FINISH )
88             ;
89         else if( zrc != Z_OK ) {
90             if( zs->msg )
91                 log_fatal("zlib deflate problem: %s\n", zs->msg );
92             else
93                 log_fatal("zlib deflate problem: rc=%d\n", zrc );
94         }
95         n = zfx->outbufsize - zs->avail_out;
96         if( DBG_FILTER )
97             log_debug("leave deflate: "
98                       "avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
99                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
100                                                (unsigned)n, zrc );
101
102         if( iobuf_write( a, zfx->outbuf, n ) ) {
103             log_debug("deflate: iobuf_write failed\n");
104             return G10ERR_WRITE_FILE;
105         }
106     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
107     return 0;
108 }
109
110 static void
111 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
112 {
113     int rc;
114
115     /****************
116      * PGP uses a windowsize of 13 bits. Using a negative value for
117      * it forces zlib not to expect a zlib header.  This is a
118      * undocumented feature Peter Gutmann told me about.
119      */
120     if( (rc = zfx->algo == 1? inflateInit2( zs, -13)
121                             : inflateInit( zs )) != Z_OK ) {
122         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
123                                rc == Z_MEM_ERROR ? "out of core" :
124                                rc == Z_VERSION_ERROR ? "invalid lib version" :
125                                                        "unknown error" );
126     }
127
128     zfx->inbufsize = 2048;
129     zfx->inbuf = m_alloc( zfx->inbufsize );
130     zs->avail_in = 0;
131 }
132
133 static int
134 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
135                IOBUF a, size_t *ret_len )
136 {
137     int zrc;
138     int rc=0;
139     size_t n;
140     int nread, count;
141     int refill = !zs->avail_in;
142
143     if( DBG_FILTER )
144         log_debug("begin inflate: avail_in=%u, avail_out=%u, inbuf=%u\n",
145                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
146                 (unsigned)zfx->inbufsize );
147     do {
148         if( zs->avail_in < zfx->inbufsize && refill ) {
149             n = zs->avail_in;
150             if( !n )
151 #ifndef __riscos__
152                 zs->next_in = zfx->inbuf;
153 #else /* __riscos__ */
154                 zs->next_in = (Bytef *) zfx->inbuf;
155 #endif /* __riscos__ */
156             count = zfx->inbufsize - n;
157             nread = iobuf_read( a, zfx->inbuf + n, count );
158             if( nread == -1 ) nread = 0;
159             n += nread;
160             /* If we use the undocumented feature to suppress
161              * the zlib header, we have to give inflate an
162              * extra dummy byte to read */
163             if( nread < count && zfx->algo == 1 ) {
164                 *(zfx->inbuf + n) = 0xFF; /* is it really needed ? */
165                 zfx->algo1hack = 1;
166                 n++;
167             }
168             zs->avail_in = n;
169         }
170         refill = 1;
171         if( DBG_FILTER )
172             log_debug("enter inflate: avail_in=%u, avail_out=%u\n",
173                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
174       #ifdef Z_SYNC_FLUSH
175         zrc = inflate( zs, Z_SYNC_FLUSH );
176       #else
177         zrc = inflate( zs, Z_PARTIAL_FLUSH );
178       #endif
179         if( DBG_FILTER )
180             log_debug("leave inflate: avail_in=%u, avail_out=%u, zrc=%d\n",
181                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
182         if( zrc == Z_STREAM_END )
183             rc = -1; /* eof */
184         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
185             if( zs->msg )
186                 log_fatal("zlib inflate problem: %s\n", zs->msg );
187             else
188                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
189         }
190     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
191     *ret_len = zfx->outbufsize - zs->avail_out;
192     if( DBG_FILTER )
193         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
194     return rc;
195 }
196
197 int
198 compress_filter( void *opaque, int control,
199                  IOBUF a, byte *buf, size_t *ret_len)
200 {
201     size_t size = *ret_len;
202     compress_filter_context_t *zfx = opaque;
203     z_stream *zs = zfx->opaque;
204     int rc=0;
205
206     if( control == IOBUFCTRL_UNDERFLOW ) {
207         if( !zfx->status ) {
208             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
209             init_uncompress( zfx, zs );
210             zfx->status = 1;
211         }
212
213 #ifndef __riscos__
214         zs->next_out = buf;
215 #else /* __riscos__ */
216         zs->next_out = (Bytef *) buf;
217 #endif /* __riscos__ */
218         zs->avail_out = size;
219         zfx->outbufsize = size; /* needed only for calculation */
220         rc = do_uncompress( zfx, zs, a, ret_len );
221     }
222     else if( control == IOBUFCTRL_FLUSH ) {
223         if( !zfx->status ) {
224             PACKET pkt;
225             PKT_compressed cd;
226
227             if( !zfx->algo )
228                 zfx->algo = DEFAULT_COMPRESS_ALGO;
229             if( zfx->algo != 1 && zfx->algo != 2 )
230               BUG();
231             memset( &cd, 0, sizeof cd );
232             cd.len = 0;
233             cd.algorithm = zfx->algo;
234             init_packet( &pkt );
235             pkt.pkttype = PKT_COMPRESSED;
236             pkt.pkt.compressed = &cd;
237             if( build_packet( a, &pkt ))
238                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
239             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
240             init_compress( zfx, zs );
241             zfx->status = 2;
242         }
243
244 #ifndef __riscos__
245         zs->next_in = buf;
246 #else /* __riscos__ */
247         zs->next_in = (Bytef *) buf;
248 #endif /* __riscos__ */
249         zs->avail_in = size;
250         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
251     }
252     else if( control == IOBUFCTRL_FREE ) {
253         if( zfx->status == 1 ) {
254             inflateEnd(zs);
255             m_free(zs);
256             zfx->opaque = NULL;
257             m_free(zfx->outbuf); zfx->outbuf = NULL;
258         }
259         else if( zfx->status == 2 ) {
260 #ifndef __riscos__
261             zs->next_in = buf;
262 #else /* __riscos__ */
263             zs->next_in = (Bytef *) buf;
264 #endif /* __riscos__ */
265             zs->avail_in = 0;
266             do_compress( zfx, zs, Z_FINISH, a );
267             deflateEnd(zs);
268             m_free(zs);
269             zfx->opaque = NULL;
270             m_free(zfx->outbuf); zfx->outbuf = NULL;
271         }
272         if (zfx->release)
273           zfx->release (zfx);
274     }
275     else if( control == IOBUFCTRL_DESC )
276         *(char**)buf = "compress_filter";
277     return rc;
278 }
279
280
281 static void
282 release_context (compress_filter_context_t *ctx)
283 {
284   m_free (ctx);
285 }
286
287 /****************
288  * Handle a compressed packet
289  */
290 int
291 handle_compressed( void *procctx, PKT_compressed *cd,
292                    int (*callback)(IOBUF, void *), void *passthru )
293 {
294     compress_filter_context_t *cfx;
295     int rc;
296
297     if( cd->algorithm < 1 || cd->algorithm > 2  )
298         return G10ERR_COMPR_ALGO;
299     cfx = m_alloc_clear (sizeof *cfx);
300     cfx->algo = cd->algorithm;
301     cfx->release = release_context;
302     iobuf_push_filter( cd->buf, compress_filter, cfx );
303     if( callback )
304         rc = callback(cd->buf, passthru );
305     else
306         rc = proc_packets(procctx, cd->buf);
307     cd->buf = NULL;
308     return rc;
309 }
310