errlog.c

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