errlog.c

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