errlog.c

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