errlog.c

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