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