Unbreak compilation for compilers that don't recognize lone defs.
[privoxy.git] / errlog.c
1 const char errlog_rcs[] = "$Id: errlog.c,v 1.95 2009/05/28 17:07:42 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/errlog.c,v $
5  *
6  * Purpose     :  Log errors to a designated destination in an elegant,
7  *                printf-like fashion.
8  *
9  * Copyright   :  Written by and Copyright (C) 2001-2009 the SourceForge
10  *                Privoxy team. http://www.privoxy.org/
11  *
12  *                Based on the Internet Junkbuster originally written
13  *                by and Copyright (C) 1997 Anonymous Coders and 
14  *                Junkbusters Corporation.  http://www.junkbusters.com
15  *
16  *                This program is free software; you can redistribute it 
17  *                and/or modify it under the terms of the GNU General
18  *                Public License as published by the Free Software
19  *                Foundation; either version 2 of the License, or (at
20  *                your option) any later version.
21  *
22  *                This program is distributed in the hope that it will
23  *                be useful, but WITHOUT ANY WARRANTY; without even the
24  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
25  *                PARTICULAR PURPOSE.  See the GNU General Public
26  *                License for more details.
27  *
28  *                The GNU General Public License should be included with
29  *                this file.  If not, you can view it at
30  *                http://www.gnu.org/copyleft/gpl.html
31  *                or write to the Free Software Foundation, Inc., 59
32  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
33  *
34  *********************************************************************/
35
36
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <stdarg.h>
40 #include <string.h>
41
42 #include "config.h"
43 #include "miscutil.h"
44
45 /* For gettimeofday() */
46 #include <sys/time.h>
47
48 #if !defined(_WIN32) && !defined(__OS2__)
49 #include <unistd.h>
50 #endif /* !defined(_WIN32) && !defined(__OS2__) */
51
52 #include <errno.h>
53 #include <assert.h>
54
55 #ifdef _WIN32
56 #ifndef STRICT
57 #define STRICT
58 #endif
59 #include <windows.h>
60 #ifndef _WIN_CONSOLE
61 #include "w32log.h"
62 #endif /* ndef _WIN_CONSOLE */
63 #endif /* def _WIN32 */
64 #ifdef _MSC_VER
65 #define inline __inline
66 #endif /* def _MSC_VER */
67
68 #ifdef __OS2__
69 #include <sys/socket.h> /* For sock_errno */
70 #define INCL_DOS
71 #include <os2.h>
72 #endif
73
74 #include "errlog.h"
75 #include "project.h"
76 #include "jcc.h"
77
78 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
79
80
81 /*
82  * LOG_LEVEL_FATAL cannot be turned off.  (There are
83  * some exceptional situations where we need to get a
84  * message to the user).
85  */
86 #define LOG_LEVEL_MINIMUM  LOG_LEVEL_FATAL
87
88 /* where to log (default: stderr) */
89 static FILE *logfp = NULL;
90
91 /* logging detail level. XXX: stupid name. */
92 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
93
94 /* static functions */
95 static void fatal_error(const char * error_message);
96 #ifdef _WIN32
97 static char *w32_socket_strerr(int errcode, char *tmp_buf);
98 #endif
99 #ifdef __OS2__
100 static char *os2_socket_strerr(int errcode, char *tmp_buf);
101 #endif
102
103 #ifdef MUTEX_LOCKS_AVAILABLE
104 static inline void lock_logfile(void)
105 {
106    privoxy_mutex_lock(&log_mutex);
107 }
108 static inline void unlock_logfile(void)
109 {
110    privoxy_mutex_unlock(&log_mutex);
111 }
112 static inline void lock_loginit(void)
113 {
114    privoxy_mutex_lock(&log_init_mutex);
115 }
116 static inline void unlock_loginit(void)
117 {
118    privoxy_mutex_unlock(&log_init_mutex);
119 }
120 #else /* ! MUTEX_LOCKS_AVAILABLE */
121 /*
122  * FIXME we need a cross-platform locking mechanism.
123  * The locking/unlocking functions below should be 
124  * fleshed out for non-pthread implementations.
125  */ 
126 static inline void lock_logfile() {}
127 static inline void unlock_logfile() {}
128 static inline void lock_loginit() {}
129 static inline void unlock_loginit() {}
130 #endif
131
132 /*********************************************************************
133  *
134  * Function    :  fatal_error
135  *
136  * Description :  Displays a fatal error to standard error (or, on 
137  *                a WIN32 GUI, to a dialog box), and exits Privoxy
138  *                with status code 1.
139  *
140  * Parameters  :
141  *          1  :  error_message = The error message to display.
142  *
143  * Returns     :  Does not return.
144  *
145  *********************************************************************/
146 static void fatal_error(const char *error_message)
147 {
148 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
149    /* Skip timestamp and thread id for the message box. */
150    const char *box_message = strstr(error_message, "Fatal error");
151    if (NULL == box_message)
152    {
153       /* Shouldn't happen but ... */
154       box_message = error_message;
155    }
156    MessageBox(g_hwndLogFrame, box_message, "Privoxy Error", 
157       MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);  
158
159    /* Cleanup - remove taskbar icon etc. */
160    TermLogWindow();
161 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
162
163    if (logfp != NULL)
164    {
165       fputs(error_message, logfp);
166    }
167
168 #if defined(unix)
169    if (pidfile)
170    {
171       unlink(pidfile);
172    }
173 #endif /* unix */
174
175    exit(1);
176 }
177
178
179 /*********************************************************************
180  *
181  * Function    :  show_version
182  *
183  * Description :  Logs the Privoxy version and the program name.
184  *
185  * Parameters  :
186  *          1  :  prog_name = The program name.
187  *
188  * Returns     :  Nothing.
189  *
190  *********************************************************************/
191 void show_version(const char *prog_name)
192 {
193    log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
194    if (prog_name != NULL)
195    {
196       log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
197    }
198 }
199
200
201 /*********************************************************************
202  *
203  * Function    :  init_log_module
204  *
205  * Description :  Initializes the logging module to log to stderr.
206  *                Can only be called while stderr hasn't been closed
207  *                yet and is only supposed to be called once.
208  *
209  * Parameters  :
210  *          1  :  prog_name = The program name.
211  *
212  * Returns     :  Nothing.
213  *
214  *********************************************************************/
215 void init_log_module(void)
216 {
217    lock_logfile();
218    logfp = stderr;
219    unlock_logfile();
220    set_debug_level(debug);
221 }
222
223
224 /*********************************************************************
225  *
226  * Function    :  set_debug_level
227  *
228  * Description :  Sets the debug level to the provided value
229  *                plus LOG_LEVEL_MINIMUM.
230  *
231  *                XXX: we should only use the LOG_LEVEL_MINIMUM
232  *                until the first time the configuration file has
233  *                been parsed.
234  *                
235  * Parameters  :  1: debug_level = The debug level to set.
236  *
237  * Returns     :  Nothing.
238  *
239  *********************************************************************/
240 void set_debug_level(int debug_level)
241 {
242    debug = debug_level | LOG_LEVEL_MINIMUM;
243 }
244
245
246 /*********************************************************************
247  *
248  * Function    :  disable_logging
249  *
250  * Description :  Disables logging.
251  *                
252  * Parameters  :  None.
253  *
254  * Returns     :  Nothing.
255  *
256  *********************************************************************/
257 void disable_logging(void)
258 {
259    if (logfp != NULL)
260    {
261       log_error(LOG_LEVEL_INFO,
262          "No logfile configured. Please enable it before reporting any problems.");
263       lock_logfile();
264       fclose(logfp);
265       logfp = NULL;
266       unlock_logfile();
267    }
268 }
269
270
271 /*********************************************************************
272  *
273  * Function    :  init_error_log
274  *
275  * Description :  Initializes the logging module to log to a file.
276  *
277  *                XXX: should be renamed.
278  *
279  * Parameters  :
280  *          1  :  prog_name  = The program name.
281  *          2  :  logfname   = The logfile to (re)open.
282  *
283  * Returns     :  N/A
284  *
285  *********************************************************************/
286 void init_error_log(const char *prog_name, const char *logfname)
287 {
288    FILE *fp;
289
290    assert(NULL != logfname);
291
292    lock_loginit();
293
294    if ((logfp != NULL) && (logfp != stderr))
295    {
296       log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
297    }
298
299    /* set the designated log file */
300    fp = fopen(logfname, "a");
301    if ((NULL == fp) && (logfp != NULL))
302    {
303       /*
304        * Some platforms (like OS/2) don't allow us to open
305        * the same file twice, therefore we give it another
306        * shot after closing the old file descriptor first.
307        *
308        * We don't do it right away because it prevents us
309        * from logging the "can't open logfile" message to
310        * the old logfile.
311        *
312        * XXX: this is a lame workaround and once the next
313        * release is out we should stop bothering reopening
314        * the logfile unless we have to.
315        *
316        * Currently we reopen it every time the config file
317        * has been reloaded, but actually we only have to
318        * reopen it if the file name changed or if the
319        * configuration reloas was caused by a SIGHUP.
320        */
321       log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
322          "Retrying after closing the old file descriptor first. If that "
323          "doesn't work, Privoxy will exit without being able to log a message.",
324          logfname);
325       lock_logfile();
326       fclose(logfp);
327       logfp = NULL;
328       unlock_logfile();
329       fp = fopen(logfname, "a");
330    }
331
332    if (NULL == fp)
333    {
334       log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
335    }
336
337    /* set logging to be completely unbuffered */
338    setbuf(fp, NULL);
339
340    lock_logfile();
341    if (logfp != NULL)
342    {
343       fclose(logfp);
344    }
345    logfp = fp;
346    unlock_logfile();
347
348    show_version(prog_name);
349
350    unlock_loginit();
351
352 } /* init_error_log */
353
354
355 /*********************************************************************
356  *
357  * Function    :  get_thread_id
358  *
359  * Description :  Returns a number that is different for each thread.
360  *
361  *                XXX: Should be moved elsewhere (miscutil.c?)
362  *                
363  * Parameters  :  None
364  *
365  * Returns     :  thread_id
366  *
367  *********************************************************************/
368 static long get_thread_id(void)
369 {
370    long this_thread = 1;  /* was: pthread_t this_thread;*/
371
372 #ifdef __OS2__
373    PTIB     ptib;
374    APIRET   ulrc; /* XXX: I have no clue what this does */
375 #endif /* __OS2__ */
376
377    /* FIXME get current thread id */
378 #ifdef FEATURE_PTHREAD
379    this_thread = (long)pthread_self();
380 #ifdef __MACH__
381    /*
382     * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
383     * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
384     * pthread_t is supposed to be opaque... but it's fairly random, though, so
385     * we make it mostly presentable.
386     */
387    this_thread = abs(this_thread % 1000);
388 #endif /* def __MACH__ */
389 #elif defined(_WIN32)
390    this_thread = GetCurrentThreadId();
391 #elif defined(__OS2__)
392    ulrc = DosGetInfoBlocks(&ptib, NULL);
393    if (ulrc == 0)
394      this_thread = ptib -> tib_ptib2 -> tib2_ultid;
395 #endif /* def FEATURE_PTHREAD */
396
397    return this_thread;
398 }
399
400
401 /*********************************************************************
402  *
403  * Function    :  get_log_timestamp
404  *
405  * Description :  Generates the time stamp for the log message prefix.
406  *
407  * Parameters  :
408  *          1  :  buffer = Storage buffer
409  *          2  :  buffer_size = Size of storage buffer
410  *
411  * Returns     :  Number of written characters or 0 for error.
412  *
413  *********************************************************************/
414 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
415 {
416    size_t length;
417    time_t now; 
418    struct tm tm_now;
419    struct timeval tv_now; /* XXX: stupid name */
420    long msecs;
421    int msecs_length = 0;
422
423    gettimeofday(&tv_now, NULL);
424    msecs = tv_now.tv_usec / 1000;
425
426    time(&now);
427
428 #ifdef HAVE_LOCALTIME_R
429    tm_now = *localtime_r(&now, &tm_now);
430 #elif defined(MUTEX_LOCKS_AVAILABLE)
431    privoxy_mutex_lock(&localtime_mutex);
432    tm_now = *localtime(&now); 
433    privoxy_mutex_unlock(&localtime_mutex);
434 #else
435    tm_now = *localtime(&now); 
436 #endif
437
438    length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
439    if (length > (size_t)0)
440    {
441       msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);               
442    }
443    if (msecs_length > 0)
444    {
445       length += (size_t)msecs_length;
446    }
447    else
448    {
449       length = 0;
450    }
451
452    return length;
453 }
454
455
456 /*********************************************************************
457  *
458  * Function    :  get_clf_timestamp
459  *
460  * Description :  Generates a Common Log Format time string.
461  *
462  * Parameters  :
463  *          1  :  buffer = Storage buffer
464  *          2  :  buffer_size = Size of storage buffer
465  *
466  * Returns     :  Number of written characters or 0 for error.
467  *
468  *********************************************************************/
469 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
470 {
471    /*
472     * Complex because not all OSs have tm_gmtoff or
473     * the %z field in strftime()
474     */
475    time_t now;
476    struct tm *tm_now; 
477    struct tm gmt;
478 #ifdef HAVE_LOCALTIME_R
479    struct tm dummy;
480 #endif
481    int days, hrs, mins;
482    size_t length;
483    int tz_length = 0;
484
485    time (&now); 
486 #ifdef HAVE_GMTIME_R
487    gmt = *gmtime_r(&now, &gmt);
488 #elif defined(MUTEX_LOCKS_AVAILABLE)
489    privoxy_mutex_lock(&gmtime_mutex);
490    gmt = *gmtime(&now);
491    privoxy_mutex_unlock(&gmtime_mutex);
492 #else
493    gmt = *gmtime(&now);
494 #endif
495 #ifdef HAVE_LOCALTIME_R
496    tm_now = localtime_r(&now, &dummy);
497 #elif defined(MUTEX_LOCKS_AVAILABLE)
498    privoxy_mutex_lock(&localtime_mutex);
499    tm_now = localtime(&now); 
500    privoxy_mutex_unlock(&localtime_mutex);
501 #else
502    tm_now = localtime(&now); 
503 #endif
504    days = tm_now->tm_yday - gmt.tm_yday; 
505    hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour); 
506    mins = hrs * 60 + tm_now->tm_min - gmt.tm_min; 
507
508    length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
509
510    if (length > (size_t)0)
511    {
512       tz_length = snprintf(buffer+length, buffer_size-length,
513                      "%+03d%02d", mins / 60, abs(mins) % 60);
514    }
515    if (tz_length > 0)
516    {
517       length += (size_t)tz_length;
518    }
519    else
520    {
521       length = 0;
522    }
523
524    return length;
525 }
526
527
528 /*********************************************************************
529  *
530  * Function    :  get_log_level_string
531  *
532  * Description :  Translates a numerical loglevel into a string.
533  *
534  * Parameters  :  
535  *          1  :  loglevel = LOG_LEVEL_FOO
536  *
537  * Returns     :  Log level string.
538  *
539  *********************************************************************/
540 static inline const char *get_log_level_string(int loglevel)
541 {
542    char *log_level_string = NULL;
543
544    assert(0 < loglevel);
545
546    switch (loglevel)
547    {
548       case LOG_LEVEL_ERROR:
549          log_level_string = "Error";
550          break;
551       case LOG_LEVEL_FATAL:
552          log_level_string = "Fatal error";
553          break;
554       case LOG_LEVEL_GPC:
555          log_level_string = "Request";
556          break;
557       case LOG_LEVEL_CONNECT:
558          log_level_string = "Connect";
559          break;
560       case LOG_LEVEL_LOG:
561          log_level_string = "Writing";
562          break;
563       case LOG_LEVEL_HEADER:
564          log_level_string = "Header";
565          break;
566       case LOG_LEVEL_INFO:
567          log_level_string = "Info";
568          break;
569       case LOG_LEVEL_RE_FILTER:
570          log_level_string = "Re-Filter";
571          break;
572 #ifdef FEATURE_FORCE_LOAD
573       case LOG_LEVEL_FORCE:
574          log_level_string = "Force";
575          break;
576 #endif /* def FEATURE_FORCE_LOAD */
577 #ifdef FEATURE_FAST_REDIRECTS
578       case LOG_LEVEL_REDIRECTS:
579          log_level_string = "Redirect";
580          break;
581 #endif /* def FEATURE_FAST_REDIRECTS */
582       case LOG_LEVEL_DEANIMATE:
583          log_level_string = "Gif-Deanimate";
584          break;
585       case LOG_LEVEL_CRUNCH:
586          log_level_string = "Crunch";
587          break;
588       case LOG_LEVEL_CGI:
589          log_level_string = "CGI";
590          break;
591       default:
592          log_level_string = "Unknown log level";
593          break;
594    }
595    assert(NULL != log_level_string);
596
597    return log_level_string;
598 }
599
600
601 /*********************************************************************
602  *
603  * Function    :  log_error
604  *
605  * Description :  This is the error-reporting and logging function.
606  *
607  * Parameters  :
608  *          1  :  loglevel  = the type of message to be logged
609  *          2  :  fmt       = the main string we want logged, printf-like
610  *          3  :  ...       = arguments to be inserted in fmt (printf-like).
611  *
612  * Returns     :  N/A
613  *
614  *********************************************************************/
615 void log_error(int loglevel, const char *fmt, ...)
616 {
617    va_list ap;
618    char *outbuf = NULL;
619    static char *outbuf_save = NULL;
620    char tempbuf[BUFFER_SIZE];
621    size_t length = 0;
622    const char * src = fmt;
623    long thread_id;
624    char timestamp[30];
625    /*
626     * XXX: Make this a config option,
627     * why else do we allocate instead of using
628     * an array?
629     */
630    size_t log_buffer_size = BUFFER_SIZE;
631
632 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
633    /*
634     * Irrespective of debug setting, a GET/POST/CONNECT makes
635     * the taskbar icon animate.  (There is an option to disable
636     * this but checking that is handled inside LogShowActivity()).
637     */
638    if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
639    {
640       LogShowActivity();
641    }
642 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
643
644    /*
645     * verify that the loglevel applies to current
646     * settings and that logging is enabled.
647     * Bail out otherwise.
648     */
649    if ((0 == (loglevel & debug))
650 #ifndef _WIN32
651       || (logfp == NULL)
652 #endif
653       )
654    {
655       if (loglevel == LOG_LEVEL_FATAL)
656       {
657          fatal_error("Fatal error. You're not supposed to"
658             "see this message. Please file a bug report.");
659       }
660       return;
661    }
662
663    thread_id = get_thread_id();
664    get_log_timestamp(timestamp, sizeof(timestamp));
665
666    /* protect the whole function because of the static buffer (outbuf) */
667    lock_logfile();
668
669    if (NULL == outbuf_save) 
670    {
671       outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
672       if (NULL == outbuf_save)
673       {
674          snprintf(tempbuf, sizeof(tempbuf),
675             "%s %08lx Fatal error: Out of memory in log_error().",
676             timestamp, thread_id);
677          fatal_error(tempbuf); /* Exit */
678          return;
679       }
680    }
681    outbuf = outbuf_save;
682
683    /*
684     * Memsetting the whole buffer to zero (in theory)
685     * makes things easier later on.
686     */
687    memset(outbuf, 0, log_buffer_size);
688
689    /* Add prefix for everything but Common Log Format messages */
690    if (loglevel != LOG_LEVEL_CLF)
691    {
692       length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
693          timestamp, thread_id, get_log_level_string(loglevel));
694    }
695
696    /* get ready to scan var. args. */
697    va_start(ap, fmt);
698
699    /* build formatted message from fmt and var-args */
700    while ((*src) && (length < log_buffer_size-2))
701    {
702       const char *sval = NULL; /* %N string  */
703       int ival;                /* %N string length or an error code */
704       unsigned uval;           /* %u value */
705       long lval;               /* %l value */
706       unsigned long ulval;     /* %ul value */
707       char ch;
708       const char *format_string = tempbuf;
709
710       ch = *src++;
711       if (ch != '%')
712       {
713          outbuf[length++] = ch;
714          /*
715           * XXX: Only necessary on platforms where multiple threads
716           * can write to the buffer at the same time because we
717           * don't support mutexes (OS/2 for example).
718           */
719          outbuf[length] = '\0';
720          continue;
721       }
722       outbuf[length] = '\0';
723       ch = *src++;
724       switch (ch) {
725          case '%':
726             tempbuf[0] = '%';
727             tempbuf[1] = '\0';
728             break;
729          case 'd':
730             ival = va_arg( ap, int );
731             snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
732             break;
733          case 'u':
734             uval = va_arg( ap, unsigned );
735             snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
736             break;
737          case 'l':
738             /* this is a modifier that must be followed by u, lu, or d */
739             ch = *src++;
740             if (ch == 'd')
741             {
742                lval = va_arg( ap, long );
743                snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
744             }
745             else if (ch == 'u')
746             {
747                ulval = va_arg( ap, unsigned long );
748                snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
749             }
750             else if ((ch == 'l') && (*src == 'u'))
751             {
752                unsigned long long lluval = va_arg(ap, unsigned long long);
753                snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
754                src++;
755             }
756             else
757             {
758                snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
759                loglevel = LOG_LEVEL_FATAL;
760             }
761             break;
762          case 'c':
763             /*
764              * Note that char paramaters are converted to int, so we need to
765              * pass "int" to va_arg.  (See K&R, 2nd ed, section A7.3.2, page 202)
766              */
767             tempbuf[0] = (char) va_arg(ap, int);
768             tempbuf[1] = '\0';
769             break;
770          case 's':
771             format_string = va_arg(ap, char *);
772             if (format_string == NULL)
773             {
774                format_string = "[null]";
775             }
776             break;
777          case 'N':
778             /*
779              * Non-standard: Print a counted unterminated string.
780              * Takes 2 parameters: int length, const char * string.
781              */
782             ival = va_arg(ap, int);
783             sval = va_arg(ap, char *);
784             if (sval == NULL)
785             {
786                format_string = "[null]";
787             }
788             else if (ival <= 0)
789             {
790                if (0 == ival)
791                {
792                   /* That's ok (but stupid) */
793                   tempbuf[0] = '\0';
794                }
795                else
796                {
797                   /*
798                    * That's not ok (and even more stupid)
799                    */
800                   assert(ival >= 0);
801                   format_string = "[counted string lenght < 0]";
802                }
803             }
804             else if ((size_t)ival >= sizeof(tempbuf))
805             {
806                /*
807                 * String is too long, copy as much as possible.
808                 * It will be further truncated later.
809                 */
810                memcpy(tempbuf, sval, sizeof(tempbuf)-1);
811                tempbuf[sizeof(tempbuf)-1] = '\0';
812             }
813             else
814             {
815                memcpy(tempbuf, sval, (size_t) ival);
816                tempbuf[ival] = '\0';
817             }
818             break;
819          case 'E':
820             /* Non-standard: Print error code from errno */
821 #ifdef _WIN32
822             ival = WSAGetLastError();
823             format_string = w32_socket_strerr(ival, tempbuf);
824 #elif __OS2__
825             ival = sock_errno();
826             if (ival != 0)
827             {
828                format_string = os2_socket_strerr(ival, tempbuf);
829             }
830             else
831             {
832                ival = errno;
833                format_string = strerror(ival);
834             }
835 #else /* ifndef _WIN32 */
836             ival = errno; 
837 #ifdef HAVE_STRERROR
838             format_string = strerror(ival);
839 #else /* ifndef HAVE_STRERROR */
840             format_string = NULL;
841 #endif /* ndef HAVE_STRERROR */
842             if (sval == NULL)
843             {
844                snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
845             }
846 #endif /* ndef _WIN32 */
847             break;
848          case 'T':
849             /* Non-standard: Print a Common Log File timestamp */
850             get_clf_timestamp(tempbuf, sizeof(tempbuf));
851             break;
852          default:
853             snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
854             loglevel = LOG_LEVEL_FATAL;
855             break;
856       } /* switch( p ) */
857
858       assert(length < log_buffer_size);
859       length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
860
861       if (length >= log_buffer_size-2)
862       {
863          static char warning[] = "... [too long, truncated]";
864
865          length = log_buffer_size - sizeof(warning) - 1;
866          length += strlcpy(outbuf + length, warning, log_buffer_size - length);
867          assert(length < log_buffer_size);
868
869          break;
870       }
871    } /* for( p ... ) */
872
873    /* done with var. args */
874    va_end(ap);
875
876    assert(length < log_buffer_size);
877    length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
878
879    /* Some sanity checks */
880    if ((length >= log_buffer_size)
881     || (outbuf[log_buffer_size-1] != '\0')
882     || (outbuf[log_buffer_size] != '\0')
883       )
884    {
885       /* Repeat as assertions */
886       assert(length < log_buffer_size);
887       assert(outbuf[log_buffer_size-1] == '\0');
888       /*
889        * outbuf's real size is log_buffer_size+1,
890        * so while this looks like an off-by-one,
891        * we're only checking our paranoia byte.
892        */
893       assert(outbuf[log_buffer_size] == '\0');
894
895       snprintf(outbuf, log_buffer_size,
896          "%s %08lx Fatal error: log_error()'s sanity checks failed."
897          "length: %d. Exiting.",
898          timestamp, thread_id, (int)length);
899       loglevel = LOG_LEVEL_FATAL;
900    }
901
902 #ifndef _WIN32
903    /*
904     * On Windows this is acceptable in case
905     * we are logging to the GUI window only.
906     */
907    assert(NULL != logfp);
908 #endif
909
910    if (loglevel == LOG_LEVEL_FATAL)
911    {
912       fatal_error(outbuf_save);
913       /* Never get here */
914    }
915    if (logfp != NULL)
916    {
917       fputs(outbuf_save, logfp);
918    }
919
920 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
921    /* Write to display */
922    LogPutString(outbuf_save);
923 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
924
925    unlock_logfile();
926
927 }
928
929
930 /*********************************************************************
931  *
932  * Function    :  jb_err_to_string
933  *
934  * Description :  Translates JB_ERR_FOO codes into strings.
935  *
936  *                XXX: the type of error codes is jb_err
937  *                but the typedef'inition is currently not
938  *                visible to all files that include errlog.h.
939  *
940  * Parameters  :
941  *          1  :  error = a valid jb_err code
942  *
943  * Returns     :  A string with the jb_err translation
944  *
945  *********************************************************************/
946 const char *jb_err_to_string(int error)
947 {
948    switch (error)
949    {
950       case JB_ERR_OK:
951          return "Success, no error";
952       case JB_ERR_MEMORY:
953          return "Out of memory";
954       case JB_ERR_CGI_PARAMS:
955          return "Missing or corrupt CGI parameters";
956       case JB_ERR_FILE:
957          return "Error opening, reading or writing a file";
958       case JB_ERR_PARSE:
959          return "Parse error";
960       case JB_ERR_MODIFIED:
961          return "File has been modified outside of the CGI actions editor.";
962       case JB_ERR_COMPRESS:
963          return "(De)compression failure";
964       default:
965          assert(0);
966          return "Unknown error";
967    }
968    assert(0);
969    return "Internal error";
970 }
971
972 #ifdef _WIN32
973 /*********************************************************************
974  *
975  * Function    :  w32_socket_strerr
976  *
977  * Description :  Translate the return value from WSAGetLastError()
978  *                into a string.
979  *
980  * Parameters  :
981  *          1  :  errcode = The return value from WSAGetLastError().
982  *          2  :  tmp_buf = A temporary buffer that might be used to
983  *                          store the string.
984  *
985  * Returns     :  String representing the error code.  This may be
986  *                a global string constant or a string stored in
987  *                tmp_buf.
988  *
989  *********************************************************************/
990 static char *w32_socket_strerr(int errcode, char *tmp_buf)
991 {
992 #define TEXT_FOR_ERROR(code,text) \
993    if (errcode == code)           \
994    {                              \
995       return #code " - " text;    \
996    }
997
998    TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
999    TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1000    TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1001    TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1002    TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1003    TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1004    TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1005    TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1006    TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1007    TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1008    TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1009    TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1010    TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1011    TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1012    TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1013    TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1014    TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1015    TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1016    TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1017    TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1018    TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1019    TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1020    TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1021    TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1022    TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1023    TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1024    TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1025    TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1026    TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1027    TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1028    TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1029    TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1030    TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1031    TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1032    TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1033    TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1034    TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1035    TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1036    TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1037    TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1038    TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1039    TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1040    /*
1041     * The following error codes are documented in the Microsoft WinSock
1042     * reference guide, but don't actually exist.
1043     *
1044     * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1045     * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1046     * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1047     * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1048     * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1049     * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1050     * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1051     * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1052     * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1053     * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1054     */
1055
1056    sprintf(tmp_buf, "(error number %d)", errcode);
1057    return tmp_buf;
1058 }
1059 #endif /* def _WIN32 */
1060
1061
1062 #ifdef __OS2__
1063 /*********************************************************************
1064  *
1065  * Function    :  os2_socket_strerr
1066  *
1067  * Description :  Translate the return value from sock_errno()
1068  *                into a string.
1069  *
1070  * Parameters  :
1071  *          1  :  errcode = The return value from sock_errno().
1072  *          2  :  tmp_buf = A temporary buffer that might be used to
1073  *                          store the string.
1074  *
1075  * Returns     :  String representing the error code.  This may be
1076  *                a global string constant or a string stored in
1077  *                tmp_buf.
1078  *
1079  *********************************************************************/
1080 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1081 {
1082 #define TEXT_FOR_ERROR(code,text) \
1083    if (errcode == code)           \
1084    {                              \
1085       return #code " - " text;    \
1086    }
1087
1088    TEXT_FOR_ERROR(SOCEPERM          , "Not owner.")
1089    TEXT_FOR_ERROR(SOCESRCH          , "No such process.")
1090    TEXT_FOR_ERROR(SOCEINTR          , "Interrupted system call.")
1091    TEXT_FOR_ERROR(SOCENXIO          , "No such device or address.")
1092    TEXT_FOR_ERROR(SOCEBADF          , "Bad file number.")
1093    TEXT_FOR_ERROR(SOCEACCES         , "Permission denied.")
1094    TEXT_FOR_ERROR(SOCEFAULT         , "Bad address.")
1095    TEXT_FOR_ERROR(SOCEINVAL         , "Invalid argument.")
1096    TEXT_FOR_ERROR(SOCEMFILE         , "Too many open files.")
1097    TEXT_FOR_ERROR(SOCEPIPE          , "Broken pipe.")
1098    TEXT_FOR_ERROR(SOCEWOULDBLOCK    , "Operation would block.")
1099    TEXT_FOR_ERROR(SOCEINPROGRESS    , "Operation now in progress.")
1100    TEXT_FOR_ERROR(SOCEALREADY       , "Operation already in progress.")
1101    TEXT_FOR_ERROR(SOCENOTSOCK       , "Socket operation on non-socket.")
1102    TEXT_FOR_ERROR(SOCEDESTADDRREQ   , "Destination address required.")
1103    TEXT_FOR_ERROR(SOCEMSGSIZE       , "Message too long.")
1104    TEXT_FOR_ERROR(SOCEPROTOTYPE     , "Protocol wrong type for socket.")
1105    TEXT_FOR_ERROR(SOCENOPROTOOPT    , "Protocol not available.")
1106    TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1107    TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1108    TEXT_FOR_ERROR(SOCEOPNOTSUPP     , "Operation not supported.")
1109    TEXT_FOR_ERROR(SOCEPFNOSUPPORT   , "Protocol family not supported.")
1110    TEXT_FOR_ERROR(SOCEAFNOSUPPORT   , "Address family not supported by protocol family.")
1111    TEXT_FOR_ERROR(SOCEADDRINUSE     , "Address already in use.")
1112    TEXT_FOR_ERROR(SOCEADDRNOTAVAIL  , "Can't assign requested address.")
1113    TEXT_FOR_ERROR(SOCENETDOWN       , "Network is down.")
1114    TEXT_FOR_ERROR(SOCENETUNREACH    , "Network is unreachable.")
1115    TEXT_FOR_ERROR(SOCENETRESET      , "Network dropped connection on reset.")
1116    TEXT_FOR_ERROR(SOCECONNABORTED   , "Software caused connection abort.")
1117    TEXT_FOR_ERROR(SOCECONNRESET     , "Connection reset by peer.")
1118    TEXT_FOR_ERROR(SOCENOBUFS        , "No buffer space available.")
1119    TEXT_FOR_ERROR(SOCEISCONN        , "Socket is already connected.")
1120    TEXT_FOR_ERROR(SOCENOTCONN       , "Socket is not connected.")
1121    TEXT_FOR_ERROR(SOCESHUTDOWN      , "Can't send after socket shutdown.")
1122    TEXT_FOR_ERROR(SOCETOOMANYREFS   , "Too many references: can't splice.")
1123    TEXT_FOR_ERROR(SOCETIMEDOUT      , "Operation timed out.")
1124    TEXT_FOR_ERROR(SOCECONNREFUSED   , "Connection refused.")
1125    TEXT_FOR_ERROR(SOCELOOP          , "Too many levels of symbolic links.")
1126    TEXT_FOR_ERROR(SOCENAMETOOLONG   , "File name too long.")
1127    TEXT_FOR_ERROR(SOCEHOSTDOWN      , "Host is down.")
1128    TEXT_FOR_ERROR(SOCEHOSTUNREACH   , "No route to host.")
1129    TEXT_FOR_ERROR(SOCENOTEMPTY      , "Directory not empty.")
1130    TEXT_FOR_ERROR(SOCEOS2ERR        , "OS/2 Error.")
1131
1132    sprintf(tmp_buf, "(error number %d)", errcode);
1133    return tmp_buf;
1134 }
1135 #endif /* def __OS2__ */
1136
1137
1138 /*
1139   Local Variables:
1140   tab-width: 3
1141   end:
1142 */