errlog.c

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