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