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