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