errlog.c

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