* configure.ac: Check for funopen and fopencookie as part of the
[gnupg.git] / jnlib / logging.c
1 /* logging.c -  useful logging functions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21
22 /* This file should replace logger.c in the future - for now it is not
23  * used by GnuPG but by GPA.
24  * It is a quite simple implemenation but sufficient for most purposes.
25  */
26
27 #include <config.h>
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdarg.h>
32 #include <stddef.h>
33 #include <errno.h>
34 #include <time.h>
35 #include <sys/types.h>
36 #include <sys/socket.h>
37 #include <sys/un.h>
38 #include <unistd.h>
39 #ifdef __MINGW32__
40 #  include <io.h>
41 #endif
42
43 #define JNLIB_NEED_LOG_LOGV 1
44 #include "libjnlib-config.h"
45 #include "logging.h"
46
47
48 static FILE *logstream;
49 static char prefix_buffer[80];
50 static int with_time;
51 static int with_prefix;
52 static int with_pid;
53
54 static int missing_lf;
55 static int errorcount;
56
57 #if 0
58 static void
59 write2stderr( const char *s )
60 {
61     write( 2, s, strlen(s) );
62 }
63
64
65 static void
66 do_die(int rc, const char *text )
67 {
68     write2stderr("\nFatal error: ");
69     write2stderr(text);
70     write2stderr("\n");
71     abort();
72 }
73 #endif
74
75 int
76 log_get_errorcount (int clear)
77 {
78     int n = errorcount;
79     if( clear )
80         errorcount = 0;
81     return n;
82 }
83
84 void
85 log_inc_errorcount (void)
86 {
87    errorcount++;
88 }
89
90
91 /* The follwing 3 functions are used by funopen to write logs to a
92    socket. */
93 #if defined (HAVE_FOPENCOOKIE) || defined (HAVE_FUNOPEN)
94 struct fun_cookie_s {
95   int fd;
96   int quiet;
97   char name[1];
98 };
99
100 /* Write NBYTES of BUF to file descriptor FD. */
101 static int
102 writen (int fd, const unsigned char *buf, size_t nbytes)
103 {
104   size_t nleft = nbytes;
105   int nwritten;
106   
107   while (nleft > 0)
108     {
109       nwritten = write (fd, buf, nleft);
110       if (nwritten < 0 && errno == EINTR)
111         continue;
112       if (nwritten < 0)
113         return -1;
114       nleft -= nwritten;
115       buf = buf + nwritten;
116     }
117   
118   return 0;
119 }
120
121
122 static int 
123 fun_writer (void *cookie_arg, const char *buffer, size_t size)
124 {
125   struct fun_cookie_s *cookie = cookie_arg;
126
127   /* Note that we always try to reconnect to the socket but print error
128      messages only the first time an error occured. */
129   if (cookie->fd == -1 )
130     {
131       /* Note yet open or meanwhile closed due to an error. */
132       struct sockaddr_un addr;
133       size_t addrlen;
134
135       cookie->fd = socket (PF_LOCAL, SOCK_STREAM, 0);
136       if (cookie->fd == -1)
137         {
138           if (!cookie->quiet)
139             fprintf (stderr, "failed to create socket for logging: %s\n",
140                      strerror(errno));
141           goto failure;
142         }
143       
144       memset (&addr, 0, sizeof addr);
145       addr.sun_family = PF_LOCAL;
146       strncpy (addr.sun_path, cookie->name, sizeof (addr.sun_path)-1);
147       addr.sun_path[sizeof (addr.sun_path)-1] = 0;
148       addrlen = (offsetof (struct sockaddr_un, sun_path)
149                  + strlen (addr.sun_path) + 1);
150       
151       if (connect (cookie->fd, (struct sockaddr *) &addr, addrlen) == -1)
152         {
153           if (!cookie->quiet)
154             fprintf (stderr, "can't connect to `%s': %s\n",
155                      cookie->name, strerror(errno));
156           close (cookie->fd);
157           cookie->fd = -1;
158           goto failure;
159         }
160       /* Connection established. */
161       cookie->quiet = 0;
162     }
163   
164   if (!writen (cookie->fd, buffer, size))
165     return size; /* Okay. */ 
166
167   fprintf (stderr, "error writing to `%s': %s\n",
168            cookie->name, strerror(errno));
169   close (cookie->fd);
170   cookie->fd = -1;
171
172  failure: 
173   if (!cookie->quiet)
174     {
175       fputs ("switching logging to stderr\n", stderr);
176       cookie->quiet = 1;
177     }
178
179   fwrite (buffer, size, 1, stderr);
180   return size;
181 }
182
183 static int
184 fun_closer (void *cookie_arg)
185 {
186   struct fun_cookie_s *cookie = cookie_arg;
187
188   if (cookie->fd != -1)
189     close (cookie->fd);
190   jnlib_free (cookie);
191   return 0;
192 }
193 #endif /* HAVE_FOPENCOOKIE || HAVE_FUNOPEN */
194
195
196
197
198 /* Set the file to write log to.  The sepcial names NULL and "_" may
199    be used to select stderr and names formatted like
200    "socket:///home/foo/mylogs" may be used to write the logging to the
201    socket "/home/foo/mylogs".  If the connection to the socket fails
202    or a write error is detected, the function writes to stderr and
203    tries the next time again to connect the socket.
204   */
205 void
206 log_set_file (const char *name) 
207 {
208   FILE *fp;
209
210   if (name && !strncmp (name, "socket://", 9) && name[9])
211     {
212 #if defined (HAVE_FOPENCOOKIE)||  defined (HAVE_FUNOPEN)
213       struct fun_cookie_s *cookie;
214
215       cookie = jnlib_xmalloc (sizeof *cookie + strlen (name+9));
216       cookie->fd = -1;
217       cookie->quiet = 0;
218       strcpy (cookie->name, name+9);
219
220 #ifdef HAVE_FOPENCOOKIE
221       {
222         cookie_io_functions_t io = { NULL };
223         io.write = fun_writer;
224         io.close = fun_closer;
225
226         fp = fopencookie (cookie, "w", io);
227       }
228 #else /*!HAVE_FOPENCOOKIE*/
229       {
230         fp = funopen (cookie, NULL, fun_writer, NULL, fun_closer);
231       }
232 #endif /*!HAVE_FOPENCOOKIE*/
233 #else /* Neither fopencookie nor funopen. */
234       {
235         fprintf (stderr, "system does not support logging to a socket - "
236                  "using stderr\n");
237         fp = stderr;
238       }
239 #endif /* Neither fopencookie nor funopen. */
240     }
241   else
242     fp = (name && strcmp(name,"-"))? fopen (name, "a") : stderr;
243   if (!fp)
244     {
245       fprintf (stderr, "failed to open log file `%s': %s\n",
246                name? name:"[stderr]", strerror(errno));
247       return;
248     }
249   setvbuf (fp, NULL, _IOLBF, 0);
250   
251   if (logstream && logstream != stderr && logstream != stdout)
252     fclose (logstream);
253   logstream = fp;
254   missing_lf = 0;
255 }
256
257
258 void
259 log_set_fd (int fd)
260 {
261   FILE *fp;
262   
263   if (fd == 1)
264     fp = stdout;
265   else if (fd == 2)
266     fp = stderr;
267   else
268     fp = fdopen (fd, "a");
269   if (!fp)
270     {
271       fprintf (stderr, "failed to fdopen log fd %d: %s\n",
272                fd, strerror(errno));
273       return;
274     }
275   setvbuf (fp, NULL, _IOLBF, 0);
276   
277   if (logstream && logstream != stderr && logstream != stdout)
278     fclose( logstream);
279   logstream = fp;
280   missing_lf = 0;
281 }
282
283
284 void
285 log_set_prefix (const char *text, unsigned int flags)
286 {
287   if (text)
288     {
289       strncpy (prefix_buffer, text, sizeof (prefix_buffer)-1);
290       prefix_buffer[sizeof (prefix_buffer)-1] = 0;
291     }
292   
293   with_prefix = (flags & 1);
294   with_time = (flags & 2);
295   with_pid  = (flags & 4);
296 }
297
298
299 const char *
300 log_get_prefix (unsigned int *flags)
301 {
302   if (flags)
303     {
304       *flags = 0;
305       if (with_prefix)
306         *flags |= 1;
307       if (with_time)
308         *flags |= 2;
309       if (with_pid)
310         *flags |=4;
311     }
312   return prefix_buffer;
313 }
314
315 int
316 log_get_fd()
317 {
318     return fileno(logstream?logstream:stderr);
319 }
320
321 FILE *
322 log_get_stream ()
323 {
324     return logstream?logstream:stderr;
325 }
326
327
328 static void
329 do_logv( int level, const char *fmt, va_list arg_ptr )
330 {
331   if (!logstream)
332     logstream = stderr;
333
334   if (missing_lf && level != JNLIB_LOG_CONT)
335     putc('\n', logstream );
336   missing_lf = 0;
337
338   if (level != JNLIB_LOG_CONT)
339     { /* Note this does not work for multiple line logging as we would
340        * need to print to a buffer first */
341       if (with_time)
342         {
343           struct tm *tp;
344           time_t atime = time (NULL);
345           
346           tp = localtime (&atime);
347           fprintf (logstream, "%04d-%02d-%02d %02d:%02d:%02d ",
348                    1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday,
349                    tp->tm_hour, tp->tm_min, tp->tm_sec );
350         }
351       if (with_prefix)
352         fputs (prefix_buffer, logstream);
353       if (with_pid)
354         fprintf (logstream, "[%u]", (unsigned int)getpid ());
355       if (!with_time)
356         putc (':', logstream);
357       /* A leading backspace suppresses the extra space so that we can
358          correclty output, programname, filename and linenumber. */
359       if (fmt && *fmt == '\b')
360         fmt++;
361       else
362         putc (' ', logstream);
363     }
364
365   switch (level)
366     {
367     case JNLIB_LOG_BEGIN: break;
368     case JNLIB_LOG_CONT: break;
369     case JNLIB_LOG_INFO: break;
370     case JNLIB_LOG_WARN: break;
371     case JNLIB_LOG_ERROR: break;
372     case JNLIB_LOG_FATAL: fputs("Fatal: ",logstream ); break;
373     case JNLIB_LOG_BUG: fputs("Ohhhh jeeee: ", logstream); break;
374     case JNLIB_LOG_DEBUG: fputs("DBG: ", logstream ); break;
375     default: fprintf(logstream,"[Unknown log level %d]: ", level ); break;
376     }
377
378
379   if (fmt)
380     {
381       vfprintf(logstream,fmt,arg_ptr) ;
382       if (*fmt && fmt[strlen(fmt)-1] != '\n')
383         missing_lf = 1;
384     }
385
386   if (level == JNLIB_LOG_FATAL)
387     exit(2);
388   if (level == JNLIB_LOG_BUG)
389     abort();
390 }
391
392 static void
393 do_log( int level, const char *fmt, ... )
394 {
395     va_list arg_ptr ;
396
397     va_start( arg_ptr, fmt ) ;
398     do_logv( level, fmt, arg_ptr );
399     va_end(arg_ptr);
400 }
401
402
403 void
404 log_logv (int level, const char *fmt, va_list arg_ptr)
405 {
406   do_logv (level, fmt, arg_ptr);
407 }
408
409 void
410 log_info( const char *fmt, ... )
411 {
412     va_list arg_ptr ;
413
414     va_start( arg_ptr, fmt ) ;
415     do_logv( JNLIB_LOG_INFO, fmt, arg_ptr );
416     va_end(arg_ptr);
417 }
418
419 void
420 log_error( const char *fmt, ... )
421 {
422     va_list arg_ptr ;
423
424     va_start( arg_ptr, fmt ) ;
425     do_logv( JNLIB_LOG_ERROR, fmt, arg_ptr );
426     va_end(arg_ptr);
427     /* protect against counter overflow */
428     if( errorcount < 30000 )
429         errorcount++;
430 }
431
432
433 void
434 log_fatal( const char *fmt, ... )
435 {
436     va_list arg_ptr ;
437
438     va_start( arg_ptr, fmt ) ;
439     do_logv( JNLIB_LOG_FATAL, fmt, arg_ptr );
440     va_end(arg_ptr);
441     abort(); /* never called, but it makes the compiler happy */
442 }
443
444 void
445 log_bug( const char *fmt, ... )
446 {
447     va_list arg_ptr ;
448
449     va_start( arg_ptr, fmt ) ;
450     do_logv( JNLIB_LOG_BUG, fmt, arg_ptr );
451     va_end(arg_ptr);
452     abort(); /* never called, but it makes the compiler happy */
453 }
454
455 void
456 log_debug( const char *fmt, ... )
457 {
458     va_list arg_ptr ;
459
460     va_start( arg_ptr, fmt ) ;
461     do_logv( JNLIB_LOG_DEBUG, fmt, arg_ptr );
462     va_end(arg_ptr);
463 }
464
465
466 void
467 log_printf (const char *fmt, ...)
468 {
469   va_list arg_ptr;
470
471   va_start (arg_ptr, fmt);
472   do_logv (fmt ? JNLIB_LOG_CONT : JNLIB_LOG_BEGIN, fmt, arg_ptr);
473   va_end (arg_ptr);
474 }
475
476 /* Print a hexdump of BUFFER.  With TEXT of NULL print just the raw
477    dump, with TEXT just an empty string, print a trailing linefeed,
478    otherwise print an entire debug line. */
479 void
480 log_printhex (const char *text, const void *buffer, size_t length)
481 {
482   if (text && *text)
483     log_debug ("%s ", text);
484   if (length)
485     {
486       const unsigned char *p = buffer;
487       log_printf ("%02X", *p);
488       for (length--, p++; length--; p++)
489         log_printf (" %02X", *p);
490     }
491   if (text)
492     log_printf ("\n");
493 }
494
495
496 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
497 void
498 bug_at( const char *file, int line, const char *func )
499 {
500     do_log( JNLIB_LOG_BUG,
501              ("... this is a bug (%s:%d:%s)\n"), file, line, func );
502     abort(); /* never called, but it makes the compiler happy */
503 }
504 #else
505 void
506 bug_at( const char *file, int line )
507 {
508     do_log( JNLIB_LOG_BUG,
509              _("you found a bug ... (%s:%d)\n"), file, line);
510     abort(); /* never called, but it makes the compiler happy */
511 }
512 #endif
513