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