use of EXTSEP_S
[gnupg.git] / g10 / textfilter.c
1 /* textfilter.c
2  * Copyright (C) 1998, 1999, 2000, 2001 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 unsigned
65 len_without_trailing_ws( byte *line, unsigned len )
66 {
67     return len_without_trailing_chars( line, len, " \t\r\n" );
68 }
69
70
71
72
73 static int
74 standard( text_filter_context_t *tfx, IOBUF a,
75           byte *buf, size_t size, size_t *ret_len)
76 {
77     int rc=0;
78     size_t len = 0;
79     unsigned maxlen;
80
81     assert( size > 10 );
82     size -= 2;  /* reserve 2 bytes to append CR,LF */
83     while( !rc && len < size ) {
84         int lf_seen;
85
86         while( len < size && tfx->buffer_pos < tfx->buffer_len )
87             buf[len++] = tfx->buffer[tfx->buffer_pos++];
88         if( len >= size )
89             continue;
90
91         /* read the next line */
92         maxlen = MAX_LINELEN;
93         tfx->buffer_pos = 0;
94         tfx->buffer_len = iobuf_read_line( a, &tfx->buffer,
95                                            &tfx->buffer_size, &maxlen );
96         if( !maxlen )
97             tfx->truncated++;
98         if( !tfx->buffer_len ) {
99             if( !len )
100                 rc = -1; /* eof */
101             break;
102         }
103         lf_seen = tfx->buffer[tfx->buffer_len-1] == '\n';
104         tfx->buffer_len = trim_trailing_ws( tfx->buffer, tfx->buffer_len );
105         if( lf_seen ) {
106             tfx->buffer[tfx->buffer_len++] = '\r';
107             tfx->buffer[tfx->buffer_len++] = '\n';
108         }
109     }
110     *ret_len = len;
111     return rc;
112 }
113
114
115
116
117 /****************
118  * The filter is used to make canonical text: Lines are terminated by
119  * CR, LF, trailing white spaces are removed.
120  */
121 int
122 text_filter( void *opaque, int control,
123              IOBUF a, byte *buf, size_t *ret_len)
124 {
125     size_t size = *ret_len;
126     text_filter_context_t *tfx = opaque;
127     int rc=0;
128
129     if( control == IOBUFCTRL_UNDERFLOW ) {
130         rc = standard( tfx, a, buf, size, ret_len );
131     }
132     else if( control == IOBUFCTRL_FREE ) {
133         if( tfx->truncated )
134             log_error(_("can't handle text lines longer than %d characters\n"),
135                         MAX_LINELEN );
136         m_free( tfx->buffer );
137         tfx->buffer = NULL;
138     }
139     else if( control == IOBUFCTRL_DESC )
140         *(char**)buf = "text_filter";
141     return rc;
142 }
143
144
145 /****************
146  * Copy data from INP to OUT and do some escaping if requested.
147  * md is updated as required by rfc2440
148  */
149 int
150 copy_clearsig_text( IOBUF out, IOBUF inp, MD_HANDLE md,
151                     int escape_dash, int escape_from, int pgp2mode )
152 {
153     unsigned maxlen;
154     byte *buffer = NULL;    /* malloced buffer */
155     unsigned bufsize;       /* and size of this buffer */
156     unsigned n;
157     int truncated = 0;
158     int pending_lf = 0;
159
160     if( !opt.pgp2_workarounds )
161         pgp2mode = 0;
162
163     if( !escape_dash )
164         escape_from = 0;
165
166     for(;;) {
167         maxlen = MAX_LINELEN;
168         n = iobuf_read_line( inp, &buffer, &bufsize, &maxlen );
169         if( !maxlen )
170             truncated++;
171
172         if( !n )
173             break; /* read_line has returned eof */
174
175         /* update the message digest */
176         if( escape_dash ) {
177             if( pending_lf ) {
178                 md_putc( md, '\r' );
179                 md_putc( md, '\n' );
180             }
181             md_write( md, buffer,
182                      len_without_trailing_chars( buffer, n,
183                                                  pgp2mode? " \r\n":" \t\r\n"));
184         }
185         else
186             md_write( md, buffer, n );
187         pending_lf = buffer[n-1] == '\n';
188
189         /* write the output */
190         if(    ( escape_dash && *buffer == '-')
191             || ( escape_from && n > 4 && !memcmp(buffer, "From ", 5 ) ) ) {
192             iobuf_put( out, '-' );
193             iobuf_put( out, ' ' );
194         }
195
196       #if  0 /*defined(HAVE_DOSISH_SYSTEM)*/
197         /* We don't use this anymore because my interpretation of rfc2440 7.1
198          * is that there is no conversion needed.  If one decides to
199          * clearsign a unix file on a DOS box he will get a mixed line endings.
200          * If at some point it turns out, that a conversion is a nice feature
201          * we can make an option out of it.
202          */
203         /* make sure the lines do end in CR,LF */
204         if( n > 1 && ( (buffer[n-2] == '\r' && buffer[n-1] == '\n' )
205                             || (buffer[n-2] == '\n' && buffer[n-1] == '\r'))) {
206             iobuf_write( out, buffer, n-2 );
207             iobuf_put( out, '\r');
208             iobuf_put( out, '\n');
209         }
210         else if( n && buffer[n-1] == '\n' ) {
211             iobuf_write( out, buffer, n-1 );
212             iobuf_put( out, '\r');
213             iobuf_put( out, '\n');
214         }
215         else
216             iobuf_write( out, buffer, n );
217
218       #else
219         iobuf_write( out, buffer, n );
220       #endif
221     }
222
223     /* at eof */
224     if( !pending_lf ) { /* make sure that the file ends with a LF */
225         iobuf_writestr( out, LF );
226         if( !escape_dash )
227             md_putc( md, '\n' );
228     }
229
230     if( truncated )
231         log_info(_("input line longer than %d characters\n"), MAX_LINELEN );
232
233     return 0; /* okay */
234 }
235