errlog.c

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