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