errlog.c

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