granicus.if.org Git - apache/blob - server/log.c

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * http_log.c: Dealing with the logs and errors
  19  *
  20  * Rob McCool
  21  *
  22  */
  23
  24 #include "apr.h"
  25 #include "apr_general.h"        /* for signal stuff */
  26 #include "apr_strings.h"
  27 #include "apr_errno.h"
  28 #include "apr_thread_proc.h"
  29 #include "apr_lib.h"
  30 #include "apr_signal.h"
  31
  32 #define APR_WANT_STDIO
  33 #define APR_WANT_STRFUNC
  34 #include "apr_want.h"
  35
  36 #if APR_HAVE_STDARG_H
  37 #include <stdarg.h>
  38 #endif
  39 #if APR_HAVE_UNISTD_H
  40 #include <unistd.h>
  41 #endif
  42
  43 #define CORE_PRIVATE
  44
  45 #include "ap_config.h"
  46 #include "httpd.h"
  47 #include "http_config.h"
  48 #include "http_core.h"
  49 #include "http_log.h"
  50 #include "http_main.h"
  51 #include "util_time.h"
  52 #include "ap_mpm.h"
  53
  54 typedef struct {
  55     char    *t_name;
  56     int      t_val;
  57 } TRANS;
  58
  59 APR_HOOK_STRUCT(
  60     APR_HOOK_LINK(error_log)
  61 )
  62
  63 int AP_DECLARE_DATA ap_default_loglevel = DEFAULT_LOGLEVEL;
  64
  65 #ifdef HAVE_SYSLOG
  66
  67 static const TRANS facilities[] = {
  68     {"auth",    LOG_AUTH},
  69 #ifdef LOG_AUTHPRIV
  70     {"authpriv",LOG_AUTHPRIV},
  71 #endif
  72 #ifdef LOG_CRON
  73     {"cron",    LOG_CRON},
  74 #endif
  75 #ifdef LOG_DAEMON
  76     {"daemon",  LOG_DAEMON},
  77 #endif
  78 #ifdef LOG_FTP
  79     {"ftp", LOG_FTP},
  80 #endif
  81 #ifdef LOG_KERN
  82     {"kern",    LOG_KERN},
  83 #endif
  84 #ifdef LOG_LPR
  85     {"lpr", LOG_LPR},
  86 #endif
  87 #ifdef LOG_MAIL
  88     {"mail",    LOG_MAIL},
  89 #endif
  90 #ifdef LOG_NEWS
  91     {"news",    LOG_NEWS},
  92 #endif
  93 #ifdef LOG_SYSLOG
  94     {"syslog",  LOG_SYSLOG},
  95 #endif
  96 #ifdef LOG_USER
  97     {"user",    LOG_USER},
  98 #endif
  99 #ifdef LOG_UUCP
 100     {"uucp",    LOG_UUCP},
 101 #endif
 102 #ifdef LOG_LOCAL0
 103     {"local0",  LOG_LOCAL0},
 104 #endif
 105 #ifdef LOG_LOCAL1
 106     {"local1",  LOG_LOCAL1},
 107 #endif
 108 #ifdef LOG_LOCAL2
 109     {"local2",  LOG_LOCAL2},
 110 #endif
 111 #ifdef LOG_LOCAL3
 112     {"local3",  LOG_LOCAL3},
 113 #endif
 114 #ifdef LOG_LOCAL4
 115     {"local4",  LOG_LOCAL4},
 116 #endif
 117 #ifdef LOG_LOCAL5
 118     {"local5",  LOG_LOCAL5},
 119 #endif
 120 #ifdef LOG_LOCAL6
 121     {"local6",  LOG_LOCAL6},
 122 #endif
 123 #ifdef LOG_LOCAL7
 124     {"local7",  LOG_LOCAL7},
 125 #endif
 126     {NULL,      -1},
 127 };
 128 #endif
 129
 130 static const TRANS priorities[] = {
 131     {"emerg",   APLOG_EMERG},
 132     {"alert",   APLOG_ALERT},
 133     {"crit",    APLOG_CRIT},
 134     {"error",   APLOG_ERR},
 135     {"warn",    APLOG_WARNING},
 136     {"notice",  APLOG_NOTICE},
 137     {"info",    APLOG_INFO},
 138     {"debug",   APLOG_DEBUG},
 139     {NULL,      -1},
 140 };
 141
 142 static apr_file_t *stderr_log = NULL;
 143
 144 /* track pipe handles to close in child process */
 145 typedef struct read_handle_t {
 146     struct read_handle_t *next;
 147     apr_file_t *handle;
 148 } read_handle_t;
 149
 150 static read_handle_t *read_handles;
 151
 152 /* clear_handle_list() is called when plog is cleared; at that
 153  * point we need to forget about our old list of pipe read
 154  * handles
 155  */
 156 static apr_status_t clear_handle_list(void *v)
 157 {
 158     read_handles = NULL;
 159     return APR_SUCCESS;
 160 }
 161
 162 /* remember to close this handle in the child process */
 163 static void close_handle_in_child(apr_pool_t *p, apr_file_t *f)
 164 {
 165     read_handle_t *new_handle;
 166
 167     new_handle = apr_pcalloc(p, sizeof(read_handle_t));
 168     new_handle->next = read_handles;
 169     new_handle->handle = f;
 170     read_handles = new_handle;
 171 }
 172
 173 void ap_logs_child_init(apr_pool_t *p, server_rec *s)
 174 {
 175     read_handle_t *cur = read_handles;
 176
 177     while (cur) {
 178         apr_file_close(cur->handle);
 179         cur = cur->next;
 180     }
 181 }
 182
 183 AP_DECLARE(void) ap_open_stderr_log(apr_pool_t *p)
 184 {
 185     apr_file_open_stderr(&stderr_log, p);
 186 }
 187
 188 AP_DECLARE(apr_status_t) ap_replace_stderr_log(apr_pool_t *p,
 189                                                const char *fname)
 190 {
 191     apr_file_t *stderr_file;
 192     apr_status_t rc;
 193     char *filename = ap_server_root_relative(p, fname);
 194     if (!filename) {
 195         ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT,
 196                      APR_EBADPATH, NULL, "Invalid -E error log file %s",
 197                      fname);
 198         return APR_EBADPATH;
 199     }
 200     if ((rc = apr_file_open(&stderr_file, filename,
 201                             APR_APPEND | APR_WRITE | APR_CREATE | APR_LARGEFILE,
 202                             APR_OS_DEFAULT, p)) != APR_SUCCESS) {
 203         ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
 204                      "%s: could not open error log file %s.",
 205                      ap_server_argv0, fname);
 206         return rc;
 207     }
 208     if ((rc = apr_file_open_stderr(&stderr_log, p)) == APR_SUCCESS) {
 209         apr_file_flush(stderr_log);
 210         if ((rc = apr_file_dup2(stderr_log, stderr_file, p)) == APR_SUCCESS) {
 211             apr_file_close(stderr_file);
 212         }
 213     }
 214     if (rc != APR_SUCCESS) {
 215         ap_log_error(APLOG_MARK, APLOG_CRIT, rc, NULL,
 216                      "unable to replace stderr with error log file");
 217     }
 218     return rc;
 219 }
 220
 221 static void log_child_errfn(apr_pool_t *pool, apr_status_t err,
 222                             const char *description)
 223 {
 224     ap_log_error(APLOG_MARK, APLOG_ERR, err, NULL,
 225                  "%s", description);
 226 }
 227
 228 /* Create a child process running PROGNAME with a pipe connected to
 229  * the childs stdin.  The write-end of the pipe will be placed in
 230  * *FPIN on successful return.  If dummy_stderr is non-zero, the
 231  * stderr for the child will be the same as the stdout of the parent.
 232  * Otherwise the child will inherit the stderr from the parent. */
 233 static int log_child(apr_pool_t *p, const char *progname,
 234                      apr_file_t **fpin, int dummy_stderr)
 235 {
 236     /* Child process code for 'ErrorLog "|..."';
 237      * may want a common framework for this, since I expect it will
 238      * be common for other foo-loggers to want this sort of thing...
 239      */
 240     apr_status_t rc;
 241     apr_procattr_t *procattr;
 242     apr_proc_t *procnew;
 243     apr_file_t *errfile;
 244
 245     if (((rc = apr_procattr_create(&procattr, p)) == APR_SUCCESS)
 246         && ((rc = apr_procattr_cmdtype_set(procattr,
 247                                            APR_SHELLCMD_ENV)) == APR_SUCCESS)
 248         && ((rc = apr_procattr_io_set(procattr,
 249                                       APR_FULL_BLOCK,
 250                                       APR_NO_PIPE,
 251                                       APR_NO_PIPE)) == APR_SUCCESS)
 252         && ((rc = apr_procattr_error_check_set(procattr, 1)) == APR_SUCCESS)
 253         && ((rc = apr_procattr_child_errfn_set(procattr, log_child_errfn)) == APR_SUCCESS)
 254         && (!dummy_stderr
 255             || ((rc = apr_file_open_stdout(&errfile, p)) == APR_SUCCESS
 256                 && (rc = apr_procattr_child_err_set(procattr,
 257                                                     errfile,
 258                                                     errfile)) == APR_SUCCESS))) {
 259         char **args;
 260         const char *pname;
 261
 262         apr_tokenize_to_argv(progname, &args, p);
 263         pname = apr_pstrdup(p, args[0]);
 264         procnew = (apr_proc_t *)apr_pcalloc(p, sizeof(*procnew));
 265         rc = apr_proc_create(procnew, pname, (const char * const *)args,
 266                              NULL, procattr, p);
 267
 268         if (rc == APR_SUCCESS) {
 269             apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
 270             (*fpin) = procnew->in;
 271             /* read handle to pipe not kept open, so no need to call
 272              * close_handle_in_child()
 273              */
 274         }
 275
 276         /* apr_procattr_child_err_set dups errfile twice: close the
 277          * remaining "parent-side" copy (apr_proc_create closes the
 278          * other). */
 279         if (dummy_stderr) {
 280             apr_file_close(procnew->err);
 281         }
 282     }
 283
 284     return rc;
 285 }
 286
 287 /* Open the error log for the given server_rec.  If IS_MAIN is
 288  * non-zero, s is the main server. */
 289 static int open_error_log(server_rec *s, int is_main, apr_pool_t *p)
 290 {
 291     const char *fname;
 292     int rc;
 293
 294     if (*s->error_fname == '|') {
 295         apr_file_t *dummy = NULL;
 296
 297         /* Spawn a new child logger.  If this is the main server_rec,
 298          * the new child must use a dummy stderr since the current
 299          * stderr might be a pipe to the old logger.  Otherwise, the
 300          * child inherits the parents stderr. */
 301         rc = log_child(p, s->error_fname + 1, &dummy, is_main);
 302         if (rc != APR_SUCCESS) {
 303             ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
 304                          "Couldn't start ErrorLog process");
 305             return DONE;
 306         }
 307
 308         s->error_log = dummy;
 309     }
 310
 311 #ifdef HAVE_SYSLOG
 312     else if (!strncasecmp(s->error_fname, "syslog", 6)) {
 313         if ((fname = strchr(s->error_fname, ':'))) {
 314             const TRANS *fac;
 315
 316             fname++;
 317             for (fac = facilities; fac->t_name; fac++) {
 318                 if (!strcasecmp(fname, fac->t_name)) {
 319                     openlog(ap_server_argv0, LOG_NDELAY|LOG_CONS|LOG_PID,
 320                             fac->t_val);
 321                     s->error_log = NULL;
 322                     return OK;
 323                 }
 324             }
 325         }
 326         else {
 327             openlog(ap_server_argv0, LOG_NDELAY|LOG_CONS|LOG_PID, LOG_LOCAL7);
 328         }
 329
 330         s->error_log = NULL;
 331     }
 332 #endif
 333     else {
 334         fname = ap_server_root_relative(p, s->error_fname);
 335         if (!fname) {
 336             ap_log_error(APLOG_MARK, APLOG_STARTUP, APR_EBADPATH, NULL,
 337                          "%s: Invalid error log path %s.",
 338                          ap_server_argv0, s->error_fname);
 339             return DONE;
 340         }
 341         if ((rc = apr_file_open(&s->error_log, fname,
 342                                APR_APPEND | APR_WRITE | APR_CREATE | APR_LARGEFILE,
 343                                APR_OS_DEFAULT, p)) != APR_SUCCESS) {
 344             ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
 345                          "%s: could not open error log file %s.",
 346                          ap_server_argv0, fname);
 347             return DONE;
 348         }
 349     }
 350
 351     return OK;
 352 }
 353
 354 int ap_open_logs(apr_pool_t *pconf, apr_pool_t *p /* plog */,
 355                  apr_pool_t *ptemp, server_rec *s_main)
 356 {
 357     server_rec *virt, *q;
 358     int replace_stderr;
 359
 360     apr_pool_cleanup_register(p, NULL, clear_handle_list,
 361                               apr_pool_cleanup_null);
 362     if (open_error_log(s_main, 1, p) != OK) {
 363         return DONE;
 364     }
 365
 366     replace_stderr = 1;
 367     if (s_main->error_log) {
 368         apr_status_t rv;
 369
 370         /* Replace existing stderr with new log. */
 371         apr_file_flush(s_main->error_log);
 372         rv = apr_file_dup2(stderr_log, s_main->error_log, p);
 373         if (rv != APR_SUCCESS) {
 374             ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s_main,
 375                          "unable to replace stderr with error_log");
 376         }
 377         else {
 378             replace_stderr = 0;
 379         }
 380     }
 381     /* note that stderr may still need to be replaced with something
 382      * because it points to the old error log, or back to the tty
 383      * of the submitter.
 384      * XXX: This is BS - /dev/null is non-portable
 385      */
 386     if (replace_stderr && freopen("/dev/null", "w", stderr) == NULL) {
 387         ap_log_error(APLOG_MARK, APLOG_CRIT, errno, s_main,
 388                      "unable to replace stderr with /dev/null");
 389     }
 390
 391     for (virt = s_main->next; virt; virt = virt->next) {
 392         if (virt->error_fname) {
 393             for (q=s_main; q != virt; q = q->next) {
 394                 if (q->error_fname != NULL
 395                     && strcmp(q->error_fname, virt->error_fname) == 0) {
 396                     break;
 397                 }
 398             }
 399
 400             if (q == virt) {
 401                 if (open_error_log(virt, 0, p) != OK) {
 402                     return DONE;
 403                 }
 404             }
 405             else {
 406                 virt->error_log = q->error_log;
 407             }
 408         }
 409         else {
 410             virt->error_log = s_main->error_log;
 411         }
 412     }
 413     return OK;
 414 }
 415
 416 AP_DECLARE(void) ap_error_log2stderr(server_rec *s) {
 417     apr_file_t *errfile = NULL;
 418
 419     apr_file_open_stderr(&errfile, s->process->pool);
 420     if (s->error_log != NULL) {
 421         apr_file_dup2(s->error_log, errfile, s->process->pool);
 422     }
 423 }
 424
 425 static void log_error_core(const char *file, int line, int level,
 426                            apr_status_t status, const server_rec *s,
 427                            const conn_rec *c,
 428                            const request_rec *r, apr_pool_t *pool,
 429                            const char *fmt, va_list args)
 430 {
 431     char errstr[MAX_STRING_LEN];
 432 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
 433     char scratch[MAX_STRING_LEN];
 434 #endif
 435     apr_size_t len, errstrlen;
 436     apr_file_t *logf = NULL;
 437     const char *referer;
 438     int level_and_mask = level & APLOG_LEVELMASK;
 439
 440     if (r && r->connection) {
 441         c = r->connection;
 442     }
 443
 444     if (s == NULL) {
 445         /*
 446          * If we are doing stderr logging (startup), don't log messages that are
 447          * above the default server log level unless it is a startup/shutdown
 448          * notice
 449          */
 450         if ((level_and_mask != APLOG_NOTICE)
 451             && (level_and_mask > ap_default_loglevel)) {
 452             return;
 453         }
 454
 455         logf = stderr_log;
 456     }
 457     else if (s->error_log) {
 458         /*
 459          * If we are doing normal logging, don't log messages that are
 460          * above the server log level unless it is a startup/shutdown notice
 461          */
 462         if ((level_and_mask != APLOG_NOTICE)
 463             && (level_and_mask > s->loglevel)) {
 464             return;
 465         }
 466
 467         logf = s->error_log;
 468     }
 469 #ifdef TPF
 470     else if (tpf_child) {
 471         /*
 472          * If we are doing normal logging, don't log messages that are
 473          * above the server log level unless it is a startup/shutdown notice
 474          */
 475         if ((level_and_mask != APLOG_NOTICE)
 476             && (level_and_mask > s->loglevel)) {
 477             return;
 478         }
 479
 480         logf = stderr;
 481     }
 482 #endif /* TPF */
 483     else {
 484         /*
 485          * If we are doing syslog logging, don't log messages that are
 486          * above the server log level (including a startup/shutdown notice)
 487          */
 488         if (level_and_mask > s->loglevel) {
 489             return;
 490         }
 491     }
 492
 493     if (logf && ((level & APLOG_STARTUP) != APLOG_STARTUP)) {
 494         errstr[0] = '[';
 495         ap_recent_ctime(errstr + 1, apr_time_now());
 496         errstr[1 + APR_CTIME_LEN - 1] = ']';
 497         errstr[1 + APR_CTIME_LEN    ] = ' ';
 498         len = 1 + APR_CTIME_LEN + 1;
 499     } else {
 500         len = 0;
 501     }
 502
 503     if ((level & APLOG_STARTUP) != APLOG_STARTUP) {
 504         len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 505                             "[%s] ", priorities[level_and_mask].t_name);
 506     }
 507
 508 #ifndef TPF
 509     if (file && level_and_mask == APLOG_DEBUG) {
 510 #if defined(_OSD_POSIX) || defined(WIN32) || defined(__MVS__)
 511         char tmp[256];
 512         char *e = strrchr(file, '/');
 513 #ifdef WIN32
 514         if (!e) {
 515             e = strrchr(file, '\\');
 516         }
 517 #endif
 518
 519         /* In OSD/POSIX, the compiler returns for __FILE__
 520          * a string like: __FILE__="*POSIX(/usr/include/stdio.h)"
 521          * (it even returns an absolute path for sources in
 522          * the current directory). Here we try to strip this
 523          * down to the basename.
 524          */
 525         if (e != NULL && e[1] != '\0') {
 526             apr_snprintf(tmp, sizeof(tmp), "%s", &e[1]);
 527             e = &tmp[strlen(tmp)-1];
 528             if (*e == ')') {
 529                 *e = '\0';
 530             }
 531             file = tmp;
 532         }
 533 #else /* _OSD_POSIX || WIN32 */
 534         const char *p;
 535         /* On Unix, __FILE__ may be an absolute path in a
 536          * VPATH build. */
 537         if (file[0] == '/' && (p = ap_strrchr_c(file, '/')) != NULL) {
 538             file = p + 1;
 539         }
 540 #endif /*_OSD_POSIX || WIN32 */
 541         len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 542                             "%s(%d): ", file, line);
 543     }
 544 #endif /* TPF */
 545
 546     if (c) {
 547         /* XXX: TODO: add a method of selecting whether logged client
 548          * addresses are in dotted quad or resolved form... dotted
 549          * quad is the most secure, which is why I'm implementing it
 550          * first. -djg
 551          */
 552         len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 553                             "[client %s] ", c->remote_ip);
 554     }
 555     if (status != 0) {
 556         if (status < APR_OS_START_EAIERR) {
 557             len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 558                                 "(%d)", status);
 559         }
 560         else if (status < APR_OS_START_SYSERR) {
 561             len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 562                                 "(EAI %d)", status - APR_OS_START_EAIERR);
 563         }
 564         else if (status < 100000 + APR_OS_START_SYSERR) {
 565             len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 566                                 "(OS %d)", status - APR_OS_START_SYSERR);
 567         }
 568         else {
 569             len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 570                                 "(os 0x%08x)", status - APR_OS_START_SYSERR);
 571         }
 572         apr_strerror(status, errstr + len, MAX_STRING_LEN - len);
 573         len += strlen(errstr + len);
 574         if (MAX_STRING_LEN - len > 2) {
 575             errstr[len++] = ':';
 576             errstr[len++] = ' ';
 577             errstr[len] = '\0';
 578         }
 579     }
 580
 581     errstrlen = len;
 582 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
 583     if (apr_vsnprintf(scratch, MAX_STRING_LEN - len, fmt, args)) {
 584         len += ap_escape_errorlog_item(errstr + len, scratch,
 585                                        MAX_STRING_LEN - len);
 586     }
 587 #else
 588     len += apr_vsnprintf(errstr + len, MAX_STRING_LEN - len, fmt, args);
 589 #endif
 590
 591     if (   r && (referer = apr_table_get(r->headers_in, "Referer"))
 592 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
 593         && ap_escape_errorlog_item(scratch, referer, MAX_STRING_LEN - len)
 594 #endif
 595         ) {
 596         len += apr_snprintf(errstr + len, MAX_STRING_LEN - len,
 597                             ", referer: %s",
 598 #ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
 599                             scratch
 600 #else
 601                             referer
 602 #endif
 603                             );
 604     }
 605
 606     /* NULL if we are logging to syslog */
 607     if (logf) {
 608         /* Truncate for the terminator (as apr_snprintf does) */
 609         if (len > MAX_STRING_LEN - sizeof(APR_EOL_STR)) {
 610             len = MAX_STRING_LEN - sizeof(APR_EOL_STR);
 611         }
 612         strcpy(errstr + len, APR_EOL_STR);
 613         apr_file_puts(errstr, logf);
 614         apr_file_flush(logf);
 615     }
 616 #ifdef HAVE_SYSLOG
 617     else {
 618         syslog(level_and_mask, "%s", errstr);
 619     }
 620 #endif
 621
 622     ap_run_error_log(file, line, level, status, s, r, pool, errstr + errstrlen);
 623 }
 624
 625 AP_DECLARE(void) ap_log_error(const char *file, int line, int level,
 626                               apr_status_t status, const server_rec *s,
 627                               const char *fmt, ...)
 628 {
 629     va_list args;
 630
 631     va_start(args, fmt);
 632     log_error_core(file, line, level, status, s, NULL, NULL, NULL, fmt, args);
 633     va_end(args);
 634 }
 635
 636 AP_DECLARE(void) ap_log_perror(const char *file, int line, int level,
 637                                apr_status_t status, apr_pool_t *p,
 638                                const char *fmt, ...)
 639 {
 640     va_list args;
 641
 642     va_start(args, fmt);
 643     log_error_core(file, line, level, status, NULL, NULL, NULL, p, fmt, args);
 644     va_end(args);
 645 }
 646
 647 AP_DECLARE(void) ap_log_rerror(const char *file, int line, int level,
 648                                apr_status_t status, const request_rec *r,
 649                                const char *fmt, ...)
 650 {
 651     va_list args;
 652
 653     va_start(args, fmt);
 654     log_error_core(file, line, level, status, r->server, NULL, r, NULL, fmt,
 655                    args);
 656
 657     /*
 658      * IF APLOG_TOCLIENT is set,
 659      * AND the error level is 'warning' or more severe,
 660      * AND there isn't already error text associated with this request,
 661      * THEN make the message text available to ErrorDocument and
 662      * other error processors.
 663      */
 664     va_end(args);
 665     va_start(args,fmt);
 666     if ((level & APLOG_TOCLIENT)
 667         && ((level & APLOG_LEVELMASK) <= APLOG_WARNING)
 668         && (apr_table_get(r->notes, "error-notes") == NULL)) {
 669         apr_table_setn(r->notes, "error-notes",
 670                        ap_escape_html(r->pool, apr_pvsprintf(r->pool, fmt,
 671                                                              args)));
 672     }
 673     va_end(args);
 674 }
 675
 676 AP_DECLARE(void) ap_log_cerror(const char *file, int line, int level,
 677                                apr_status_t status, const conn_rec *c,
 678                                const char *fmt, ...)
 679 {
 680     va_list args;
 681
 682     va_start(args, fmt);
 683     log_error_core(file, line, level, status, c->base_server, c, NULL, NULL,
 684                    fmt, args);
 685     va_end(args);
 686 }
 687
 688 AP_DECLARE(void) ap_log_pid(apr_pool_t *p, const char *filename)
 689 {
 690     apr_file_t *pid_file = NULL;
 691     apr_finfo_t finfo;
 692     static pid_t saved_pid = -1;
 693     pid_t mypid;
 694     apr_status_t rv;
 695     const char *fname;
 696
 697     if (!filename) {
 698         return;
 699     }
 700
 701     fname = ap_server_root_relative(p, filename);
 702     if (!fname) {
 703         ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT, APR_EBADPATH,
 704                      NULL, "Invalid PID file path %s, ignoring.", filename);
 705         return;
 706     }
 707
 708     mypid = getpid();
 709     if (mypid != saved_pid
 710         && apr_stat(&finfo, fname, APR_FINFO_MTIME, p) == APR_SUCCESS) {
 711         /* AP_SIG_GRACEFUL and HUP call this on each restart.
 712          * Only warn on first time through for this pid.
 713          *
 714          * XXX: Could just write first time through too, although
 715          *      that may screw up scripts written to do something
 716          *      based on the last modification time of the pid file.
 717          */
 718         ap_log_perror(APLOG_MARK, APLOG_WARNING, 0, p,
 719                       "pid file %s overwritten -- Unclean "
 720                       "shutdown of previous Apache run?",
 721                       fname);
 722     }
 723
 724     if ((rv = apr_file_open(&pid_file, fname,
 725                             APR_WRITE | APR_CREATE | APR_TRUNCATE,
 726                             APR_UREAD | APR_UWRITE | APR_GREAD | APR_WREAD, p))
 727         != APR_SUCCESS) {
 728         ap_log_error(APLOG_MARK, APLOG_ERR, rv, NULL,
 729                      "could not create %s", fname);
 730         ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
 731                      "%s: could not log pid to file %s",
 732                      ap_server_argv0, fname);
 733         exit(1);
 734     }
 735     apr_file_printf(pid_file, "%ld" APR_EOL_STR, (long)mypid);
 736     apr_file_close(pid_file);
 737     saved_pid = mypid;
 738 }
 739
 740 AP_DECLARE(apr_status_t) ap_read_pid(apr_pool_t *p, const char *filename,
 741                                      pid_t *mypid)
 742 {
 743     const apr_size_t BUFFER_SIZE = sizeof(long) * 3 + 2; /* see apr_ltoa */
 744     apr_file_t *pid_file = NULL;
 745     apr_status_t rv;
 746     const char *fname;
 747     char *buf, *endptr;
 748     apr_size_t bytes_read;
 749
 750     if (!filename) {
 751         return APR_EGENERAL;
 752     }
 753
 754     fname = ap_server_root_relative(p, filename);
 755     if (!fname) {
 756         ap_log_error(APLOG_MARK, APLOG_STARTUP|APLOG_CRIT, APR_EBADPATH,
 757                      NULL, "Invalid PID file path %s, ignoring.", filename);
 758         return APR_EGENERAL;
 759     }
 760
 761     rv = apr_file_open(&pid_file, fname, APR_READ, APR_OS_DEFAULT, p);
 762     if (rv != APR_SUCCESS) {
 763         return rv;
 764     }
 765
 766     buf = apr_palloc(p, BUFFER_SIZE);
 767
 768     rv = apr_file_read_full(pid_file, buf, BUFFER_SIZE - 1, &bytes_read);
 769     if (rv != APR_SUCCESS && rv != APR_EOF) {
 770         return rv;
 771     }
 772
 773     /* If we fill the buffer, we're probably reading a corrupt pid file.
 774      * To be nice, let's also ensure the first char is a digit. */
 775     if (bytes_read == 0 || bytes_read == BUFFER_SIZE - 1 || !apr_isdigit(*buf)) {
 776         return APR_EGENERAL;
 777     }
 778
 779     buf[bytes_read] = '\0';
 780     *mypid = strtol(buf, &endptr, 10);
 781
 782     apr_file_close(pid_file);
 783     return APR_SUCCESS;
 784 }
 785
 786 AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile,
 787                                int nLine)
 788 {
 789     char time_str[APR_CTIME_LEN];
 790
 791     apr_ctime(time_str, apr_time_now());
 792     ap_log_error(APLOG_MARK, APLOG_CRIT, 0, NULL,
 793                  "[%s] file %s, line %d, assertion \"%s\" failed",
 794                  time_str, szFile, nLine, szExp);
 795 #if defined(WIN32)
 796     DebugBreak();
 797 #else
 798     /* unix assert does an abort leading to a core dump */
 799     abort();
 800 #endif
 801 }
 802
 803 /* piped log support */
 804
 805 #ifdef AP_HAVE_RELIABLE_PIPED_LOGS
 806 /* forward declaration */
 807 static void piped_log_maintenance(int reason, void *data, apr_wait_t status);
 808
 809 /* Spawn the piped logger process pl->program. */
 810 static apr_status_t piped_log_spawn(piped_log *pl)
 811 {
 812     apr_procattr_t *procattr;
 813     apr_proc_t *procnew = NULL;
 814     apr_status_t status;
 815
 816     if (((status = apr_procattr_create(&procattr, pl->p)) != APR_SUCCESS) ||
 817         ((status = apr_procattr_cmdtype_set(procattr,
 818                                             APR_SHELLCMD_ENV)) != APR_SUCCESS) ||
 819         ((status = apr_procattr_child_in_set(procattr,
 820                                              ap_piped_log_read_fd(pl),
 821                                              ap_piped_log_write_fd(pl)))
 822         != APR_SUCCESS) ||
 823         ((status = apr_procattr_child_errfn_set(procattr, log_child_errfn))
 824          != APR_SUCCESS) ||
 825         ((status = apr_procattr_error_check_set(procattr, 1)) != APR_SUCCESS)) {
 826         char buf[120];
 827         /* Something bad happened, give up and go away. */
 828         ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
 829                      "piped_log_spawn: unable to setup child process '%s': %s",
 830                      pl->program, apr_strerror(status, buf, sizeof(buf)));
 831     }
 832     else {
 833         char **args;
 834         const char *pname;
 835
 836         apr_tokenize_to_argv(pl->program, &args, pl->p);
 837         pname = apr_pstrdup(pl->p, args[0]);
 838         procnew = apr_pcalloc(pl->p, sizeof(apr_proc_t));
 839         status = apr_proc_create(procnew, pname, (const char * const *) args,
 840                                  NULL, procattr, pl->p);
 841
 842         if (status == APR_SUCCESS) {
 843             pl->pid = procnew;
 844             /* procnew->in was dup2'd from ap_piped_log_write_fd(pl);
 845              * since the original fd is still valid, close the copy to
 846              * avoid a leak. */
 847             apr_file_close(procnew->in);
 848             procnew->in = NULL;
 849             apr_proc_other_child_register(procnew, piped_log_maintenance, pl,
 850                                           ap_piped_log_write_fd(pl), pl->p);
 851             close_handle_in_child(pl->p, ap_piped_log_read_fd(pl));
 852         }
 853         else {
 854             char buf[120];
 855             /* Something bad happened, give up and go away. */
 856             ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
 857                          "unable to start piped log program '%s': %s",
 858                          pl->program, apr_strerror(status, buf, sizeof(buf)));
 859         }
 860     }
 861
 862     return status;
 863 }
 864
 865
 866 static void piped_log_maintenance(int reason, void *data, apr_wait_t status)
 867 {
 868     piped_log *pl = data;
 869     apr_status_t stats;
 870     int mpm_state;
 871
 872     switch (reason) {
 873     case APR_OC_REASON_DEATH:
 874     case APR_OC_REASON_LOST:
 875         pl->pid = NULL; /* in case we don't get it going again, this
 876                          * tells other logic not to try to kill it
 877                          */
 878         apr_proc_other_child_unregister(pl);
 879         stats = ap_mpm_query(AP_MPMQ_MPM_STATE, &mpm_state);
 880         if (stats != APR_SUCCESS) {
 881             ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
 882                          "can't query MPM state; not restarting "
 883                          "piped log program '%s'",
 884                          pl->program);
 885         }
 886         else if (mpm_state != AP_MPMQ_STOPPING) {
 887             ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
 888                          "piped log program '%s' failed unexpectedly",
 889                          pl->program);
 890             if ((stats = piped_log_spawn(pl)) != APR_SUCCESS) {
 891                 /* what can we do?  This could be the error log we're having
 892                  * problems opening up... */
 893                 char buf[120];
 894                 ap_log_error(APLOG_MARK, APLOG_STARTUP, 0, NULL,
 895                              "piped_log_maintenance: unable to respawn '%s': %s",
 896                              pl->program, apr_strerror(stats, buf, sizeof(buf)));
 897             }
 898         }
 899         break;
 900
 901     case APR_OC_REASON_UNWRITABLE:
 902         /* We should not kill off the pipe here, since it may only be full.
 903          * If it really is locked, we should kill it off manually. */
 904     break;
 905
 906     case APR_OC_REASON_RESTART:
 907         if (pl->pid != NULL) {
 908             apr_proc_kill(pl->pid, SIGTERM);
 909             pl->pid = NULL;
 910         }
 911         break;
 912
 913     case APR_OC_REASON_UNREGISTER:
 914         break;
 915     }
 916 }
 917
 918
 919 static apr_status_t piped_log_cleanup_for_exec(void *data)
 920 {
 921     piped_log *pl = data;
 922
 923     apr_file_close(ap_piped_log_read_fd(pl));
 924     apr_file_close(ap_piped_log_write_fd(pl));
 925     return APR_SUCCESS;
 926 }
 927
 928
 929 static apr_status_t piped_log_cleanup(void *data)
 930 {
 931     piped_log *pl = data;
 932
 933     if (pl->pid != NULL) {
 934         apr_proc_kill(pl->pid, SIGTERM);
 935     }
 936     return piped_log_cleanup_for_exec(data);
 937 }
 938
 939
 940 AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program)
 941 {
 942     piped_log *pl;
 943
 944     pl = apr_palloc(p, sizeof (*pl));
 945     pl->p = p;
 946     pl->program = apr_pstrdup(p, program);
 947     pl->pid = NULL;
 948     if (apr_file_pipe_create(&ap_piped_log_read_fd(pl),
 949                              &ap_piped_log_write_fd(pl), p) != APR_SUCCESS) {
 950         return NULL;
 951     }
 952     apr_pool_cleanup_register(p, pl, piped_log_cleanup,
 953                               piped_log_cleanup_for_exec);
 954     if (piped_log_spawn(pl) != APR_SUCCESS) {
 955         apr_pool_cleanup_kill(p, pl, piped_log_cleanup);
 956         apr_file_close(ap_piped_log_read_fd(pl));
 957         apr_file_close(ap_piped_log_write_fd(pl));
 958         return NULL;
 959     }
 960     return pl;
 961 }
 962
 963 #else /* !AP_HAVE_RELIABLE_PIPED_LOGS */
 964
 965 static apr_status_t piped_log_cleanup(void *data)
 966 {
 967     piped_log *pl = data;
 968
 969     apr_file_close(ap_piped_log_write_fd(pl));
 970     return APR_SUCCESS;
 971 }
 972
 973 AP_DECLARE(piped_log *) ap_open_piped_log(apr_pool_t *p, const char *program)
 974 {
 975     piped_log *pl;
 976     apr_file_t *dummy = NULL;
 977     int rc;
 978
 979     rc = log_child(p, program, &dummy, 0);
 980     if (rc != APR_SUCCESS) {
 981         ap_log_error(APLOG_MARK, APLOG_STARTUP, rc, NULL,
 982                      "Couldn't start piped log process");
 983         return NULL;
 984     }
 985
 986     pl = apr_palloc(p, sizeof (*pl));
 987     pl->p = p;
 988     ap_piped_log_read_fd(pl) = NULL;
 989     ap_piped_log_write_fd(pl) = dummy;
 990     apr_pool_cleanup_register(p, pl, piped_log_cleanup, piped_log_cleanup);
 991
 992     return pl;
 993 }
 994
 995 #endif
 996
 997 AP_DECLARE(void) ap_close_piped_log(piped_log *pl)
 998 {
 999     apr_pool_cleanup_run(pl->p, pl, piped_log_cleanup);
1000 }
1001
1002 AP_IMPLEMENT_HOOK_VOID(error_log,
1003                        (const char *file, int line, int level,
1004                         apr_status_t status, const server_rec *s,
1005                         const request_rec *r, apr_pool_t *pool,
1006                         const char *errstr), (file, line, level,
1007                         status, s, r, pool, errstr))
1008