See ChangeLog: Wed Jan 20 18:59:49 CET 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 "errors.h"
29 #include "iobuf.h"
30 #include "memory.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 unsigned
41 len_without_trailing_ws( byte *line, unsigned len )
42 {
43     byte *p, *mark;
44     unsigned n;
45
46     for(mark=NULL, p=line, n=0; n < len; n++, p++ ) {
47         if( strchr(" \t\r\n", *p ) ) {
48             if( !mark )
49                 mark = p;
50         }
51         else
52             mark = NULL;
53     }
54
55     return mark? (mark - line) : len;
56 }
57
58
59
60
61 static int
62 standard( text_filter_context_t *tfx, IOBUF a,
63           byte *buf, size_t size, size_t *ret_len)
64 {
65     int rc=0;
66     size_t len = 0;
67     unsigned maxlen;
68
69     assert( size > 10 );
70     size -= 2;  /* reserve 2 bytes to append CR,LF */
71     while( !rc && len < size ) {
72         int lf_seen;
73
74         while( len < size && tfx->buffer_pos < tfx->buffer_len )
75             buf[len++] = tfx->buffer[tfx->buffer_pos++];
76         if( len >= size )
77             continue;
78
79         /* read the next line */
80         maxlen = MAX_LINELEN;
81         tfx->buffer_pos = 0;
82         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
83                                            &tfx->buffer_size, &maxlen );
84         if( !maxlen )
85             tfx->truncated++;
86         if( !tfx->buffer_len ) {
87             if( !len )
88                 rc = -1; /* eof */
89             break;
90         }
91         lf_seen = tfx->buffer[tfx->buffer_len-1] == '\n';
92         tfx->buffer_len = trim_trailing_ws( tfx->buffer, tfx->buffer_len );
93         if( lf_seen ) {
94             tfx->buffer[tfx->buffer_len++] = '\r';
95             tfx->buffer[tfx->buffer_len++] = '\n';
96         }
97     }
98     *ret_len = len;
99     return rc;
100 }
101
102 static int
103 clearsign( text_filter_context_t *tfx, IOBUF a,
104             byte *buf, size_t size, size_t *ret_len)
105 {
106     int rc=0;
107     size_t len = 0;
108     unsigned maxlen;
109
110     assert( size > 2 );
111     size -= 3;  /* reserve for dash escaping and extra LF */
112     while( !rc && len < size ) {
113         unsigned n;
114         byte *p;
115
116         if( tfx->pending_esc ) {
117             buf[len++] = '-';
118             buf[len++] = ' ';
119             tfx->pending_esc = 0;
120         }
121         while( len < size && tfx->buffer_pos < tfx->buffer_len )
122             buf[len++] = tfx->buffer[tfx->buffer_pos++];
123         if( len >= size )
124             continue;
125
126         /* read the next line */
127         maxlen = MAX_LINELEN;
128         tfx->buffer_pos = 0;
129         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
130                                            &tfx->buffer_size, &maxlen );
131         p = tfx->buffer;
132         n = tfx->buffer_len;
133         if( !maxlen )
134             tfx->truncated++;
135         if( !n ) { /* readline has returned eof */
136             /* don't hash a pending lf here because the last one is
137              * not part of the signed material. OpenPGP does not
138              * hash the last LF because it may have to add an
139              * extra one in case that the original material
140              * does not end with one.  The clear signed text
141              * must end in a LF, so that the following armor
142              * line can be detected by the parser
143              */
144             if( !tfx->pending_lf ) {
145                 /* make sure that the file ends with a LF */
146                 buf[len++] = '\n';
147                 if( tfx->not_dash_escaped )
148                     md_putc(tfx->md, '\n' );
149                 tfx->pending_lf = 1;
150             }
151             if( !len )
152                 rc = -1; /* eof */
153             break;
154         }
155         if( tfx->md ) {
156             if( tfx->not_dash_escaped )
157                 md_write( tfx->md, p, n );
158             else {
159                 if( tfx->pending_lf ) {
160                     md_putc(tfx->md, '\r' );
161                     md_putc(tfx->md, '\n' );
162                 }
163                 md_write( tfx->md, p, len_without_trailing_ws( p, n ) );
164             }
165         }
166         tfx->pending_lf = p[n-1] == '\n';
167         if( tfx->not_dash_escaped )
168             ;
169         else if( *p == '-' )
170             tfx->pending_esc = 1;
171         else if( tfx->escape_from && n > 4 && !memcmp(p, "From ", 5 ) )
172             tfx->pending_esc = 1;
173     }
174     *ret_len = len;
175     return rc;
176 }
177
178
179 /****************
180  * The filter is used to make canonical text: Lines are terminated by
181  * CR, LF, trailing white spaces are removed.
182  */
183 int
184 text_filter( void *opaque, int control,
185              IOBUF a, byte *buf, size_t *ret_len)
186 {
187     size_t size = *ret_len;
188     text_filter_context_t *tfx = opaque;
189     int rc=0;
190
191     if( control == IOBUFCTRL_UNDERFLOW ) {
192         if( tfx->clearsign )
193             rc = clearsign( tfx, a, buf, size, ret_len );
194         else
195             rc = standard( tfx, a, buf, size, ret_len );
196     }
197     else if( control == IOBUFCTRL_FREE ) {
198         if( tfx->truncated )
199             log_error(_("can't handle text lines longer than %d characters\n"),
200                         MAX_LINELEN );
201         m_free( tfx->buffer );
202         tfx->buffer = NULL;
203     }
204     else if( control == IOBUFCTRL_DESC )
205         *(char**)buf = "text_filter";
206     return rc;
207 }
208
209
210