errlog.c

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