bug fix release
[gnupg.git] / g10 / compress.c
1 /* compress.c - compress filter
2  *      Copyright (C) 1998 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 "options.h"
35
36
37 static void
38 init_compress( compress_filter_context_t *zfx, z_stream *zs )
39 {
40     int rc;
41     int level;
42
43     if( opt.compress >= 0 && opt.compress <= 9 )
44         level = opt.compress;
45     else if( opt.compress == -1 )
46         level = Z_DEFAULT_COMPRESSION;
47     else if( opt.compress == 10 ) /* remove this ! */
48         level = 0;
49     else {
50         log_error("invalid compression level; using default level\n");
51         level = Z_DEFAULT_COMPRESSION;
52     }
53
54
55     if( (rc = zfx->algo == 1? deflateInit2( zs, level, Z_DEFLATED,
56                                             -13, 8, Z_DEFAULT_STRATEGY)
57                             : deflateInit( zs, level )
58                             ) != Z_OK ) {
59         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
60                                rc == Z_MEM_ERROR ? "out of core" :
61                                rc == Z_VERSION_ERROR ? "invalid lib version" :
62                                                        "unknown error" );
63     }
64
65     zfx->outbufsize = 8192;
66     zfx->outbuf = m_alloc( zfx->outbufsize );
67 }
68
69 static int
70 do_compress( compress_filter_context_t *zfx, z_stream *zs, int flush, IOBUF a )
71 {
72     int zrc;
73     unsigned n;
74
75     do {
76         zs->next_out = zfx->outbuf;
77         zs->avail_out = zfx->outbufsize;
78         if( DBG_FILTER )
79             log_debug("call deflate: avail_in=%u, avail_out=%u\n",
80                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
81         zrc = deflate( zs, flush );
82         if( zrc == Z_STREAM_END && flush == Z_FINISH )
83             ;
84         else if( zrc != Z_OK ) {
85             if( zs->msg )
86                 log_fatal("zlib deflate problem: %s\n", zs->msg );
87             else
88                 log_fatal("zlib deflate problem: rc=%d\n", zrc );
89         }
90         n = zfx->outbufsize - zs->avail_out;
91         if( DBG_FILTER )
92             log_debug("deflate returned: avail_in=%u, avail_out=%u, n=%u\n",
93                 (unsigned)zs->avail_in, (unsigned)zs->avail_out, (unsigned)n );
94
95         if( iobuf_write( a, zfx->outbuf, n ) ) {
96             log_debug("deflate: iobuf_write failed\n");
97             return G10ERR_WRITE_FILE;
98         }
99     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
100     return 0;
101 }
102
103 static void
104 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
105 {
106     int rc;
107
108     /****************
109      * PGP uses a windowsize of 13 bits. Using a negative value for
110      * it forces zlib not to expect a zlib header.  This is a
111      * undocumented feature Peter Gutmann told me about.
112      */
113     if( (rc = zfx->algo == 1? inflateInit2( zs, -13)
114                             : inflateInit( zs )) != Z_OK ) {
115         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
116                                rc == Z_MEM_ERROR ? "out of core" :
117                                rc == Z_VERSION_ERROR ? "invalid lib version" :
118                                                        "unknown error" );
119     }
120
121     zfx->inbufsize = 2048;
122     zfx->inbuf = m_alloc( zfx->inbufsize );
123     zs->avail_in = 0;
124 }
125
126 static int
127 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
128                IOBUF a, size_t *ret_len )
129 {
130     int zrc;
131     int rc=0;
132     size_t n;
133     byte *p;
134     int c;
135
136     if( DBG_FILTER )
137         log_debug("do_uncompress: avail_in=%u, avail_out=%u\n",
138                 (unsigned)zs->avail_in, (unsigned)zs->avail_out);
139     do {
140         if( zs->avail_in < zfx->inbufsize ) {
141             n = zs->avail_in;
142             if( !n )
143                 zs->next_in = zfx->inbuf;
144             for( p=zfx->inbuf+n; n < zfx->inbufsize; n++, p++ ) {
145                 if( (c=iobuf_get(a)) == -1 )
146                     break;
147                 *p = c & 0xff;
148             }
149             zs->avail_in = n;
150         }
151         if( DBG_FILTER )
152             log_debug("call inflate: avail_in=%u, avail_out=%u\n",
153                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
154       #ifdef Z_SYNC_FLUSH
155         zrc = inflate( zs, Z_SYNC_FLUSH );
156       #else
157         zrc = inflate( zs, Z_PARTIAL_FLUSH );
158       #endif
159         if( DBG_FILTER )
160             log_debug("inflate returned: avail_in=%u, avail_out=%u, zrc=%d\n",
161                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
162         if( zrc == Z_STREAM_END )
163             rc = -1; /* eof */
164         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
165             if( zs->msg )
166                 log_fatal("zlib inflate problem: %s\n", zs->msg );
167             else
168                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
169         }
170     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
171     *ret_len = zfx->outbufsize - zs->avail_out;
172     if( DBG_FILTER )
173         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
174     return rc;
175 }
176
177 int
178 compress_filter( void *opaque, int control,
179                  IOBUF a, byte *buf, size_t *ret_len)
180 {
181     size_t size = *ret_len;
182     compress_filter_context_t *zfx = opaque;
183     z_stream *zs = zfx->opaque;
184     int rc=0;
185
186     if( control == IOBUFCTRL_UNDERFLOW ) {
187         if( !zfx->status ) {
188             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
189             init_uncompress( zfx, zs );
190             zfx->status = 1;
191         }
192
193         zs->next_out = buf;
194         zs->avail_out = size;
195         zfx->outbufsize = size; /* needed only for calculation */
196         rc = do_uncompress( zfx, zs, a, ret_len );
197     }
198     else if( control == IOBUFCTRL_FLUSH ) {
199         if( !zfx->status ) {
200             PACKET pkt;
201             PKT_compressed cd;
202
203             if( !zfx->algo )
204                 zfx->algo = opt.def_compress_algo;
205             memset( &cd, 0, sizeof cd );
206             cd.len = 0;
207             cd.algorithm = zfx->algo;
208             init_packet( &pkt );
209             pkt.pkttype = PKT_COMPRESSED;
210             pkt.pkt.compressed = &cd;
211             if( build_packet( a, &pkt ))
212                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
213             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
214             init_compress( zfx, zs );
215             zfx->status = 2;
216         }
217
218         zs->next_in = buf;
219         zs->avail_in = size;
220         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
221     }
222     else if( control == IOBUFCTRL_FREE ) {
223         if( zfx->status == 1 ) {
224             inflateEnd(zs);
225             m_free(zs);
226             zfx->opaque = NULL;
227             m_free(zfx->outbuf); zfx->outbuf = NULL;
228         }
229         else if( zfx->status == 2 ) {
230             zs->next_in = buf;
231             zs->avail_in = 0;
232             do_compress( zfx, zs, Z_FINISH, a );
233             deflateEnd(zs);
234             m_free(zs);
235             zfx->opaque = NULL;
236             m_free(zfx->outbuf); zfx->outbuf = NULL;
237         }
238     }
239     else if( control == IOBUFCTRL_DESC )
240         *(char**)buf = "compress_filter";
241     return rc;
242 }
243
244 /****************
245  * Handle a compressed packet
246  */
247 int
248 handle_compressed( PKT_compressed *cd,
249                    int (*callback)(IOBUF, void *), void *passthru )
250 {
251     compress_filter_context_t cfx;
252     int rc;
253
254     memset( &cfx, 0, sizeof cfx );
255     if( cd->algorithm < 1 || cd->algorithm > 2  )
256         return G10ERR_COMPR_ALGO;
257     cfx.algo = cd->algorithm;
258
259     iobuf_push_filter( cd->buf, compress_filter, &cfx );
260     if( callback )
261         rc = callback(cd->buf, passthru );
262     else
263         rc = proc_packets(cd->buf);
264     iobuf_pop_filter( cd->buf, compress_filter, &cfx );
265   #if 0
266     if( cd->len )
267         iobuf_set_limit( cd->buf, 0 ); /* disable the readlimit */
268     else
269         iobuf_clear_eof( cd->buf );
270   #endif
271     cd->buf = NULL;
272     return rc;
273 }
274