See ChangeLog: Wed Jan 13 14:10:15 CET 1999 Werner Koch
[gnupg.git] / util / iobuf.c
1 /* iobuf.c  -  file handling
2  *      Copyright (C) 1998, 1999 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 <errno.h>
26 #include <assert.h>
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30
31 #include "memory.h"
32 #include "util.h"
33 #include "iobuf.h"
34
35 typedef struct {
36     FILE *fp;      /* open file handle */
37     int  print_only_name; /* flags indicating that fname is not a real file*/
38     char fname[1]; /* name of the file */
39 } file_filter_ctx_t ;
40
41 /* The first partial length header block must be of size 512
42  * to make it easier (and efficienter) we use a min. block size of 512
43  * for all chznks (but the last one) */
44 #define OP_MIN_PARTIAL_CHUNK      512
45 #define OP_MIN_PARTIAL_CHUNK_2POW 9
46
47 typedef struct {
48     int usage;
49     size_t size;
50     size_t count;
51     int partial;  /* 1 = partial header, 2 in last partial packet */
52     char *buffer;    /* used for partial header */
53     size_t buflen;   /* used size of buffer */
54     int first_c;     /* of partial header (which is > 0)*/
55     int eof;
56 } block_filter_ctx_t;
57
58
59 static int underflow(IOBUF a);
60 static const char *get_real_fname( IOBUF a );
61
62 /****************
63  * Read data from a file into buf which has an allocated length of *LEN.
64  * return the number of read bytes in *LEN. OPAQUE is the FILE * of
65  * the stream. A is not used.
66  * control may be:
67  * IOBUFCTRL_INIT: called just before the function is linked into the
68  *                 list of function. This can be used to prepare internal
69  *                 data structures of the function.
70  * IOBUFCTRL_FREE: called just before the function is removed from the
71  *                  list of functions and can be used to release internal
72  *                  data structures or close a file etc.
73  * IOBUFCTRL_UNDERFLOW: called by iobuf_underflow to fill the buffer
74  *                  with new stuff. *RET_LEN is the available size of the
75  *                  buffer, and should be set to the number of bytes
76  *                  which were put into the buffer. The function
77  *                  returns 0 to indicate success, -1 on EOF and
78  *                  G10ERR_xxxxx for other errors.
79  *
80  * IOBUFCTRL_FLUSH: called by iobuf_flush() to write out the collected stuff.
81  *                  *RET_LAN is the number of bytes in BUF.
82  *
83  */
84 static int
85 file_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
86 {
87     file_filter_ctx_t *a = opaque;
88     FILE *fp = a->fp;
89     size_t size = *ret_len;
90     size_t nbytes = 0;
91     int c, rc = 0;
92     char *p;
93
94     if( control == IOBUFCTRL_UNDERFLOW ) {
95         assert( size ); /* need a buffer */
96         for(; size; size-- ) {
97             if( (c=getc(fp)) == EOF ) {
98                 if( ferror(fp) ) {
99                     log_error("%s: read error: %s\n",
100                                         a->fname, strerror(errno));
101                     rc = G10ERR_READ_FILE;
102                 }
103                 else if( !nbytes )
104                     rc = -1; /* okay: we can return EOF now. */
105                 break;
106             }
107             buf[nbytes++] = c & 0xff;
108         }
109         *ret_len = nbytes;
110     }
111     else if( control == IOBUFCTRL_FLUSH ) {
112         for(p=buf; nbytes < size; nbytes++, p++ ) {
113             if( putc(*p, fp) == EOF ) {
114                 log_error("%s: write error: %s\n",
115                                     a->fname, strerror(errno));
116                 rc = G10ERR_WRITE_FILE;
117                 break;
118             }
119         }
120         *ret_len = nbytes;
121     }
122     else if( control == IOBUFCTRL_INIT ) {
123     }
124     else if( control == IOBUFCTRL_DESC ) {
125         *(char**)buf = "file_filter";
126     }
127     else if( control == IOBUFCTRL_FREE ) {
128         if( fp != stdin && fp != stdout )
129             fclose(fp);
130         fp = NULL;
131         m_free(a); /* we can free our context now */
132     }
133
134     return rc;
135 }
136
137
138 /****************
139  * This is used to implement the block write mode.
140  * Block reading is done on a byte by byte basis in readbyte(),
141  * without a filter
142  */
143 static int
144 block_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
145 {
146     block_filter_ctx_t *a = opaque;
147     size_t size = *ret_len;
148     int c, rc = 0;
149     char *p;
150
151     if( control == IOBUFCTRL_UNDERFLOW ) {
152         size_t n=0;
153
154         p = buf;
155         assert( size ); /* need a buffer */
156         if( a->eof ) /* don't read any further */
157             rc = -1;
158         while( !rc && size ) {
159             if( !a->size ) { /* get the length bytes */
160                 if( a->partial == 2 ) {
161                     a->eof = 1;
162                     if( !n )
163                         rc = -1;
164                     break;
165                 }
166                 else if( a->partial ) {
167                     /* These OpenPGP introduced huffman encoded length
168                      * bytes are really a mess :-( */
169                     if( a->first_c ) {
170                         c = a->first_c;
171                         a->first_c = 0;
172                         assert( c >= 224 && c < 255 );
173                     }
174                     else if( (c = iobuf_get(chain)) == -1 ) {
175                         log_error("block_filter: 1st length byte missing\n");
176                         rc = G10ERR_READ_FILE;
177                         break;
178                     }
179                     if( c < 192 ) {
180                         a->size = c;
181                         a->partial = 2;
182                         if( !a->size ) {
183                             a->eof = 1;
184                             if( !n )
185                                 rc = -1;
186                             break;
187                         }
188                     }
189                     else if( c < 224 ) {
190                         a->size = (c - 192) * 256;
191                         if( (c = iobuf_get(chain)) == -1 ) {
192                             log_error("block_filter: 2nd length byte missing\n");
193                             rc = G10ERR_READ_FILE;
194                             break;
195                         }
196                         a->size += c + 192;
197                         a->partial = 2;
198                         if( !a->size ) {
199                             a->eof = 1;
200                             if( !n )
201                                 rc = -1;
202                             break;
203                         }
204                     }
205                     else if( c == 255 ) {
206                         a->size  = iobuf_get(chain) << 24;
207                         a->size |= iobuf_get(chain) << 16;
208                         a->size |= iobuf_get(chain) << 8;
209                         if( (c = iobuf_get(chain)) == -1 ) {
210                             log_error("block_filter: invalid 4 byte length\n");
211                             rc = G10ERR_READ_FILE;
212                             break;
213                         }
214                         a->size |= c;
215                     }
216                     else { /* next partial body length */
217                         a->size = 1 << (c & 0x1f);
218                     }
219                 }
220                 else { /* the gnupg partial length scheme - much better :-) */
221                     c = iobuf_get(chain);
222                     a->size = c << 8;
223                     c = iobuf_get(chain);
224                     a->size |= c;
225                     if( c == -1 ) {
226                         log_error("block_filter: error reading length info\n");
227                         rc = G10ERR_READ_FILE;
228                     }
229                     if( !a->size ) {
230                         a->eof = 1;
231                         if( !n )
232                             rc = -1;
233                         break;
234                     }
235                 }
236             }
237
238             for(; !rc && size && a->size; size--, a->size-- ) {
239                 if( (c=iobuf_get(chain)) == -1 ) {
240                     log_error("block_filter %p: read error (size=%lu,a->size=%lu)\n",
241                                 a,  (ulong)size, (ulong)a->size);
242                     rc = G10ERR_READ_FILE;
243                 }
244                 else {
245                     *p++ = c;
246                     n++;
247                 }
248             }
249         }
250         *ret_len = n;
251     }
252     else if( control == IOBUFCTRL_FLUSH ) {
253         if( a->partial ) { /* the complicated openpgp scheme */
254             size_t blen, n, nbytes = size + a->buflen;
255
256             assert( a->buflen <= OP_MIN_PARTIAL_CHUNK );
257             if( nbytes < OP_MIN_PARTIAL_CHUNK ) {
258                 /* not enough to write a partial block out , so we store it*/
259                 if( !a->buffer )
260                     a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
261                 memcpy( a->buffer + a->buflen, buf, size );
262                 a->buflen += size;
263             }
264             else { /* okay, we can write out something */
265                 /* do this in a loop to use the most efficient block lengths */
266                 p = buf;
267                 do {
268                     /* find the best matching block length - this is limited
269                      * by the size of the internal buffering */
270                     for( blen=OP_MIN_PARTIAL_CHUNK*2,
271                             c=OP_MIN_PARTIAL_CHUNK_2POW+1; blen < nbytes;
272                                                             blen *=2, c++ )
273                         ;
274                     blen /= 2; c--;
275                     /* write the partial length header */
276                     assert( c <= 0x1f ); /*;-)*/
277                     c |= 0xe0;
278                     iobuf_put( chain, c );
279                     if( (n=a->buflen) ) { /* write stuff from the buffer */
280                         assert( n == OP_MIN_PARTIAL_CHUNK);
281                         if( iobuf_write(chain, a->buffer, n ) )
282                             rc = G10ERR_WRITE_FILE;
283                         a->buflen = 0;
284                         nbytes -= n;
285                     }
286                     if( (n = nbytes) > blen )
287                         n = blen;
288                     if( n && iobuf_write(chain, p, n ) )
289                         rc = G10ERR_WRITE_FILE;
290                     p += n;
291                     nbytes -= n;
292                 } while( !rc && nbytes >= OP_MIN_PARTIAL_CHUNK );
293                 /* store the rest in the buffer */
294                 if( !rc && nbytes ) {
295                     assert( !a->buflen );
296                     assert( nbytes < OP_MIN_PARTIAL_CHUNK );
297                     if( !a->buffer )
298                         a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
299                     memcpy( a->buffer, p, nbytes );
300                     a->buflen = nbytes;
301                 }
302             }
303         }
304         else { /* the gnupg scheme */
305             size_t avail, n;
306
307             for(p=buf; !rc && size; ) {
308                 n = size;
309                 avail = a->size - a->count;
310                 if( !avail ) {
311                     if( n > a->size ) {
312                         iobuf_put( chain, (a->size >> 8) & 0xff );
313                         iobuf_put( chain, a->size & 0xff );
314                         avail = a->size;
315                         a->count = 0;
316                     }
317                     else {
318                         iobuf_put( chain, (n >> 8) & 0xff );
319                         iobuf_put( chain, n & 0xff );
320                         avail = n;
321                         a->count = a->size - n;
322                     }
323                 }
324                 if( n > avail )
325                     n = avail;
326                 if( iobuf_write(chain, p, n ) )
327                     rc = G10ERR_WRITE_FILE;
328                 a->count += n;
329                 p += n;
330                 size -= n;
331             }
332         }
333     }
334     else if( control == IOBUFCTRL_INIT ) {
335         if( DBG_IOBUF )
336             log_debug("init block_filter %p\n", a );
337         if( a->partial )
338             a->count = 0;
339         else if( a->usage == 1 )
340             a->count = a->size = 0;
341         else
342             a->count = a->size; /* force first length bytes */
343         a->eof = 0;
344         a->buffer = NULL;
345         a->buflen = 0;
346     }
347     else if( control == IOBUFCTRL_DESC ) {
348         *(char**)buf = "block_filter";
349     }
350     else if( control == IOBUFCTRL_FREE ) {
351         if( a->usage == 2 ) { /* write the end markers */
352             if( a->partial ) {
353                 u32 len;
354                 /* write out the remaining bytes without a partial header
355                  * the length of this header may be 0 - but if it is
356                  * the first block we are not allowed to use a partial header
357                  * and frankly we can't do so, because this length must be
358                  * a power of 2. This is _really_ complicated because we
359                  * have to check the possible length of a packet prior
360                  * to it's creation: a chein of filters becomes complicated
361                  * and we need a lot of code to handle compressed packets etc.
362                  *   :-(((((((
363                  */
364                 /* construct header */
365                 len = a->buflen;
366                 if( len < 192 )
367                     rc = iobuf_put(chain, len );
368                 else if( len < 8384 ) {
369                     if( !(rc=iobuf_put( chain, ((len-192) / 256) + 192)) )
370                         rc = iobuf_put( chain, ((len-192) % 256));
371                 }
372                 else { /* use a 4 byte header */
373                     if( !(rc=iobuf_put( chain, 0xff )) )
374                         if( !(rc=iobuf_put( chain, (len >> 24)&0xff )) )
375                             if( !(rc=iobuf_put( chain, (len >> 16)&0xff )) )
376                                 if( !(rc=iobuf_put( chain, (len >> 8)&0xff )))
377                                     rc=iobuf_put( chain, len & 0xff );
378                 }
379                 if( !rc && len )
380                     rc = iobuf_write(chain, a->buffer, len );
381                 if( rc ) {
382                     log_error("block_filter: write error: %s\n",strerror(errno));
383                     rc = G10ERR_WRITE_FILE;
384                 }
385                 m_free( a->buffer ); a->buffer = NULL; a->buflen = 0;
386             }
387             else {
388                 iobuf_writebyte(chain, 0);
389                 iobuf_writebyte(chain, 0);
390             }
391         }
392         else if( a->size ) {
393             log_error("block_filter: pending bytes!\n");
394         }
395         if( DBG_IOBUF )
396             log_debug("free block_filter %p\n", a );
397         m_free(a); /* we can free our context now */
398     }
399
400     return rc;
401 }
402
403
404 static void
405 print_chain( IOBUF a )
406 {
407     if( !DBG_IOBUF )
408         return;
409     for(; a; a = a->chain ) {
410         size_t dummy_len = 0;
411         const char *desc = "[none]";
412
413         if( a->filter )
414             a->filter( a->filter_ov, IOBUFCTRL_DESC, NULL,
415                                                 (byte*)&desc, &dummy_len );
416
417         log_debug("iobuf chain: %d.%d `%s' filter_eof=%d start=%d len=%d\n",
418                    a->no, a->subno, desc, a->filter_eof,
419                    a->d.start, a->d.len );
420     }
421 }
422
423 /****************
424  * Allocate a new io buffer, with no function assigned.
425  * Usage is the desired usage: 1 for input, 2 for output, 3 for temp buffer
426  * BUFSIZE is a suggested buffer size.
427  */
428 IOBUF
429 iobuf_alloc(int usage, size_t bufsize)
430 {
431     IOBUF a;
432     static int number=0;
433
434     a = m_alloc_clear(sizeof *a);
435     a->usage = usage;
436     a->d.buf = m_alloc( bufsize );
437     a->d.size = bufsize;
438     a->no = ++number;
439     a->subno = 0;
440     a->opaque = NULL;
441     return a;
442 }
443
444
445 int
446 iobuf_close( IOBUF a )
447 {
448     IOBUF a2;
449     size_t dummy_len;
450     int rc=0;
451
452     if( a && a->directfp ) {
453         fclose( a->directfp );
454         if( DBG_IOBUF )
455             log_debug("iobuf_close -> %p\n", a->directfp );
456         return 0;
457     }
458
459     for( ; a && !rc ; a = a2 ) {
460         a2 = a->chain;
461         if( a->usage == 2 && (rc=iobuf_flush(a)) )
462             log_error("iobuf_flush failed on close: %s\n", g10_errstr(rc));
463
464         if( DBG_IOBUF )
465             log_debug("iobuf-%d.%d: close `%s'\n", a->no, a->subno, a->desc );
466         if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE,
467                                          a->chain, NULL, &dummy_len)) )
468             log_error("IOBUFCTRL_FREE failed on close: %s\n", g10_errstr(rc) );
469         m_free(a->d.buf);
470         m_free(a);
471     }
472     return rc;
473 }
474
475 int
476 iobuf_cancel( IOBUF a )
477 {
478     const char *s;
479
480     if( a && a->usage == 2 ) {
481         s = get_real_fname(a);
482         if( s && *s )
483             remove(s);  /* remove the file. Fixme: this will fail for MSDOZE*/
484     }                   /* because the file is still open */
485     return iobuf_close(a);
486 }
487
488
489 /****************
490  * create a temporary iobuf, which can be used to collect stuff
491  * in an iobuf and later be written by iobuf_write_temp() to another
492  * iobuf.
493  */
494 IOBUF
495 iobuf_temp()
496 {
497     IOBUF a;
498
499     a = iobuf_alloc(3, 8192 );
500
501     return a;
502 }
503
504 IOBUF
505 iobuf_temp_with_content( const char *buffer, size_t length )
506 {
507     IOBUF a;
508
509     a = iobuf_alloc(3, length );
510     memcpy( a->d.buf, buffer, length );
511     a->d.len = length;
512
513     return a;
514 }
515
516
517 /****************
518  * Create a head iobuf for reading from a file
519  * returns: NULL if an error occures and sets errno
520  */
521 IOBUF
522 iobuf_open( const char *fname )
523 {
524     IOBUF a;
525     FILE *fp;
526     file_filter_ctx_t *fcx;
527     size_t len;
528     int print_only = 0;
529
530     if( !fname || (*fname=='-' && !fname[1])  ) {
531         fp = stdin; /* fixme: set binary mode for msdoze */
532         fname = "[stdin]";
533         print_only = 1;
534     }
535     else if( !(fp = fopen(fname, "rb")) )
536         return NULL;
537     a = iobuf_alloc(1, 8192 );
538     fcx = m_alloc( sizeof *fcx + strlen(fname) );
539     fcx->fp = fp;
540     fcx->print_only_name = print_only;
541     strcpy(fcx->fname, fname );
542     a->filter = file_filter;
543     a->filter_ov = fcx;
544     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
545     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
546     if( DBG_IOBUF )
547         log_debug("iobuf-%d.%d: open `%s'\n", a->no, a->subno, fname );
548
549     return a;
550 }
551
552 /****************
553  * Create a head iobuf for reading from a file
554  * returns: NULL if an error occures and sets errno
555  */
556 IOBUF
557 iobuf_fdopen( int fd, const char *mode )
558 {
559     IOBUF a;
560     FILE *fp;
561     file_filter_ctx_t *fcx;
562     size_t len;
563
564     if( strchr( mode, 'w' ) )
565         log_bug("iobuf_fdopen: mode `%s' is not supported", mode);
566
567     if( !(fp = fdopen(fd, mode)) )
568         return NULL;
569     a = iobuf_alloc(1, 8192 );
570     fcx = m_alloc( sizeof *fcx + 20 );
571     fcx->fp = fp;
572     fcx->print_only_name = 1;
573     sprintf(fcx->fname, "[fd %d]", fd );
574     a->filter = file_filter;
575     a->filter_ov = fcx;
576     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
577     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
578     if( DBG_IOBUF )
579         log_debug("iobuf-%d.%d: fdopen `%s'\n", a->no, a->subno, fcx->fname );
580
581     return a;
582 }
583
584 /****************
585  * create an iobuf for writing to a file; the file will be created.
586  */
587 IOBUF
588 iobuf_create( const char *fname )
589 {
590     IOBUF a;
591     FILE *fp;
592     file_filter_ctx_t *fcx;
593     size_t len;
594     int print_only = 0;
595
596     if( !fname || (*fname=='-' && !fname[1]) ) {
597         fp = stdout;
598         fname = "[stdout]";
599         print_only = 1;
600     }
601     else if( !(fp = fopen(fname, "wb")) )
602         return NULL;
603     a = iobuf_alloc(2, 8192 );
604     fcx = m_alloc( sizeof *fcx + strlen(fname) );
605     fcx->fp = fp;
606     fcx->print_only_name = print_only;
607     strcpy(fcx->fname, fname );
608     a->filter = file_filter;
609     a->filter_ov = fcx;
610     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
611     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
612     if( DBG_IOBUF )
613         log_debug("iobuf-%d.%d: create `%s'\n", a->no, a->subno, a->desc );
614
615     return a;
616 }
617
618 /****************
619  * append to an iobuf; if the file does not exist, create it.
620  * cannot be used for stdout.
621  */
622 IOBUF
623 iobuf_append( const char *fname )
624 {
625     IOBUF a;
626     FILE *fp;
627     file_filter_ctx_t *fcx;
628     size_t len;
629
630     if( !fname )
631         return NULL;
632     else if( !(fp = fopen(fname, "ab")) )
633         return NULL;
634     a = iobuf_alloc(2, 8192 );
635     fcx = m_alloc( sizeof *fcx + strlen(fname) );
636     fcx->fp = fp;
637     strcpy(fcx->fname, fname );
638     a->filter = file_filter;
639     a->filter_ov = fcx;
640     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
641     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
642     if( DBG_IOBUF )
643         log_debug("iobuf-%d.%d: append `%s'\n", a->no, a->subno, a->desc );
644
645     return a;
646 }
647
648 IOBUF
649 iobuf_openrw( const char *fname )
650 {
651     IOBUF a;
652     FILE *fp;
653     file_filter_ctx_t *fcx;
654     size_t len;
655
656     if( !fname )
657         return NULL;
658     else if( !(fp = fopen(fname, "r+b")) )
659         return NULL;
660     a = iobuf_alloc(2, 8192 );
661     fcx = m_alloc( sizeof *fcx + strlen(fname) );
662     fcx->fp = fp;
663     strcpy(fcx->fname, fname );
664     a->filter = file_filter;
665     a->filter_ov = fcx;
666     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
667     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
668     if( DBG_IOBUF )
669         log_debug("iobuf-%d.%d: openrw `%s'\n", a->no, a->subno, a->desc );
670
671     return a;
672 }
673
674
675
676 /****************
677  * You can overwrite the normal iobuf behaviour by using this function.
678  * If used the iobuf is a simple wrapper around stdio.
679  * NULL if an error occures and sets errno
680  */
681 IOBUF
682 iobuf_fopen( const char *fname, const char *mode )
683 {
684     IOBUF a;
685     FILE *fp;
686     int print_only = 0;
687
688     if( !fname || (*fname=='-' && !fname[1])  ) {
689         fp = stdin; /* fixme: set binary mode for msdoze */
690         fname = "[stdin]";
691         print_only = 1;
692     }
693     else if( !(fp = fopen(fname, mode) ) )
694         return NULL;
695     a = iobuf_alloc(1, 8192 );
696     a->directfp = fp;
697
698     if( DBG_IOBUF )
699         log_debug("iobuf_fopen -> %p\n", a->directfp );
700
701     return a;
702 }
703
704
705
706
707 /****************
708  * Register an i/o filter.
709  */
710 int
711 iobuf_push_filter( IOBUF a,
712                    int (*f)(void *opaque, int control,
713                    IOBUF chain, byte *buf, size_t *len), void *ov )
714 {
715     IOBUF b;
716     size_t dummy_len=0;
717     int rc=0;
718
719     if( a->directfp )
720         BUG();
721
722     if( a->usage == 2 && (rc=iobuf_flush(a)) )
723         return rc;
724     /* make a copy of the current stream, so that
725      * A is the new stream and B the original one.
726      * The contents of the buffers are transferred to the
727      * new stream.
728      */
729     b = m_alloc(sizeof *b);
730     memcpy(b, a, sizeof *b );
731     /* remove the filter stuff from the new stream */
732     a->filter = NULL;
733     a->filter_ov = NULL;
734     a->filter_eof = 0;
735     if( a->usage == 2 ) { /* allocate a fresh buffer for the original stream */
736         b->d.buf = m_alloc( a->d.size );
737         b->d.len = 0;
738         b->d.start = 0;
739     }
740     else { /* allocate a fresh buffer for the new stream */
741         a->d.buf = m_alloc( a->d.size );
742         a->d.len = 0;
743         a->d.start = 0;
744     }
745     /* disable nlimit for the new stream */
746     a->ntotal = b->ntotal + b->nbytes;
747     a->nlimit = a->nbytes = 0;
748     a->nofast &= ~1;
749     /* make a link from the new stream to the original stream */
750     a->chain = b;
751     a->opaque = b->opaque;
752
753     /* setup the function on the new stream */
754     a->filter = f;
755     a->filter_ov = ov;
756
757     a->subno = b->subno + 1;
758     f( ov, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &dummy_len );
759
760     if( DBG_IOBUF ) {
761         log_debug("iobuf-%d.%d: push `%s'\n", a->no, a->subno, a->desc );
762         print_chain( a );
763     }
764
765     /* now we can initialize the new function if we have one */
766     if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_INIT, a->chain,
767                        NULL, &dummy_len)) )
768         log_error("IOBUFCTRL_INIT failed: %s\n", g10_errstr(rc) );
769     return rc;
770 }
771
772 /****************
773  * Remove an i/o filter.
774  * Only needed for iobuf_seek?
775  */
776 static int
777 pop_filter( IOBUF a, int (*f)(void *opaque, int control,
778                       IOBUF chain, byte *buf, size_t *len), void *ov )
779 {
780     IOBUF b;
781     size_t dummy_len=0;
782     int rc=0;
783
784     if( a->directfp )
785         BUG();
786
787     if( DBG_IOBUF )
788         log_debug("iobuf-%d.%d: pop `%s'\n", a->no, a->subno, a->desc );
789     if( !a->filter ) { /* this is simple */
790         b = a->chain;
791         assert(b);
792         m_free(a->d.buf);
793         memcpy(a,b, sizeof *a);
794         m_free(b);
795         return 0;
796     }
797     for(b=a ; b; b = b->chain )
798         if( b->filter == f && (!ov || b->filter_ov == ov) )
799             break;
800     if( !b )
801         log_bug("iobuf_pop_filter(): filter function not found\n");
802
803     /* flush this stream if it is an output stream */
804     if( a->usage == 2 && (rc=iobuf_flush(b)) ) {
805         log_error("iobuf_flush failed in pop_filter: %s\n", g10_errstr(rc));
806         return rc;
807     }
808     /* and tell the filter to free it self */
809     if( b->filter && (rc = b->filter(b->filter_ov, IOBUFCTRL_FREE, b->chain,
810                        NULL, &dummy_len)) ) {
811         log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
812         return rc;
813     }
814
815     /* and see how to remove it */
816     if( a == b && !b->chain )
817         log_bug("can't remove the last filter from the chain\n");
818     else if( a == b ) { /* remove the first iobuf from the chain */
819         /* everything from b is copied to a. This is save because
820          * a flush has been done on the to be removed entry
821          */
822         b = a->chain;
823         m_free(a->d.buf);
824         memcpy(a,b, sizeof *a);
825         m_free(b);
826         if( DBG_IOBUF )
827            log_debug("iobuf-%d.%d: popped filter\n", a->no, a->subno );
828     }
829     else if( !b->chain ) { /* remove the last iobuf from the chain */
830         log_bug("Ohh jeee, trying to remove a head filter\n");
831     }
832     else {  /* remove an intermediate iobuf from the chain */
833         log_bug("Ohh jeee, trying to remove an intermediate filter\n");
834     }
835
836     return rc;
837 }
838
839
840
841 /****************
842  * read underflow: read more bytes into the buffer and return
843  * the first byte or -1 on EOF.
844  */
845 static int
846 underflow(IOBUF a)
847 {
848     size_t len;
849     int rc;
850
851     assert( a->d.start == a->d.len );
852     if( a->usage == 3 )
853         return -1; /* EOF because a temp buffer can't do an underflow */
854
855     if( a->filter_eof ) {
856         if( a->chain && a->filter_eof == 1 ) {
857             IOBUF b = a->chain;
858             if( DBG_IOBUF )
859                 log_debug("iobuf-%d.%d: pop `%s' in underflow\n",
860                                         a->no, a->subno, a->desc );
861             m_free(a->d.buf);
862             memcpy(a, b, sizeof *a);
863             m_free(b);
864             print_chain(a);
865         }
866         else
867             a->filter_eof = 0;
868         if( DBG_IOBUF )
869             log_debug("iobuf-%d.%d: underflow: eof (due to filter eof)\n",
870                                                     a->no, a->subno );
871         return -1; /* return one(!) EOF */
872     }
873     if( a->error ) {
874         if( DBG_IOBUF )
875             log_debug("iobuf-%d.%d: error\n", a->no, a->subno );
876         return -1;
877     }
878
879     if( a->directfp ) {
880         FILE *fp = a->directfp;
881
882         len = fread( a->d.buf, 1, a->d.size, fp);
883         if( len < a->d.size ) {
884             if( ferror(fp) )
885                 a->error = 1;
886         }
887         a->d.len = len;
888         a->d.start = 0;
889         return len? a->d.buf[a->d.start++] : -1;
890     }
891
892
893     if( a->filter ) {
894         len = a->d.size;
895         rc = a->filter( a->filter_ov, IOBUFCTRL_UNDERFLOW, a->chain,
896                         a->d.buf, &len );
897         if( DBG_IOBUF ) {
898             log_debug("iobuf-%d.%d: underflow: req=%lu got=%lu rc=%d\n",
899                     a->no, a->subno, (ulong)a->d.size, (ulong)len, rc );
900           #if 0
901             if( a->no == 7 ) {
902                 print_string(stderr, a->d.buf, len, 0 );
903                 putc('\n', stderr );
904             }
905           #endif
906
907         }
908         if( a->usage == 1 && rc == -1 ) { /* EOF: we can remove the filter */
909             size_t dummy_len;
910
911             /* and tell the filter to free itself */
912             if( (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE, a->chain,
913                                NULL, &dummy_len)) )
914                 log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
915             a->filter = NULL;
916             a->desc = NULL;
917             a->filter_ov = NULL;
918             a->filter_eof = 1;
919             if( !len && a->chain ) {
920                 IOBUF b = a->chain;
921                 if( DBG_IOBUF )
922                     log_debug("iobuf-%d.%d: pop `%s' in underflow (!len)\n",
923                                                a->no, a->subno, a->desc );
924                 print_chain(a);
925                 m_free(a->d.buf);
926                 memcpy(a,b, sizeof *a);
927                 m_free(b);
928                 print_chain(a);
929
930
931             }
932         }
933         else if( rc )
934             a->error = 1;
935
936         if( !len ) {
937             if( DBG_IOBUF )
938                 log_debug("iobuf-%d.%d: underflow: eof\n", a->no, a->subno );
939             return -1;
940         }
941         a->d.len = len;
942         a->d.start = 0;
943         return a->d.buf[a->d.start++];
944     }
945     else {
946         if( DBG_IOBUF )
947             log_debug("iobuf-%d.%d: underflow: eof (no filter)\n",
948                                                     a->no, a->subno );
949         return -1;  /* no filter; return EOF */
950     }
951 }
952
953
954 int
955 iobuf_flush(IOBUF a)
956 {
957     size_t len;
958     int rc;
959
960     if( a->directfp )
961         return 0;
962
963     /*log_debug("iobuf-%d.%d: flush\n", a->no, a->subno );*/
964     if( a->usage == 3 ) { /* must increase the size of the temp buffer */
965         char *newbuf;
966         size_t newsize = a->d.size + 8192;
967
968         log_debug("increasing temp iobuf from %lu to %lu\n",
969                     (ulong)a->d.size, (ulong)newsize );
970         newbuf = m_alloc( newsize );
971         memcpy( newbuf, a->d.buf, a->d.len );
972         m_free(a->d.buf);
973         a->d.buf = newbuf;
974         a->d.size = newsize;
975         return 0;
976     }
977     else if( a->usage != 2 )
978         log_bug("flush on non-output iobuf\n");
979     else if( !a->filter )
980         log_bug("iobuf_flush: no filter\n");
981     len = a->d.len;
982     rc = a->filter( a->filter_ov, IOBUFCTRL_FLUSH, a->chain, a->d.buf, &len );
983     if( !rc && len != a->d.len ) {
984         log_info("iobuf_flush did not write all!\n");
985         rc = G10ERR_WRITE_FILE;
986     }
987     else if( rc )
988         a->error = 1;
989     a->d.len = 0;
990
991     return rc;
992 }
993
994
995 /****************
996  * Read a byte from the iobuf; returns -1 on EOF
997  */
998 int
999 iobuf_readbyte(IOBUF a)
1000 {
1001     int c;
1002
1003     /* nlimit does not work together with unget */
1004     /* nbytes is also not valid! */
1005     if( a->unget.buf ) {
1006         if( a->unget.start < a->unget.len )
1007             return a->unget.buf[a->unget.start++];
1008         m_free(a->unget.buf);
1009         a->unget.buf = NULL;
1010         a->nofast &= ~2;
1011     }
1012
1013     if( a->nlimit && a->nbytes >= a->nlimit )
1014         return -1; /* forced EOF */
1015
1016     if( a->d.start < a->d.len ) {
1017         c = a->d.buf[a->d.start++];
1018     }
1019     else if( (c=underflow(a)) == -1 )
1020         return -1; /* EOF */
1021
1022     a->nbytes++;
1023     return c;
1024 }
1025
1026
1027 int
1028 iobuf_read(IOBUF a, byte *buf, unsigned buflen )
1029 {
1030     int c, n;
1031
1032     if( a->unget.buf || a->nlimit ) {
1033         /* handle special cases */
1034         for(n=0 ; n < buflen; n++, buf++ ) {
1035             if( (c = iobuf_readbyte(a)) == -1 ) {
1036                 if( !n )
1037                     return -1; /* eof */
1038                 break;
1039             }
1040             else
1041                 *buf = c;
1042         }
1043         return n;
1044     }
1045
1046     n = 0;
1047     do {
1048         for( ; n < buflen && a->d.start < a->d.len; n++ )
1049             *buf++ = a->d.buf[a->d.start++];
1050         if( n < buflen ) {
1051             if( (c=underflow(a)) == -1 ) {
1052                 a->nbytes += n;
1053                 return n? n : -1/*EOF*/;
1054             }
1055             *buf++ = c; n++;
1056         }
1057     } while( n < buflen );
1058     a->nbytes += n;
1059     return n;
1060 }
1061
1062
1063 /****************
1064  * Have a look at the iobuf.
1065  * NOTE: This only works in special cases.
1066  */
1067 int
1068 iobuf_peek(IOBUF a, byte *buf, unsigned buflen )
1069 {
1070     int n=0;
1071
1072     if( a->filter_eof )
1073         return -1;
1074
1075     if( !(a->d.start < a->d.len) ) {
1076         if( underflow(a) == -1 )
1077             return -1;
1078         /* and unget this character */
1079         assert(a->d.start == 1);
1080         a->d.start = 0;
1081     }
1082
1083     for(n=0 ; n < buflen && (a->d.start+n) < a->d.len ; n++, buf++ )
1084         *buf = a->d.buf[n];
1085     return n;
1086 }
1087
1088
1089
1090
1091 int
1092 iobuf_writebyte(IOBUF a, unsigned c)
1093 {
1094
1095     if( a->directfp )
1096         BUG();
1097
1098     if( a->d.len == a->d.size )
1099         if( iobuf_flush(a) )
1100             return -1;
1101
1102     assert( a->d.len < a->d.size );
1103     a->d.buf[a->d.len++] = c;
1104     return 0;
1105 }
1106
1107
1108 int
1109 iobuf_write(IOBUF a, byte *buf, unsigned buflen )
1110 {
1111
1112     if( a->directfp )
1113         BUG();
1114
1115     do {
1116         for( ; buflen && a->d.len < a->d.size; buflen--, buf++ )
1117             a->d.buf[a->d.len++] = *buf;
1118         if( buflen ) {
1119             if( iobuf_flush(a) )
1120                 return -1;
1121         }
1122     } while( buflen );
1123     return 0;
1124 }
1125
1126
1127 int
1128 iobuf_writestr(IOBUF a, const char *buf )
1129 {
1130     for( ; *buf; buf++ )
1131         if( iobuf_writebyte(a, *buf) )
1132             return -1;
1133     return 0;
1134 }
1135
1136
1137
1138 /****************
1139  * copy the contents of TEMP to A.
1140  */
1141 int
1142 iobuf_write_temp( IOBUF a, IOBUF temp )
1143 {
1144     return iobuf_write(a, temp->d.buf, temp->d.len );
1145 }
1146
1147 /****************
1148  * copy the contents of the temp io stream to BUFFER.
1149  */
1150 size_t
1151 iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen )
1152 {
1153     size_t n = a->d.len;
1154
1155     if( n > buflen )
1156         n = buflen;
1157     memcpy( buffer, a->d.buf, n );
1158     return n;
1159 }
1160
1161 /****************
1162  * unget the contents of the temp io stream to A and close temp
1163  * Could be optimized!!
1164  */
1165 void
1166 iobuf_unget_and_close_temp( IOBUF a, IOBUF temp )
1167 {
1168     if( a->unget.buf ) {
1169         if( a->unget.start < a->unget.len )
1170             log_fatal("cannot do any more ungets on this buffer\n");
1171         /* not yet cleaned up; do it now */
1172         m_free(a->unget.buf);
1173         a->unget.buf = NULL;
1174         a->nofast &= ~2;
1175     }
1176     a->unget.size = temp->d.len;
1177     a->unget.buf = m_alloc( a->unget.size );
1178     a->nofast |= 2;
1179     a->unget.len = temp->d.len;
1180     a->unget.start = 0;
1181     memcpy( a->unget.buf, temp->d.buf, a->unget.len );
1182     iobuf_close(temp);
1183 }
1184
1185
1186 /****************
1187  * Set a limit on how many bytes may be read from the input stream A.
1188  * Setting the limit to 0 disables this feature.
1189  */
1190 void
1191 iobuf_set_limit( IOBUF a, unsigned long nlimit )
1192 {
1193     if( nlimit )
1194         a->nofast |= 1;
1195     else
1196         a->nofast &= ~1;
1197     a->nlimit = nlimit;
1198     a->ntotal += a->nbytes;
1199     a->nbytes = 0;
1200 }
1201
1202
1203
1204 /****************
1205  * Return the length of an open file
1206  */
1207 u32
1208 iobuf_get_filelength( IOBUF a )
1209 {
1210     struct stat st;
1211
1212     if( a->directfp )  {
1213         FILE *fp = a->directfp;
1214
1215         if( !fstat(fileno(fp), &st) )
1216             return st.st_size;
1217         log_error("fstat() failed: %s\n", strerror(errno) );
1218         return 0;
1219     }
1220
1221     for( ; a; a = a->chain )
1222         if( !a->chain && a->filter == file_filter ) {
1223             file_filter_ctx_t *b = a->filter_ov;
1224             FILE *fp = b->fp;
1225
1226             if( !fstat(fileno(fp), &st) )
1227                 return st.st_size;
1228             log_error("fstat() failed: %s\n", strerror(errno) );
1229             break;
1230         }
1231
1232     return 0;
1233 }
1234
1235 /****************
1236  * Tell the file position, where the next read will take place
1237  */
1238 ulong
1239 iobuf_tell( IOBUF a )
1240 {
1241     return a->ntotal + a->nbytes;
1242 }
1243
1244
1245
1246 /****************
1247  * This is a very limited implementation. It simply discards all internal
1248  * buffering and removes all filters but the first one.
1249  */
1250 int
1251 iobuf_seek( IOBUF a, ulong newpos )
1252 {
1253     file_filter_ctx_t *b = NULL;
1254
1255     if( a->directfp ) {
1256         FILE *fp = a->directfp;
1257         if( fseek( fp, newpos, SEEK_SET ) ) {
1258             log_error("can't seek to %lu: %s\n", newpos, strerror(errno) );
1259             return -1;
1260         }
1261         clearerr(fp);
1262     }
1263     else {
1264         for( ; a; a = a->chain ) {
1265             if( !a->chain && a->filter == file_filter ) {
1266                 b = a->filter_ov;
1267                 break;
1268             }
1269         }
1270         if( !a )
1271             return -1;
1272         if( fseek( b->fp, newpos, SEEK_SET ) ) {
1273             log_error("can't seek to %lu: %s\n", newpos, strerror(errno) );
1274             return -1;
1275         }
1276     }
1277     a->d.len = 0;   /* discard buffer */
1278     a->d.start = 0;
1279     a->nbytes = 0;
1280     a->nlimit = 0;
1281     a->nofast &= ~1;
1282     a->ntotal = newpos;
1283     a->error = 0;
1284     /* remove filters, but the last */
1285     if( a->chain )
1286         log_debug("pop_filter called in iobuf_seek - please report\n");
1287     while( a->chain )
1288         pop_filter( a, a->filter, NULL );
1289
1290     return 0;
1291 }
1292
1293
1294
1295
1296
1297
1298 /****************
1299  * Retrieve the real filename
1300  */
1301 static const char *
1302 get_real_fname( IOBUF a )
1303 {
1304     for( ; a; a = a->chain )
1305         if( !a->chain && a->filter == file_filter ) {
1306             file_filter_ctx_t *b = a->filter_ov;
1307             return b->print_only_name? NULL : b->fname;
1308         }
1309
1310     return NULL;
1311 }
1312
1313 /****************
1314  * Retrieve the filename
1315  */
1316 const char *
1317 iobuf_get_fname( IOBUF a )
1318 {
1319     for( ; a; a = a->chain )
1320         if( !a->chain && a->filter == file_filter ) {
1321             file_filter_ctx_t *b = a->filter_ov;
1322             return b->fname;
1323         }
1324
1325     return NULL;
1326 }
1327
1328 /****************
1329  * Start the block write mode, see rfc1991.new for details.
1330  * A value of 0 for N stops this mode (flushes and writes
1331  * the end marker)
1332  */
1333 void
1334 iobuf_set_block_mode( IOBUF a, size_t n )
1335 {
1336     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1337
1338     assert( a->usage == 1 || a->usage == 2 );
1339     ctx->usage = a->usage;
1340     if( !n ) {
1341         if( a->usage == 1 )
1342             log_debug("pop_filter called in set_block_mode - please report\n");
1343         pop_filter(a, block_filter, NULL );
1344     }
1345     else {
1346         ctx->size = n; /* only needed for usage 2 */
1347         iobuf_push_filter(a, block_filter, ctx );
1348     }
1349 }
1350
1351 /****************
1352  * enable partial block mode as described in the OpenPGP draft.
1353  * LEN is the first length byte on read, but ignored on writes.
1354  */
1355 void
1356 iobuf_set_partial_block_mode( IOBUF a, size_t len )
1357 {
1358     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1359
1360     assert( a->usage == 1 || a->usage == 2 );
1361     ctx->usage = a->usage;
1362     if( !len ) {
1363         if( a->usage == 1 )
1364             log_debug("pop_filter called in set_partial_block_mode"
1365                                                     " - please report\n");
1366         pop_filter(a, block_filter, NULL );
1367     }
1368     else {
1369         ctx->partial = 1;
1370         ctx->size = 0;
1371         ctx->first_c = len;
1372         iobuf_push_filter(a, block_filter, ctx );
1373     }
1374 }
1375
1376
1377 /****************
1378  * Checks whether the stream is in block mode
1379  * Note: This does not work if other filters are pushed on the stream.
1380  */
1381 int
1382 iobuf_in_block_mode( IOBUF a )
1383 {
1384     if( a && a->filter == block_filter )
1385         return 1; /* yes */
1386     return 0; /* no */
1387 }
1388
1389
1390 /****************
1391  * Same as fgets() but if the buffer is too short a larger one will
1392  * be allocated up to some limit *max_length.
1393  * A line is considered a byte stream ending in a LF.
1394  * Returns the length of the line. EOF is indicated by a line of
1395  * length zero. The last LF may be missing due to an EOF.
1396  * is max_length is zero on return, the line has been truncated.
1397  *
1398  * Note: The buffer is allocated with enough space to append a CR,LF,EOL
1399  */
1400 unsigned
1401 iobuf_read_line( IOBUF a, byte **addr_of_buffer,
1402                           unsigned *length_of_buffer, unsigned *max_length )
1403 {
1404     int c;
1405     char *buffer = *addr_of_buffer;
1406     unsigned length = *length_of_buffer;
1407     unsigned nbytes = 0;
1408     unsigned maxlen = *max_length;
1409     char *p;
1410
1411     if( !buffer ) { /* must allocate a new buffer */
1412         length = 256;
1413         buffer = m_alloc( length );
1414         *addr_of_buffer = buffer;
1415         *length_of_buffer = length;
1416     }
1417
1418     length -= 3; /* reserve 3 bytes (cr,lf,eol) */
1419     p = buffer;
1420     while( (c=iobuf_get(a)) != -1 ) {
1421         if( nbytes == length ) { /* increase the buffer */
1422             if( length > maxlen  ) { /* this is out limit */
1423                 /* skip the rest of the line */
1424                 while( c != '\n' && (c=iobuf_get(a)) != -1 )
1425                     ;
1426                 *p++ = '\n'; /* always append a LF (we have reserved space) */
1427                 nbytes++;
1428                 *max_length = 0; /* indicate truncation */
1429                 break;
1430             }
1431             length += 3; /* correct for the reserved byte */
1432             length += length < 1024? 256 : 1024;
1433             buffer = m_realloc( buffer, length );
1434             *addr_of_buffer = buffer;
1435             *length_of_buffer = length;
1436             length -= 3; /* and reserve again */
1437             p = buffer + nbytes;
1438         }
1439         *p++ = c;
1440         nbytes++;
1441         if( c == '\n' )
1442             break;
1443     }
1444     *p = 0; /* make sure the line is a string */
1445
1446     return nbytes;
1447 }
1448