errlog.c

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