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 "base/RefCount.h"
35 #include "comm/Connection.h"
36 #include "HttpHeader.h"
37 #include "http/ProtocolVersion.h"
38 #include "HttpRequestMethod.h"
39 #include "HierarchyLogEntry.h"
40 #include "icp_opcode.h"
41 #include "ip/Address.h"
45 #include "adaptation/icap/Elements.h"
48 #include "ssl/gadgets.h"
56 class AccessLogEntry
: public RefCountable
60 typedef RefCount
<AccessLogEntry
> Pointer
;
62 AccessLogEntry() : url(NULL
), tcpClient(), reply(NULL
), request(NULL
),
63 adapted_request(NULL
) {}
66 /// Fetch the client IP log string into the given buffer.
67 /// Knows about several alternate locations of the IP
68 /// including indirect forwarded-for IP if configured to log that
69 void getLogClientIp(char *buf
, size_t bufsz
) const;
73 /// TCP/IP level details about the client connection
74 Comm::ConnectionPointer tcpClient
;
75 // TCP/IP level details about the server or peer connection
76 // are stored in hier.tcpServer
78 /** \brief This subclass holds log info for HTTP protocol
79 * \todo Inner class declarations should be moved outside
80 * \todo details of HTTP held in the parent class need moving into here.
86 HttpDetails() : method(Http::METHOD_NONE
), code(0), content_type(NULL
),
87 timedout(false), aborted(false) {}
89 HttpRequestMethod method
;
91 const char *content_type
;
92 Http::ProtocolVersion version
;
93 bool timedout
; ///< terminated due to a lifetime or I/O timeout
94 bool aborted
; ///< other abnormal termination (e.g., I/O error)
96 /// compute suffix for the status access.log field
97 const char *statusSfx() const {
98 return timedout
? "_TIMEDOUT" : (aborted
? "_ABORTED" : "");
102 /** \brief This subclass holds log info for ICP protocol
103 * \todo Inner class declarations should be moved outside
109 IcpDetails() : opcode(ICP_INVALID
) {}
114 /** \brief This subclass holds log info for HTCP protocol
115 * \todo Inner class declarations should be moved outside
120 HtcpDetails() : opcode(NULL
) {};
126 /// logging information specific to the SSL protocol
132 const char *user
; ///< emailAddress from the SSL client certificate
133 int bumpMode
; ///< whether and how the request was SslBumped
137 /** \brief This subclass holds log info for Squid internal stats
138 * \todo Inner class declarations should be moved outside
139 * \todo some details relevant to particular protocols need shuffling to other sub-classes
140 * \todo this object field need renaming to 'squid' or something.
146 CacheDetails() : caddr(),
149 requestHeadersSize(0),
167 int requestHeadersSize
; ///< received, including request line
168 int replyHeadersSize
; ///< sent, including status line
178 Ssl::X509_Pointer sslClientCert
; ///< cert received from the client
184 /** \brief This subclass holds log info for various headers in raw format
185 * \todo shuffle this to the relevant protocol section.
191 Headers() : request(NULL
),
192 adapted_request(NULL
),
195 char *request
; //< virgin HTTP request headers
197 char *adapted_request
; //< HTTP request headers after adaptation and redirection
203 /** \brief This subclass holds general adaptation log info.
204 * \todo Inner class declarations should be moved outside.
206 class AdaptationDetails
210 AdaptationDetails(): last_meta(NULL
) {}
212 /// image of the last ICAP response header or eCAP meta received
217 // Why is this a sub-class and not a set of real "private:" fields?
218 // It looks like its duplicating HTTPRequestMethod anyway!
219 // TODO: shuffle this to the relevant protocol section OR replace with request->method
224 Private() : method_str(NULL
) {}
226 const char *method_str
;
228 HierarchyLogEntry hier
;
230 HttpRequest
*request
; //< virgin HTTP request
231 HttpRequest
*adapted_request
; //< HTTP request after adaptation and redirection
233 /// key:value pairs set by squid.conf note directive and
234 /// key=value pairs returned from URL rewrite/redirect helper
235 NotePairs::Pointer notes
;
238 /** \brief This subclass holds log info for ICAP part of request
239 * \todo Inner class declarations should be moved outside
244 IcapLogEntry() : reqMethod(Adaptation::methodNone
), bytesSent(0), bytesRead(0),
245 bodyBytesRead(-1), request(NULL
), reply(NULL
),
246 outcome(Adaptation::Icap::xoUnknown
), trTime(0),
247 ioTime(0), resStatus(Http::scNone
), processingTime(0) {}
249 Ip::Address hostAddr
; ///< ICAP server IP address
250 String serviceName
; ///< ICAP service name
251 String reqUri
; ///< ICAP Request-URI
252 Adaptation::Icap::ICAP::Method reqMethod
; ///< ICAP request method
253 int64_t bytesSent
; ///< number of bytes sent to ICAP server so far
254 int64_t bytesRead
; ///< number of bytes read from ICAP server so far
256 * number of ICAP body bytes read from ICAP server or -1 for no encapsulated
257 * message data in ICAP reply (eg 204 responses)
259 int64_t bodyBytesRead
;
260 HttpRequest
* request
; ///< ICAP request
261 HttpReply
* reply
; ///< ICAP reply
263 Adaptation::Icap::XactOutcome outcome
; ///< final transaction status
264 /** \brief Transaction response time.
265 * The timer starts when the ICAP transaction
266 * is created and stops when the result of the transaction is logged
269 /** \brief Transaction I/O time.
270 * The timer starts when the first ICAP request
271 * byte is scheduled for sending and stops when the lastbyte of the
272 * ICAP response is received.
275 Http::StatusCode resStatus
; ///< ICAP response status code
276 int processingTime
; ///< total ICAP processing time in milliseconds
285 /* Should be in 'AccessLog.h' as the driver */
286 void accessLogLogTo(CustomLog
* log
, AccessLogEntry::Pointer
&al
, ACLChecklist
* checklist
= NULL
);
287 void accessLogLog(AccessLogEntry::Pointer
&, ACLChecklist
* checklist
);
288 void accessLogRotate(void);
289 void accessLogClose(void);
290 void accessLogInit(void);
291 const char *accessLogTime(time_t);
293 #endif /* SQUID_HTTPACCESSLOGENTRY_H */