errlog.c

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