errlog.c

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