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