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