In init_error_log(), suppress the "(Re-)Opening logfile" message if
[privoxy.git] / errlog.c
1 const char errlog_rcs[] = "$Id: errlog.c,v 1.90 2009/03/18 20:43:19 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  * Revisions   :
35  *    $Log: errlog.c,v $
36  *    Revision 1.90  2009/03/18 20:43:19  fabiankeil
37  *    Don't enable LOG_LEVEL_INFO by default and don't apply the user's
38  *    debug settings until the logfile has been opened (if there is one).
39  *    Patch submitted by Roland in #2624120.
40  *
41  *    Revision 1.89  2009/03/07 12:56:12  fabiankeil
42  *    Add log_error() support for unsigned long long (%lld).
43  *
44  *    Revision 1.88  2009/03/07 11:34:36  fabiankeil
45  *    Omit timestamp and thread id in the mingw32 message box.
46  *
47  *    Revision 1.87  2009/03/01 18:28:24  fabiankeil
48  *    Help clang understand that we aren't dereferencing
49  *    NULL pointers here.
50  *
51  *    Revision 1.86  2009/02/09 21:21:15  fabiankeil
52  *    Now that init_log_module() is called earlier, call show_version()
53  *    later on from main() directly so it doesn't get called for --help
54  *    or --version.
55  *
56  *    Revision 1.85  2009/02/06 17:51:38  fabiankeil
57  *    Be prepared if I break the log module initialization again.
58  *
59  *    Revision 1.84  2008/12/14 15:46:22  fabiankeil
60  *    Give crunched requests their own log level.
61  *
62  *    Revision 1.83  2008/12/04 18:14:32  fabiankeil
63  *    Fix some cparser warnings.
64  *
65  *    Revision 1.82  2008/11/23 16:06:58  fabiankeil
66  *    Update a log message I missed in 1.80.
67  *
68  *    Revision 1.81  2008/11/23 15:59:27  fabiankeil
69  *    - Update copyright range.
70  *    - Remove stray line breaks in a log message
71  *      nobody is supposed to see anyway.
72  *
73  *    Revision 1.80  2008/11/23 15:49:49  fabiankeil
74  *    In log_error(), don't surround the thread id with "Privoxy(" and ")".
75  *
76  *    Revision 1.79  2008/10/20 17:09:25  fabiankeil
77  *    Update init_error_log() description to match reality.
78  *
79  *    Revision 1.78  2008/09/07 16:59:31  fabiankeil
80  *    Update a comment to reflect that we
81  *    have mutex support on mingw32 now.
82  *
83  *    Revision 1.77  2008/09/07 12:43:44  fabiankeil
84  *    Move the LogPutString() call in log_error() into the locked
85  *    region so the Windows GUI log is consistent with the logfile.
86  *
87  *    Revision 1.76  2008/09/07 12:35:05  fabiankeil
88  *    Add mutex lock support for _WIN32.
89  *
90  *    Revision 1.75  2008/09/04 08:13:58  fabiankeil
91  *    Prepare for critical sections on Windows by adding a
92  *    layer of indirection before the pthread mutex functions.
93  *
94  *    Revision 1.74  2008/08/06 18:33:36  fabiankeil
95  *    If the "close fd first" workaround doesn't work,
96  *    the fatal error message will be lost, so we better
97  *    explain the consequences while we still can.
98  *
99  *    Revision 1.73  2008/08/04 19:06:55  fabiankeil
100  *    Add a lame workaround for the "can't open an already open
101  *    logfile on OS/2" problem reported by Maynard in #2028842
102  *    and describe what a real solution would look like.
103  *
104  *    Revision 1.72  2008/07/27 12:04:28  fabiankeil
105  *    Fix a comment typo.
106  *
107  *    Revision 1.71  2008/06/28 17:17:15  fabiankeil
108  *    Remove another stray semicolon.
109  *
110  *    Revision 1.70  2008/06/28 17:10:29  fabiankeil
111  *    Remove stray semicolon in get_log_timestamp().
112  *    Reported by Jochen Voss in #2005221.
113  *
114  *    Revision 1.69  2008/05/30 15:55:25  fabiankeil
115  *    Declare variable "debug" static and complain about its name.
116  *
117  *    Revision 1.68  2008/04/27 16:50:46  fabiankeil
118  *    Remove an incorrect assertion. The value of debug may change if
119  *    the configuration is reloaded in another thread. While we could
120  *    cache the initial value, the assertion doesn't seem worth it.
121  *
122  *    Revision 1.67  2008/03/27 18:27:23  fabiankeil
123  *    Remove kill-popups action.
124  *
125  *    Revision 1.66  2008/01/31 15:38:14  fabiankeil
126  *    - Make the logfp assertion more strict. As of 1.63, the "||" could
127  *      have been an "&&", which means we can use two separate assertions
128  *      and skip on of them on Windows.
129  *    - Break a long commit message line in two.
130  *
131  *    Revision 1.65  2008/01/31 14:44:33  fabiankeil
132  *    Use (a != b) instead of !(a == b) so the sanity check looks less insane.
133  *
134  *    Revision 1.64  2008/01/21 18:56:46  david__schmidt
135  *    Swap #def from negative to positive, re-joined it so it didn't
136  *    span an assertion (compilation failure on OS/2)
137  *
138  *    Revision 1.63  2007/12/15 19:49:32  fabiankeil
139  *    Stop overloading logfile to control the mingw32 log window as well.
140  *    It's no longer necessary now that we disable all debug lines by default
141  *    and at least one user perceived it as a regression (added in 1.55).
142  *
143  *    Revision 1.62  2007/11/30 15:33:46  fabiankeil
144  *    Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
145  *    and on mingw32 fatal log messages didn't end up in the log file.
146  *
147  *    Revision 1.61  2007/11/04 19:03:01  fabiankeil
148  *    Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
149  *
150  *    Revision 1.60  2007/11/03 19:03:31  fabiankeil
151  *    - Prevent the Windows GUI from showing the version two times in a row.
152  *    - Stop using the imperative in the "(Re-)Open logfile" message.
153  *    - Ditch the "Switching to daemon mode" message as the detection
154  *      whether or not we're already in daemon mode doesn't actually work.
155  *
156  *    Revision 1.59  2007/11/01 12:50:56  fabiankeil
157  *    Here's looking at you, deadlock.
158  *
159  *    Revision 1.58  2007/10/28 19:04:21  fabiankeil
160  *    Don't mention daemon mode in "Logging disabled" message. Some
161  *    platforms call it differently and it's not really relevant anyway.
162  *
163  *    Revision 1.57  2007/10/27 13:02:26  fabiankeil
164  *    Relocate daemon-mode-related log messages to make sure
165  *    they aren't shown again in case of configuration reloads.
166  *
167  *    Revision 1.56  2007/10/14 14:26:56  fabiankeil
168  *    Remove the old log_error() version.
169  *
170  *    Revision 1.55  2007/10/14 14:12:41  fabiankeil
171  *    When in daemon mode, close stderr after the configuration file has been
172  *    parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
173  *
174  *    Revision 1.54  2007/09/22 16:15:34  fabiankeil
175  *    - Let it compile with pcc.
176  *    - Move our includes below system includes to prevent macro conflicts.
177  *
178  *    Revision 1.53  2007/08/05 13:53:14  fabiankeil
179  *    #1763173 from Stefan Huehner: declare some more functions
180  *    static and use void instead of empty parameter lists.
181  *
182  *    Revision 1.52  2007/07/14 07:28:47  fabiankeil
183  *    Add translation function for JB_ERR_FOO codes.
184  *
185  *    Revision 1.51  2007/05/11 11:51:34  fabiankeil
186  *    Fix a type mismatch warning.
187  *
188  *    Revision 1.50  2007/04/11 10:55:44  fabiankeil
189  *    Enforce some assertions that could be triggered
190  *    on mingw32 and other systems where we use threads
191  *    but no locks.
192  *
193  *    Revision 1.49  2007/04/08 16:44:15  fabiankeil
194  *    We need <sys/time.h> for gettimeofday(), not <time.h>.
195  *
196  *    Revision 1.48  2007/03/31 13:33:28  fabiankeil
197  *    Add alternative log_error() with timestamps
198  *    that contain milliseconds and without using
199  *    strcpy(), strcat() or sprintf().
200  *
201  *    Revision 1.47  2006/11/28 15:25:15  fabiankeil
202  *    Only unlink the pidfile if it's actually used.
203  *
204  *    Revision 1.46  2006/11/13 19:05:51  fabiankeil
205  *    Make pthread mutex locking more generic. Instead of
206  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
207  *    and use mutex locking unless there is an _r function
208  *    available. Better safe than sorry.
209  *
210  *    Fixes "./configure --disable-pthread" and should result
211  *    in less threading-related problems on pthread-using platforms,
212  *    but it still doesn't fix BR#1122404.
213  *
214  *    Revision 1.45  2006/08/21 11:15:54  david__schmidt
215  *    MS Visual C++ build updates
216  *
217  *    Revision 1.44  2006/08/18 16:03:16  david__schmidt
218  *    Tweak for OS/2 build happiness.
219  *
220  *    Revision 1.43  2006/08/03 02:46:41  david__schmidt
221  *    Incorporate Fabian Keil's patch work:
222  *    http://www.fabiankeil.de/sourcecode/privoxy/
223  *
224  *    Revision 1.42  2006/07/18 14:48:46  david__schmidt
225  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
226  *    with what was really the latest development (the v_3_0_branch branch)
227  *
228  *    Revision 1.40.2.4  2005/04/03 20:10:50  david__schmidt
229  *    Thanks to Jindrich Makovicka for a race condition fix for the log
230  *    file.  The race condition remains for non-pthread implementations.
231  *    Reference patch #1175720.
232  *
233  *    Revision 1.40.2.3  2003/03/07 03:41:04  david__schmidt
234  *    Wrapping all *_r functions (the non-_r versions of them) with mutex 
235  *    semaphores for OSX.  Hopefully this will take care of all of those pesky
236  *    crash reports.
237  *
238  *    Revision 1.40.2.2  2002/09/28 00:30:57  david__schmidt
239  *    Update error logging to give sane values for thread IDs on Mach kernels.
240  *    It's still a hack, but at least it looks farily normal.  We print the
241  *    absolute value of the first 4 bytes of the pthread_t modded with 1000.
242  *
243  *    Revision 1.40.2.1  2002/09/25 12:47:42  oes
244  *    Make log_error safe against NULL string arguments
245  *
246  *    Revision 1.40  2002/05/22 01:27:27  david__schmidt
247  *
248  *    Add os2_socket_strerr mirroring w32_socket_strerr.
249  *
250  *    Revision 1.39  2002/04/03 17:15:27  gliptak
251  *    zero padding thread ids in log
252  *
253  *    Revision 1.38  2002/03/31 17:18:59  jongfoster
254  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
255  *
256  *    Revision 1.37  2002/03/27 14:32:43  david__schmidt
257  *    More compiler warning message maintenance
258  *
259  *    Revision 1.36  2002/03/26 22:29:54  swa
260  *    we have a new homepage!
261  *
262  *    Revision 1.35  2002/03/24 15:23:33  jongfoster
263  *    Name changes
264  *
265  *    Revision 1.34  2002/03/24 13:25:43  swa
266  *    name change related issues
267  *
268  *    Revision 1.33  2002/03/13 00:27:04  jongfoster
269  *    Killing warnings
270  *
271  *    Revision 1.32  2002/03/07 03:46:17  oes
272  *    Fixed compiler warnings
273  *
274  *    Revision 1.31  2002/03/06 23:02:57  jongfoster
275  *    Removing tabs
276  *
277  *    Revision 1.30  2002/03/05 22:43:45  david__schmidt
278  *    - Better error reporting on OS/2
279  *    - Fix double-slash comment (oops)
280  *
281  *    Revision 1.29  2002/03/04 23:45:13  jongfoster
282  *    Printing thread ID if using Win32 native threads
283  *
284  *    Revision 1.28  2002/03/04 17:59:59  oes
285  *    Deleted deletePidFile(), cosmetics
286  *
287  *    Revision 1.27  2002/03/04 02:08:01  david__schmidt
288  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
289  *
290  *    Revision 1.26  2002/01/09 19:05:45  steudten
291  *    Fix big memory leak.
292  *
293  *    Revision 1.25  2002/01/09 14:32:08  oes
294  *    Added support for gmtime_r and localtime_r.
295  *
296  *    Revision 1.24  2001/12/30 14:07:32  steudten
297  *    - Add signal handling (unix)
298  *    - Add SIGHUP handler (unix)
299  *    - Add creation of pidfile (unix)
300  *    - Add action 'top' in rc file (RH)
301  *    - Add entry 'SIGNALS' to manpage
302  *    - Add exit message to logfile (unix)
303  *
304  *    Revision 1.23  2001/11/07 00:02:13  steudten
305  *    Add line number in error output for lineparsing for
306  *    actionsfile and configfile.
307  *    Special handling for CLF added.
308  *
309  *    Revision 1.22  2001/11/05 23:43:05  steudten
310  *    Add time+date to log files.
311  *
312  *    Revision 1.21  2001/10/25 03:40:47  david__schmidt
313  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
314  *    threads to call select() simultaneously.  So, it's time to do a real, live,
315  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
316  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
317  *
318  *    Revision 1.20  2001/09/16 23:04:34  jongfoster
319  *    Fixing a warning
320  *
321  *    Revision 1.19  2001/09/13 20:08:06  jongfoster
322  *    Adding support for LOG_LEVEL_CGI
323  *
324  *    Revision 1.18  2001/09/10 11:27:24  oes
325  *    Declaration of w32_socket_strerr now conditional
326  *
327  *    Revision 1.17  2001/09/10 10:17:13  oes
328  *    Removed unused variable; Fixed sprintf format
329  *
330  *    Revision 1.16  2001/07/30 22:08:36  jongfoster
331  *    Tidying up #defines:
332  *    - All feature #defines are now of the form FEATURE_xxx
333  *    - Permanently turned off WIN_GUI_EDIT
334  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
335  *
336  *    Revision 1.15  2001/07/29 17:41:10  jongfoster
337  *    Now prints thread ID for each message (pthreads only)
338  *
339  *    Revision 1.14  2001/07/19 19:03:48  haroon
340  *    - Added case for LOG_LEVEL_POPUPS
341  *
342  *    Revision 1.13  2001/07/13 13:58:58  oes
343  *     - Added case for LOG_LEVEL_DEANIMATE
344  *     - Removed all #ifdef PCRS
345  *
346  *    Revision 1.12  2001/06/09 10:55:28  jongfoster
347  *    Changing BUFSIZ ==> BUFFER_SIZE
348  *
349  *    Revision 1.11  2001/06/01 18:14:49  jongfoster
350  *    Changing the calls to strerr() to check HAVE_STRERR (which is defined
351  *    in config.h if appropriate) rather than the NO_STRERR macro.
352  *
353  *    Revision 1.10  2001/05/29 11:52:21  oes
354  *    Conditional compilation of w32_socket_error
355  *
356  *    Revision 1.9  2001/05/28 16:15:17  jongfoster
357  *    Improved reporting of errors under Win32.
358  *
359  *    Revision 1.8  2001/05/26 17:25:14  jongfoster
360  *    Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
361  *
362  *    Revision 1.7  2001/05/26 15:21:28  jongfoster
363  *    Activity animation in Win32 GUI now works even if debug==0
364  *
365  *    Revision 1.6  2001/05/25 21:55:08  jongfoster
366  *    Now cleans up properly on FATAL (removes taskbar icon etc)
367  *
368  *    Revision 1.5  2001/05/22 18:46:04  oes
369  *
370  *    - Enabled filtering banners by size rather than URL
371  *      by adding patterns that replace all standard banner
372  *      sizes with the "Junkbuster" gif to the re_filterfile
373  *
374  *    - Enabled filtering WebBugs by providing a pattern
375  *      which kills all 1x1 images
376  *
377  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
378  *      which is selected by the (nonstandard and therefore
379  *      capital) letter 'U' in the option string.
380  *      It causes the quantifiers to be ungreedy by default.
381  *      Appending a ? turns back to greedy (!).
382  *
383  *    - Added a new interceptor ijb-send-banner, which
384  *      sends back the "Junkbuster" gif. Without imagelist or
385  *      MSIE detection support, or if tinygif = 1, or the
386  *      URL isn't recognized as an imageurl, a lame HTML
387  *      explanation is sent instead.
388  *
389  *    - Added new feature, which permits blocking remote
390  *      script redirects and firing back a local redirect
391  *      to the browser.
392  *      The feature is conditionally compiled, i.e. it
393  *      can be disabled with --disable-fast-redirects,
394  *      plus it must be activated by a "fast-redirects"
395  *      line in the config file, has its own log level
396  *      and of course wants to be displayed by show-proxy-args
397  *      Note: Boy, all the #ifdefs in 1001 locations and
398  *      all the fumbling with configure.in and acconfig.h
399  *      were *way* more work than the feature itself :-(
400  *
401  *    - Because a generic redirect template was needed for
402  *      this, tinygif = 3 now uses the same.
403  *
404  *    - Moved GIFs, and other static HTTP response templates
405  *      to project.h
406  *
407  *    - Some minor fixes
408  *
409  *    - Removed some >400 CRs again (Jon, you really worked
410  *      a lot! ;-)
411  *
412  *    Revision 1.4  2001/05/21 19:32:54  jongfoster
413  *    Added another #ifdef _WIN_CONSOLE
414  *
415  *    Revision 1.3  2001/05/20 01:11:40  jongfoster
416  *    Added support for LOG_LEVEL_FATAL
417  *    Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
418  *    and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
419  *
420  *    Revision 1.2  2001/05/17 22:42:01  oes
421  *     - Cleaned CRLF's from the sources and related files
422  *     - Repaired logging for REF and FRC
423  *
424  *    Revision 1.1.1.1  2001/05/15 13:58:51  oes
425  *    Initial import of version 2.9.3 source tree
426  *
427  *
428  *********************************************************************/
429 \f
430
431 #include <stdlib.h>
432 #include <stdio.h>
433 #include <stdarg.h>
434 #include <string.h>
435
436 #include "config.h"
437 #include "miscutil.h"
438
439 /* For gettimeofday() */
440 #include <sys/time.h>
441
442 #if !defined(_WIN32) && !defined(__OS2__)
443 #include <unistd.h>
444 #endif /* !defined(_WIN32) && !defined(__OS2__) */
445
446 #include <errno.h>
447 #include <assert.h>
448
449 #ifdef _WIN32
450 #ifndef STRICT
451 #define STRICT
452 #endif
453 #include <windows.h>
454 #ifndef _WIN_CONSOLE
455 #include "w32log.h"
456 #endif /* ndef _WIN_CONSOLE */
457 #endif /* def _WIN32 */
458 #ifdef _MSC_VER
459 #define inline __inline
460 #endif /* def _MSC_VER */
461
462 #ifdef __OS2__
463 #include <sys/socket.h> /* For sock_errno */
464 #define INCL_DOS
465 #include <os2.h>
466 #endif
467
468 #include "errlog.h"
469 #include "project.h"
470 #include "jcc.h"
471
472 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
473
474
475 /*
476  * LOG_LEVEL_FATAL cannot be turned off.  (There are
477  * some exceptional situations where we need to get a
478  * message to the user).
479  */
480 #define LOG_LEVEL_MINIMUM  LOG_LEVEL_FATAL
481
482 /* where to log (default: stderr) */
483 static FILE *logfp = NULL;
484
485 /* logging detail level. XXX: stupid name. */
486 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
487
488 /* static functions */
489 static void fatal_error(const char * error_message);
490 #ifdef _WIN32
491 static char *w32_socket_strerr(int errcode, char *tmp_buf);
492 #endif
493 #ifdef __OS2__
494 static char *os2_socket_strerr(int errcode, char *tmp_buf);
495 #endif
496
497 #ifdef MUTEX_LOCKS_AVAILABLE
498 static inline void lock_logfile(void)
499 {
500    privoxy_mutex_lock(&log_mutex);
501 }
502 static inline void unlock_logfile(void)
503 {
504    privoxy_mutex_unlock(&log_mutex);
505 }
506 static inline void lock_loginit(void)
507 {
508    privoxy_mutex_lock(&log_init_mutex);
509 }
510 static inline void unlock_loginit(void)
511 {
512    privoxy_mutex_unlock(&log_init_mutex);
513 }
514 #else /* ! MUTEX_LOCKS_AVAILABLE */
515 /*
516  * FIXME we need a cross-platform locking mechanism.
517  * The locking/unlocking functions below should be 
518  * fleshed out for non-pthread implementations.
519  */ 
520 static inline void lock_logfile() {}
521 static inline void unlock_logfile() {}
522 static inline void lock_loginit() {}
523 static inline void unlock_loginit() {}
524 #endif
525
526 /*********************************************************************
527  *
528  * Function    :  fatal_error
529  *
530  * Description :  Displays a fatal error to standard error (or, on 
531  *                a WIN32 GUI, to a dialog box), and exits Privoxy
532  *                with status code 1.
533  *
534  * Parameters  :
535  *          1  :  error_message = The error message to display.
536  *
537  * Returns     :  Does not return.
538  *
539  *********************************************************************/
540 static void fatal_error(const char *error_message)
541 {
542 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
543    /* Skip timestamp and thread id for the message box. */
544    const char *box_message = strstr(error_message, "Fatal error");
545    if (NULL == box_message)
546    {
547       /* Shouldn't happen but ... */
548       box_message = error_message;
549    }
550    MessageBox(g_hwndLogFrame, box_message, "Privoxy Error", 
551       MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);  
552
553    /* Cleanup - remove taskbar icon etc. */
554    TermLogWindow();
555 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
556
557    if (logfp != NULL)
558    {
559       fputs(error_message, logfp);
560    }
561
562 #if defined(unix)
563    if (pidfile)
564    {
565       unlink(pidfile);
566    }
567 #endif /* unix */
568
569    exit(1);
570 }
571
572
573 /*********************************************************************
574  *
575  * Function    :  show_version
576  *
577  * Description :  Logs the Privoxy version and the program name.
578  *
579  * Parameters  :
580  *          1  :  prog_name = The program name.
581  *
582  * Returns     :  Nothing.
583  *
584  *********************************************************************/
585 void show_version(const char *prog_name)
586 {
587    log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
588    if (prog_name != NULL)
589    {
590       log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
591    }
592 }
593
594
595 /*********************************************************************
596  *
597  * Function    :  init_log_module
598  *
599  * Description :  Initializes the logging module to log to stderr.
600  *                Can only be called while stderr hasn't been closed
601  *                yet and is only supposed to be called once.
602  *
603  * Parameters  :
604  *          1  :  prog_name = The program name.
605  *
606  * Returns     :  Nothing.
607  *
608  *********************************************************************/
609 void init_log_module(void)
610 {
611    lock_logfile();
612    logfp = stderr;
613    unlock_logfile();
614    set_debug_level(debug);
615 }
616
617
618 /*********************************************************************
619  *
620  * Function    :  set_debug_level
621  *
622  * Description :  Sets the debug level to the provided value
623  *                plus LOG_LEVEL_MINIMUM.
624  *
625  *                XXX: we should only use the LOG_LEVEL_MINIMUM
626  *                until the first time the configuration file has
627  *                been parsed.
628  *                
629  * Parameters  :  1: debug_level = The debug level to set.
630  *
631  * Returns     :  Nothing.
632  *
633  *********************************************************************/
634 void set_debug_level(int debug_level)
635 {
636    debug = debug_level | LOG_LEVEL_MINIMUM;
637 }
638
639
640 /*********************************************************************
641  *
642  * Function    :  disable_logging
643  *
644  * Description :  Disables logging.
645  *                
646  * Parameters  :  None.
647  *
648  * Returns     :  Nothing.
649  *
650  *********************************************************************/
651 void disable_logging(void)
652 {
653    if (logfp != NULL)
654    {
655       log_error(LOG_LEVEL_INFO,
656          "No logfile configured. Please enable it before reporting any problems.");
657       lock_logfile();
658       fclose(logfp);
659       logfp = NULL;
660       unlock_logfile();
661    }
662 }
663
664
665 /*********************************************************************
666  *
667  * Function    :  init_error_log
668  *
669  * Description :  Initializes the logging module to log to a file.
670  *
671  *                XXX: should be renamed.
672  *
673  * Parameters  :
674  *          1  :  prog_name  = The program name.
675  *          2  :  logfname   = The logfile to (re)open.
676  *
677  * Returns     :  N/A
678  *
679  *********************************************************************/
680 void init_error_log(const char *prog_name, const char *logfname)
681 {
682    FILE *fp;
683
684    assert(NULL != logfname);
685
686    lock_loginit();
687
688    if ((logfp != NULL) && (logfp != stderr))
689    {
690       log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
691    }
692
693    /* set the designated log file */
694    fp = fopen(logfname, "a");
695    if ((NULL == fp) && (logfp != NULL))
696    {
697       /*
698        * Some platforms (like OS/2) don't allow us to open
699        * the same file twice, therefore we give it another
700        * shot after closing the old file descriptor first.
701        *
702        * We don't do it right away because it prevents us
703        * from logging the "can't open logfile" message to
704        * the old logfile.
705        *
706        * XXX: this is a lame workaround and once the next
707        * release is out we should stop bothering reopening
708        * the logfile unless we have to.
709        *
710        * Currently we reopen it every time the config file
711        * has been reloaded, but actually we only have to
712        * reopen it if the file name changed or if the
713        * configuration reloas was caused by a SIGHUP.
714        */
715       log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
716          "Retrying after closing the old file descriptor first. If that "
717          "doesn't work, Privoxy will exit without being able to log a message.",
718          logfname);
719       lock_logfile();
720       fclose(logfp);
721       logfp = NULL;
722       unlock_logfile();
723       fp = fopen(logfname, "a");
724    }
725
726    if (NULL == fp)
727    {
728       log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
729    }
730
731    /* set logging to be completely unbuffered */
732    setbuf(fp, NULL);
733
734    lock_logfile();
735    if (logfp != NULL)
736    {
737       fclose(logfp);
738    }
739    logfp = fp;
740    unlock_logfile();
741
742 #if !defined(_WIN32)
743    /*
744     * Prevent the Windows GUI from showing the version two
745     * times in a row on startup. It already displayed the show_version()
746     * call from main() that other systems write to stderr.
747     *
748     * This means mingw32 users will never see the version in their
749     * log file, but I assume they wouldn't look for it there anyway
750     * and simply use the "Help/About Privoxy" menu.
751     */
752    show_version(prog_name);
753 #endif /* def unix */
754
755    unlock_loginit();
756
757 } /* init_error_log */
758
759
760 /*********************************************************************
761  *
762  * Function    :  get_thread_id
763  *
764  * Description :  Returns a number that is different for each thread.
765  *
766  *                XXX: Should be moved elsewhere (miscutil.c?)
767  *                
768  * Parameters  :  None
769  *
770  * Returns     :  thread_id
771  *
772  *********************************************************************/
773 static long get_thread_id(void)
774 {
775    long this_thread = 1;  /* was: pthread_t this_thread;*/
776
777 #ifdef __OS2__
778    PTIB     ptib;
779    APIRET   ulrc; /* XXX: I have no clue what this does */
780 #endif /* __OS2__ */
781
782    /* FIXME get current thread id */
783 #ifdef FEATURE_PTHREAD
784    this_thread = (long)pthread_self();
785 #ifdef __MACH__
786    /*
787     * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
788     * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
789     * pthread_t is supposed to be opaque... but it's fairly random, though, so
790     * we make it mostly presentable.
791     */
792    this_thread = abs(this_thread % 1000);
793 #endif /* def __MACH__ */
794 #elif defined(_WIN32)
795    this_thread = GetCurrentThreadId();
796 #elif defined(__OS2__)
797    ulrc = DosGetInfoBlocks(&ptib, NULL);
798    if (ulrc == 0)
799      this_thread = ptib -> tib_ptib2 -> tib2_ultid;
800 #endif /* def FEATURE_PTHREAD */
801
802    return this_thread;
803 }
804
805
806 /*********************************************************************
807  *
808  * Function    :  get_log_timestamp
809  *
810  * Description :  Generates the time stamp for the log message prefix.
811  *
812  * Parameters  :
813  *          1  :  buffer = Storage buffer
814  *          2  :  buffer_size = Size of storage buffer
815  *
816  * Returns     :  Number of written characters or 0 for error.
817  *
818  *********************************************************************/
819 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
820 {
821    size_t length;
822    time_t now; 
823    struct tm tm_now;
824    struct timeval tv_now; /* XXX: stupid name */
825    long msecs;
826    int msecs_length = 0;
827
828    gettimeofday(&tv_now, NULL);
829    msecs = tv_now.tv_usec / 1000;
830
831    time(&now);
832
833 #ifdef HAVE_LOCALTIME_R
834    tm_now = *localtime_r(&now, &tm_now);
835 #elif FEATURE_PTHREAD
836    privoxy_mutex_lock(&localtime_mutex);
837    tm_now = *localtime(&now); 
838    privoxy_mutex_unlock(&localtime_mutex);
839 #else
840    tm_now = *localtime(&now); 
841 #endif
842
843    length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
844    if (length > (size_t)0)
845    {
846       msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);               
847    }
848    if (msecs_length > 0)
849    {
850       length += (size_t)msecs_length;
851    }
852    else
853    {
854       length = 0;
855    }
856
857    return length;
858 }
859
860
861 /*********************************************************************
862  *
863  * Function    :  get_clf_timestamp
864  *
865  * Description :  Generates a Common Log Format time string.
866  *
867  * Parameters  :
868  *          1  :  buffer = Storage buffer
869  *          2  :  buffer_size = Size of storage buffer
870  *
871  * Returns     :  Number of written characters or 0 for error.
872  *
873  *********************************************************************/
874 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
875 {
876    /*
877     * Complex because not all OSs have tm_gmtoff or
878     * the %z field in strftime()
879     */
880    time_t now;
881    struct tm *tm_now; 
882    struct tm gmt;
883 #ifdef HAVE_LOCALTIME_R
884    struct tm dummy;
885 #endif
886    int days, hrs, mins;
887    size_t length;
888    int tz_length = 0;
889
890    time (&now); 
891 #ifdef HAVE_GMTIME_R
892    gmt = *gmtime_r(&now, &gmt);
893 #elif FEATURE_PTHREAD
894    privoxy_mutex_lock(&gmtime_mutex);
895    gmt = *gmtime(&now);
896    privoxy_mutex_unlock(&gmtime_mutex);
897 #else
898    gmt = *gmtime(&now);
899 #endif
900 #ifdef HAVE_LOCALTIME_R
901    tm_now = localtime_r(&now, &dummy);
902 #elif FEATURE_PTHREAD
903    privoxy_mutex_lock(&localtime_mutex);
904    tm_now = localtime(&now); 
905    privoxy_mutex_unlock(&localtime_mutex);
906 #else
907    tm_now = localtime(&now); 
908 #endif
909    days = tm_now->tm_yday - gmt.tm_yday; 
910    hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour); 
911    mins = hrs * 60 + tm_now->tm_min - gmt.tm_min; 
912
913    length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
914
915    if (length > (size_t)0)
916    {
917       tz_length = snprintf(buffer+length, buffer_size-length,
918                      "%+03d%02d", mins / 60, abs(mins) % 60);
919    }
920    if (tz_length > 0)
921    {
922       length += (size_t)tz_length;
923    }
924    else
925    {
926       length = 0;
927    }
928
929    return length;
930 }
931
932
933 /*********************************************************************
934  *
935  * Function    :  get_log_level_string
936  *
937  * Description :  Translates a numerical loglevel into a string.
938  *
939  * Parameters  :  
940  *          1  :  loglevel = LOG_LEVEL_FOO
941  *
942  * Returns     :  Log level string.
943  *
944  *********************************************************************/
945 static inline const char *get_log_level_string(int loglevel)
946 {
947    char *log_level_string = NULL;
948
949    assert(0 < loglevel);
950
951    switch (loglevel)
952    {
953       case LOG_LEVEL_ERROR:
954          log_level_string = "Error";
955          break;
956       case LOG_LEVEL_FATAL:
957          log_level_string = "Fatal error";
958          break;
959       case LOG_LEVEL_GPC:
960          log_level_string = "Request";
961          break;
962       case LOG_LEVEL_CONNECT:
963          log_level_string = "Connect";
964          break;
965       case LOG_LEVEL_LOG:
966          log_level_string = "Writing";
967          break;
968       case LOG_LEVEL_HEADER:
969          log_level_string = "Header";
970          break;
971       case LOG_LEVEL_INFO:
972          log_level_string = "Info";
973          break;
974       case LOG_LEVEL_RE_FILTER:
975          log_level_string = "Re-Filter";
976          break;
977 #ifdef FEATURE_FORCE_LOAD
978       case LOG_LEVEL_FORCE:
979          log_level_string = "Force";
980          break;
981 #endif /* def FEATURE_FORCE_LOAD */
982 #ifdef FEATURE_FAST_REDIRECTS
983       case LOG_LEVEL_REDIRECTS:
984          log_level_string = "Redirect";
985          break;
986 #endif /* def FEATURE_FAST_REDIRECTS */
987       case LOG_LEVEL_DEANIMATE:
988          log_level_string = "Gif-Deanimate";
989          break;
990       case LOG_LEVEL_CRUNCH:
991          log_level_string = "Crunch";
992          break;
993       case LOG_LEVEL_CGI:
994          log_level_string = "CGI";
995          break;
996       default:
997          log_level_string = "Unknown log level";
998          break;
999    }
1000    assert(NULL != log_level_string);
1001
1002    return log_level_string;
1003 }
1004
1005
1006 /*********************************************************************
1007  *
1008  * Function    :  log_error
1009  *
1010  * Description :  This is the error-reporting and logging function.
1011  *
1012  * Parameters  :
1013  *          1  :  loglevel  = the type of message to be logged
1014  *          2  :  fmt       = the main string we want logged, printf-like
1015  *          3  :  ...       = arguments to be inserted in fmt (printf-like).
1016  *
1017  * Returns     :  N/A
1018  *
1019  *********************************************************************/
1020 void log_error(int loglevel, const char *fmt, ...)
1021 {
1022    va_list ap;
1023    char *outbuf = NULL;
1024    static char *outbuf_save = NULL;
1025    char tempbuf[BUFFER_SIZE];
1026    size_t length = 0;
1027    const char * src = fmt;
1028    long thread_id;
1029    char timestamp[30];
1030    /*
1031     * XXX: Make this a config option,
1032     * why else do we allocate instead of using
1033     * an array?
1034     */
1035    size_t log_buffer_size = BUFFER_SIZE;
1036
1037 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1038    /*
1039     * Irrespective of debug setting, a GET/POST/CONNECT makes
1040     * the taskbar icon animate.  (There is an option to disable
1041     * this but checking that is handled inside LogShowActivity()).
1042     */
1043    if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
1044    {
1045       LogShowActivity();
1046    }
1047 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1048
1049    /*
1050     * verify that the loglevel applies to current
1051     * settings and that logging is enabled.
1052     * Bail out otherwise.
1053     */
1054    if ((0 == (loglevel & debug))
1055 #ifndef _WIN32
1056       || (logfp == NULL)
1057 #endif
1058       )
1059    {
1060       if (loglevel == LOG_LEVEL_FATAL)
1061       {
1062          fatal_error("Fatal error. You're not supposed to"
1063             "see this message. Please file a bug report.");
1064       }
1065       return;
1066    }
1067
1068    thread_id = get_thread_id();
1069    get_log_timestamp(timestamp, sizeof(timestamp));
1070
1071    /* protect the whole function because of the static buffer (outbuf) */
1072    lock_logfile();
1073
1074    if (NULL == outbuf_save) 
1075    {
1076       outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
1077       if (NULL == outbuf_save)
1078       {
1079          snprintf(tempbuf, sizeof(tempbuf),
1080             "%s %08lx Fatal error: Out of memory in log_error().",
1081             timestamp, thread_id);
1082          fatal_error(tempbuf); /* Exit */
1083          return;
1084       }
1085    }
1086    outbuf = outbuf_save;
1087
1088    /*
1089     * Memsetting the whole buffer to zero (in theory)
1090     * makes things easier later on.
1091     */
1092    memset(outbuf, 0, log_buffer_size);
1093
1094    /* Add prefix for everything but Common Log Format messages */
1095    if (loglevel != LOG_LEVEL_CLF)
1096    {
1097       length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
1098          timestamp, thread_id, get_log_level_string(loglevel));
1099    }
1100
1101    /* get ready to scan var. args. */
1102    va_start(ap, fmt);
1103
1104    /* build formatted message from fmt and var-args */
1105    while ((*src) && (length < log_buffer_size-2))
1106    {
1107       const char *sval = NULL; /* %N string  */
1108       int ival;                /* %N string length or an error code */
1109       unsigned uval;           /* %u value */
1110       long lval;               /* %l value */
1111       unsigned long ulval;     /* %ul value */
1112       char ch;
1113       const char *format_string = tempbuf;
1114
1115       ch = *src++;
1116       if (ch != '%')
1117       {
1118          outbuf[length++] = ch;
1119          /*
1120           * XXX: Only necessary on platforms where multiple threads
1121           * can write to the buffer at the same time because we
1122           * don't support mutexes (OS/2 for example).
1123           */
1124          outbuf[length] = '\0';
1125          continue;
1126       }
1127       outbuf[length] = '\0';
1128       ch = *src++;
1129       switch (ch) {
1130          case '%':
1131             tempbuf[0] = '%';
1132             tempbuf[1] = '\0';
1133             break;
1134          case 'd':
1135             ival = va_arg( ap, int );
1136             snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
1137             break;
1138          case 'u':
1139             uval = va_arg( ap, unsigned );
1140             snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1141             break;
1142          case 'l':
1143             /* this is a modifier that must be followed by u, lu, or d */
1144             ch = *src++;
1145             if (ch == 'd')
1146             {
1147                lval = va_arg( ap, long );
1148                snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1149             }
1150             else if (ch == 'u')
1151             {
1152                ulval = va_arg( ap, unsigned long );
1153                snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1154             }
1155             else if ((ch == 'l') && (*src == 'u'))
1156             {
1157                unsigned long long lluval = va_arg(ap, unsigned long long);
1158                snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
1159                ch = *src++;
1160             }
1161             else
1162             {
1163                snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1164                loglevel = LOG_LEVEL_FATAL;
1165             }
1166             break;
1167          case 'c':
1168             /*
1169              * Note that char paramaters are converted to int, so we need to
1170              * pass "int" to va_arg.  (See K&R, 2nd ed, section A7.3.2, page 202)
1171              */
1172             tempbuf[0] = (char) va_arg(ap, int);
1173             tempbuf[1] = '\0';
1174             break;
1175          case 's':
1176             format_string = va_arg(ap, char *);
1177             if (format_string == NULL)
1178             {
1179                format_string = "[null]";
1180             }
1181             break;
1182          case 'N':
1183             /*
1184              * Non-standard: Print a counted unterminated string.
1185              * Takes 2 parameters: int length, const char * string.
1186              */
1187             ival = va_arg(ap, int);
1188             sval = va_arg(ap, char *);
1189             if (sval == NULL)
1190             {
1191                format_string = "[null]";
1192             }
1193             else if (ival <= 0)
1194             {
1195                if (0 == ival)
1196                {
1197                   /* That's ok (but stupid) */
1198                   tempbuf[0] = '\0';
1199                }
1200                else
1201                {
1202                   /*
1203                    * That's not ok (and even more stupid)
1204                    */
1205                   assert(ival >= 0);
1206                   format_string = "[counted string lenght < 0]";
1207                }
1208             }
1209             else if ((size_t)ival >= sizeof(tempbuf))
1210             {
1211                /*
1212                 * String is too long, copy as much as possible.
1213                 * It will be further truncated later.
1214                 */
1215                memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1216                tempbuf[sizeof(tempbuf)-1] = '\0';
1217             }
1218             else
1219             {
1220                memcpy(tempbuf, sval, (size_t) ival);
1221                tempbuf[ival] = '\0';
1222             }
1223             break;
1224          case 'E':
1225             /* Non-standard: Print error code from errno */
1226 #ifdef _WIN32
1227             ival = WSAGetLastError();
1228             format_string = w32_socket_strerr(ival, tempbuf);
1229 #elif __OS2__
1230             ival = sock_errno();
1231             if (ival != 0)
1232             {
1233                format_string = os2_socket_strerr(ival, tempbuf);
1234             }
1235             else
1236             {
1237                ival = errno;
1238                format_string = strerror(ival);
1239             }
1240 #else /* ifndef _WIN32 */
1241             ival = errno; 
1242 #ifdef HAVE_STRERROR
1243             format_string = strerror(ival);
1244 #else /* ifndef HAVE_STRERROR */
1245             format_string = NULL;
1246 #endif /* ndef HAVE_STRERROR */
1247             if (sval == NULL)
1248             {
1249                snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1250             }
1251 #endif /* ndef _WIN32 */
1252             break;
1253          case 'T':
1254             /* Non-standard: Print a Common Log File timestamp */
1255             get_clf_timestamp(tempbuf, sizeof(tempbuf));
1256             break;
1257          default:
1258             snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1259             loglevel = LOG_LEVEL_FATAL;
1260             break;
1261       } /* switch( p ) */
1262
1263       assert(length < log_buffer_size);
1264       length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1265
1266       if (length >= log_buffer_size-2)
1267       {
1268          static char warning[] = "... [too long, truncated]";
1269
1270          length = log_buffer_size - sizeof(warning) - 1;
1271          length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1272          assert(length < log_buffer_size);
1273
1274          break;
1275       }
1276    } /* for( p ... ) */
1277
1278    /* done with var. args */
1279    va_end(ap);
1280
1281    assert(length < log_buffer_size);
1282    length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1283
1284    /* Some sanity checks */
1285    if ((length >= log_buffer_size)
1286     || (outbuf[log_buffer_size-1] != '\0')
1287     || (outbuf[log_buffer_size] != '\0')
1288       )
1289    {
1290       /* Repeat as assertions */
1291       assert(length < log_buffer_size);
1292       assert(outbuf[log_buffer_size-1] == '\0');
1293       /*
1294        * outbuf's real size is log_buffer_size+1,
1295        * so while this looks like an off-by-one,
1296        * we're only checking our paranoia byte.
1297        */
1298       assert(outbuf[log_buffer_size] == '\0');
1299
1300       snprintf(outbuf, log_buffer_size,
1301          "%s %08lx Fatal error: log_error()'s sanity checks failed."
1302          "length: %d. Exiting.",
1303          timestamp, thread_id, (int)length);
1304       loglevel = LOG_LEVEL_FATAL;
1305    }
1306
1307 #ifndef _WIN32
1308    /*
1309     * On Windows this is acceptable in case
1310     * we are logging to the GUI window only.
1311     */
1312    assert(NULL != logfp);
1313 #endif
1314
1315    if (loglevel == LOG_LEVEL_FATAL)
1316    {
1317       fatal_error(outbuf_save);
1318       /* Never get here */
1319    }
1320    if (logfp != NULL)
1321    {
1322       fputs(outbuf_save, logfp);
1323    }
1324
1325 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1326    /* Write to display */
1327    LogPutString(outbuf_save);
1328 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1329
1330    unlock_logfile();
1331
1332 }
1333
1334
1335 /*********************************************************************
1336  *
1337  * Function    :  jb_err_to_string
1338  *
1339  * Description :  Translates JB_ERR_FOO codes into strings.
1340  *
1341  *                XXX: the type of error codes is jb_err
1342  *                but the typedef'inition is currently not
1343  *                visible to all files that include errlog.h.
1344  *
1345  * Parameters  :
1346  *          1  :  error = a valid jb_err code
1347  *
1348  * Returns     :  A string with the jb_err translation
1349  *
1350  *********************************************************************/
1351 const char *jb_err_to_string(int error)
1352 {
1353    switch (error)
1354    {
1355       case JB_ERR_OK:
1356          return "Success, no error";
1357       case JB_ERR_MEMORY:
1358          return "Out of memory";
1359       case JB_ERR_CGI_PARAMS:
1360          return "Missing or corrupt CGI parameters";
1361       case JB_ERR_FILE:
1362          return "Error opening, reading or writing a file";
1363       case JB_ERR_PARSE:
1364          return "Parse error";
1365       case JB_ERR_MODIFIED:
1366          return "File has been modified outside of the CGI actions editor.";
1367       case JB_ERR_COMPRESS:
1368          return "(De)compression failure";
1369       default:
1370          assert(0);
1371          return "Unknown error";
1372    }
1373    assert(0);
1374    return "Internal error";
1375 }
1376
1377 #ifdef _WIN32
1378 /*********************************************************************
1379  *
1380  * Function    :  w32_socket_strerr
1381  *
1382  * Description :  Translate the return value from WSAGetLastError()
1383  *                into a string.
1384  *
1385  * Parameters  :
1386  *          1  :  errcode = The return value from WSAGetLastError().
1387  *          2  :  tmp_buf = A temporary buffer that might be used to
1388  *                          store the string.
1389  *
1390  * Returns     :  String representing the error code.  This may be
1391  *                a global string constant or a string stored in
1392  *                tmp_buf.
1393  *
1394  *********************************************************************/
1395 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1396 {
1397 #define TEXT_FOR_ERROR(code,text) \
1398    if (errcode == code)           \
1399    {                              \
1400       return #code " - " text;    \
1401    }
1402
1403    TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1404    TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1405    TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1406    TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1407    TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1408    TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1409    TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1410    TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1411    TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1412    TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1413    TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1414    TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1415    TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1416    TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1417    TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1418    TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1419    TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1420    TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1421    TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1422    TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1423    TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1424    TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1425    TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1426    TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1427    TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1428    TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1429    TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1430    TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1431    TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1432    TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1433    TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1434    TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1435    TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1436    TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1437    TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1438    TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1439    TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1440    TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1441    TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1442    TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1443    TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1444    TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1445    /*
1446     * The following error codes are documented in the Microsoft WinSock
1447     * reference guide, but don't actually exist.
1448     *
1449     * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1450     * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1451     * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1452     * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1453     * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1454     * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1455     * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1456     * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1457     * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1458     * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1459     */
1460
1461    sprintf(tmp_buf, "(error number %d)", errcode);
1462    return tmp_buf;
1463 }
1464 #endif /* def _WIN32 */
1465
1466
1467 #ifdef __OS2__
1468 /*********************************************************************
1469  *
1470  * Function    :  os2_socket_strerr
1471  *
1472  * Description :  Translate the return value from sock_errno()
1473  *                into a string.
1474  *
1475  * Parameters  :
1476  *          1  :  errcode = The return value from sock_errno().
1477  *          2  :  tmp_buf = A temporary buffer that might be used to
1478  *                          store the string.
1479  *
1480  * Returns     :  String representing the error code.  This may be
1481  *                a global string constant or a string stored in
1482  *                tmp_buf.
1483  *
1484  *********************************************************************/
1485 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1486 {
1487 #define TEXT_FOR_ERROR(code,text) \
1488    if (errcode == code)           \
1489    {                              \
1490       return #code " - " text;    \
1491    }
1492
1493    TEXT_FOR_ERROR(SOCEPERM          , "Not owner.")
1494    TEXT_FOR_ERROR(SOCESRCH          , "No such process.")
1495    TEXT_FOR_ERROR(SOCEINTR          , "Interrupted system call.")
1496    TEXT_FOR_ERROR(SOCENXIO          , "No such device or address.")
1497    TEXT_FOR_ERROR(SOCEBADF          , "Bad file number.")
1498    TEXT_FOR_ERROR(SOCEACCES         , "Permission denied.")
1499    TEXT_FOR_ERROR(SOCEFAULT         , "Bad address.")
1500    TEXT_FOR_ERROR(SOCEINVAL         , "Invalid argument.")
1501    TEXT_FOR_ERROR(SOCEMFILE         , "Too many open files.")
1502    TEXT_FOR_ERROR(SOCEPIPE          , "Broken pipe.")
1503    TEXT_FOR_ERROR(SOCEWOULDBLOCK    , "Operation would block.")
1504    TEXT_FOR_ERROR(SOCEINPROGRESS    , "Operation now in progress.")
1505    TEXT_FOR_ERROR(SOCEALREADY       , "Operation already in progress.")
1506    TEXT_FOR_ERROR(SOCENOTSOCK       , "Socket operation on non-socket.")
1507    TEXT_FOR_ERROR(SOCEDESTADDRREQ   , "Destination address required.")
1508    TEXT_FOR_ERROR(SOCEMSGSIZE       , "Message too long.")
1509    TEXT_FOR_ERROR(SOCEPROTOTYPE     , "Protocol wrong type for socket.")
1510    TEXT_FOR_ERROR(SOCENOPROTOOPT    , "Protocol not available.")
1511    TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1512    TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1513    TEXT_FOR_ERROR(SOCEOPNOTSUPP     , "Operation not supported.")
1514    TEXT_FOR_ERROR(SOCEPFNOSUPPORT   , "Protocol family not supported.")
1515    TEXT_FOR_ERROR(SOCEAFNOSUPPORT   , "Address family not supported by protocol family.")
1516    TEXT_FOR_ERROR(SOCEADDRINUSE     , "Address already in use.")
1517    TEXT_FOR_ERROR(SOCEADDRNOTAVAIL  , "Can't assign requested address.")
1518    TEXT_FOR_ERROR(SOCENETDOWN       , "Network is down.")
1519    TEXT_FOR_ERROR(SOCENETUNREACH    , "Network is unreachable.")
1520    TEXT_FOR_ERROR(SOCENETRESET      , "Network dropped connection on reset.")
1521    TEXT_FOR_ERROR(SOCECONNABORTED   , "Software caused connection abort.")
1522    TEXT_FOR_ERROR(SOCECONNRESET     , "Connection reset by peer.")
1523    TEXT_FOR_ERROR(SOCENOBUFS        , "No buffer space available.")
1524    TEXT_FOR_ERROR(SOCEISCONN        , "Socket is already connected.")
1525    TEXT_FOR_ERROR(SOCENOTCONN       , "Socket is not connected.")
1526    TEXT_FOR_ERROR(SOCESHUTDOWN      , "Can't send after socket shutdown.")
1527    TEXT_FOR_ERROR(SOCETOOMANYREFS   , "Too many references: can't splice.")
1528    TEXT_FOR_ERROR(SOCETIMEDOUT      , "Operation timed out.")
1529    TEXT_FOR_ERROR(SOCECONNREFUSED   , "Connection refused.")
1530    TEXT_FOR_ERROR(SOCELOOP          , "Too many levels of symbolic links.")
1531    TEXT_FOR_ERROR(SOCENAMETOOLONG   , "File name too long.")
1532    TEXT_FOR_ERROR(SOCEHOSTDOWN      , "Host is down.")
1533    TEXT_FOR_ERROR(SOCEHOSTUNREACH   , "No route to host.")
1534    TEXT_FOR_ERROR(SOCENOTEMPTY      , "Directory not empty.")
1535    TEXT_FOR_ERROR(SOCEOS2ERR        , "OS/2 Error.")
1536
1537    sprintf(tmp_buf, "(error number %d)", errcode);
1538    return tmp_buf;
1539 }
1540 #endif /* def __OS2__ */
1541
1542
1543 /*
1544   Local Variables:
1545   tab-width: 3
1546   end:
1547 */