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