See ChangeLog: Tue Aug 31 17:20:44 CEST 1999 Werner Koch
[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("enter deflate: avail_in=%u, avail_out=%u, flush=%d\n",
80                     (unsigned)zs->avail_in, (unsigned)zs->avail_out, flush );
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("leave deflate: "
93                       "avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
94                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
95                                                (unsigned)n, zrc );
96
97         if( iobuf_write( a, zfx->outbuf, n ) ) {
98             log_debug("deflate: iobuf_write failed\n");
99             return G10ERR_WRITE_FILE;
100         }
101     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
102     return 0;
103 }
104
105 static void
106 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
107 {
108     int rc;
109
110     /****************
111      * PGP uses a windowsize of 13 bits. Using a negative value for
112      * it forces zlib not to expect a zlib header.  This is a
113      * undocumented feature Peter Gutmann told me about.
114      */
115     if( (rc = zfx->algo == 1? inflateInit2( zs, -13)
116                             : inflateInit( zs )) != Z_OK ) {
117         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
118                                rc == Z_MEM_ERROR ? "out of core" :
119                                rc == Z_VERSION_ERROR ? "invalid lib version" :
120                                                        "unknown error" );
121     }
122
123     zfx->inbufsize = 2048;
124     zfx->inbuf = m_alloc( zfx->inbufsize );
125     zs->avail_in = 0;
126 }
127
128 static int
129 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
130                IOBUF a, size_t *ret_len )
131 {
132     int zrc;
133     int rc=0;
134     size_t n;
135     int nread, count;
136     int refill = !zs->avail_in;
137
138     if( DBG_FILTER )
139         log_debug("begin inflate: avail_in=%u, avail_out=%u, inbuf=%u\n",
140                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
141                 (unsigned)zfx->inbufsize );
142     do {
143         if( zs->avail_in < zfx->inbufsize && refill ) {
144             n = zs->avail_in;
145             if( !n )
146                 zs->next_in = zfx->inbuf;
147             count = zfx->inbufsize - n;
148             nread = iobuf_read( a, zfx->inbuf + n, count );
149             if( nread == -1 ) nread = 0;
150             n += nread;
151             /* If we use the undocumented feature to suppress
152              * the zlib header, we have to give inflate an
153              * extra dummy byte to read */
154             if( nread < count && zfx->algo == 1 ) {
155                 *(zfx->inbuf + n) = 0xFF; /* is it really needed ? */
156                 zfx->algo1hack = 1;
157                 n++;
158             }
159             zs->avail_in = n;
160         }
161         refill = 1;
162         if( DBG_FILTER )
163             log_debug("enter inflate: avail_in=%u, avail_out=%u\n",
164                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
165       #ifdef Z_SYNC_FLUSH
166         zrc = inflate( zs, Z_SYNC_FLUSH );
167       #else
168         zrc = inflate( zs, Z_PARTIAL_FLUSH );
169       #endif
170         if( DBG_FILTER )
171             log_debug("leave inflate: avail_in=%u, avail_out=%u, zrc=%d\n",
172                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
173         if( zrc == Z_STREAM_END )
174             rc = -1; /* eof */
175         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
176             if( zs->msg )
177                 log_fatal("zlib inflate problem: %s\n", zs->msg );
178             else
179                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
180         }
181     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
182     *ret_len = zfx->outbufsize - zs->avail_out;
183     if( DBG_FILTER )
184         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
185     return rc;
186 }
187
188 int
189 compress_filter( void *opaque, int control,
190                  IOBUF a, byte *buf, size_t *ret_len)
191 {
192     size_t size = *ret_len;
193     compress_filter_context_t *zfx = opaque;
194     z_stream *zs = zfx->opaque;
195     int rc=0;
196
197     if( control == IOBUFCTRL_UNDERFLOW ) {
198         if( !zfx->status ) {
199             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
200             init_uncompress( zfx, zs );
201             zfx->status = 1;
202         }
203
204         zs->next_out = buf;
205         zs->avail_out = size;
206         zfx->outbufsize = size; /* needed only for calculation */
207         rc = do_uncompress( zfx, zs, a, ret_len );
208     }
209     else if( control == IOBUFCTRL_FLUSH ) {
210         if( !zfx->status ) {
211             PACKET pkt;
212             PKT_compressed cd;
213
214             if( !zfx->algo )
215                 zfx->algo = opt.def_compress_algo;
216             memset( &cd, 0, sizeof cd );
217             cd.len = 0;
218             cd.algorithm = zfx->algo;
219             init_packet( &pkt );
220             pkt.pkttype = PKT_COMPRESSED;
221             pkt.pkt.compressed = &cd;
222             if( build_packet( a, &pkt ))
223                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
224             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
225             init_compress( zfx, zs );
226             zfx->status = 2;
227         }
228
229         zs->next_in = buf;
230         zs->avail_in = size;
231         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
232     }
233     else if( control == IOBUFCTRL_FREE ) {
234         if( zfx->status == 1 ) {
235             inflateEnd(zs);
236             m_free(zs);
237             zfx->opaque = NULL;
238             m_free(zfx->outbuf); zfx->outbuf = NULL;
239         }
240         else if( zfx->status == 2 ) {
241             zs->next_in = buf;
242             zs->avail_in = 0;
243             do_compress( zfx, zs, Z_FINISH, a );
244             deflateEnd(zs);
245             m_free(zs);
246             zfx->opaque = NULL;
247             m_free(zfx->outbuf); zfx->outbuf = NULL;
248         }
249     }
250     else if( control == IOBUFCTRL_DESC )
251         *(char**)buf = "compress_filter";
252     return rc;
253 }
254
255 /****************
256  * Handle a compressed packet
257  */
258 int
259 handle_compressed( void *procctx, PKT_compressed *cd,
260                    int (*callback)(IOBUF, void *), void *passthru )
261 {
262     compress_filter_context_t cfx;
263     int rc;
264
265     memset( &cfx, 0, sizeof cfx );
266     if( cd->algorithm < 1 || cd->algorithm > 2  )
267         return G10ERR_COMPR_ALGO;
268     cfx.algo = cd->algorithm;
269
270     iobuf_push_filter( cd->buf, compress_filter, &cfx );
271     if( callback )
272         rc = callback(cd->buf, passthru );
273     else
274         rc = proc_packets(procctx, cd->buf);
275   #if 0
276     iobuf_pop_filter( cd->buf, compress_filter, &cfx );
277     if( cd->len )
278         iobuf_set_limit( cd->buf, 0 ); /* disable the readlimit */
279     else
280         iobuf_clear_eof( cd->buf );
281   #endif
282     cd->buf = NULL;
283     return rc;
284 }
285