errlog.c

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