Minor fixes
[gnupg.git] / g10 / textfilter.c
1 /* textfilter.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2004 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 "errors.h"
29 #include "iobuf.h"
30 #include "memory.h"
31 #include "util.h"
32 #include "filter.h"
33 #include "i18n.h"
34 #include "options.h"
35
36 #ifdef HAVE_DOSISH_SYSTEM
37 #define LF "\r\n"
38 #else
39 #define LF "\n"
40 #endif
41
42 #define MAX_LINELEN 19995 /* a little bit smaller than in armor.c */
43                           /* to make sure that a warning is displayed while */
44                           /* creating a message */
45
46 static unsigned
47 len_without_trailing_chars( byte *line, unsigned len, const char *trimchars )
48 {
49     byte *p, *mark;
50     unsigned n;
51
52     for(mark=NULL, p=line, n=0; n < len; n++, p++ ) {
53         if( strchr( trimchars, *p ) ) {
54             if( !mark )
55                 mark = p;
56         }
57         else
58             mark = NULL;
59     }
60
61     return mark? (mark - line) : len;
62 }
63
64
65 static int
66 standard( text_filter_context_t *tfx, IOBUF a,
67           byte *buf, size_t size, size_t *ret_len)
68 {
69     int rc=0;
70     size_t len = 0;
71     unsigned maxlen;
72
73     assert( size > 10 );
74     size -= 2;  /* reserve 2 bytes to append CR,LF */
75     while( !rc && len < size ) {
76         int lf_seen;
77
78         while( len < size && tfx->buffer_pos < tfx->buffer_len )
79             buf[len++] = tfx->buffer[tfx->buffer_pos++];
80         if( len >= size )
81             continue;
82
83         /* read the next line */
84         maxlen = MAX_LINELEN;
85         tfx->buffer_pos = 0;
86         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
87                                            &tfx->buffer_size, &maxlen );
88         if( !maxlen )
89             tfx->truncated++;
90         if( !tfx->buffer_len ) {
91             if( !len )
92                 rc = -1; /* eof */
93             break;
94         }
95         lf_seen = tfx->buffer[tfx->buffer_len-1] == '\n';
96
97         /* The story behind this is that 2440 says that textmode
98            hashes should canonicalize line endings to CRLF and remove
99            spaces and tabs.  2440bis-12 says to just canonicalize to
100            CRLF.  So, we default to the 2440bis-12 behavior, but
101            revert to the strict 2440 behavior if the user specifies
102            --rfc2440. In practical terms this makes no difference to
103            any signatures in the real world except for a textmode
104            detached signature.  PGP always used the 2440bis-12 (1991)
105            behavior (ignoring 2440 itself), so this actually makes us
106            compatible with PGP textmode detached signatures for the
107            first time. */
108         if(RFC2440)
109           tfx->buffer_len=trim_trailing_chars(tfx->buffer,tfx->buffer_len,
110                                               " \t\r\n");
111         else
112           tfx->buffer_len=trim_trailing_chars(tfx->buffer,tfx->buffer_len,
113                                               "\r\n");
114
115         if( lf_seen ) {
116             tfx->buffer[tfx->buffer_len++] = '\r';
117             tfx->buffer[tfx->buffer_len++] = '\n';
118         }
119     }
120     *ret_len = len;
121     return rc;
122 }
123
124
125 /****************
126  * The filter is used to make canonical text: Lines are terminated by
127  * CR, LF, trailing white spaces are removed.
128  */
129 int
130 text_filter( void *opaque, int control,
131              IOBUF a, byte *buf, size_t *ret_len)
132 {
133     size_t size = *ret_len;
134     text_filter_context_t *tfx = opaque;
135     int rc=0;
136
137     if( control == IOBUFCTRL_UNDERFLOW ) {
138         rc = standard( tfx, a, buf, size, ret_len );
139     }
140     else if( control == IOBUFCTRL_FREE ) {
141         if( tfx->truncated )
142             log_error(_("can't handle text lines longer than %d characters\n"),
143                         MAX_LINELEN );
144         m_free( tfx->buffer );
145         tfx->buffer = NULL;
146     }
147     else if( control == IOBUFCTRL_DESC )
148         *(char**)buf = "text_filter";
149     return rc;
150 }
151
152
153 /****************
154  * Copy data from INP to OUT and do some escaping if requested.
155  * md is updated as required by rfc2440
156  */
157 int
158 copy_clearsig_text( IOBUF out, IOBUF inp, MD_HANDLE md,
159                     int escape_dash, int escape_from, int pgp2mode )
160 {
161     unsigned maxlen;
162     byte *buffer = NULL;    /* malloced buffer */
163     unsigned bufsize;       /* and size of this buffer */
164     unsigned n;
165     int truncated = 0;
166     int pending_lf = 0;
167
168     if( !opt.pgp2_workarounds )
169         pgp2mode = 0;
170
171     if( !escape_dash )
172         escape_from = 0;
173
174     for(;;) {
175         maxlen = MAX_LINELEN;
176         n = iobuf_read_line( inp, &buffer, &bufsize, &maxlen );
177         if( !maxlen )
178             truncated++;
179
180         if( !n )
181             break; /* read_line has returned eof */
182
183         /* update the message digest */
184         if( escape_dash ) {
185             if( pending_lf ) {
186                 md_putc( md, '\r' );
187                 md_putc( md, '\n' );
188             }
189             md_write( md, buffer,
190                      len_without_trailing_chars( buffer, n,
191                                                  pgp2mode? " \r\n":" \t\r\n"));
192         }
193         else
194             md_write( md, buffer, n );
195         pending_lf = buffer[n-1] == '\n';
196
197         /* write the output */
198         if(    ( escape_dash && *buffer == '-')
199             || ( escape_from && n > 4 && !memcmp(buffer, "From ", 5 ) ) ) {
200             iobuf_put( out, '-' );
201             iobuf_put( out, ' ' );
202         }
203
204 #if  0 /*defined(HAVE_DOSISH_SYSTEM)*/
205         /* We don't use this anymore because my interpretation of rfc2440 7.1
206          * is that there is no conversion needed.  If one decides to
207          * clearsign a unix file on a DOS box he will get a mixed line endings.
208          * If at some point it turns out, that a conversion is a nice feature
209          * we can make an option out of it.
210          */
211         /* make sure the lines do end in CR,LF */
212         if( n > 1 && ( (buffer[n-2] == '\r' && buffer[n-1] == '\n' )
213                             || (buffer[n-2] == '\n' && buffer[n-1] == '\r'))) {
214             iobuf_write( out, buffer, n-2 );
215             iobuf_put( out, '\r');
216             iobuf_put( out, '\n');
217         }
218         else if( n && buffer[n-1] == '\n' ) {
219             iobuf_write( out, buffer, n-1 );
220             iobuf_put( out, '\r');
221             iobuf_put( out, '\n');
222         }
223         else
224             iobuf_write( out, buffer, n );
225
226 #else
227         iobuf_write( out, buffer, n );
228 #endif
229     }
230
231     /* at eof */
232     if( !pending_lf ) { /* make sure that the file ends with a LF */
233         iobuf_writestr( out, LF );
234         if( !escape_dash )
235             md_putc( md, '\n' );
236     }
237
238     if( truncated )
239         log_info(_("input line longer than %d characters\n"), MAX_LINELEN );
240
241     return 0; /* okay */
242 }