errlog.c

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