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