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