2 * SQUID Web Proxy Cache http://www.squid-cache.org/
3 * ----------------------------------------------------------
5 * Squid is the result of efforts by numerous individuals from
6 * the Internet community; see the CONTRIBUTORS file for full
7 * details. Many organizations have provided support for Squid's
8 * development; see the SPONSORS file for full details. Squid is
9 * Copyrighted (C) 2001 by the Regents of the University of
10 * California; see the COPYRIGHT file for full details. Squid
11 * incorporates software developed and/or copyrighted by other
12 * sources; see the CREDITS file for full details.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
28 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
30 #ifndef SQUID_HTTPACCESSLOGENTRY_H
31 #define SQUID_HTTPACCESSLOGENTRY_H
33 #include "anyp/PortCfg.h"
34 #include "comm/Connection.h"
35 #include "HttpVersion.h"
36 #include "HttpRequestMethod.h"
37 #include "HierarchyLogEntry.h"
38 #include "ip/Address.h"
39 #include "HttpRequestMethod.h"
41 #include "adaptation/icap/Elements.h"
45 #include "ssl/gadgets.h"
52 class AccessLogEntry
: public RefCountable
56 typedef RefCount
<AccessLogEntry
> Pointer
;
58 AccessLogEntry() : url(NULL
), tcpClient(), reply(NULL
), request(NULL
),
59 adapted_request(NULL
) {}
62 /// Fetch the client IP log string into the given buffer.
63 /// Knows about several alternate locations of the IP
64 /// including indirect forwarded-for IP if configured to log that
65 void getLogClientIp(char *buf
, size_t bufsz
) const;
69 /// TCP/IP level details about the client connection
70 Comm::ConnectionPointer tcpClient
;
71 // TCP/IP level details about the server or peer connection
72 // are stored in hier.tcpServer
74 /** \brief This subclass holds log info for HTTP protocol
75 * \todo Inner class declarations should be moved outside
76 * \todo details of HTTP held in the parent class need moving into here.
82 HttpDetails() : method(METHOD_NONE
), code(0), content_type(NULL
),
83 timedout(false), aborted(false) {}
85 HttpRequestMethod method
;
87 const char *content_type
;
89 bool timedout
; ///< terminated due to a lifetime or I/O timeout
90 bool aborted
; ///< other abnormal termination (e.g., I/O error)
92 /// compute suffix for the status access.log field
93 const char *statusSfx() const {
94 return timedout
? "_TIMEDOUT" : (aborted
? "_ABORTED" : "");
98 /** \brief This subclass holds log info for ICP protocol
99 * \todo Inner class declarations should be moved outside
105 IcpDetails() : opcode(ICP_INVALID
) {}
110 /** \brief This subclass holds log info for HTCP protocol
111 * \todo Inner class declarations should be moved outside
116 HtcpDetails() : opcode(NULL
) {};
122 /// logging information specific to the SSL protocol
128 const char *user
; ///< emailAddress from the SSL client certificate
129 int bumpMode
; ///< whether and how the request was SslBumped
133 /** \brief This subclass holds log info for Squid internal stats
134 * \todo Inner class declarations should be moved outside
135 * \todo some details relevant to particular protocols need shuffling to other sub-classes
136 * \todo this object field need renaming to 'squid' or something.
142 CacheDetails() : caddr(),
145 requestHeadersSize(0),
164 int requestHeadersSize
; ///< received, including request line
165 int replyHeadersSize
; ///< sent, including status line
171 const char *authuser
;
176 Ssl::X509_Pointer sslClientCert
; ///< cert received from the client
182 /** \brief This subclass holds log info for various headers in raw format
183 * \todo shuffle this to the relevant protocol section.
189 Headers() : request(NULL
),
190 adapted_request(NULL
),
193 char *request
; //< virgin HTTP request headers
195 char *adapted_request
; //< HTTP request headers after adaptation and redirection
201 /** \brief This subclass holds general adaptation log info.
202 * \todo Inner class declarations should be moved outside.
204 class AdaptationDetails
208 AdaptationDetails(): last_meta(NULL
) {}
210 /// image of the last ICAP response header or eCAP meta received
215 // Why is this a sub-class and not a set of real "private:" fields?
216 // It looks like its duplicating HTTPRequestMethod anyway!
217 // TODO: shuffle this to the relevant protocol section OR replace with request->method
222 Private() : method_str(NULL
) {}
224 const char *method_str
;
226 HierarchyLogEntry hier
;
228 HttpRequest
*request
; //< virgin HTTP request
229 HttpRequest
*adapted_request
; //< HTTP request after adaptation and redirection
233 /** \brief This subclass holds log info for ICAP part of request
234 * \todo Inner class declarations should be moved outside
239 IcapLogEntry():bodyBytesRead(-1),request(NULL
),reply(NULL
),outcome(Adaptation::Icap::xoUnknown
),trTime(0),ioTime(0),resStatus(HTTP_STATUS_NONE
) {}
241 Ip::Address hostAddr
; ///< ICAP server IP address
242 String serviceName
; ///< ICAP service name
243 String reqUri
; ///< ICAP Request-URI
244 Adaptation::Icap::ICAP::Method reqMethod
; ///< ICAP request method
245 int64_t bytesSent
; ///< number of bytes sent to ICAP server so far
246 int64_t bytesRead
; ///< number of bytes read from ICAP server so far
248 * number of ICAP body bytes read from ICAP server or -1 for no encapsulated
249 * message data in ICAP reply (eg 204 responses)
251 int64_t bodyBytesRead
;
252 HttpRequest
* request
; ///< ICAP request
253 HttpReply
* reply
; ///< ICAP reply
255 Adaptation::Icap::XactOutcome outcome
; ///< final transaction status
256 /** \brief Transaction response time.
257 * The timer starts when the ICAP transaction
258 * is created and stops when the result of the transaction is logged
261 /** \brief Transaction I/O time.
262 * The timer starts when the first ICAP request
263 * byte is scheduled for sending and stops when the lastbyte of the
264 * ICAP response is received.
267 http_status resStatus
; ///< ICAP response status code
268 int processingTime
; ///< total ICAP processing time in milliseconds
277 /* Should be in 'AccessLog.h' as the driver */
278 extern void accessLogLogTo(customlog
* log
, AccessLogEntry::Pointer
&al
, ACLChecklist
* checklist
= NULL
);
279 extern void accessLogLog(AccessLogEntry::Pointer
&, ACLChecklist
* checklist
);
280 extern void accessLogRotate(void);
281 extern void accessLogClose(void);
282 extern void accessLogInit(void);
283 extern const char *accessLogTime(time_t);
285 #endif /* SQUID_HTTPACCESSLOGENTRY_H */