See ChangeLog: Mon Jan 24 13:04:28 CET 2000 Werner Koch
[gnupg.git] / g10 / textfilter.c
1 /* textfilter.c
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
28 #include <gcrypt.h>
29 #include "errors.h"
30 #include "iobuf.h"
31 #include "util.h"
32 #include "filter.h"
33 #include "i18n.h"
34
35
36 #define MAX_LINELEN 19995 /* a little bit smaller than in armor.c */
37                           /* to make sure that a warning is displayed while */
38                           /* creating a message */
39
40 static unsigned
41 len_without_trailing_chars( byte *line, unsigned len, const char *trimchars )
42 {
43     byte *p, *mark;
44     unsigned n;
45
46     for(mark=NULL, p=line, n=0; n < len; n++, p++ ) {
47         if( strchr( trimchars, *p ) ) {
48             if( !mark )
49                 mark = p;
50         }
51         else
52             mark = NULL;
53     }
54
55     return mark? (mark - line) : len;
56 }
57
58 unsigned
59 len_without_trailing_ws( byte *line, unsigned len )
60 {
61     return len_without_trailing_chars( line, len, " \t\r\n" );
62 }
63
64
65
66
67 static int
68 standard( text_filter_context_t *tfx, IOBUF a,
69           byte *buf, size_t size, size_t *ret_len)
70 {
71     int rc=0;
72     size_t len = 0;
73     unsigned maxlen;
74
75     assert( size > 10 );
76     size -= 2;  /* reserve 2 bytes to append CR,LF */
77     while( !rc && len < size ) {
78         int lf_seen;
79
80         while( len < size && tfx->buffer_pos < tfx->buffer_len )
81             buf[len++] = tfx->buffer[tfx->buffer_pos++];
82         if( len >= size )
83             continue;
84
85         /* read the next line */
86         maxlen = MAX_LINELEN;
87         tfx->buffer_pos = 0;
88         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
89                                            &tfx->buffer_size, &maxlen );
90         if( !maxlen )
91             tfx->truncated++;
92         if( !tfx->buffer_len ) {
93             if( !len )
94                 rc = -1; /* eof */
95             break;
96         }
97         lf_seen = tfx->buffer[tfx->buffer_len-1] == '\n';
98         tfx->buffer_len = trim_trailing_ws( tfx->buffer, tfx->buffer_len );
99         if( lf_seen ) {
100             tfx->buffer[tfx->buffer_len++] = '\r';
101             tfx->buffer[tfx->buffer_len++] = '\n';
102         }
103     }
104     *ret_len = len;
105     return rc;
106 }
107
108
109
110
111 /****************
112  * The filter is used to make canonical text: Lines are terminated by
113  * CR, LF, trailing white spaces are removed.
114  */
115 int
116 text_filter( void *opaque, int control,
117              IOBUF a, byte *buf, size_t *ret_len)
118 {
119     size_t size = *ret_len;
120     text_filter_context_t *tfx = opaque;
121     int rc=0;
122
123     if( control == IOBUFCTRL_UNDERFLOW ) {
124         rc = standard( tfx, a, buf, size, ret_len );
125     }
126     else if( control == IOBUFCTRL_FREE ) {
127         if( tfx->truncated )
128             log_error(_("can't handle text lines longer than %d characters\n"),
129                         MAX_LINELEN );
130         gcry_free( tfx->buffer );
131         tfx->buffer = NULL;
132     }
133     else if( control == IOBUFCTRL_DESC )
134         *(char**)buf = "text_filter";
135     return rc;
136 }
137
138
139 /****************
140  * Copy data from INP to OUT and do some escaping if requested.
141  * md is updated as required by rfc2440
142  */
143 int
144 copy_clearsig_text( IOBUF out, IOBUF inp, GCRY_MD_HD md,
145                     int escape_dash, int escape_from, int pgp2mode )
146 {
147     unsigned maxlen;
148     byte *buffer = NULL;    /* malloced buffer */
149     unsigned bufsize;       /* and size of this buffer */
150     unsigned n;
151     int truncated = 0;
152     int pending_lf = 0;
153
154     if( !escape_dash )
155         escape_from = 0;
156
157     for(;;) {
158         maxlen = MAX_LINELEN;
159         n = iobuf_read_line( inp, &buffer, &bufsize, &maxlen );
160         if( !maxlen )
161             truncated++;
162
163         if( !n )
164             break; /* read_line has returned eof */
165
166         /* update the message digest */
167         if( escape_dash ) {
168             if( pending_lf ) {
169                 gcry_md_putc( md, '\r' );
170                 gcry_md_putc( md, '\n' );
171             }
172             gcry_md_write( md, buffer,
173                      len_without_trailing_chars( buffer, n,
174                                                  pgp2mode? " \r\n":" \t\r\n"));
175         }
176         else
177             gcry_md_write( md, buffer, n );
178         pending_lf = buffer[n-1] == '\n';
179
180         /* write the output */
181         if(    ( escape_dash && *buffer == '-')
182             || ( escape_from && n > 4 && !memcmp(buffer, "From ", 5 ) ) ) {
183             iobuf_put( out, '-' );
184             iobuf_put( out, ' ' );
185         }
186         iobuf_write( out, buffer, n );
187     }
188
189     /* at eof */
190     if( !pending_lf ) { /* make sure that the file ends with a LF */
191         iobuf_put( out, '\n');
192         if( !escape_dash )
193             gcry_md_putc( md, '\n' );
194     }
195
196     if( truncated )
197         log_info(_("input line longer than %d characters\n"), MAX_LINELEN );
198
199     return 0; /* okay */
200 }
201