errlog.c

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