1 /* Copyright 1999-2004 The Apache Software Foundation
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * Modified by djm@va.pubnix.com:
18 * If no TransferLog is given explicitly, decline to log.
20 * This is module implements the TransferLog directive (same as the
21 * common log module), and additional directives, LogFormat and CustomLog.
26 * TransferLog fn Logs transfers to fn in standard log format, unless
27 * a custom format is set with LogFormat
28 * LogFormat format Set a log format from TransferLog files
30 * Log to file fn with format given by the format
33 * CookieLog fn For backwards compatability with old Cookie
34 * logging module - now deprecated.
36 * There can be any number of TransferLog and CustomLog
37 * commands. Each request will be logged to _ALL_ the
38 * named files, in the appropriate format.
40 * If no TransferLog or CustomLog directive appears in a VirtualHost,
41 * the request will be logged to the log file(s) defined outside
42 * the virtual host section. If a TransferLog or CustomLog directive
43 * appears in the VirtualHost section, the log files defined outside
44 * the VirtualHost will _not_ be used. This makes this module compatable
45 * with the CLF and config log modules, where the use of TransferLog
46 * inside the VirtualHost section overrides its use outside.
50 * TransferLog logs/access_log
52 * LogFormat "... custom format ..."
53 * TransferLog log/virtual_only
54 * CustomLog log/virtual_useragents "%t %{user-agent}i"
57 * This will log using CLF to access_log any requests handled by the
58 * main server, while any requests to the virtual host will be logged
59 * with the "... custom format..." to virtual_only _AND_ using
60 * the custom user-agent log to virtual_useragents.
62 * Note that the NCSA referer and user-agent logs are easily added with
64 * CustomLog logs/referer "%{referer}i -> %U"
65 * CustomLog logs/agent "%{user-agent}i"
67 * RefererIgnore functionality can be obtained with conditional
68 * logging (SetEnvIf and CustomLog ... env=!VAR).
70 * But using this method allows much easier modification of the
71 * log format, e.g. to log hosts along with UA:
72 * CustomLog logs/referer "%{referer}i %U %h"
74 * The argument to LogFormat and CustomLog is a string, which can include
75 * literal characters copied into the log files, and '%' directives as
78 * %...B: bytes sent, excluding HTTP headers.
79 * %...b: bytes sent, excluding HTTP headers in CLF format, i.e. a '-'
80 * when no bytes where sent (rather than a '0'.
81 * %...{FOOBAR}C: The contents of the HTTP cookie FOOBAR
82 * %...{FOOBAR}e: The contents of the environment variable FOOBAR
85 * %...a: remote IP-address
86 * %...A: local IP-address
87 * %...{Foobar}i: The contents of Foobar: header line(s) in the request
89 * %...l: remote logname (from identd, if supplied)
90 * %...{Foobar}n: The contents of note "Foobar" from another module.
91 * %...{Foobar}o: The contents of Foobar: header line(s) in the reply.
92 * %...p: the port the request was served to
93 * %...P: the process ID of the child that serviced the request.
94 * %...{format}P: the process ID or thread ID of the child/thread that
95 * serviced the request
96 * %...r: first line of request
97 * %...s: status. For requests that got internally redirected, this
98 * is status of the *original* request --- %...>s for the last.
99 * %...t: time, in common log format time format
100 * %...{format}t: The time, in the form given by format, which should
101 * be in strftime(3) format.
102 * %...T: the time taken to serve the request, in seconds.
103 * %...D: the time taken to serve the request, in micro seconds.
104 * %...u: remote user (from auth; may be bogus if return status (%s) is 401)
105 * %...U: the URL path requested.
106 * %...v: the configured name of the server (i.e. which virtual host?)
107 * %...V: the server name according to the UseCanonicalName setting
108 * %...m: the request method
109 * %...H: the request protocol
110 * %...q: the query string prepended by "?", or empty if no query string
111 * %...X: Status of the connection.
112 * 'X' = connection aborted before the response completed.
113 * '+' = connection may be kept alive after the response is sent.
114 * '-' = connection will be closed after the response is sent.
115 (This directive was %...c in late versions of Apache 1.3, but
116 this conflicted with the historical ssl %...{var}c syntax.)
118 * The '...' can be nothing at all (e.g. "%h %u %r %s %b"), or it can
119 * indicate conditions for inclusion of the item (which will cause it
120 * to be replaced with '-' if the condition is not met). Note that
121 * there is no escaping performed on the strings from %r, %...i and
122 * %...o; some with long memories may remember that I thought this was
123 * a bad idea, once upon a time, and I'm still not comfortable with
124 * it, but it is difficult to see how to "do the right thing" with all
125 * of '%..i', unless we URL-escape everything and break with CLF.
127 * The forms of condition are a list of HTTP status codes, which may
128 * or may not be preceded by '!'. Thus, '%400,501{User-agent}i' logs
129 * User-agent: on 400 errors and 501 errors (Bad Request, Not
130 * Implemented) only; '%!200,304,302{Referer}i' logs Referer: on all
131 * requests which did *not* return some sort of normal status.
133 * The default LogFormat reproduces CLF; see below.
135 * The way this is supposed to work with virtual hosts is as follows:
136 * a virtual host can have its own LogFormat, or its own TransferLog.
137 * If it doesn't have its own LogFormat, it inherits from the main
138 * server. If it doesn't have its own TransferLog, it writes to the
139 * same descriptor (meaning the same process for "| ...").
143 #include "apr_strings.h"
145 #include "apr_hash.h"
146 #include "apr_optional.h"
147 #include "apr_anylock.h"
149 #define APR_WANT_STRFUNC
150 #include "apr_want.h"
152 #include "ap_config.h"
153 #include "mod_log_config.h"
155 #include "http_config.h"
156 #include "http_core.h" /* For REMOTE_NAME */
157 #include "http_log.h"
158 #include "http_protocol.h"
159 #include "util_time.h"
162 #if APR_HAVE_UNISTD_H
169 #define DEFAULT_LOG_FORMAT "%h %l %u %t \"%r\" %>s %b"
171 module AP_MODULE_DECLARE_DATA log_config_module;
174 static int xfer_flags = (APR_WRITE | APR_APPEND | APR_CREATE | APR_LARGEFILE);
175 static apr_fileperms_t xfer_perms = APR_OS_DEFAULT;
176 static apr_hash_t *log_hash;
177 static apr_status_t ap_default_log_writer(request_rec *r,
183 static apr_status_t ap_buffered_log_writer(request_rec *r,
189 static void *ap_default_log_writer_init(apr_pool_t *p, server_rec *s,
191 static void *ap_buffered_log_writer_init(apr_pool_t *p, server_rec *s,
194 static ap_log_writer_init* ap_log_set_writer_init(ap_log_writer_init *handle);
195 static ap_log_writer* ap_log_set_writer(ap_log_writer *handle);
196 static ap_log_writer *log_writer = ap_default_log_writer;
197 static ap_log_writer_init *log_writer_init = ap_default_log_writer_init;
198 static int buffered_logs = 0; /* default unbuffered */
199 static apr_array_header_t *all_buffered_logs = NULL;
201 /* POSIX.1 defines PIPE_BUF as the maximum number of bytes that is
202 * guaranteed to be atomic when writing a pipe. And PIPE_BUF >= 512
203 * is guaranteed. So we'll just guess 512 in the event the system
204 * doesn't have this. Now, for file writes there is actually no limit,
205 * the entire write is atomic. Whether all systems implement this
206 * correctly is another question entirely ... so we'll just use PIPE_BUF
207 * because it's probably a good guess as to what is implemented correctly
211 #define LOG_BUFSIZE PIPE_BUF
213 #define LOG_BUFSIZE (512)
217 * multi_log_state is our per-(virtual)-server configuration. We store
218 * an array of the logs we are going to use, each of type config_log_state.
219 * If a default log format is given by LogFormat, store in default_format
220 * (backward compat. with mod_log_config). We also store for each virtual
221 * server a pointer to the logs specified for the main server, so that if this
222 * vhost has no logs defined, we can use the main server's logs instead.
224 * So, for the main server, config_logs contains a list of the log files
225 * and server_config_logs is empty. For a vhost, server_config_logs
226 * points to the same array as config_logs in the main server, and
227 * config_logs points to the array of logs defined inside this vhost,
228 * which might be empty.
232 const char *default_format_string;
233 apr_array_header_t *default_format;
234 apr_array_header_t *config_logs;
235 apr_array_header_t *server_config_logs;
236 apr_table_t *formats;
240 * config_log_state holds the status of a single log file. fname might
241 * be NULL, which means this module does no logging for this
242 * request. format might be NULL, in which case the default_format
243 * from the multi_log_state should be used, or if that is NULL as
245 * log_writer is NULL before the log file is opened and is
246 * set to a opaque structure (usually a fd) after it is opened.
252 char outbuf[LOG_BUFSIZE];
258 const char *format_string;
259 apr_array_header_t *format;
266 * Note that many of these could have ap_sprintfs replaced with static buffers.
270 ap_log_handler_fn_t *func;
274 apr_array_header_t *conditions;
277 static char *format_integer(apr_pool_t *p, int i)
279 return apr_itoa(p, i);
282 static char *pfmt(apr_pool_t *p, int i)
288 return format_integer(p, i);
292 static const char *constant_item(request_rec *dummy, char *stuff)
297 static const char *log_remote_host(request_rec *r, char *a)
299 return ap_escape_logitem(r->pool, ap_get_remote_host(r->connection,
304 static const char *log_remote_address(request_rec *r, char *a)
306 return r->connection->remote_ip;
309 static const char *log_local_address(request_rec *r, char *a)
311 return r->connection->local_ip;
314 static const char *log_remote_logname(request_rec *r, char *a)
316 return ap_escape_logitem(r->pool, ap_get_remote_logname(r));
319 static const char *log_remote_user(request_rec *r, char *a)
321 char *rvalue = r->user;
323 if (rvalue == NULL) {
326 else if (strlen(rvalue) == 0) {
330 rvalue = ap_escape_logitem(r->pool, rvalue);
336 static const char *log_request_line(request_rec *r, char *a)
338 /* NOTE: If the original request contained a password, we
339 * re-write the request line here to contain XXXXXX instead:
340 * (note the truncation before the protocol string for HTTP/0.9 requests)
341 * (note also that r->the_request contains the unmodified request)
343 return ap_escape_logitem(r->pool,
344 (r->parsed_uri.password)
345 ? apr_pstrcat(r->pool, r->method, " ",
346 apr_uri_unparse(r->pool,
348 r->assbackwards ? NULL : " ",
353 static const char *log_request_file(request_rec *r, char *a)
355 return ap_escape_logitem(r->pool, r->filename);
357 static const char *log_request_uri(request_rec *r, char *a)
359 return ap_escape_logitem(r->pool, r->uri);
361 static const char *log_request_method(request_rec *r, char *a)
363 return ap_escape_logitem(r->pool, r->method);
365 static const char *log_request_protocol(request_rec *r, char *a)
367 return ap_escape_logitem(r->pool, r->protocol);
369 static const char *log_request_query(request_rec *r, char *a)
371 return (r->args) ? apr_pstrcat(r->pool, "?",
372 ap_escape_logitem(r->pool, r->args), NULL)
375 static const char *log_status(request_rec *r, char *a)
377 return pfmt(r->pool, r->status);
380 static const char *clf_log_bytes_sent(request_rec *r, char *a)
382 if (!r->sent_bodyct || !r->bytes_sent) {
386 return apr_off_t_toa(r->pool, r->bytes_sent);
390 static const char *log_bytes_sent(request_rec *r, char *a)
392 if (!r->sent_bodyct || !r->bytes_sent) {
396 return apr_off_t_toa(r->pool, r->bytes_sent);
401 static const char *log_header_in(request_rec *r, char *a)
403 return ap_escape_logitem(r->pool, apr_table_get(r->headers_in, a));
406 static APR_INLINE char *find_multiple_headers(apr_pool_t *pool,
407 const apr_table_t *table,
410 const apr_array_header_t *elts;
411 const apr_table_entry_t *t_elt;
412 const apr_table_entry_t *t_end;
420 elts = apr_table_elts(table);
426 t_elt = (const apr_table_entry_t *)elts->elts;
427 t_end = t_elt + elts->nelts;
429 result_list = rp = NULL;
432 if (!strcasecmp(t_elt->key, key)) {
434 result_list = rp = apr_palloc(pool, sizeof(*rp));
437 rp = rp->next = apr_palloc(pool, sizeof(*rp));
442 rp->value = t_elt->val;
443 rp->len = strlen(rp->value);
448 } while (t_elt < t_end);
451 char *result = apr_palloc(pool, len);
456 if (rp != result_list) {
460 memcpy(cp, rp->value, rp->len);
472 static const char *log_header_out(request_rec *r, char *a)
474 const char *cp = NULL;
476 if (!strcasecmp(a, "Content-type") && r->content_type) {
477 cp = ap_field_noparam(r->pool, r->content_type);
479 else if (!strcasecmp(a, "Set-Cookie")) {
480 cp = find_multiple_headers(r->pool, r->headers_out, a);
483 cp = apr_table_get(r->headers_out, a);
486 return ap_escape_logitem(r->pool, cp);
489 static const char *log_note(request_rec *r, char *a)
491 return ap_escape_logitem(r->pool, apr_table_get(r->notes, a));
493 static const char *log_env_var(request_rec *r, char *a)
495 return ap_escape_logitem(r->pool, apr_table_get(r->subprocess_env, a));
498 static const char *log_cookie(request_rec *r, char *a)
501 const char *start_cookie;
503 if ((cookies = apr_table_get(r->headers_in, "Cookie"))) {
504 if ((start_cookie = ap_strstr_c(cookies,a))) {
505 char *cookie, *end_cookie;
506 start_cookie += strlen(a) + 1; /* cookie_name + '=' */
507 cookie = apr_pstrdup(r->pool, start_cookie);
508 /* kill everything in cookie after ';' */
509 end_cookie = strchr(cookie, ';');
513 return ap_escape_logitem(r->pool, cookie);
519 static const char *log_request_time_custom(request_rec *r, char *a,
523 char tstr[MAX_STRING_LEN];
524 apr_strftime(tstr, &retcode, sizeof(tstr), a, xt);
525 return apr_pstrdup(r->pool, tstr);
528 #define DEFAULT_REQUEST_TIME_SIZE 32
531 char timestr[DEFAULT_REQUEST_TIME_SIZE];
533 } cached_request_time;
535 #define TIME_CACHE_SIZE 4
536 #define TIME_CACHE_MASK 3
537 static cached_request_time request_time_cache[TIME_CACHE_SIZE];
539 static const char *log_request_time(request_rec *r, char *a)
543 /* ### I think getting the time again at the end of the request
544 * just for logging is dumb. i know it's "required" for CLF.
545 * folks writing log parsing tools don't realise that out of order
546 * times have always been possible (consider what happens if one
547 * process calculates the time to log, but then there's a context
548 * switch before it writes and before that process is run again the
549 * log rotation occurs) and they should just fix their tools rather
550 * than force the server to pay extra cpu cycles. if you've got
551 * a problem with this, you can set the define. -djg
553 if (a && *a) { /* Custom format */
554 /* The custom time formatting uses a very large temp buffer
555 * on the stack. To avoid using so much stack space in the
556 * common case where we're not using a custom format, the code
557 * for the custom format in a separate function. (That's why
558 * log_request_time_custom is not inlined right here.)
560 #ifdef I_INSIST_ON_EXTRA_CYCLES_FOR_CLF_COMPLIANCE
561 ap_explode_recent_localtime(&xt, apr_time_now());
563 ap_explode_recent_localtime(&xt, r->request_time);
565 return log_request_time_custom(r, a, &xt);
567 else { /* CLF format */
568 /* This code uses the same technique as ap_explode_recent_localtime():
569 * optimistic caching with logic to detect and correct race conditions.
570 * See the comments in server/util_time.c for more information.
572 cached_request_time* cached_time = apr_palloc(r->pool,
573 sizeof(*cached_time));
574 #ifdef I_INSIST_ON_EXTRA_CYCLES_FOR_CLF_COMPLIANCE
575 apr_time_t request_time = apr_time_now();
577 apr_time_t request_time = r->request_time;
579 unsigned t_seconds = (unsigned)apr_time_sec(request_time);
580 unsigned i = t_seconds & TIME_CACHE_MASK;
581 memcpy(cached_time, &(request_time_cache[i]), sizeof(*cached_time));
582 if ((t_seconds != cached_time->t) ||
583 (t_seconds != cached_time->t_validate)) {
585 /* Invalid or old snapshot, so compute the proper time string
586 * and store it in the cache
591 ap_explode_recent_localtime(&xt, request_time);
600 cached_time->t = t_seconds;
601 apr_snprintf(cached_time->timestr, DEFAULT_REQUEST_TIME_SIZE,
602 "[%02d/%s/%d:%02d:%02d:%02d %c%.2d%.2d]",
603 xt.tm_mday, apr_month_snames[xt.tm_mon],
604 xt.tm_year+1900, xt.tm_hour, xt.tm_min, xt.tm_sec,
605 sign, timz / (60*60), (timz % (60*60)) / 60);
606 cached_time->t_validate = t_seconds;
607 memcpy(&(request_time_cache[i]), cached_time,
608 sizeof(*cached_time));
610 return cached_time->timestr;
614 static const char *log_request_duration(request_rec *r, char *a)
616 apr_time_t duration = apr_time_now() - r->request_time;
617 return apr_psprintf(r->pool, "%" APR_TIME_T_FMT, apr_time_sec(duration));
620 static const char *log_request_duration_microseconds(request_rec *r, char *a)
622 return apr_psprintf(r->pool, "%" APR_TIME_T_FMT,
623 (apr_time_now() - r->request_time));
626 /* These next two routines use the canonical name:port so that log
627 * parsers don't need to duplicate all the vhost parsing crud.
629 static const char *log_virtual_host(request_rec *r, char *a)
631 return ap_escape_logitem(r->pool, r->server->server_hostname);
634 static const char *log_server_port(request_rec *r, char *a)
636 return apr_psprintf(r->pool, "%u",
637 r->server->port ? r->server->port : ap_default_port(r));
640 /* This respects the setting of UseCanonicalName so that
641 * the dynamic mass virtual hosting trick works better.
643 static const char *log_server_name(request_rec *r, char *a)
645 return ap_escape_logitem(r->pool, ap_get_server_name(r));
648 static const char *log_pid_tid(request_rec *r, char *a)
650 if (*a == '\0' || !strcmp(a, "pid")) {
651 return apr_psprintf(r->pool, "%" APR_PID_T_FMT, getpid());
653 else if (!strcmp(a, "tid")) {
655 apr_os_thread_t tid = apr_os_thread_current();
657 int tid = 0; /* APR will format "0" anyway but an arg is needed */
659 return apr_psprintf(r->pool, "%pT", &tid);
665 static const char *log_connection_status(request_rec *r, char *a)
667 if (r->connection->aborted)
670 if (r->connection->keepalive == AP_CONN_KEEPALIVE &&
671 (!r->server->keep_alive_max ||
672 (r->server->keep_alive_max - r->connection->keepalives) > 0)) {
678 /*****************************************************************
680 * Parsing the log format string
683 static char *parse_log_misc_string(apr_pool_t *p, log_format_item *it,
689 it->func = constant_item;
690 it->conditions = NULL;
693 while (*s && *s != '%') {
697 * This might allocate a few chars extra if there's a backslash
698 * escape in the format string.
700 it->arg = apr_palloc(p, s - *sa + 1);
704 while (*s && *s != '%') {
731 * Allow the loop to deal with this *s in the normal
732 * fashion so that it handles end of string etc.
745 static char *parse_log_item(apr_pool_t *p, log_format_item *it, const char **sa)
748 ap_log_handler *handler;
751 return parse_log_misc_string(p, it, sa);
755 it->condition_sense = 0;
756 it->conditions = NULL;
760 it->func = constant_item;
767 it->arg = ""; /* For safety's sake... */
775 it->condition_sense = !it->condition_sense;
794 it->arg = ap_getword(p, &s, '}');
808 while (apr_isdigit(*++s)) {
809 i = i * 10 + (*s) - '0';
811 if (!it->conditions) {
812 it->conditions = apr_array_make(p, 4, sizeof(int));
814 *(int *) apr_array_push(it->conditions) = i;
818 handler = (ap_log_handler *)apr_hash_get(log_hash, s++, 1);
824 return apr_pstrcat(p, "Unrecognized LogFormat directive %",
827 it->func = handler->func;
828 if (it->want_orig == -1) {
829 it->want_orig = handler->want_orig_default;
836 return "Ran off end of LogFormat parsing args to some directive";
839 static apr_array_header_t *parse_log_string(apr_pool_t *p, const char *s, const char **err)
841 apr_array_header_t *a = apr_array_make(p, 30, sizeof(log_format_item));
845 if ((res = parse_log_item(p, (log_format_item *) apr_array_push(a), &s))) {
852 parse_log_item(p, (log_format_item *) apr_array_push(a), &s);
856 /*****************************************************************
861 static const char *process_item(request_rec *r, request_rec *orig,
862 log_format_item *item)
866 /* First, see if we need to process this thing at all... */
868 if (item->conditions && item->conditions->nelts != 0) {
870 int *conds = (int *) item->conditions->elts;
873 for (i = 0; i < item->conditions->nelts; ++i) {
874 if (r->status == conds[i]) {
880 if ((item->condition_sense && in_list)
881 || (!item->condition_sense && !in_list)) {
886 /* We do. Do it... */
888 cp = (*item->func) (item->want_orig ? orig : r, item->arg);
889 return cp ? cp : "-";
892 static void flush_log(buffered_log *buf)
894 if (buf->outcnt && buf->handle != NULL) {
895 apr_file_write(buf->handle, buf->outbuf, &buf->outcnt);
901 static int config_log_transaction(request_rec *r, config_log_state *cls,
902 apr_array_header_t *default_format)
904 log_format_item *items;
910 apr_array_header_t *format;
914 if (cls->fname == NULL) {
919 * See if we've got any conditional envariable-controlled logging decisions
922 if (cls->condition_var != NULL) {
923 envar = cls->condition_var;
925 if (apr_table_get(r->subprocess_env, envar) == NULL) {
930 if (apr_table_get(r->subprocess_env, &envar[1]) != NULL) {
936 format = cls->format ? cls->format : default_format;
938 strs = apr_palloc(r->pool, sizeof(char *) * (format->nelts));
939 strl = apr_palloc(r->pool, sizeof(int) * (format->nelts));
940 items = (log_format_item *) format->elts;
950 for (i = 0; i < format->nelts; ++i) {
951 strs[i] = process_item(r, orig, &items[i]);
954 for (i = 0; i < format->nelts; ++i) {
955 len += strl[i] = strlen(strs[i]);
958 ap_log_rerror(APLOG_MARK, APLOG_ERR, APR_EGENERAL, r,
959 "log writer isn't correctly setup");
960 return HTTP_INTERNAL_SERVER_ERROR;
962 rv = log_writer(r, cls->log_writer, strs, strl, format->nelts, len);
963 /* xxx: do we return an error on log_writer? */
967 static int multi_log_transaction(request_rec *r)
969 multi_log_state *mls = ap_get_module_config(r->server->module_config,
971 config_log_state *clsarray;
975 * Log this transaction..
977 if (mls->config_logs->nelts) {
978 clsarray = (config_log_state *) mls->config_logs->elts;
979 for (i = 0; i < mls->config_logs->nelts; ++i) {
980 config_log_state *cls = &clsarray[i];
982 config_log_transaction(r, cls, mls->default_format);
985 else if (mls->server_config_logs) {
986 clsarray = (config_log_state *) mls->server_config_logs->elts;
987 for (i = 0; i < mls->server_config_logs->nelts; ++i) {
988 config_log_state *cls = &clsarray[i];
990 config_log_transaction(r, cls, mls->default_format);
997 /*****************************************************************
1002 static void *make_config_log_state(apr_pool_t *p, server_rec *s)
1004 multi_log_state *mls;
1006 mls = (multi_log_state *) apr_palloc(p, sizeof(multi_log_state));
1007 mls->config_logs = apr_array_make(p, 1, sizeof(config_log_state));
1008 mls->default_format_string = NULL;
1009 mls->default_format = NULL;
1010 mls->server_config_logs = NULL;
1011 mls->formats = apr_table_make(p, 4);
1012 apr_table_setn(mls->formats, "CLF", DEFAULT_LOG_FORMAT);
1018 * Use the merger to simply add a pointer from the vhost log state
1019 * to the log of logs specified for the non-vhost configuration. Make sure
1020 * vhosts inherit any globally-defined format names.
1023 static void *merge_config_log_state(apr_pool_t *p, void *basev, void *addv)
1025 multi_log_state *base = (multi_log_state *) basev;
1026 multi_log_state *add = (multi_log_state *) addv;
1028 add->server_config_logs = base->config_logs;
1029 if (!add->default_format) {
1030 add->default_format_string = base->default_format_string;
1031 add->default_format = base->default_format;
1033 add->formats = apr_table_overlay(p, base->formats, add->formats);
1039 * Set the default logfile format, or define a nickname for a format string.
1041 static const char *log_format(cmd_parms *cmd, void *dummy, const char *fmt,
1044 const char *err_string = NULL;
1045 multi_log_state *mls = ap_get_module_config(cmd->server->module_config,
1046 &log_config_module);
1049 * If we were given two arguments, the second is a name to be given to the
1050 * format. This syntax just defines the nickname - it doesn't actually
1051 * make the format the default.
1054 parse_log_string(cmd->pool, fmt, &err_string);
1055 if (err_string == NULL) {
1056 apr_table_setn(mls->formats, name, fmt);
1060 mls->default_format_string = fmt;
1061 mls->default_format = parse_log_string(cmd->pool, fmt, &err_string);
1067 static const char *add_custom_log(cmd_parms *cmd, void *dummy, const char *fn,
1068 const char *fmt, const char *envclause)
1070 const char *err_string = NULL;
1071 multi_log_state *mls = ap_get_module_config(cmd->server->module_config,
1072 &log_config_module);
1073 config_log_state *cls;
1075 cls = (config_log_state *) apr_array_push(mls->config_logs);
1076 cls->condition_var = NULL;
1077 if (envclause != NULL) {
1078 if (strncasecmp(envclause, "env=", 4) != 0) {
1079 return "error in condition clause";
1081 if ((envclause[4] == '\0')
1082 || ((envclause[4] == '!') && (envclause[5] == '\0'))) {
1083 return "missing environment variable name";
1085 cls->condition_var = apr_pstrdup(cmd->pool, &envclause[4]);
1089 cls->format_string = fmt;
1094 cls->format = parse_log_string(cmd->pool, fmt, &err_string);
1096 cls->log_writer = NULL;
1101 static const char *set_transfer_log(cmd_parms *cmd, void *dummy,
1104 return add_custom_log(cmd, dummy, fn, NULL, NULL);
1107 static const char *set_cookie_log(cmd_parms *cmd, void *dummy, const char *fn)
1109 return add_custom_log(cmd, dummy, fn, "%{Cookie}n \"%r\" %t", NULL);
1112 static const char *set_buffered_logs_on(cmd_parms *parms, void *dummy, int flag)
1114 buffered_logs = flag;
1115 if (buffered_logs) {
1116 ap_log_set_writer_init(ap_buffered_log_writer_init);
1117 ap_log_set_writer(ap_buffered_log_writer);
1121 static const command_rec config_log_cmds[] =
1123 AP_INIT_TAKE23("CustomLog", add_custom_log, NULL, RSRC_CONF,
1124 "a file name, a custom log format string or format name, "
1125 "and an optional \"env=\" clause (see docs)"),
1126 AP_INIT_TAKE1("TransferLog", set_transfer_log, NULL, RSRC_CONF,
1127 "the filename of the access log"),
1128 AP_INIT_TAKE12("LogFormat", log_format, NULL, RSRC_CONF,
1129 "a log format string (see docs) and an optional format name"),
1130 AP_INIT_TAKE1("CookieLog", set_cookie_log, NULL, RSRC_CONF,
1131 "the filename of the cookie log"),
1132 AP_INIT_FLAG("BufferedLogs", set_buffered_logs_on, NULL, RSRC_CONF,
1133 "Enable Buffered Logging (experimental)"),
1137 static config_log_state *open_config_log(server_rec *s, apr_pool_t *p,
1138 config_log_state *cls,
1139 apr_array_header_t *default_format)
1141 if (cls->log_writer != NULL) {
1142 return cls; /* virtual config shared w/main server */
1145 if (cls->fname == NULL) {
1146 return cls; /* Leave it NULL to decline. */
1149 cls->log_writer = log_writer_init(p, s, cls->fname);
1150 if (cls->log_writer == NULL)
1156 static int open_multi_logs(server_rec *s, apr_pool_t *p)
1159 multi_log_state *mls = ap_get_module_config(s->module_config,
1160 &log_config_module);
1161 config_log_state *clsarray;
1165 if (mls->default_format_string) {
1166 format = apr_table_get(mls->formats, mls->default_format_string);
1168 mls->default_format = parse_log_string(p, format, &dummy);
1172 if (!mls->default_format) {
1173 mls->default_format = parse_log_string(p, DEFAULT_LOG_FORMAT, &dummy);
1176 if (mls->config_logs->nelts) {
1177 clsarray = (config_log_state *) mls->config_logs->elts;
1178 for (i = 0; i < mls->config_logs->nelts; ++i) {
1179 config_log_state *cls = &clsarray[i];
1181 if (cls->format_string) {
1182 format = apr_table_get(mls->formats, cls->format_string);
1184 cls->format = parse_log_string(p, format, &dummy);
1188 if (!open_config_log(s, p, cls, mls->default_format)) {
1189 /* Failure already logged by open_config_log */
1194 else if (mls->server_config_logs) {
1195 clsarray = (config_log_state *) mls->server_config_logs->elts;
1196 for (i = 0; i < mls->server_config_logs->nelts; ++i) {
1197 config_log_state *cls = &clsarray[i];
1199 if (cls->format_string) {
1200 format = apr_table_get(mls->formats, cls->format_string);
1202 cls->format = parse_log_string(p, format, &dummy);
1206 if (!open_config_log(s, p, cls, mls->default_format)) {
1207 /* Failure already logged by open_config_log */
1217 static apr_status_t flush_all_logs(void *data)
1219 server_rec *s = data;
1220 multi_log_state *mls;
1221 apr_array_header_t *log_list;
1222 config_log_state *clsarray;
1229 for (; s; s = s->next) {
1230 mls = ap_get_module_config(s->module_config, &log_config_module);
1232 if (mls->config_logs->nelts) {
1233 log_list = mls->config_logs;
1235 else if (mls->server_config_logs) {
1236 log_list = mls->server_config_logs;
1239 clsarray = (config_log_state *) log_list->elts;
1240 for (i = 0; i < log_list->nelts; ++i) {
1241 buf = clsarray[i].log_writer;
1250 static int init_config_log(apr_pool_t *pc, apr_pool_t *p, apr_pool_t *pt, server_rec *s)
1254 /* First init the buffered logs array, which is needed when opening the logs. */
1255 if (buffered_logs) {
1256 all_buffered_logs = apr_array_make(p, 5, sizeof(buffered_log *));
1259 /* Next, do "physical" server, which gets default log fd and format
1260 * for the virtual servers, if they don't override...
1262 res = open_multi_logs(s, p);
1264 /* Then, virtual servers */
1266 for (s = s->next; (res == OK) && s; s = s->next) {
1267 res = open_multi_logs(s, p);
1273 static void init_child(apr_pool_t *p, server_rec *s)
1277 ap_mpm_query(AP_MPMQ_MAX_THREADS, &mpm_threads);
1279 /* Now register the last buffer flush with the cleanup engine */
1280 if (buffered_logs) {
1282 buffered_log **array = (buffered_log **)all_buffered_logs->elts;
1284 apr_pool_cleanup_register(p, s, flush_all_logs, flush_all_logs);
1286 for (i = 0; i < all_buffered_logs->nelts; i++) {
1287 buffered_log *this = array[i];
1290 if (mpm_threads > 1) {
1293 this->mutex.type = apr_anylock_threadmutex;
1294 rv = apr_thread_mutex_create(&this->mutex.lock.tm,
1295 APR_THREAD_MUTEX_DEFAULT,
1297 if (rv != APR_SUCCESS) {
1298 ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s,
1299 "could not initialize buffered log mutex, "
1300 "transfer log may become corrupted");
1301 this->mutex.type = apr_anylock_none;
1307 this->mutex.type = apr_anylock_none;
1313 static void ap_register_log_handler(apr_pool_t *p, char *tag,
1314 ap_log_handler_fn_t *handler, int def)
1316 ap_log_handler *log_struct = apr_palloc(p, sizeof(*log_struct));
1317 log_struct->func = handler;
1318 log_struct->want_orig_default = def;
1320 apr_hash_set(log_hash, tag, 1, (const void *)log_struct);
1322 static ap_log_writer_init* ap_log_set_writer_init(ap_log_writer_init *handle)
1324 ap_log_writer_init *old = log_writer_init;
1325 log_writer_init = handle;
1330 static ap_log_writer *ap_log_set_writer(ap_log_writer *handle)
1332 ap_log_writer *old = log_writer;
1333 log_writer = handle;
1338 static apr_status_t ap_default_log_writer( request_rec *r,
1351 str = apr_palloc(r->pool, len + 1);
1353 for (i = 0, s = str; i < nelts; ++i) {
1354 memcpy(s, strs[i], strl[i]);
1358 rv = apr_file_write((apr_file_t*)handle, str, &len);
1362 static void *ap_default_log_writer_init(apr_pool_t *p, server_rec *s,
1368 pl = ap_open_piped_log(p, name + 1);
1372 return ap_piped_log_write_fd(pl);
1375 const char *fname = ap_server_root_relative(p, name);
1380 ap_log_error(APLOG_MARK, APLOG_ERR, APR_EBADPATH, s,
1381 "invalid transfer log path %s.", name);
1384 rv = apr_file_open(&fd, fname, xfer_flags, xfer_perms, p);
1385 if (rv != APR_SUCCESS) {
1386 ap_log_error(APLOG_MARK, APLOG_ERR, rv, s,
1387 "could not open transfer log file %s.", fname);
1393 static void *ap_buffered_log_writer_init(apr_pool_t *p, server_rec *s,
1397 b = apr_pcalloc(p, sizeof(buffered_log));
1398 b->handle = ap_default_log_writer_init(p, s, name);
1401 *(buffered_log **)apr_array_push(all_buffered_logs) = b;
1407 static apr_status_t ap_buffered_log_writer(request_rec *r,
1419 buffered_log *buf = (buffered_log*)handle;
1421 if ((rv = APR_ANYLOCK_LOCK(&buf->mutex)) != APR_SUCCESS) {
1425 if (len + buf->outcnt > LOG_BUFSIZE) {
1428 if (len >= LOG_BUFSIZE) {
1431 str = apr_palloc(r->pool, len + 1);
1432 for (i = 0, s = str; i < nelts; ++i) {
1433 memcpy(s, strs[i], strl[i]);
1437 rv = apr_file_write(buf->handle, str, &w);
1441 for (i = 0, s = &buf->outbuf[buf->outcnt]; i < nelts; ++i) {
1442 memcpy(s, strs[i], strl[i]);
1449 APR_ANYLOCK_UNLOCK(&buf->mutex);
1453 static int log_pre_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp)
1455 static APR_OPTIONAL_FN_TYPE(ap_register_log_handler) *log_pfn_register;
1457 log_pfn_register = APR_RETRIEVE_OPTIONAL_FN(ap_register_log_handler);
1459 if (log_pfn_register) {
1460 log_pfn_register(p, "h", log_remote_host, 0);
1461 log_pfn_register(p, "a", log_remote_address, 0 );
1462 log_pfn_register(p, "A", log_local_address, 0 );
1463 log_pfn_register(p, "l", log_remote_logname, 0);
1464 log_pfn_register(p, "u", log_remote_user, 0);
1465 log_pfn_register(p, "t", log_request_time, 0);
1466 log_pfn_register(p, "f", log_request_file, 0);
1467 log_pfn_register(p, "b", clf_log_bytes_sent, 0);
1468 log_pfn_register(p, "B", log_bytes_sent, 0);
1469 log_pfn_register(p, "i", log_header_in, 0);
1470 log_pfn_register(p, "o", log_header_out, 0);
1471 log_pfn_register(p, "n", log_note, 0);
1472 log_pfn_register(p, "e", log_env_var, 0);
1473 log_pfn_register(p, "V", log_server_name, 0);
1474 log_pfn_register(p, "v", log_virtual_host, 0);
1475 log_pfn_register(p, "p", log_server_port, 0);
1476 log_pfn_register(p, "P", log_pid_tid, 0);
1477 log_pfn_register(p, "H", log_request_protocol, 0);
1478 log_pfn_register(p, "m", log_request_method, 0);
1479 log_pfn_register(p, "q", log_request_query, 0);
1480 log_pfn_register(p, "X", log_connection_status, 0);
1481 log_pfn_register(p, "C", log_cookie, 0);
1482 log_pfn_register(p, "r", log_request_line, 1);
1483 log_pfn_register(p, "D", log_request_duration_microseconds, 1);
1484 log_pfn_register(p, "T", log_request_duration, 1);
1485 log_pfn_register(p, "U", log_request_uri, 1);
1486 log_pfn_register(p, "s", log_status, 1);
1492 static void register_hooks(apr_pool_t *p)
1494 ap_hook_pre_config(log_pre_config,NULL,NULL,APR_HOOK_REALLY_FIRST);
1495 ap_hook_child_init(init_child,NULL,NULL,APR_HOOK_MIDDLE);
1496 ap_hook_open_logs(init_config_log,NULL,NULL,APR_HOOK_MIDDLE);
1497 ap_hook_log_transaction(multi_log_transaction,NULL,NULL,APR_HOOK_MIDDLE);
1499 /* Init log_hash before we register the optional function. It is
1500 * possible for the optional function, ap_register_log_handler,
1501 * to be called before any other mod_log_config hooks are called.
1502 * As a policy, we should init everything required by an optional function
1503 * before calling APR_REGISTER_OPTIONAL_FN.
1505 log_hash = apr_hash_make(p);
1506 APR_REGISTER_OPTIONAL_FN(ap_register_log_handler);
1507 APR_REGISTER_OPTIONAL_FN(ap_log_set_writer_init);
1508 APR_REGISTER_OPTIONAL_FN(ap_log_set_writer);
1511 module AP_MODULE_DECLARE_DATA log_config_module =
1513 STANDARD20_MODULE_STUFF,
1514 NULL, /* create per-dir config */
1515 NULL, /* merge per-dir config */
1516 make_config_log_state, /* server config */
1517 merge_config_log_state, /* merge server config */
1518 config_log_cmds, /* command apr_table_t */
1519 register_hooks /* register hooks */