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