Updated FSF street address and preparations for a release candidate.
[gnupg.git] / util / ttyio.c
1 /* ttyio.c -  tty i/O functions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22
23 #include <config.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <stdarg.h>
28 #include <unistd.h>
29 #ifdef HAVE_TCGETATTR
30 #include <termios.h>
31 #else
32 #ifdef HAVE_TERMIO_H
33 /* simulate termios with termio */
34 #include <termio.h>
35 #define termios termio
36 #define tcsetattr ioctl
37 #define TCSAFLUSH TCSETAF
38 #define tcgetattr(A,B) ioctl(A,TCGETA,B)
39 #define HAVE_TCGETATTR
40 #endif
41 #endif
42 #ifdef _WIN32 /* use the odd Win32 functions */
43 #include <windows.h>
44 #ifdef HAVE_TCGETATTR
45 #error windows and termios
46 #endif
47 #endif
48 #include <errno.h>
49 #include <ctype.h>
50 #ifdef HAVE_LIBREADLINE
51 #include <readline/readline.h>
52 #include <readline/history.h>
53 #endif
54
55 #include "util.h"
56 #include "memory.h"
57 #include "ttyio.h"
58
59 #define CONTROL_D ('D' - 'A' + 1)
60
61 #ifdef _WIN32 /* use the odd Win32 functions */
62 static struct {
63     HANDLE in, out;
64 } con;
65 #define DEF_INPMODE  (ENABLE_LINE_INPUT|ENABLE_ECHO_INPUT    \
66                                         |ENABLE_PROCESSED_INPUT )
67 #define HID_INPMODE  (ENABLE_LINE_INPUT|ENABLE_PROCESSED_INPUT )
68 #define DEF_OUTMODE  (ENABLE_WRAP_AT_EOL_OUTPUT|ENABLE_PROCESSED_OUTPUT)
69
70 #else /* yeah, we have a real OS */
71 static FILE *ttyfp = NULL;
72 #endif
73
74 static int initialized;
75 static int last_prompt_len;
76 static int batchmode;
77 static int no_terminal;
78
79 #ifdef HAVE_TCGETATTR
80     static struct termios termsave;
81     static int restore_termios;
82 #endif
83
84
85
86 /* This is a wrapper around ttyname so that we can use it even when
87    the standard streams are redirected.  It figures the name out the
88    first time and returns it in a statically allocated buffer. */
89 const char *
90 tty_get_ttyname (void)
91 {
92   static char *name;
93
94   /* On a GNU system ctermid() always return /dev/tty, so this does
95      not make much sense - however if it is ever changed we do the
96      Right Thing now. */
97 #ifdef HAVE_CTERMID
98   static int got_name;
99
100   if (!got_name)
101     {
102       const char *s;
103       s = ctermid (NULL);
104       if (s)
105         name = strdup (s);
106       got_name = 1;
107     }
108 #endif
109   /* Assume the standard tty on memory error or when there is no
110      ctermid. */
111   return name? name : "/dev/tty";
112 }
113
114
115 #ifdef HAVE_TCGETATTR
116 static void
117 cleanup(void)
118 {
119     if( restore_termios ) {
120         restore_termios = 0; /* do it prios in case it is interrupted again */
121         if( tcsetattr(fileno(ttyfp), TCSAFLUSH, &termsave) )
122             log_error("tcsetattr() failed: %s\n", strerror(errno) );
123     }
124 }
125 #endif
126
127 static void
128 init_ttyfp(void)
129 {
130     if( initialized )
131         return;
132
133 #if defined(_WIN32)
134     {
135         SECURITY_ATTRIBUTES sa;
136
137         memset(&sa, 0, sizeof(sa));
138         sa.nLength = sizeof(sa);
139         sa.bInheritHandle = TRUE;
140         con.out = CreateFileA( "CONOUT$", GENERIC_READ|GENERIC_WRITE,
141                                FILE_SHARE_READ|FILE_SHARE_WRITE,
142                                &sa, OPEN_EXISTING, 0, 0 );
143         if( con.out == INVALID_HANDLE_VALUE )
144             log_fatal ("open(CONOUT$) failed: %s", w32_strerror (0));
145         memset(&sa, 0, sizeof(sa));
146         sa.nLength = sizeof(sa);
147         sa.bInheritHandle = TRUE;
148         con.in = CreateFileA( "CONIN$", GENERIC_READ|GENERIC_WRITE,
149                                FILE_SHARE_READ|FILE_SHARE_WRITE,
150                                &sa, OPEN_EXISTING, 0, 0 );
151         if (con.in == INVALID_HANDLE_VALUE)
152             log_fatal ("open(CONIN$) failed: %s", w32_strerror (0));
153     }
154     SetConsoleMode(con.in, DEF_INPMODE );
155     SetConsoleMode(con.out, DEF_OUTMODE );
156
157 #elif defined(__EMX__)
158     ttyfp = stdout; /* Fixme: replace by the real functions: see wklib */
159 #else
160     ttyfp = batchmode? stderr : fopen( tty_get_ttyname (), "r+");
161     if( !ttyfp ) {
162         log_error("cannot open `%s': %s\n",
163                   tty_get_ttyname (), strerror(errno) );
164         exit(2);
165     }
166 #ifdef HAVE_LIBREADLINE
167     rl_catch_signals = 0;
168     rl_instream = rl_outstream = ttyfp;
169     rl_inhibit_completion = 1;
170 #endif
171 #endif
172 #ifdef HAVE_TCGETATTR
173     atexit( cleanup );
174 #endif
175     initialized = 1;
176 }
177
178 #ifdef HAVE_LIBREADLINE
179 void
180 tty_enable_completion(rl_completion_func_t *completer)
181 {
182   if( !initialized )
183     init_ttyfp();
184   rl_attempted_completion_function=completer;
185   rl_inhibit_completion=0;
186 }
187
188 void
189 tty_disable_completion(void)
190 {
191   if( !initialized )
192     init_ttyfp();
193   rl_inhibit_completion=1;
194 }
195 #endif /*HAVE_LIBREADLINE*/
196
197 int
198 tty_batchmode( int onoff )
199 {
200     int old = batchmode;
201     if( onoff != -1 )
202         batchmode = onoff;
203     return old;
204 }
205
206 int
207 tty_no_terminal(int onoff)
208 {
209     int old = no_terminal;
210     no_terminal = onoff ? 1 : 0;
211     return old;
212 }
213
214 void
215 tty_printf( const char *fmt, ... )
216 {
217     va_list arg_ptr;
218
219     if (no_terminal)
220         return;
221
222     if( !initialized )
223         init_ttyfp();
224
225     va_start( arg_ptr, fmt ) ;
226 #ifdef _WIN32
227     {   
228         char *buf = NULL;
229         int n;
230         DWORD nwritten;
231
232         n = vasprintf(&buf, fmt, arg_ptr);
233         if( !buf )
234             log_bug("vasprintf() failed\n");
235         
236         if (!WriteConsoleA (con.out, buf, n, &nwritten, NULL))
237             log_fatal ("WriteConsole failed: %s", w32_strerror (0));
238         if( n != nwritten )
239             log_fatal ("WriteConsole failed: %d != %d\n", n, (int)nwritten );
240         last_prompt_len += n;
241         m_free (buf);
242     }
243 #else
244     last_prompt_len += vfprintf(ttyfp,fmt,arg_ptr) ;
245     fflush(ttyfp);
246 #endif
247     va_end(arg_ptr);
248 }
249
250
251 /* Same as tty_printf but if FP is not NULL, behave like the standard
252    fprintf. */
253 void
254 tty_fprintf (FILE *fp, const char *fmt, ... )
255 {
256   va_list arg_ptr;
257
258   if (fp)
259     {
260       va_start (arg_ptr, fmt) ;
261       vfprintf (fp, fmt, arg_ptr );
262       va_end (arg_ptr);
263       return;
264     }
265
266   if (no_terminal)
267     return;
268
269   if( !initialized )
270     init_ttyfp();
271
272     va_start( arg_ptr, fmt ) ;
273 #ifdef _WIN32
274     {   
275         char *buf = NULL;
276         int n;
277         DWORD nwritten;
278
279         n = vasprintf(&buf, fmt, arg_ptr);
280         if( !buf )
281             log_bug("vasprintf() failed\n");
282         
283         if (!WriteConsoleA (con.out, buf, n, &nwritten, NULL))
284             log_fatal ("WriteConsole failed: %s", w32_strerror (0));
285         if (n != nwritten)
286             log_fatal ("WriteConsole failed: %d != %d\n", n, (int)nwritten);
287         last_prompt_len += n;
288         xfree (buf);
289     }
290 #else
291     last_prompt_len += vfprintf(ttyfp,fmt,arg_ptr) ;
292     fflush(ttyfp);
293 #endif
294     va_end(arg_ptr);
295 }
296
297
298 /****************
299  * Print a string, but filter all control characters out.
300  */
301 void
302 tty_print_string( const byte *p, size_t n )
303 {
304     if (no_terminal)
305         return;
306
307     if( !initialized )
308         init_ttyfp();
309
310 #ifdef _WIN32
311     /* not so effective, change it if you want */
312     for( ; n; n--, p++ )
313         if( iscntrl( *p ) ) {
314             if( *p == '\n' )
315                 tty_printf("\\n");
316             else if( !*p )
317                 tty_printf("\\0");
318             else
319                 tty_printf("\\x%02x", *p);
320         }
321         else
322             tty_printf("%c", *p);
323 #else
324     for( ; n; n--, p++ )
325         if( iscntrl( *p ) ) {
326             putc('\\', ttyfp);
327             if( *p == '\n' )
328                 putc('n', ttyfp);
329             else if( !*p )
330                 putc('0', ttyfp);
331             else
332                 fprintf(ttyfp, "x%02x", *p );
333         }
334         else
335             putc(*p, ttyfp);
336 #endif
337 }
338
339 void
340 tty_print_utf8_string2 (const byte *p, size_t n, size_t max_n )
341 {
342     size_t i;
343     char *buf;
344
345     if (no_terminal)
346         return;
347
348     /* we can handle plain ascii simpler, so check for it first */
349     for(i=0; i < n; i++ ) {
350         if( p[i] & 0x80 )
351             break;
352     }
353     if( i < n ) {
354         buf = utf8_to_native( p, n, 0 );
355         if( max_n && (strlen( buf ) > max_n )) {
356             buf[max_n] = 0;
357         }
358         /*(utf8 conversion already does the control character quoting)*/
359         tty_printf("%s", buf );
360         m_free( buf );
361     }
362     else {
363         if( max_n && (n > max_n) ) {
364             n = max_n;
365         }
366         tty_print_string( p, n );
367     }
368 }
369
370 void
371 tty_print_utf8_string( const byte *p, size_t n )
372 {
373     tty_print_utf8_string2( p, n, 0 );
374 }
375
376
377 static char *
378 do_get( const char *prompt, int hidden )
379 {
380     char *buf;
381 #ifndef __riscos__
382     byte cbuf[1];
383 #endif
384     int c, n, i;
385
386     if( batchmode ) {
387         log_error("Sorry, we are in batchmode - can't get input\n");
388         exit(2);
389     }
390
391     if (no_terminal) {
392         log_error("Sorry, no terminal at all requested - can't get input\n");
393         exit(2);
394     }
395
396     if( !initialized )
397         init_ttyfp();
398
399     last_prompt_len = 0;
400     tty_printf( "%s", prompt );
401     buf = m_alloc(n=50);
402     i = 0;
403
404 #ifdef _WIN32 /* windoze version */
405     if( hidden )
406         SetConsoleMode(con.in, HID_INPMODE );
407
408     for(;;) {
409         DWORD nread;
410
411         if (!ReadConsoleA (con.in, cbuf, 1, &nread, NULL))
412             log_fatal ("ReadConsole failed: %s", w32_strerror (0));
413         if( !nread )
414             continue;
415         if( *cbuf == '\n' )
416             break;
417
418         if( !hidden )
419             last_prompt_len++;
420         c = *cbuf;
421         if( c == '\t' )
422             c = ' ';
423         else if( c > 0xa0 )
424             ; /* we don't allow 0xa0, as this is a protected blank which may
425                * confuse the user */
426         else if( iscntrl(c) )
427             continue;
428         if( !(i < n-1) ) {
429             n += 50;
430             buf = m_realloc( buf, n );
431         }
432         buf[i++] = c;
433     }
434
435     if( hidden )
436         SetConsoleMode(con.in, DEF_INPMODE );
437
438 #elif defined(__riscos__)
439     do {
440         c = riscos_getchar();
441         if (c == 0xa || c == 0xd) { /* Return || Enter */
442             c = (int) '\n';
443         } else if (c == 0x8 || c == 0x7f) { /* Backspace || Delete */
444             if (i>0) {
445                 i--;
446                 if (!hidden) {
447                     last_prompt_len--;
448                     fputc(8, ttyfp);
449                     fputc(32, ttyfp);
450                     fputc(8, ttyfp);
451                     fflush(ttyfp);
452                 }
453             } else {
454                 fputc(7, ttyfp);
455                 fflush(ttyfp);
456             }
457             continue;
458         } else if (c == (int) '\t') { /* Tab */
459             c = ' ';
460         } else if (c > 0xa0) {
461             ; /* we don't allow 0xa0, as this is a protected blank which may
462                * confuse the user */
463         } else if (iscntrl(c)) {
464             continue;
465         }
466         if(!(i < n-1)) {
467             n += 50;
468             buf = m_realloc(buf, n);
469         }
470         buf[i++] = c;
471         if (!hidden) {
472             last_prompt_len++;
473             fputc(c, ttyfp);
474             fflush(ttyfp);
475         }
476     } while (c != '\n');
477     i = (i>0) ? i-1 : 0;
478 #else /* unix version */
479     if( hidden ) {
480 #ifdef HAVE_TCGETATTR
481         struct termios term;
482
483         if( tcgetattr(fileno(ttyfp), &termsave) )
484             log_fatal("tcgetattr() failed: %s\n", strerror(errno) );
485         restore_termios = 1;
486         term = termsave;
487         term.c_lflag &= ~(ECHO | ECHOE | ECHOK | ECHONL);
488         if( tcsetattr( fileno(ttyfp), TCSAFLUSH, &term ) )
489             log_fatal("tcsetattr() failed: %s\n", strerror(errno) );
490 #endif
491     }
492
493     /* fixme: How can we avoid that the \n is echoed w/o disabling
494      * canonical mode - w/o this kill_prompt can't work */
495     while( read(fileno(ttyfp), cbuf, 1) == 1 && *cbuf != '\n' ) {
496         if( !hidden )
497             last_prompt_len++;
498         c = *cbuf;
499         if( c == CONTROL_D )
500             log_info("control d found\n");
501         if( c == '\t' )
502             c = ' ';
503         else if( c > 0xa0 )
504             ; /* we don't allow 0xa0, as this is a protected blank which may
505                * confuse the user */
506         else if( iscntrl(c) )
507             continue;
508         if( !(i < n-1) ) {
509             n += 50;
510             buf = m_realloc( buf, n );
511         }
512         buf[i++] = c;
513     }
514     if( *cbuf != '\n' ) {
515         buf[0] = CONTROL_D;
516         i = 1;
517     }
518
519
520     if( hidden ) {
521 #ifdef HAVE_TCGETATTR
522         if( tcsetattr(fileno(ttyfp), TCSAFLUSH, &termsave) )
523             log_error("tcsetattr() failed: %s\n", strerror(errno) );
524         restore_termios = 0;
525 #endif
526     }
527 #endif /* end unix version */
528     buf[i] = 0;
529     return buf;
530 }
531
532
533 char *
534 tty_get( const char *prompt )
535 {
536 #ifdef HAVE_LIBREADLINE
537     if (!batchmode && !no_terminal) {
538       char *line;
539       char *buf;
540
541       if( !initialized )
542         init_ttyfp();
543
544       last_prompt_len = 0;
545
546       line = readline (prompt?prompt:"");
547
548       /* We need to copy it to memory controlled by our malloc
549          implementations; further we need to convert an EOF to our
550          convention. */
551       buf = m_alloc(line? strlen(line)+1:2);
552       if (line)
553         {
554           strcpy (buf, line);
555           trim_spaces (buf);
556           if (strlen (buf) > 2 )
557             add_history (line); /* Note that we test BUF but add LINE. */
558           free (line);
559         }
560       else
561         {
562           buf[0] = CONTROL_D;
563           buf[1] = 0;
564         }
565       return buf;
566     }
567     else
568 #endif /* HAVE_LIBREADLINE */
569       return do_get( prompt, 0 );
570 }
571
572 char *
573 tty_get_hidden( const char *prompt )
574 {
575     return do_get( prompt, 1 );
576 }
577
578
579 void
580 tty_kill_prompt()
581 {
582     if ( no_terminal )
583         return;
584
585     if( !initialized )
586         init_ttyfp();
587
588     if( batchmode )
589         last_prompt_len = 0;
590     if( !last_prompt_len )
591         return;
592 #ifdef _WIN32
593     tty_printf("\r%*s\r", last_prompt_len, "");
594 #else
595     {
596         int i;
597         putc('\r', ttyfp);
598         for(i=0; i < last_prompt_len; i ++ )
599             putc(' ', ttyfp);
600         putc('\r', ttyfp);
601         fflush(ttyfp);
602     }
603 #endif
604     last_prompt_len = 0;
605 }
606
607
608 int
609 tty_get_answer_is_yes( const char *prompt )
610 {
611     int yes;
612     char *p = tty_get( prompt );
613     tty_kill_prompt();
614     yes = answer_is_yes(p);
615     m_free(p);
616     return yes;
617 }