errlog.c

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