http_log.h revision b4c8a80f7dbfc9b56dbe03bdc28f0b5eb5f23697
3802a3d3d7af51ddff31943d5514382f01265770Lennart Poettering/* ====================================================================
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * Copyright (c) 1995-1999 The Apache Group. All rights reserved.
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * Redistribution and use in source and binary forms, with or without
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * modification, are permitted provided that the following conditions
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * are met:
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * 1. Redistributions of source code must retain the above copyright
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * notice, this list of conditions and the following disclaimer.
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek *
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * 2. Redistributions in binary form must reproduce the above copyright
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * notice, this list of conditions and the following disclaimer in
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * the documentation and/or other materials provided with the
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * distribution.
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek *
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * 3. All advertising materials mentioning features or use of this
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * software must display the following acknowledgment:
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * "This product includes software developed by the Apache Group
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * for use in the Apache HTTP server project (http://www.apache.org/)."
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek *
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek * 4. The names "Apache Server" and "Apache Group" must not be used to
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * endorse or promote products derived from this software without
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * prior written permission. For written permission, please contact
48f69d8fb4d0cf34d578352572c96d86e13caa79Lennart Poettering * apache@apache.org.
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * 5. Products derived from this software may not be called "Apache"
faae655de3cdbed4be1d472b01ce0c4d81e905edLennart Poettering * nor may "Apache" appear in their names without prior written
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * permission of the Apache Group.
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * 6. Redistributions of any form whatsoever must retain the following
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * acknowledgment:
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * "This product includes software developed by the Apache Group
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * for use in the Apache HTTP server project (http://www.apache.org/)."
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * OF THE POSSIBILITY OF SUCH DAMAGE.
02855643499f63045159fec72f23a339ef5a64d6Lennart Poettering * ====================================================================
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * This software consists of voluntary contributions made by many
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * individuals on behalf of the Apache Group and was originally based
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * on public domain software written at the National Center for
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * Supercomputing Applications, University of Illinois, Urbana-Champaign.
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * For more information on the Apache Group and the Apache HTTP server
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * project, please see <http://www.apache.org/>.
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering *
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifndef APACHE_HTTP_LOG_H
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APACHE_HTTP_LOG_H
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifdef __cplusplus
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poetteringextern "C" {
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifdef HAVE_SYSLOG
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#include <syslog.h>
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_EMERG LOG_EMERG /* system is unusable */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_ALERT LOG_ALERT /* action must be taken immediately */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_CRIT LOG_CRIT /* critical conditions */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_ERR LOG_ERR /* error conditions */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_WARNING LOG_WARNING /* warning conditions */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_NOTICE LOG_NOTICE /* normal but significant condition */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_INFO LOG_INFO /* informational */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_DEBUG LOG_DEBUG /* debug-level messages */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_LEVELMASK LOG_PRIMASK /* mask off the level value */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#else
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_EMERG 0 /* system is unusable */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_ALERT 1 /* action must be taken immediately */
b8bde11658366290521e3d03316378b482600323Jan Engelhardt#define APLOG_CRIT 2 /* critical conditions */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_ERR 3 /* error conditions */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_WARNING 4 /* warning conditions */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_NOTICE 5 /* normal but significant condition */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_INFO 6 /* informational */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_DEBUG 7 /* debug-level messages */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_LEVELMASK 7 /* mask off the level value */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif
b8bde11658366290521e3d03316378b482600323Jan Engelhardt
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_NOERRNO (APLOG_LEVELMASK + 1)
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifdef WIN32
b8bde11658366290521e3d03316378b482600323Jan Engelhardt/* Set to indicate that error msg should come from Win32's GetLastError(),
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering * not errno. */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define APLOG_WIN32ERROR ((APLOG_LEVELMASK+1) * 2)
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif
b8bde11658366290521e3d03316378b482600323Jan Engelhardt
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifndef DEFAULT_LOGLEVEL
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define DEFAULT_LOGLEVEL APLOG_WARNING
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif
b8bde11658366290521e3d03316378b482600323Jan Engelhardt
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering#define APLOG_MARK __FILE__,__LINE__
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poetteringvoid ap_open_logs (server_rec *, ap_context_t *p);
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ae9376394babe02685251ecfd6962b6f0f73a662Zbigniew Jędrzejewski-Szmek/* The two primary logging functions, ap_log_error and ap_log_rerror,
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * use a printf style format string to build the log message. It is
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt * VERY IMPORTANT that you not include any raw data from the network,
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * such as the request-URI or request header fields, within the format
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * string. Doing so makes the server vulnerable to a denial-of-service
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * attack and other messy behavior. Instead, use a simple format string
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * like "%s", followed by the string containing the untrusted data.
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_error(const char *file, int line, int level,
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering const server_rec *s, const char *fmt, ...)
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering __attribute__((format(printf,5,6)));
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_rerror(const char *file, int line, int level,
a8eaaee72a2f06e0fb64fb71de3b71ecba31dafbJan Engelhardt const request_rec *s, const char *fmt, ...)
f131770b1465fbf423881f16ba85523a05f846feVeres Lajos __attribute__((format(printf,5,6)));
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart PoetteringAPI_EXPORT(void) ap_error_log2stderr (server_rec *);
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poetteringvoid ap_log_pid (ap_context_t *p, const char *fname);
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering/* These are for legacy code, new code should use ap_log_error,
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering * or ap_log_rerror.
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering */
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_error_old(const char *err, server_rec *s);
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_unixerr(const char *routine, const char *file,
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering const char *msg, server_rec *s);
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_printf(const server_rec *s, const char *fmt, ...)
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering __attribute__((format(printf,2,3)));
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart PoetteringAPI_EXPORT(void) ap_log_reason(const char *reason, const char *fname,
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering request_rec *r);
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poetteringtypedef struct piped_log {
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering ap_context_t *p;
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering#ifndef NO_RELIABLE_PIPED_LOGS
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering char *program;
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering int pid;
850df10ac10aedbc2140bcd1152d6e86fdad9b48Lennart Poettering int fds[2];
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt#else
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering FILE *write_f;
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering#endif
a8eaaee72a2f06e0fb64fb71de3b71ecba31dafbJan Engelhardt} piped_log;
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart Poettering
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart PoetteringAPI_EXPORT(piped_log *) ap_open_piped_log (ap_context_t *p, const char *program);
b5dae4c7f77f7c87b91e0afb60a31c690dda4a1fLennart PoetteringAPI_EXPORT(void) ap_close_piped_log (piped_log *);
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifndef NO_RELIABLE_PIPED_LOGS
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define ap_piped_log_read_fd(pl) ((pl)->fds[0])
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define ap_piped_log_write_fd(pl) ((pl)->fds[1])
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#else
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#define ap_piped_log_read_fd(pl) (-1)
dd2b607b7d1ce355e93f9f71cd256ec20b8ae9c4Thomas Hindoe Paaboel Andersen#define ap_piped_log_write_fd(pl) (fileno((pl)->write_f))
faae655de3cdbed4be1d472b01ce0c4d81e905edLennart Poettering#endif
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#ifdef __cplusplus
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering}
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering#endif /* !APACHE_HTTP_LOG_H */
ce236b57bee9a081d62db04bcc5be34e3ba6d217Lennart Poettering