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