errlog.c

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