indent: Fix indentation of read_block in g10/import.c
[gnupg.git] / g10 / cpr.c
1 /* status.c - Status message and command-fd interface
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004, 2005, 2006, 2010 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 3 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, see <https://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <unistd.h>
27 #ifdef HAVE_SIGNAL_H
28 # include <signal.h>
29 #endif
30
31 #include "gpg.h"
32 #include "../common/util.h"
33 #include "../common/status.h"
34 #include "../common/ttyio.h"
35 #include "options.h"
36 #include "main.h"
37 #include "../common/i18n.h"
38
39 #define CONTROL_D ('D' - 'A' + 1)
40
41
42 /* The stream to output the status information.  Output is disabled if
43    this is NULL.  */
44 static estream_t statusfp;
45
46
47 static void
48 progress_cb (void *ctx, const char *what, int printchar,
49              int current, int total)
50 {
51   char buf[50];
52
53   (void)ctx;
54
55   if ( printchar == '\n' && !strcmp (what, "primegen") )
56     snprintf (buf, sizeof buf, "%.20s X 100 100", what );
57   else
58     snprintf (buf, sizeof buf, "%.20s %c %d %d",
59               what, printchar=='\n'?'X':printchar, current, total );
60   write_status_text (STATUS_PROGRESS, buf);
61 }
62
63
64 /* Return true if the status message NO may currently be issued.  We
65    need this to avoid syncronisation problem while auto retrieving a
66    key.  There it may happen that a status NODATA is issued for a non
67    available key and the user may falsely interpret this has a missing
68    signature. */
69 static int
70 status_currently_allowed (int no)
71 {
72   if (!glo_ctrl.in_auto_key_retrieve)
73     return 1; /* Yes. */
74
75   /* We allow some statis anyway, so that import statistics are
76      correct and to avoid problems if the retrieval subsystem will
77      prompt the user. */
78   switch (no)
79     {
80     case STATUS_GET_BOOL:
81     case STATUS_GET_LINE:
82     case STATUS_GET_HIDDEN:
83     case STATUS_GOT_IT:
84     case STATUS_IMPORTED:
85     case STATUS_IMPORT_OK:
86     case STATUS_IMPORT_CHECK:
87     case STATUS_IMPORT_RES:
88       return 1; /* Yes. */
89     default:
90       break;
91     }
92   return 0; /* No. */
93 }
94
95
96 void
97 set_status_fd (int fd)
98 {
99   static int last_fd = -1;
100
101   if (fd != -1 && last_fd == fd)
102     return;
103
104   if (statusfp && statusfp != es_stdout && statusfp != es_stderr )
105     es_fclose (statusfp);
106   statusfp = NULL;
107   if (fd == -1)
108     return;
109
110   if (! gnupg_fd_valid (fd))
111     log_fatal ("status-fd is invalid: %s\n", strerror (errno));
112
113   if (fd == 1)
114     statusfp = es_stdout;
115   else if (fd == 2)
116     statusfp = es_stderr;
117   else
118     statusfp = es_fdopen (fd, "w");
119   if (!statusfp)
120     {
121       log_fatal ("can't open fd %d for status output: %s\n",
122                  fd, strerror (errno));
123     }
124   last_fd = fd;
125
126   gcry_set_progress_handler (progress_cb, NULL);
127 }
128
129
130 int
131 is_status_enabled ()
132 {
133   return !!statusfp;
134 }
135
136
137 void
138 write_status ( int no )
139 {
140     write_status_text( no, NULL );
141 }
142
143
144 /* Write a status line with code NO followed by the string TEXT and
145    directly followed by the remaining strings up to a NULL. */
146 void
147 write_status_strings (int no, const char *text, ...)
148 {
149   va_list arg_ptr;
150   const char *s;
151
152   if (!statusfp || !status_currently_allowed (no) )
153     return;  /* Not enabled or allowed. */
154
155   es_fputs ("[GNUPG:] ", statusfp);
156   es_fputs (get_status_string (no), statusfp);
157   if ( text )
158     {
159       es_putc ( ' ', statusfp);
160       va_start (arg_ptr, text);
161       s = text;
162       do
163         {
164           for (; *s; s++)
165             {
166               if (*s == '\n')
167                 es_fputs ("\\n", statusfp);
168               else if (*s == '\r')
169                 es_fputs ("\\r", statusfp);
170               else
171                 es_fputc (*(const byte *)s, statusfp);
172             }
173         }
174       while ((s = va_arg (arg_ptr, const char*)));
175       va_end (arg_ptr);
176     }
177   es_putc ('\n', statusfp);
178   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
179     g10_exit (0);
180 }
181
182
183 void
184 write_status_text (int no, const char *text)
185 {
186   write_status_strings (no, text, NULL);
187 }
188
189
190 /* Write a status line with code NO followed by the outout of the
191  * printf style FORMAT.  The caller needs to make sure that LFs and
192  * CRs are not printed.  */
193 void
194 write_status_printf (int no, const char *format, ...)
195 {
196   va_list arg_ptr;
197
198   if (!statusfp || !status_currently_allowed (no) )
199     return;  /* Not enabled or allowed. */
200
201   es_fputs ("[GNUPG:] ", statusfp);
202   es_fputs (get_status_string (no), statusfp);
203   if (format)
204     {
205       es_putc ( ' ', statusfp);
206       va_start (arg_ptr, format);
207       es_vfprintf (statusfp, format, arg_ptr);
208       va_end (arg_ptr);
209     }
210   es_putc ('\n', statusfp);
211   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
212     g10_exit (0);
213 }
214
215
216 /* Write an ERROR status line using a full gpg-error error value.  */
217 void
218 write_status_error (const char *where, gpg_error_t err)
219 {
220   if (!statusfp || !status_currently_allowed (STATUS_ERROR))
221     return;  /* Not enabled or allowed. */
222
223   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
224               get_status_string (STATUS_ERROR), where, err);
225   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
226     g10_exit (0);
227 }
228
229
230 /* Same as above but outputs the error code only.  */
231 void
232 write_status_errcode (const char *where, int errcode)
233 {
234   if (!statusfp || !status_currently_allowed (STATUS_ERROR))
235     return;  /* Not enabled or allowed. */
236
237   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
238               get_status_string (STATUS_ERROR), where, gpg_err_code (errcode));
239   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
240     g10_exit (0);
241 }
242
243
244 /* Write a FAILURE status line.  */
245 void
246 write_status_failure (const char *where, gpg_error_t err)
247 {
248   static int any_failure_printed;
249
250   if (!statusfp || !status_currently_allowed (STATUS_FAILURE))
251     return;  /* Not enabled or allowed. */
252   if (any_failure_printed)
253     return;
254   any_failure_printed = 1;
255   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
256               get_status_string (STATUS_FAILURE), where, err);
257   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
258     g10_exit (0);
259 }
260
261
262 /*
263  * Write a status line with a buffer using %XX escapes.  If WRAP is >
264  * 0 wrap the line after this length.  If STRING is not NULL it will
265  * be prepended to the buffer, no escaping is done for string.
266  * A wrap of -1 forces spaces not to be encoded as %20.
267  */
268 void
269 write_status_text_and_buffer (int no, const char *string,
270                               const char *buffer, size_t len, int wrap)
271 {
272   const char *s, *text;
273   int esc, first;
274   int lower_limit = ' ';
275   size_t n, count, dowrap;
276
277   if (!statusfp || !status_currently_allowed (no))
278     return;  /* Not enabled or allowed. */
279
280   if (wrap == -1)
281     {
282       lower_limit--;
283       wrap = 0;
284     }
285
286   text = get_status_string (no);
287   count = dowrap = first = 1;
288   do
289     {
290       if (dowrap)
291         {
292           es_fprintf (statusfp, "[GNUPG:] %s ", text);
293           count = dowrap = 0;
294           if (first && string)
295             {
296               es_fputs (string, statusfp);
297               count += strlen (string);
298               /* Make sure that there is a space after the string.  */
299               if (*string && string[strlen (string)-1] != ' ')
300                 {
301                   es_putc (' ', statusfp);
302                   count++;
303                 }
304             }
305           first = 0;
306         }
307       for (esc=0, s=buffer, n=len; n && !esc; s++, n--)
308         {
309           if (*s == '%' || *(const byte*)s <= lower_limit
310               || *(const byte*)s == 127 )
311             esc = 1;
312           if (wrap && ++count > wrap)
313             {
314               dowrap=1;
315               break;
316             }
317         }
318       if (esc)
319         {
320           s--; n++;
321         }
322       if (s != buffer)
323         es_fwrite (buffer, s-buffer, 1, statusfp);
324       if ( esc )
325         {
326           es_fprintf (statusfp, "%%%02X", *(const byte*)s );
327           s++; n--;
328         }
329       buffer = s;
330       len = n;
331       if (dowrap && len)
332         es_putc ('\n', statusfp);
333     }
334   while (len);
335
336   es_putc ('\n',statusfp);
337   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
338     g10_exit (0);
339 }
340
341
342 void
343 write_status_buffer (int no, const char *buffer, size_t len, int wrap)
344 {
345   write_status_text_and_buffer (no, NULL, buffer, len, wrap);
346 }
347
348
349 /* Print the BEGIN_SIGNING status message.  If MD is not NULL it is
350    used to retrieve the hash algorithms used for the message. */
351 void
352 write_status_begin_signing (gcry_md_hd_t md)
353 {
354   if (md)
355     {
356       char buf[100];
357       size_t buflen;
358       int i, ga;
359
360       buflen = 0;
361       for (i=1; i <= 110; i++)
362         {
363           ga = map_md_openpgp_to_gcry (i);
364           if (ga && gcry_md_is_enabled (md, ga) && buflen+10 < DIM(buf))
365             {
366               snprintf (buf+buflen, DIM(buf) - buflen,
367                         "%sH%d", buflen? " ":"",i);
368               buflen += strlen (buf+buflen);
369             }
370         }
371       write_status_text (STATUS_BEGIN_SIGNING, buf);
372     }
373   else
374     write_status ( STATUS_BEGIN_SIGNING );
375 }
376
377
378 static int
379 myread(int fd, void *buf, size_t count)
380 {
381   int rc;
382   do
383     {
384       rc = read( fd, buf, count );
385     }
386   while (rc == -1 && errno == EINTR);
387
388   if (!rc && count)
389     {
390       static int eof_emmited=0;
391       if ( eof_emmited < 3 )
392         {
393           *(char*)buf = CONTROL_D;
394           rc = 1;
395           eof_emmited++;
396         }
397       else /* Ctrl-D not caught - do something reasonable */
398         {
399 #ifdef HAVE_DOSISH_SYSTEM
400 #ifndef HAVE_W32CE_SYSTEM
401           raise (SIGINT); /* Nothing to hangup under DOS.  */
402 #endif
403 #else
404           raise (SIGHUP); /* No more input data.  */
405 #endif
406         }
407     }
408   return rc;
409 }
410
411
412
413 /* Request a string from the client over the command-fd.  If GETBOOL
414    is set the function returns a static string (do not free) if the
415    entered value was true or NULL if the entered value was false.  */
416 static char *
417 do_get_from_fd ( const char *keyword, int hidden, int getbool )
418 {
419   int i, len;
420   char *string;
421
422   if (statusfp != es_stdout)
423     es_fflush (es_stdout);
424
425   write_status_text (getbool? STATUS_GET_BOOL :
426                      hidden? STATUS_GET_HIDDEN : STATUS_GET_LINE, keyword);
427
428   for (string = NULL, i = len = 200; ; i++ )
429     {
430       if (i >= len-1 )
431         {
432           /* On the first iteration allocate a new buffer.  If that
433            * buffer is too short at further iterations do a poor man's
434            * realloc.  */
435           char *save = string;
436           len += 100;
437           string = hidden? xmalloc_secure ( len ) : xmalloc ( len );
438           if (save)
439             {
440               memcpy (string, save, i);
441               xfree (save);
442             }
443           else
444             i = 0;
445         }
446       /* Fixme: why not use our read_line function here? */
447       if ( myread( opt.command_fd, string+i, 1) != 1 || string[i] == '\n'  )
448         break;
449       else if ( string[i] == CONTROL_D )
450         {
451           /* Found ETX - Cancel the line and return a sole ETX.  */
452           string[0] = CONTROL_D;
453           i = 1;
454           break;
455         }
456     }
457   string[i] = 0;
458
459   write_status (STATUS_GOT_IT);
460
461   if (getbool)   /* Fixme: is this correct??? */
462     return (string[0] == 'Y' || string[0] == 'y') ? "" : NULL;
463
464   return string;
465 }
466
467
468
469 int
470 cpr_enabled()
471 {
472     if( opt.command_fd != -1 )
473         return 1;
474     return 0;
475 }
476
477 char *
478 cpr_get_no_help( const char *keyword, const char *prompt )
479 {
480     char *p;
481
482     if( opt.command_fd != -1 )
483         return do_get_from_fd ( keyword, 0, 0 );
484     for(;;) {
485         p = tty_get( prompt );
486         return p;
487     }
488 }
489
490 char *
491 cpr_get( const char *keyword, const char *prompt )
492 {
493     char *p;
494
495     if( opt.command_fd != -1 )
496         return do_get_from_fd ( keyword, 0, 0 );
497     for(;;) {
498         p = tty_get( prompt );
499         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
500             xfree(p);
501             display_online_help( keyword );
502         }
503         else
504             return p;
505     }
506 }
507
508
509 char *
510 cpr_get_utf8( const char *keyword, const char *prompt )
511 {
512     char *p;
513     p = cpr_get( keyword, prompt );
514     if( p ) {
515         char *utf8 = native_to_utf8( p );
516         xfree( p );
517         p = utf8;
518     }
519     return p;
520 }
521
522 char *
523 cpr_get_hidden( const char *keyword, const char *prompt )
524 {
525     char *p;
526
527     if( opt.command_fd != -1 )
528         return do_get_from_fd ( keyword, 1, 0 );
529     for(;;) {
530         p = tty_get_hidden( prompt );
531         if( *p == '?' && !p[1] ) {
532             xfree(p);
533             display_online_help( keyword );
534         }
535         else
536             return p;
537     }
538 }
539
540 void
541 cpr_kill_prompt(void)
542 {
543     if( opt.command_fd != -1 )
544         return;
545     tty_kill_prompt();
546     return;
547 }
548
549 int
550 cpr_get_answer_is_yes_def (const char *keyword, const char *prompt, int def_yes)
551 {
552     int yes;
553     char *p;
554
555     if( opt.command_fd != -1 )
556         return !!do_get_from_fd ( keyword, 0, 1 );
557     for(;;) {
558         p = tty_get( prompt );
559         trim_spaces(p); /* it is okay to do this here */
560         if( *p == '?' && !p[1] ) {
561             xfree(p);
562             display_online_help( keyword );
563         }
564         else {
565             tty_kill_prompt();
566             yes = answer_is_yes_no_default (p, def_yes);
567             xfree(p);
568             return yes;
569         }
570     }
571 }
572
573 int
574 cpr_get_answer_is_yes (const char *keyword, const char *prompt)
575 {
576   return cpr_get_answer_is_yes_def (keyword, prompt, 0);
577 }
578
579 int
580 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
581 {
582     int yes;
583     char *p;
584
585     if( opt.command_fd != -1 )
586         return !!do_get_from_fd ( keyword, 0, 1 );
587     for(;;) {
588         p = tty_get( prompt );
589         trim_spaces(p); /* it is okay to do this here */
590         if( *p == '?' && !p[1] ) {
591             xfree(p);
592             display_online_help( keyword );
593         }
594         else {
595             tty_kill_prompt();
596             yes = answer_is_yes_no_quit(p);
597             xfree(p);
598             return yes;
599         }
600     }
601 }
602
603
604 int
605 cpr_get_answer_okay_cancel (const char *keyword,
606                             const char *prompt,
607                             int def_answer)
608 {
609   int yes;
610   char *answer = NULL;
611   char *p;
612
613   if( opt.command_fd != -1 )
614     answer = do_get_from_fd ( keyword, 0, 0 );
615
616   if (answer)
617     {
618       yes = answer_is_okay_cancel (answer, def_answer);
619       xfree (answer);
620       return yes;
621     }
622
623   for(;;)
624     {
625       p = tty_get( prompt );
626       trim_spaces(p); /* it is okay to do this here */
627       if (*p == '?' && !p[1])
628         {
629           xfree(p);
630           display_online_help (keyword);
631         }
632       else
633         {
634           tty_kill_prompt();
635           yes = answer_is_okay_cancel (p, def_answer);
636           xfree(p);
637           return yes;
638         }
639     }
640 }