errlog.c

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