errlog.c

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