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