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