errlog.c

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