* keyring.c: Make some strings translatable.
[gnupg.git] / g10 / status.c
1 /* status.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <unistd.h>
28 #include <signal.h>
29 #ifdef USE_SHM_COPROCESSING
30 #ifdef USE_CAPABILITIES
31 #include <sys/capability.h>
32 #endif
33 #ifdef HAVE_SYS_IPC_H
34 #include <sys/types.h>
35 #include <sys/ipc.h>
36 #endif
37 #ifdef HAVE_SYS_SHM_H
38 #include <sys/shm.h>
39 #endif
40 #if defined(HAVE_MLOCK)
41 #include <sys/mman.h>
42 #endif
43 #endif
44 #include "util.h"
45 #include "status.h"
46 #include "ttyio.h"
47 #include "options.h"
48 #include "main.h"
49 #include "i18n.h"
50 #include "cipher.h" /* for progress functions */
51
52 #define CONTROL_D ('D' - 'A' + 1)
53
54
55
56 static FILE *statusfp;
57
58 #ifdef USE_SHM_COPROCESSING
59   static int shm_id = -1;
60   static volatile char *shm_area;
61   static size_t shm_size;
62   static int shm_is_locked;
63 #endif /*USE_SHM_COPROCESSING*/
64
65
66 static void
67 progress_cb ( void *ctx, int c )
68 {
69     char buf[50];
70
71     if ( c == '\n' )
72         sprintf ( buf, "%.20s X 100 100", (char*)ctx );
73     else
74         sprintf ( buf, "%.20s %c 0 0", (char*)ctx, c );
75     write_status_text ( STATUS_PROGRESS, buf );
76 }
77
78 static const char *
79 get_status_string ( int no ) 
80 {
81     const char *s;
82
83     switch( no ) {
84       case STATUS_ENTER  : s = "ENTER"; break;
85       case STATUS_LEAVE  : s = "LEAVE"; break;
86       case STATUS_ABORT  : s = "ABORT"; break;
87       case STATUS_NEWSIG : s = "NEWSIG"; break;
88       case STATUS_GOODSIG: s = "GOODSIG"; break;
89       case STATUS_KEYEXPIRED: s = "KEYEXPIRED"; break;
90       case STATUS_KEYREVOKED: s = "KEYREVOKED"; break;
91       case STATUS_BADSIG : s = "BADSIG"; break;
92       case STATUS_ERRSIG : s = "ERRSIG"; break;
93       case STATUS_BADARMOR : s = "BADARMOR"; break;
94       case STATUS_RSA_OR_IDEA : s= "RSA_OR_IDEA"; break;
95       case STATUS_TRUST_UNDEFINED: s = "TRUST_UNDEFINED"; break;
96       case STATUS_TRUST_NEVER    : s = "TRUST_NEVER"; break;
97       case STATUS_TRUST_MARGINAL : s = "TRUST_MARGINAL"; break;
98       case STATUS_TRUST_FULLY    : s = "TRUST_FULLY"; break;
99       case STATUS_TRUST_ULTIMATE : s = "TRUST_ULTIMATE"; break;
100       case STATUS_GET_BOOL       : s = "GET_BOOL"; break;
101       case STATUS_GET_LINE       : s = "GET_LINE"; break;
102       case STATUS_GET_HIDDEN     : s = "GET_HIDDEN"; break;
103       case STATUS_GOT_IT         : s = "GOT_IT"; break;
104       case STATUS_SHM_INFO       : s = "SHM_INFO"; break;
105       case STATUS_SHM_GET        : s = "SHM_GET"; break;
106       case STATUS_SHM_GET_BOOL   : s = "SHM_GET_BOOL"; break;
107       case STATUS_SHM_GET_HIDDEN : s = "SHM_GET_HIDDEN"; break;
108       case STATUS_NEED_PASSPHRASE: s = "NEED_PASSPHRASE"; break;
109       case STATUS_VALIDSIG       : s = "VALIDSIG"; break;
110       case STATUS_SIG_ID         : s = "SIG_ID"; break;
111       case STATUS_ENC_TO         : s = "ENC_TO"; break;
112       case STATUS_NODATA         : s = "NODATA"; break;
113       case STATUS_BAD_PASSPHRASE : s = "BAD_PASSPHRASE"; break;
114       case STATUS_NO_PUBKEY      : s = "NO_PUBKEY"; break;
115       case STATUS_NO_SECKEY      : s = "NO_SECKEY"; break;
116       case STATUS_NEED_PASSPHRASE_SYM: s = "NEED_PASSPHRASE_SYM"; break;
117       case STATUS_NEED_PASSPHRASE_PIN: s = "NEED_PASSPHRASE_PIN"; break;
118       case STATUS_DECRYPTION_FAILED: s = "DECRYPTION_FAILED"; break;
119       case STATUS_DECRYPTION_OKAY: s = "DECRYPTION_OKAY"; break;
120       case STATUS_MISSING_PASSPHRASE: s = "MISSING_PASSPHRASE"; break;
121       case STATUS_GOOD_PASSPHRASE : s = "GOOD_PASSPHRASE"; break;
122       case STATUS_GOODMDC        : s = "GOODMDC"; break;
123       case STATUS_BADMDC         : s = "BADMDC"; break;
124       case STATUS_ERRMDC         : s = "ERRMDC"; break;
125       case STATUS_IMPORTED       : s = "IMPORTED"; break;
126       case STATUS_IMPORT_OK      : s = "IMPORT_OK"; break;
127       case STATUS_IMPORT_CHECK   : s = "IMPORT_CHECK"; break;
128       case STATUS_IMPORT_RES     : s = "IMPORT_RES"; break;
129       case STATUS_FILE_START     : s = "FILE_START"; break;
130       case STATUS_FILE_DONE      : s = "FILE_DONE"; break;
131       case STATUS_FILE_ERROR     : s = "FILE_ERROR"; break;
132       case STATUS_BEGIN_DECRYPTION:s = "BEGIN_DECRYPTION"; break;
133       case STATUS_END_DECRYPTION : s = "END_DECRYPTION"; break;
134       case STATUS_BEGIN_ENCRYPTION:s = "BEGIN_ENCRYPTION"; break;
135       case STATUS_END_ENCRYPTION : s = "END_ENCRYPTION"; break;
136       case STATUS_DELETE_PROBLEM : s = "DELETE_PROBLEM"; break;
137       case STATUS_PROGRESS       : s = "PROGRESS"; break;
138       case STATUS_SIG_CREATED    : s = "SIG_CREATED"; break;
139       case STATUS_SESSION_KEY    : s = "SESSION_KEY"; break;
140       case STATUS_NOTATION_NAME  : s = "NOTATION_NAME" ; break;
141       case STATUS_NOTATION_DATA  : s = "NOTATION_DATA" ; break;
142       case STATUS_POLICY_URL     : s = "POLICY_URL" ; break;
143       case STATUS_BEGIN_STREAM   : s = "BEGIN_STREAM"; break;
144       case STATUS_END_STREAM     : s = "END_STREAM"; break;
145       case STATUS_KEY_CREATED    : s = "KEY_CREATED"; break;
146       case STATUS_KEY_NOT_CREATED: s = "KEY_NOT_CREATED"; break;
147       case STATUS_USERID_HINT    : s = "USERID_HINT"; break;
148       case STATUS_UNEXPECTED     : s = "UNEXPECTED"; break;
149       case STATUS_INV_RECP       : s = "INV_RECP"; break;
150       case STATUS_NO_RECP        : s = "NO_RECP"; break;
151       case STATUS_ALREADY_SIGNED : s = "ALREADY_SIGNED"; break;
152       case STATUS_SIGEXPIRED     : s = "SIGEXPIRED deprecated-use-keyexpired-instead"; break;
153       case STATUS_EXPSIG         : s = "EXPSIG"; break;
154       case STATUS_EXPKEYSIG      : s = "EXPKEYSIG"; break;
155       case STATUS_REVKEYSIG      : s = "REVKEYSIG"; break;
156       case STATUS_ATTRIBUTE      : s = "ATTRIBUTE"; break;
157       case STATUS_CARDCTRL       : s = "CARDCTRL"; break;
158       case STATUS_PLAINTEXT      : s = "PLAINTEXT"; break;
159       case STATUS_PLAINTEXT_LENGTH:s = "PLAINTEXT_LENGTH"; break;
160       default: s = "?"; break;
161     }
162     return s;
163 }
164
165
166 /* Return true if the status message NO may currently be issued.  We
167    need this to avoid syncronisation problem while auto retrieving a
168    key.  There it may happen that a status NODATA is issued for a non
169    available key and the user may falsely interpret this has a missing
170    signature. */
171 static int
172 status_currently_allowed (int no)
173 {
174   if (!glo_ctrl.in_auto_key_retrieve)
175     return 1; /* Yes. */
176
177   /* We allow some statis anyway, so that import statistics are
178      correct and to avoid problems if the retriebval subsystem will
179      prompt the user. */
180   switch (no)
181     {
182     case STATUS_GET_BOOL:        
183     case STATUS_GET_LINE:        
184     case STATUS_GET_HIDDEN:      
185     case STATUS_GOT_IT:  
186     case STATUS_IMPORTED:
187     case STATUS_IMPORT_OK:      
188     case STATUS_IMPORT_CHECK:  
189     case STATUS_IMPORT_RES:
190       return 1; /* Yes. */
191     default:
192       break;
193     }
194   return 0; /* No. */
195 }
196
197
198 void
199 set_status_fd ( int fd )
200 {
201     static int last_fd = -1;
202
203     if ( fd != -1 && last_fd == fd )
204         return;
205
206     if ( statusfp && statusfp != stdout && statusfp != stderr )
207         fclose (statusfp);
208     statusfp = NULL;
209     if ( fd == -1 ) 
210         return;
211
212     if( fd == 1 )
213         statusfp = stdout;
214     else if( fd == 2 )
215         statusfp = stderr;
216     else
217         statusfp = fdopen( fd, "w" );
218     if( !statusfp ) {
219         log_fatal("can't open fd %d for status output: %s\n",
220                   fd, strerror(errno));
221     }
222     last_fd = fd;
223     register_primegen_progress ( progress_cb, "primegen" );
224     register_pk_dsa_progress ( progress_cb, "pk_dsa" );
225     register_pk_elg_progress ( progress_cb, "pk_elg" );
226 }
227
228 int
229 is_status_enabled()
230 {
231     return !!statusfp;
232 }
233
234 void
235 write_status ( int no )
236 {
237     write_status_text( no, NULL );
238 }
239
240 void
241 write_status_text ( int no, const char *text)
242 {
243     if( !statusfp || !status_currently_allowed (no) )
244         return;  /* Not enabled or allowed. */
245
246     fputs ( "[GNUPG:] ", statusfp );
247     fputs ( get_status_string (no), statusfp );
248     if( text ) {
249         putc ( ' ', statusfp );
250         for (; *text; text++) {
251             if (*text == '\n')
252                 fputs ( "\\n", statusfp );
253             else if (*text == '\r')
254                 fputs ( "\\r", statusfp );
255             else 
256                 putc ( *(const byte *)text,  statusfp );
257         }
258     }
259     putc ('\n',statusfp);
260     fflush (statusfp);
261 }
262
263
264 /*
265  * Write a status line with a buffer using %XX escapes.  If WRAP is >
266  * 0 wrap the line after this length.  If STRING is not NULL it will
267  * be prepended to the buffer, no escaping is done for string.
268  * A wrap of -1 forces spaces not to be encoded as %20.
269  */
270 void
271 write_status_text_and_buffer ( int no, const char *string,
272                                const char *buffer, size_t len, int wrap )
273 {
274     const char *s, *text;
275     int esc, first;
276     int lower_limit = ' ';
277     size_t n, count, dowrap;
278
279     if( !statusfp || !status_currently_allowed (no) )
280         return;  /* Not enabled or allowed. */
281     
282     if (wrap == -1) {
283         lower_limit--;
284         wrap = 0;
285     }
286
287     text = get_status_string (no);
288     count = dowrap = first = 1;
289     do {
290         if (dowrap) {
291             fprintf (statusfp, "[GNUPG:] %s ", text );
292             count = dowrap = 0;
293             if (first && string) {
294                 fputs (string, statusfp);
295                 count += strlen (string);
296             }
297             first = 0;
298         }
299         for (esc=0, s=buffer, n=len; n && !esc; s++, n-- ) {
300             if ( *s == '%' || *(const byte*)s <= lower_limit 
301                            || *(const byte*)s == 127 ) 
302                 esc = 1;
303             if ( wrap && ++count > wrap ) {
304                 dowrap=1;
305                 break;
306             }
307         }
308         if (esc) {
309             s--; n++;
310         }
311         if (s != buffer) 
312             fwrite (buffer, s-buffer, 1, statusfp );
313         if ( esc ) {
314             fprintf (statusfp, "%%%02X", *(const byte*)s );
315             s++; n--;
316         }
317         buffer = s;
318         len = n;
319         if ( dowrap && len )
320             putc ( '\n', statusfp );
321     } while ( len );
322
323     putc ('\n',statusfp);
324     fflush (statusfp);
325 }
326
327 void
328 write_status_buffer ( int no, const char *buffer, size_t len, int wrap )
329 {
330     write_status_text_and_buffer (no, NULL, buffer, len, wrap);
331 }
332
333
334
335 #ifdef USE_SHM_COPROCESSING
336
337 #ifndef IPC_RMID_DEFERRED_RELEASE
338 static void
339 remove_shmid( void )
340 {
341     if( shm_id != -1 ) {
342         shmctl ( shm_id, IPC_RMID, 0);
343         shm_id = -1;
344     }
345 }
346 #endif
347
348 void
349 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
350 {
351     char buf[100];
352     struct shmid_ds shmds;
353
354 #ifndef IPC_RMID_DEFERRED_RELEASE
355     atexit( remove_shmid );
356 #endif
357     requested_shm_size = (requested_shm_size + 4095) & ~4095;
358     if ( requested_shm_size > 2 * 4096 )
359         log_fatal("too much shared memory requested; only 8k are allowed\n");
360     shm_size = 4096 /* one page for us */ + requested_shm_size;
361
362     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0700 );
363     if ( shm_id == -1 )
364         log_fatal("can't get %uk of shared memory: %s\n",
365                                 (unsigned)shm_size/1024, strerror(errno));
366
367 #if !defined(IPC_HAVE_SHM_LOCK) \
368       && defined(HAVE_MLOCK) && !defined(HAVE_BROKEN_MLOCK)
369     /* part of the old code which uses mlock */
370     shm_area = shmat( shm_id, 0, 0 );
371     if ( shm_area == (char*)-1 )
372         log_fatal("can't attach %uk shared memory: %s\n",
373                                 (unsigned)shm_size/1024, strerror(errno));
374     log_debug("mapped %uk shared memory at %p, id=%d\n",
375                             (unsigned)shm_size/1024, shm_area, shm_id );
376     if( lock_mem ) {
377 #ifdef USE_CAPABILITIES
378         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
379 #endif
380         /* (need the cast for Solaris with Sun's workshop compilers) */
381         if ( mlock ( (char*)shm_area, shm_size) )
382             log_info("locking shared memory %d failed: %s\n",
383                                 shm_id, strerror(errno));
384         else
385             shm_is_locked = 1;
386 #ifdef USE_CAPABILITIES
387         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
388 #endif
389     }
390
391 #ifdef IPC_RMID_DEFERRED_RELEASE
392     if( shmctl( shm_id, IPC_RMID, 0) )
393         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
394                                             shm_id, strerror(errno));
395 #endif
396
397     if( shmctl( shm_id, IPC_STAT, &shmds ) )
398         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
399                                             shm_id, strerror(errno));
400     if( shmds.shm_perm.uid != getuid() ) {
401         shmds.shm_perm.uid = getuid();
402         if( shmctl( shm_id, IPC_SET, &shmds ) )
403             log_fatal("shmctl IPC_SET of %d failed: %s\n",
404                                                 shm_id, strerror(errno));
405     }
406
407 #else /* this is the new code which handles the changes in the SHM
408        * semantics introduced with Linux 2.4.  The changes is that we
409        * now change the permissions and then attach to the memory.
410        */
411
412     if( lock_mem ) {
413 #ifdef USE_CAPABILITIES
414         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
415 #endif
416 #ifdef IPC_HAVE_SHM_LOCK
417         if ( shmctl (shm_id, SHM_LOCK, 0) )
418             log_info("locking shared memory %d failed: %s\n",
419                                 shm_id, strerror(errno));
420         else
421             shm_is_locked = 1;
422 #else
423         log_info("Locking shared memory %d failed: No way to do it\n", shm_id );
424 #endif
425 #ifdef USE_CAPABILITIES
426         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
427 #endif
428     }
429
430     if( shmctl( shm_id, IPC_STAT, &shmds ) )
431         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
432                                             shm_id, strerror(errno));
433     if( shmds.shm_perm.uid != getuid() ) {
434         shmds.shm_perm.uid = getuid();
435         if( shmctl( shm_id, IPC_SET, &shmds ) )
436             log_fatal("shmctl IPC_SET of %d failed: %s\n",
437                                                 shm_id, strerror(errno));
438     }
439
440     shm_area = shmat( shm_id, 0, 0 );
441     if ( shm_area == (char*)-1 )
442         log_fatal("can't attach %uk shared memory: %s\n",
443                                 (unsigned)shm_size/1024, strerror(errno));
444     log_debug("mapped %uk shared memory at %p, id=%d\n",
445                             (unsigned)shm_size/1024, shm_area, shm_id );
446
447 #ifdef IPC_RMID_DEFERRED_RELEASE
448     if( shmctl( shm_id, IPC_RMID, 0) )
449         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
450                                             shm_id, strerror(errno));
451 #endif
452
453 #endif
454     /* write info; Protocol version, id, size, locked size */
455     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
456             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
457     write_status_text( STATUS_SHM_INFO, buf );
458 }
459
460 /****************
461  * Request a string from client
462  * If bool, returns static string on true (do not free) or NULL for false
463  */
464 static char *
465 do_shm_get( const char *keyword, int hidden, int bool )
466 {
467     size_t n;
468     byte *p;
469     char *string;
470
471     if( !shm_area )
472         BUG();
473
474     shm_area[0] = 0;  /* msb of length of control block */
475     shm_area[1] = 32; /* and lsb */
476     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
477     shm_area[3] = 0;  /* clear data available flag */
478
479     write_status_text( bool? STATUS_SHM_GET_BOOL :
480                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
481
482     do {
483         pause_on_sigusr(1);
484         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
485             log_fatal("client modified shm control block - abort\n");
486     } while( !shm_area[3] );
487     shm_area[2] = 0; /* reset request flag */
488     p = (byte*)shm_area+32;
489     n = p[0] << 8 | p[1];
490     p += 2;
491     if( n+32+2+1 > 4095 )
492         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
493
494     if( bool )
495         return p[0]? "" : NULL;
496
497     string = hidden? m_alloc_secure( n+1 ) : m_alloc( n+1 );
498     memcpy(string, p, n );
499     string[n] = 0; /* make sure it is a string */
500     if( hidden ) /* invalidate the memory */
501         memset( p, 0, n );
502
503     return string;
504 }
505
506 #endif /* USE_SHM_COPROCESSING */
507
508 static int
509 myread(int fd, void *buf, size_t count)
510 {
511     int rc;
512     do {
513         rc = read( fd, buf, count );
514     } while ( rc == -1 && errno == EINTR );
515     if ( !rc && count ) {
516         static int eof_emmited=0;
517         if ( eof_emmited < 3 ) {
518             *(char*)buf = CONTROL_D;
519             rc = 1;
520             eof_emmited++;
521         }
522         else { /* Ctrl-D not caught - do something reasonable */
523 #ifdef HAVE_DOSISH_SYSTEM
524             raise (SIGINT);  /* nothing to hangup under DOS */
525 #else
526             raise (SIGHUP); /* no more input data */
527 #endif
528         }
529     }    
530     return rc;
531 }
532
533
534
535 /****************
536  * Request a string from the client over the command-fd
537  * If bool, returns static string on true (do not free) or NULL for false
538  */
539 static char *
540 do_get_from_fd( const char *keyword, int hidden, int bool )
541 {
542     int i, len;
543     char *string;
544
545     if(statusfp!=stdout)
546       fflush(stdout);
547
548     write_status_text( bool? STATUS_GET_BOOL :
549                        hidden? STATUS_GET_HIDDEN : STATUS_GET_LINE, keyword );
550
551     for( string = NULL, i = len = 200; ; i++ ) {
552         if( i >= len-1 ) {
553             char *save = string;
554             len += 100;
555             string = hidden? m_alloc_secure ( len ) : m_alloc ( len );
556             if( save )
557                 memcpy(string, save, i );
558             else
559                 i=0;
560         }
561         /* Hmmm: why not use our read_line function here */
562         if( myread( opt.command_fd, string+i, 1) != 1 || string[i] == '\n'  )
563             break;
564         else if ( string[i] == CONTROL_D ) {
565             /* found ETX - cancel the line and return a sole ETX */
566             string[0] = CONTROL_D;
567             i=1;
568             break;
569         }
570     }
571     string[i] = 0;
572
573     write_status( STATUS_GOT_IT );
574
575     if( bool )   /* Fixme: is this correct??? */
576         return (string[0] == 'Y' || string[0] == 'y') ? "" : NULL;
577
578     return string;
579 }
580
581
582
583 int
584 cpr_enabled()
585 {
586     if( opt.command_fd != -1 )
587         return 1;
588 #ifdef USE_SHM_COPROCESSING
589     if( opt.shm_coprocess )
590         return 1;
591 #endif
592     return 0;
593 }
594
595 char *
596 cpr_get_no_help( const char *keyword, const char *prompt )
597 {
598     char *p;
599
600     if( opt.command_fd != -1 )
601         return do_get_from_fd ( keyword, 0, 0 );
602 #ifdef USE_SHM_COPROCESSING
603     if( opt.shm_coprocess )
604         return do_shm_get( keyword, 0, 0 );
605 #endif
606     for(;;) {
607         p = tty_get( prompt );
608         return p;
609     }
610 }
611
612 char *
613 cpr_get( const char *keyword, const char *prompt )
614 {
615     char *p;
616
617     if( opt.command_fd != -1 )
618         return do_get_from_fd ( keyword, 0, 0 );
619 #ifdef USE_SHM_COPROCESSING
620     if( opt.shm_coprocess )
621         return do_shm_get( keyword, 0, 0 );
622 #endif
623     for(;;) {
624         p = tty_get( prompt );
625         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
626             m_free(p);
627             display_online_help( keyword );
628         }
629         else
630             return p;
631     }
632 }
633
634
635 char *
636 cpr_get_utf8( const char *keyword, const char *prompt )
637 {
638     char *p;
639     p = cpr_get( keyword, prompt );
640     if( p ) {
641         char *utf8 = native_to_utf8( p );
642         m_free( p );
643         p = utf8;
644     }
645     return p;
646 }
647
648 char *
649 cpr_get_hidden( const char *keyword, const char *prompt )
650 {
651     char *p;
652
653     if( opt.command_fd != -1 )
654         return do_get_from_fd ( keyword, 1, 0 );
655 #ifdef USE_SHM_COPROCESSING
656     if( opt.shm_coprocess )
657         return do_shm_get( keyword, 1, 0 );
658 #endif
659     for(;;) {
660         p = tty_get_hidden( prompt );
661         if( *p == '?' && !p[1] ) {
662             m_free(p);
663             display_online_help( keyword );
664         }
665         else
666             return p;
667     }
668 }
669
670 void
671 cpr_kill_prompt(void)
672 {
673     if( opt.command_fd != -1 )
674         return;
675 #ifdef USE_SHM_COPROCESSING
676     if( opt.shm_coprocess )
677         return;
678 #endif
679     tty_kill_prompt();
680     return;
681 }
682
683 int
684 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
685 {
686     int yes;
687     char *p;
688
689     if( opt.command_fd != -1 )
690         return !!do_get_from_fd ( keyword, 0, 1 );
691 #ifdef USE_SHM_COPROCESSING
692     if( opt.shm_coprocess )
693         return !!do_shm_get( keyword, 0, 1 );
694 #endif
695     for(;;) {
696         p = tty_get( prompt );
697         trim_spaces(p); /* it is okay to do this here */
698         if( *p == '?' && !p[1] ) {
699             m_free(p);
700             display_online_help( keyword );
701         }
702         else {
703             tty_kill_prompt();
704             yes = answer_is_yes(p);
705             m_free(p);
706             return yes;
707         }
708     }
709 }
710
711 int
712 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
713 {
714     int yes;
715     char *p;
716
717     if( opt.command_fd != -1 )
718         return !!do_get_from_fd ( keyword, 0, 1 );
719 #ifdef USE_SHM_COPROCESSING
720     if( opt.shm_coprocess )
721         return !!do_shm_get( keyword, 0, 1 );
722 #endif
723     for(;;) {
724         p = tty_get( prompt );
725         trim_spaces(p); /* it is okay to do this here */
726         if( *p == '?' && !p[1] ) {
727             m_free(p);
728             display_online_help( keyword );
729         }
730         else {
731             tty_kill_prompt();
732             yes = answer_is_yes_no_quit(p);
733             m_free(p);
734             return yes;
735         }
736     }
737 }
738
739
740 int
741 cpr_get_answer_okay_cancel (const char *keyword,
742                             const char *prompt,
743                             int def_answer)
744 {
745   int yes;
746   char *answer = NULL;
747   char *p;
748
749   if( opt.command_fd != -1 )
750     answer = do_get_from_fd ( keyword, 0, 0 );
751 #ifdef USE_SHM_COPROCESSING
752   else if( opt.shm_coprocess )
753     answer = do_shm_get( keyword, 0, 0 );
754 #endif
755
756   if (answer)
757     {
758       yes = answer_is_okay_cancel (answer, def_answer);
759       m_free (answer);
760       return yes;
761     }
762
763   for(;;)
764     {
765       p = tty_get( prompt );
766       trim_spaces(p); /* it is okay to do this here */
767       if (*p == '?' && !p[1])
768         {
769           m_free(p);
770           display_online_help (keyword);
771         }
772       else
773         {
774           tty_kill_prompt();
775           yes = answer_is_okay_cancel (p, def_answer);
776           m_free(p);
777           return yes;
778         }
779     }
780 }
781