errlog.c

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