errlog.c

   1 const char errlog_rcs[] = "$Id: errlog.c,v 1.125 2016/01/26 17:12:14 diem 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-2014 the
  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  *********************************************************************/
  35
  36
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <stdarg.h>
  40 #include <string.h>
  41 #include <ctype.h>
  42
  43 #include "config.h"
  44 #include "miscutil.h"
  45
  46 /* For gettimeofday() */
  47 #include <sys/time.h>
  48
  49 #if !defined(_WIN32) && !defined(__OS2__)
  50 #include <unistd.h>
  51 #endif /* !defined(_WIN32) && !defined(__OS2__) */
  52
  53 #include <errno.h>
  54 #include <assert.h>
  55
  56 #ifdef _WIN32
  57 #ifndef STRICT
  58 #define STRICT
  59 #endif
  60 #include <windows.h>
  61 #ifndef _WIN_CONSOLE
  62 #include "w32log.h"
  63 #endif /* ndef _WIN_CONSOLE */
  64 #endif /* def _WIN32 */
  65 #ifdef _MSC_VER
  66 #define inline __inline
  67 #endif /* def _MSC_VER */
  68
  69 #ifdef __OS2__
  70 #include <sys/socket.h> /* For sock_errno */
  71 #define INCL_DOS
  72 #include <os2.h>
  73 #endif
  74
  75 #include "errlog.h"
  76 #include "project.h"
  77 #include "jcc.h"
  78 #ifdef FEATURE_EXTERNAL_FILTERS
  79 #include "jbsockets.h"
  80 #endif
  81
  82 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
  83
  84
  85 /*
  86  * LOG_LEVEL_FATAL cannot be turned off.  (There are
  87  * some exceptional situations where we need to get a
  88  * message to the user).
  89  */
  90 #define LOG_LEVEL_MINIMUM  LOG_LEVEL_FATAL
  91
  92 /* where to log (default: stderr) */
  93 static FILE *logfp = NULL;
  94
  95 /* logging detail level. XXX: stupid name. */
  96 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
  97
  98 /* static functions */
  99 static void fatal_error(const char * error_message);
 100 #ifdef _WIN32
 101 static char *w32_socket_strerr(int errcode, char *tmp_buf);
 102 #endif
 103 #ifdef __OS2__
 104 static char *os2_socket_strerr(int errcode, char *tmp_buf);
 105 #endif
 106
 107 #ifdef MUTEX_LOCKS_AVAILABLE
 108 static inline void lock_logfile(void)
 109 {
 110    privoxy_mutex_lock(&log_mutex);
 111 }
 112 static inline void unlock_logfile(void)
 113 {
 114    privoxy_mutex_unlock(&log_mutex);
 115 }
 116 static inline void lock_loginit(void)
 117 {
 118    privoxy_mutex_lock(&log_init_mutex);
 119 }
 120 static inline void unlock_loginit(void)
 121 {
 122    privoxy_mutex_unlock(&log_init_mutex);
 123 }
 124 #else /* ! MUTEX_LOCKS_AVAILABLE */
 125 /*
 126  * FIXME we need a cross-platform locking mechanism.
 127  * The locking/unlocking functions below should be
 128  * fleshed out for non-pthread implementations.
 129  */
 130 static inline void lock_logfile() {}
 131 static inline void unlock_logfile() {}
 132 static inline void lock_loginit() {}
 133 static inline void unlock_loginit() {}
 134 #endif
 135
 136 /*********************************************************************
 137  *
 138  * Function    :  fatal_error
 139  *
 140  * Description :  Displays a fatal error to standard error (or, on
 141  *                a WIN32 GUI, to a dialog box), and exits Privoxy
 142  *                with status code 1.
 143  *
 144  * Parameters  :
 145  *          1  :  error_message = The error message to display.
 146  *
 147  * Returns     :  Does not return.
 148  *
 149  *********************************************************************/
 150 static void fatal_error(const char *error_message)
 151 {
 152    if (logfp != NULL)
 153    {
 154       fputs(error_message, logfp);
 155    }
 156
 157 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
 158    {
 159       /* Skip timestamp and thread id for the message box. */
 160       const char *box_message = strstr(error_message, "Fatal error");
 161       if (NULL == box_message)
 162       {
 163          /* Shouldn't happen but ... */
 164          box_message = error_message;
 165       }
 166       MessageBox(g_hwndLogFrame, box_message, "Privoxy Error",
 167          MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
 168
 169       /* Cleanup - remove taskbar icon etc. */
 170       TermLogWindow();
 171    }
 172 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
 173
 174 #if defined(unix)
 175    if (pidfile)
 176    {
 177       unlink(pidfile);
 178    }
 179 #endif /* unix */
 180
 181    exit(1);
 182 }
 183
 184
 185 /*********************************************************************
 186  *
 187  * Function    :  show_version
 188  *
 189  * Description :  Logs the Privoxy version and the program name.
 190  *
 191  * Parameters  :
 192  *          1  :  prog_name = The program name.
 193  *
 194  * Returns     :  Nothing.
 195  *
 196  *********************************************************************/
 197 void show_version(const char *prog_name)
 198 {
 199    log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
 200    if (prog_name != NULL)
 201    {
 202       log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
 203    }
 204 }
 205
 206
 207 /*********************************************************************
 208  *
 209  * Function    :  init_log_module
 210  *
 211  * Description :  Initializes the logging module to log to stderr.
 212  *                Can only be called while stderr hasn't been closed
 213  *                yet and is only supposed to be called once.
 214  *
 215  * Parameters  :
 216  *          1  :  prog_name = The program name.
 217  *
 218  * Returns     :  Nothing.
 219  *
 220  *********************************************************************/
 221 void init_log_module(void)
 222 {
 223    lock_logfile();
 224    logfp = stderr;
 225    unlock_logfile();
 226    set_debug_level(debug);
 227 }
 228
 229
 230 /*********************************************************************
 231  *
 232  * Function    :  set_debug_level
 233  *
 234  * Description :  Sets the debug level to the provided value
 235  *                plus LOG_LEVEL_MINIMUM.
 236  *
 237  *                XXX: we should only use the LOG_LEVEL_MINIMUM
 238  *                until the first time the configuration file has
 239  *                been parsed.
 240  *
 241  * Parameters  :  1: debug_level = The debug level to set.
 242  *
 243  * Returns     :  Nothing.
 244  *
 245  *********************************************************************/
 246 void set_debug_level(int debug_level)
 247 {
 248    debug = debug_level | LOG_LEVEL_MINIMUM;
 249 }
 250
 251
 252 /*********************************************************************
 253  *
 254  * Function    :  debug_level_is_enabled
 255  *
 256  * Description :  Checks if a certain debug level is enabled.
 257  *
 258  * Parameters  :  1: debug_level = The debug level to check.
 259  *
 260  * Returns     :  Nothing.
 261  *
 262  *********************************************************************/
 263 int debug_level_is_enabled(int debug_level)
 264 {
 265    return (0 != (debug & debug_level));
 266 }
 267
 268
 269 /*********************************************************************
 270  *
 271  * Function    :  disable_logging
 272  *
 273  * Description :  Disables logging.
 274  *
 275  * Parameters  :  None.
 276  *
 277  * Returns     :  Nothing.
 278  *
 279  *********************************************************************/
 280 void disable_logging(void)
 281 {
 282    if (logfp != NULL)
 283    {
 284       log_error(LOG_LEVEL_INFO,
 285          "No logfile configured. Please enable it before reporting any problems.");
 286       lock_logfile();
 287       fclose(logfp);
 288       logfp = NULL;
 289       unlock_logfile();
 290    }
 291 }
 292
 293
 294 /*********************************************************************
 295  *
 296  * Function    :  init_error_log
 297  *
 298  * Description :  Initializes the logging module to log to a file.
 299  *
 300  *                XXX: should be renamed.
 301  *
 302  * Parameters  :
 303  *          1  :  prog_name  = The program name.
 304  *          2  :  logfname   = The logfile to (re)open.
 305  *
 306  * Returns     :  N/A
 307  *
 308  *********************************************************************/
 309 void init_error_log(const char *prog_name, const char *logfname)
 310 {
 311    FILE *fp;
 312
 313    assert(NULL != logfname);
 314
 315    lock_loginit();
 316
 317    if ((logfp != NULL) && (logfp != stderr))
 318    {
 319       log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
 320    }
 321
 322    /* set the designated log file */
 323    fp = fopen(logfname, "a");
 324    if ((NULL == fp) && (logfp != NULL))
 325    {
 326       /*
 327        * Some platforms (like OS/2) don't allow us to open
 328        * the same file twice, therefore we give it another
 329        * shot after closing the old file descriptor first.
 330        *
 331        * We don't do it right away because it prevents us
 332        * from logging the "can't open logfile" message to
 333        * the old logfile.
 334        *
 335        * XXX: this is a lame workaround and once the next
 336        * release is out we should stop bothering reopening
 337        * the logfile unless we have to.
 338        *
 339        * Currently we reopen it every time the config file
 340        * has been reloaded, but actually we only have to
 341        * reopen it if the file name changed or if the
 342        * configuration reload was caused by a SIGHUP.
 343        */
 344       log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
 345          "Retrying after closing the old file descriptor first. If that "
 346          "doesn't work, Privoxy will exit without being able to log a message.",
 347          logfname);
 348       lock_logfile();
 349       fclose(logfp);
 350       logfp = NULL;
 351       unlock_logfile();
 352       fp = fopen(logfname, "a");
 353    }
 354
 355    if (NULL == fp)
 356    {
 357       log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
 358    }
 359
 360 #ifdef FEATURE_EXTERNAL_FILTERS
 361    mark_socket_for_close_on_execute(3);
 362 #endif
 363
 364    /* set logging to be completely unbuffered */
 365    setbuf(fp, NULL);
 366
 367    lock_logfile();
 368    if (logfp != NULL)
 369    {
 370       fclose(logfp);
 371    }
 372 #ifdef unix
 373    if (daemon_mode && (logfp == stderr))
 374    {
 375       if (dup2(1, 2) == -1)
 376       {
 377          /*
 378           * We only use fatal_error() to clear the pid
 379           * file and to exit. Given that stderr has just
 380           * been closed, the user will not see the error
 381           * message.
 382           */
 383          fatal_error("Failed to reserve fd 2.");
 384       }
 385    }
 386 #endif
 387    logfp = fp;
 388    unlock_logfile();
 389
 390    show_version(prog_name);
 391
 392    unlock_loginit();
 393
 394 } /* init_error_log */
 395
 396
 397 /*********************************************************************
 398  *
 399  * Function    :  get_thread_id
 400  *
 401  * Description :  Returns a number that is different for each thread.
 402  *
 403  *                XXX: Should be moved elsewhere (miscutil.c?)
 404  *
 405  * Parameters  :  None
 406  *
 407  * Returns     :  thread_id
 408  *
 409  *********************************************************************/
 410 static long get_thread_id(void)
 411 {
 412    long this_thread;
 413
 414 #ifdef __OS2__
 415    PTIB     ptib;
 416    APIRET   ulrc; /* XXX: I have no clue what this does */
 417 #endif /* __OS2__ */
 418
 419    /* FIXME get current thread id */
 420 #ifdef FEATURE_PTHREAD
 421    this_thread = (long)pthread_self();
 422 #ifdef __MACH__
 423    /*
 424     * Mac OSX (and perhaps other Mach instances) doesn't have a unique
 425     * value at the lowest order 4 bytes of pthread_self()'s return value, a pthread_t,
 426     * so trim the three lowest-order bytes from the value (16^3).
 427     */
 428    this_thread = this_thread / 4096;
 429 #endif /* def __MACH__ */
 430 #elif defined(_WIN32)
 431    this_thread = GetCurrentThreadId();
 432 #elif defined(__OS2__)
 433    ulrc = DosGetInfoBlocks(&ptib, NULL);
 434    if (ulrc == 0)
 435      this_thread = ptib -> tib_ptib2 -> tib2_ultid;
 436 #else
 437    /* Forking instead of threading. */
 438    this_thread = 1;
 439 #endif /* def FEATURE_PTHREAD */
 440
 441    return this_thread;
 442 }
 443
 444
 445 /*********************************************************************
 446  *
 447  * Function    :  get_log_timestamp
 448  *
 449  * Description :  Generates the time stamp for the log message prefix.
 450  *
 451  * Parameters  :
 452  *          1  :  buffer = Storage buffer
 453  *          2  :  buffer_size = Size of storage buffer
 454  *
 455  * Returns     :  Number of written characters or 0 for error.
 456  *
 457  *********************************************************************/
 458 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
 459 {
 460    size_t length;
 461    time_t now;
 462    struct tm tm_now;
 463    struct timeval tv_now; /* XXX: stupid name */
 464    long msecs;
 465    int msecs_length = 0;
 466
 467    gettimeofday(&tv_now, NULL);
 468    msecs = tv_now.tv_usec / 1000;
 469    now = tv_now.tv_sec;
 470
 471 #ifdef HAVE_LOCALTIME_R
 472    tm_now = *localtime_r(&now, &tm_now);
 473 #elif defined(MUTEX_LOCKS_AVAILABLE)
 474    privoxy_mutex_lock(&localtime_mutex);
 475    tm_now = *localtime(&now);
 476    privoxy_mutex_unlock(&localtime_mutex);
 477 #else
 478    tm_now = *localtime(&now);
 479 #endif
 480
 481    length = strftime(buffer, buffer_size, "%Y-%m-%d %H:%M:%S", &tm_now);
 482    if (length > (size_t)0)
 483    {
 484       msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
 485    }
 486    if (msecs_length > 0)
 487    {
 488       length += (size_t)msecs_length;
 489    }
 490    else
 491    {
 492       length = 0;
 493    }
 494
 495    return length;
 496 }
 497
 498
 499 /*********************************************************************
 500  *
 501  * Function    :  get_clf_timestamp
 502  *
 503  * Description :  Generates a Common Log Format time string.
 504  *
 505  * Parameters  :
 506  *          1  :  buffer = Storage buffer
 507  *          2  :  buffer_size = Size of storage buffer
 508  *
 509  * Returns     :  Number of written characters or 0 for error.
 510  *
 511  *********************************************************************/
 512 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
 513 {
 514    /*
 515     * Complex because not all OSs have tm_gmtoff or
 516     * the %z field in strftime()
 517     */
 518    time_t now;
 519    struct tm *tm_now;
 520    struct tm gmt;
 521 #ifdef HAVE_LOCALTIME_R
 522    struct tm dummy;
 523 #endif
 524    int days, hrs, mins;
 525    size_t length;
 526    int tz_length = 0;
 527
 528    time (&now);
 529 #ifdef HAVE_GMTIME_R
 530    gmt = *gmtime_r(&now, &gmt);
 531 #elif defined(MUTEX_LOCKS_AVAILABLE)
 532    privoxy_mutex_lock(&gmtime_mutex);
 533    gmt = *gmtime(&now);
 534    privoxy_mutex_unlock(&gmtime_mutex);
 535 #else
 536    gmt = *gmtime(&now);
 537 #endif
 538 #ifdef HAVE_LOCALTIME_R
 539    tm_now = localtime_r(&now, &dummy);
 540 #elif defined(MUTEX_LOCKS_AVAILABLE)
 541    privoxy_mutex_lock(&localtime_mutex);
 542    tm_now = localtime(&now);
 543    privoxy_mutex_unlock(&localtime_mutex);
 544 #else
 545    tm_now = localtime(&now);
 546 #endif
 547    days = tm_now->tm_yday - gmt.tm_yday;
 548    hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
 549    mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
 550
 551    length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
 552
 553    if (length > (size_t)0)
 554    {
 555       tz_length = snprintf(buffer+length, buffer_size-length,
 556                      "%+03d%02d", mins / 60, abs(mins) % 60);
 557    }
 558    if (tz_length > 0)
 559    {
 560       length += (size_t)tz_length;
 561    }
 562    else
 563    {
 564       length = 0;
 565    }
 566
 567    return length;
 568 }
 569
 570
 571 /*********************************************************************
 572  *
 573  * Function    :  get_log_level_string
 574  *
 575  * Description :  Translates a numerical loglevel into a string.
 576  *
 577  * Parameters  :
 578  *          1  :  loglevel = LOG_LEVEL_FOO
 579  *
 580  * Returns     :  Log level string.
 581  *
 582  *********************************************************************/
 583 static inline const char *get_log_level_string(int loglevel)
 584 {
 585    char *log_level_string = NULL;
 586
 587    assert(0 < loglevel);
 588
 589    switch (loglevel)
 590    {
 591       case LOG_LEVEL_ERROR:
 592          log_level_string = "Error";
 593          break;
 594       case LOG_LEVEL_FATAL:
 595          log_level_string = "Fatal error";
 596          break;
 597       case LOG_LEVEL_GPC:
 598          log_level_string = "Request";
 599          break;
 600       case LOG_LEVEL_CONNECT:
 601          log_level_string = "Connect";
 602          break;
 603       case LOG_LEVEL_WRITING:
 604          log_level_string = "Writing";
 605          break;
 606       case LOG_LEVEL_RECEIVED:
 607          log_level_string = "Received";
 608          break;
 609       case LOG_LEVEL_HEADER:
 610          log_level_string = "Header";
 611          break;
 612       case LOG_LEVEL_INFO:
 613          log_level_string = "Info";
 614          break;
 615       case LOG_LEVEL_RE_FILTER:
 616          log_level_string = "Re-Filter";
 617          break;
 618 #ifdef FEATURE_FORCE_LOAD
 619       case LOG_LEVEL_FORCE:
 620          log_level_string = "Force";
 621          break;
 622 #endif /* def FEATURE_FORCE_LOAD */
 623       case LOG_LEVEL_REDIRECTS:
 624          log_level_string = "Redirect";
 625          break;
 626       case LOG_LEVEL_DEANIMATE:
 627          log_level_string = "Gif-Deanimate";
 628          break;
 629       case LOG_LEVEL_CRUNCH:
 630          log_level_string = "Crunch";
 631          break;
 632       case LOG_LEVEL_CGI:
 633          log_level_string = "CGI";
 634          break;
 635       case LOG_LEVEL_ACTIONS:
 636          log_level_string = "Actions";
 637          break;
 638       default:
 639          log_level_string = "Unknown log level";
 640          break;
 641    }
 642    assert(NULL != log_level_string);
 643
 644    return log_level_string;
 645 }
 646
 647
 648 #define LOG_BUFFER_SIZE BUFFER_SIZE
 649 /*********************************************************************
 650  *
 651  * Function    :  log_error
 652  *
 653  * Description :  This is the error-reporting and logging function.
 654  *
 655  * Parameters  :
 656  *          1  :  loglevel  = the type of message to be logged
 657  *          2  :  fmt       = the main string we want logged, printf-like
 658  *          3  :  ...       = arguments to be inserted in fmt (printf-like).
 659  *
 660  * Returns     :  N/A
 661  *
 662  *********************************************************************/
 663 void log_error(int loglevel, const char *fmt, ...)
 664 {
 665    va_list ap;
 666    char *outbuf = NULL;
 667    static char *outbuf_save = NULL;
 668    char tempbuf[LOG_BUFFER_SIZE];
 669    size_t length = 0;
 670    const char * src = fmt;
 671    long thread_id;
 672    char timestamp[30];
 673    /*
 674     * XXX: Make this a config option,
 675     * why else do we allocate instead of using
 676     * an array?
 677     */
 678    size_t log_buffer_size = LOG_BUFFER_SIZE;
 679
 680 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
 681    /*
 682     * Irrespective of debug setting, a GET/POST/CONNECT makes
 683     * the taskbar icon animate.  (There is an option to disable
 684     * this but checking that is handled inside LogShowActivity()).
 685     */
 686    if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
 687    {
 688       LogShowActivity();
 689    }
 690 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
 691
 692    /*
 693     * verify that the loglevel applies to current
 694     * settings and that logging is enabled.
 695     * Bail out otherwise.
 696     */
 697    if ((0 == (loglevel & debug))
 698 #ifndef _WIN32
 699       || (logfp == NULL)
 700 #endif
 701       )
 702    {
 703       if (loglevel == LOG_LEVEL_FATAL)
 704       {
 705          fatal_error("Fatal error. You're not supposed to"
 706             "see this message. Please file a bug report.");
 707       }
 708       return;
 709    }
 710
 711    thread_id = get_thread_id();
 712    get_log_timestamp(timestamp, sizeof(timestamp));
 713
 714    /* protect the whole function because of the static buffer (outbuf) */
 715    lock_logfile();
 716
 717    if (NULL == outbuf_save)
 718    {
 719       outbuf_save = zalloc_or_die(log_buffer_size + 1); /* +1 for paranoia */
 720    }
 721    outbuf = outbuf_save;
 722
 723    /*
 724     * Memsetting the whole buffer to zero (in theory)
 725     * makes things easier later on.
 726     */
 727    memset(outbuf, 0, log_buffer_size);
 728
 729    /* Add prefix for everything but Common Log Format messages */
 730    if (loglevel != LOG_LEVEL_CLF)
 731    {
 732       length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
 733          timestamp, thread_id, get_log_level_string(loglevel));
 734    }
 735
 736    /* get ready to scan var. args. */
 737    va_start(ap, fmt);
 738
 739    /* build formatted message from fmt and var-args */
 740    while ((*src) && (length < log_buffer_size-2))
 741    {
 742       const char *sval = NULL; /* %N string  */
 743       int ival;                /* %N string length or an error code */
 744       unsigned uval;           /* %u value */
 745       long lval;               /* %l value */
 746       unsigned long ulval;     /* %ul value */
 747       char ch;
 748       const char *format_string = tempbuf;
 749
 750       ch = *src++;
 751       if (ch != '%')
 752       {
 753          outbuf[length++] = ch;
 754          /*
 755           * XXX: Only necessary on platforms where multiple threads
 756           * can write to the buffer at the same time because we
 757           * don't support mutexes (OS/2 for example).
 758           */
 759          outbuf[length] = '\0';
 760          continue;
 761       }
 762       outbuf[length] = '\0';
 763       ch = *src++;
 764       switch (ch) {
 765          case '%':
 766             tempbuf[0] = '%';
 767             tempbuf[1] = '\0';
 768             break;
 769          case 'd':
 770             ival = va_arg(ap, int);
 771             snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
 772             break;
 773          case 'u':
 774             uval = va_arg(ap, unsigned);
 775             snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
 776             break;
 777          case 'l':
 778             /* this is a modifier that must be followed by u, lu, or d */
 779             ch = *src++;
 780             if (ch == 'd')
 781             {
 782                lval = va_arg(ap, long);
 783                snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
 784             }
 785             else if (ch == 'u')
 786             {
 787                ulval = va_arg(ap, unsigned long);
 788                snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
 789             }
 790             else if ((ch == 'l') && (*src == 'u'))
 791             {
 792                unsigned long long lluval = va_arg(ap, unsigned long long);
 793                snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
 794                src++;
 795             }
 796             else
 797             {
 798                snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
 799                loglevel = LOG_LEVEL_FATAL;
 800             }
 801             break;
 802          case 'c':
 803             /*
 804              * Note that char paramaters are converted to int, so we need to
 805              * pass "int" to va_arg.  (See K&R, 2nd ed, section A7.3.2, page 202)
 806              */
 807             tempbuf[0] = (char) va_arg(ap, int);
 808             tempbuf[1] = '\0';
 809             break;
 810          case 's':
 811             format_string = va_arg(ap, char *);
 812             if (format_string == NULL)
 813             {
 814                format_string = "[null]";
 815             }
 816             break;
 817          case 'N':
 818             /*
 819              * Non-standard: Print a counted unterminated string,
 820              * replacing unprintable bytes with their hex value.
 821              * Takes 2 parameters: int length, const char * string.
 822              */
 823             ival = va_arg(ap, int);
 824             assert(ival >= 0);
 825             sval = va_arg(ap, char *);
 826             assert(sval != NULL);
 827
 828             while ((ival-- > 0) && (length < log_buffer_size - 6))
 829             {
 830                if (isprint((int)*sval) && (*sval != '\\'))
 831                {
 832                   outbuf[length++] = *sval;
 833                   outbuf[length] = '\0';
 834                }
 835                else
 836                {
 837                   int ret = snprintf(outbuf + length,
 838                      log_buffer_size - length - 2, "\\x%.2x", (unsigned char)*sval);
 839                   assert(ret == 4);
 840                   length += 4;
 841                }
 842                sval++;
 843             }
 844             /*
 845              * XXX: In case of printable characters at the end of
 846              *      the %N string, we're not using the whole buffer.
 847              */
 848             format_string = (length < log_buffer_size - 6) ? "" : "[too long]";
 849             break;
 850          case 'E':
 851             /* Non-standard: Print error code from errno */
 852 #ifdef _WIN32
 853             ival = WSAGetLastError();
 854             format_string = w32_socket_strerr(ival, tempbuf);
 855 #elif __OS2__
 856             ival = sock_errno();
 857             if (ival != 0)
 858             {
 859                format_string = os2_socket_strerr(ival, tempbuf);
 860             }
 861             else
 862             {
 863                ival = errno;
 864                format_string = strerror(ival);
 865             }
 866 #else /* ifndef _WIN32 */
 867             ival = errno;
 868 #ifdef HAVE_STRERROR
 869             format_string = strerror(ival);
 870 #else /* ifndef HAVE_STRERROR */
 871             format_string = NULL;
 872 #endif /* ndef HAVE_STRERROR */
 873             if (sval == NULL)
 874             {
 875                snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
 876             }
 877 #endif /* ndef _WIN32 */
 878             break;
 879          case 'T':
 880             /* Non-standard: Print a Common Log File timestamp */
 881             get_clf_timestamp(tempbuf, sizeof(tempbuf));
 882             break;
 883          default:
 884             snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
 885             loglevel = LOG_LEVEL_FATAL;
 886             break;
 887       }
 888
 889       assert(length < log_buffer_size);
 890       length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
 891
 892       if (length >= log_buffer_size-2)
 893       {
 894          static const char warning[] = "... [too long, truncated]";
 895
 896          length = log_buffer_size - sizeof(warning) - 1;
 897          length += strlcpy(outbuf + length, warning, log_buffer_size - length);
 898          assert(length < log_buffer_size);
 899
 900          break;
 901       }
 902    }
 903
 904    /* done with var. args */
 905    va_end(ap);
 906
 907    assert(length < log_buffer_size);
 908    length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
 909
 910    /* Some sanity checks */
 911    if ((length >= log_buffer_size)
 912     || (outbuf[log_buffer_size-1] != '\0')
 913     || (outbuf[log_buffer_size] != '\0')
 914       )
 915    {
 916       /* Repeat as assertions */
 917       assert(length < log_buffer_size);
 918       assert(outbuf[log_buffer_size-1] == '\0');
 919       /*
 920        * outbuf's real size is log_buffer_size+1,
 921        * so while this looks like an off-by-one,
 922        * we're only checking our paranoia byte.
 923        */
 924       assert(outbuf[log_buffer_size] == '\0');
 925
 926       snprintf(outbuf, log_buffer_size,
 927          "%s %08lx Fatal error: log_error()'s sanity checks failed."
 928          "length: %d. Exiting.",
 929          timestamp, thread_id, (int)length);
 930       loglevel = LOG_LEVEL_FATAL;
 931    }
 932
 933 #ifndef _WIN32
 934    /*
 935     * On Windows this is acceptable in case
 936     * we are logging to the GUI window only.
 937     */
 938    assert(NULL != logfp);
 939 #endif
 940
 941    if (loglevel == LOG_LEVEL_FATAL)
 942    {
 943       fatal_error(outbuf_save);
 944       /* Never get here */
 945    }
 946    if (logfp != NULL)
 947    {
 948       fputs(outbuf_save, logfp);
 949    }
 950
 951 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
 952    /* Write to display */
 953    LogPutString(outbuf_save);
 954 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
 955
 956    unlock_logfile();
 957
 958 }
 959
 960
 961 /*********************************************************************
 962  *
 963  * Function    :  jb_err_to_string
 964  *
 965  * Description :  Translates JB_ERR_FOO codes into strings.
 966  *
 967  *                XXX: the type of error codes is jb_err
 968  *                but the typedef'inition is currently not
 969  *                visible to all files that include errlog.h.
 970  *
 971  * Parameters  :
 972  *          1  :  jb_error = a valid jb_err code
 973  *
 974  * Returns     :  A string with the jb_err translation
 975  *
 976  *********************************************************************/
 977 const char *jb_err_to_string(int jb_error)
 978 {
 979    switch (jb_error)
 980    {
 981       case JB_ERR_OK:
 982          return "Success, no error";
 983       case JB_ERR_MEMORY:
 984          return "Out of memory";
 985       case JB_ERR_CGI_PARAMS:
 986          return "Missing or corrupt CGI parameters";
 987       case JB_ERR_FILE:
 988          return "Error opening, reading or writing a file";
 989       case JB_ERR_PARSE:
 990          return "Parse error";
 991       case JB_ERR_MODIFIED:
 992          return "File has been modified outside of the CGI actions editor.";
 993       case JB_ERR_COMPRESS:
 994          return "(De)compression failure";
 995    }
 996    assert(0);
 997    return "Internal error";
 998 }
 999
1000 #ifdef _WIN32
1001 /*********************************************************************
1002  *
1003  * Function    :  w32_socket_strerr
1004  *
1005  * Description :  Translate the return value from WSAGetLastError()
1006  *                into a string.
1007  *
1008  * Parameters  :
1009  *          1  :  errcode = The return value from WSAGetLastError().
1010  *          2  :  tmp_buf = A temporary buffer that might be used to
1011  *                          store the string.
1012  *
1013  * Returns     :  String representing the error code.  This may be
1014  *                a global string constant or a string stored in
1015  *                tmp_buf.
1016  *
1017  *********************************************************************/
1018 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1019 {
1020 #define TEXT_FOR_ERROR(code,text) \
1021    if (errcode == code)           \
1022    {                              \
1023       return #code " - " text;    \
1024    }
1025
1026    TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1027    TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1028    TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1029    TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1030    TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1031    TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1032    TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1033    TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1034    TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1035    TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1036    TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1037    TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1038    TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1039    TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1040    TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1041    TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1042    TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1043    TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1044    TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1045    TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1046    TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1047    TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1048    TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1049    TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1050    TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1051    TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1052    TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1053    TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1054    TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1055    TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1056    TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1057    TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1058    TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1059    TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1060    TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1061    TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1062    TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1063    TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1064    TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1065    TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1066    TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1067    TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1068    /*
1069     * The following error codes are documented in the Microsoft WinSock
1070     * reference guide, but don't actually exist.
1071     *
1072     * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1073     * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1074     * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1075     * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1076     * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1077     * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1078     * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1079     * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1080     * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1081     * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1082     */
1083
1084    sprintf(tmp_buf, "(error number %d)", errcode);
1085    return tmp_buf;
1086 }
1087 #endif /* def _WIN32 */
1088
1089
1090 #ifdef __OS2__
1091 /*********************************************************************
1092  *
1093  * Function    :  os2_socket_strerr
1094  *
1095  * Description :  Translate the return value from sock_errno()
1096  *                into a string.
1097  *
1098  * Parameters  :
1099  *          1  :  errcode = The return value from sock_errno().
1100  *          2  :  tmp_buf = A temporary buffer that might be used to
1101  *                          store the string.
1102  *
1103  * Returns     :  String representing the error code.  This may be
1104  *                a global string constant or a string stored in
1105  *                tmp_buf.
1106  *
1107  *********************************************************************/
1108 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1109 {
1110 #define TEXT_FOR_ERROR(code,text) \
1111    if (errcode == code)           \
1112    {                              \
1113       return #code " - " text;    \
1114    }
1115
1116    TEXT_FOR_ERROR(SOCEPERM          , "Not owner.")
1117    TEXT_FOR_ERROR(SOCESRCH          , "No such process.")
1118    TEXT_FOR_ERROR(SOCEINTR          , "Interrupted system call.")
1119    TEXT_FOR_ERROR(SOCENXIO          , "No such device or address.")
1120    TEXT_FOR_ERROR(SOCEBADF          , "Bad file number.")
1121    TEXT_FOR_ERROR(SOCEACCES         , "Permission denied.")
1122    TEXT_FOR_ERROR(SOCEFAULT         , "Bad address.")
1123    TEXT_FOR_ERROR(SOCEINVAL         , "Invalid argument.")
1124    TEXT_FOR_ERROR(SOCEMFILE         , "Too many open files.")
1125    TEXT_FOR_ERROR(SOCEPIPE          , "Broken pipe.")
1126    TEXT_FOR_ERROR(SOCEWOULDBLOCK    , "Operation would block.")
1127    TEXT_FOR_ERROR(SOCEINPROGRESS    , "Operation now in progress.")
1128    TEXT_FOR_ERROR(SOCEALREADY       , "Operation already in progress.")
1129    TEXT_FOR_ERROR(SOCENOTSOCK       , "Socket operation on non-socket.")
1130    TEXT_FOR_ERROR(SOCEDESTADDRREQ   , "Destination address required.")
1131    TEXT_FOR_ERROR(SOCEMSGSIZE       , "Message too long.")
1132    TEXT_FOR_ERROR(SOCEPROTOTYPE     , "Protocol wrong type for socket.")
1133    TEXT_FOR_ERROR(SOCENOPROTOOPT    , "Protocol not available.")
1134    TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1135    TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1136    TEXT_FOR_ERROR(SOCEOPNOTSUPP     , "Operation not supported.")
1137    TEXT_FOR_ERROR(SOCEPFNOSUPPORT   , "Protocol family not supported.")
1138    TEXT_FOR_ERROR(SOCEAFNOSUPPORT   , "Address family not supported by protocol family.")
1139    TEXT_FOR_ERROR(SOCEADDRINUSE     , "Address already in use.")
1140    TEXT_FOR_ERROR(SOCEADDRNOTAVAIL  , "Can't assign requested address.")
1141    TEXT_FOR_ERROR(SOCENETDOWN       , "Network is down.")
1142    TEXT_FOR_ERROR(SOCENETUNREACH    , "Network is unreachable.")
1143    TEXT_FOR_ERROR(SOCENETRESET      , "Network dropped connection on reset.")
1144    TEXT_FOR_ERROR(SOCECONNABORTED   , "Software caused connection abort.")
1145    TEXT_FOR_ERROR(SOCECONNRESET     , "Connection reset by peer.")
1146    TEXT_FOR_ERROR(SOCENOBUFS        , "No buffer space available.")
1147    TEXT_FOR_ERROR(SOCEISCONN        , "Socket is already connected.")
1148    TEXT_FOR_ERROR(SOCENOTCONN       , "Socket is not connected.")
1149    TEXT_FOR_ERROR(SOCESHUTDOWN      , "Can't send after socket shutdown.")
1150    TEXT_FOR_ERROR(SOCETOOMANYREFS   , "Too many references: can't splice.")
1151    TEXT_FOR_ERROR(SOCETIMEDOUT      , "Operation timed out.")
1152    TEXT_FOR_ERROR(SOCECONNREFUSED   , "Connection refused.")
1153    TEXT_FOR_ERROR(SOCELOOP          , "Too many levels of symbolic links.")
1154    TEXT_FOR_ERROR(SOCENAMETOOLONG   , "File name too long.")
1155    TEXT_FOR_ERROR(SOCEHOSTDOWN      , "Host is down.")
1156    TEXT_FOR_ERROR(SOCEHOSTUNREACH   , "No route to host.")
1157    TEXT_FOR_ERROR(SOCENOTEMPTY      , "Directory not empty.")
1158    TEXT_FOR_ERROR(SOCEOS2ERR        , "OS/2 Error.")
1159
1160    sprintf(tmp_buf, "(error number %d)", errcode);
1161    return tmp_buf;
1162 }
1163 #endif /* def __OS2__ */
1164
1165
1166 /*
1167   Local Variables:
1168   tab-width: 3
1169   end:
1170 */