errlog.c

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