src/AccessLogEntry.h

   1 /*
   2  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   3  * ----------------------------------------------------------
   4  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  27  *
  28  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  29  */
  30 #ifndef SQUID_HTTPACCESSLOGENTRY_H
  31 #define SQUID_HTTPACCESSLOGENTRY_H
  32
  33 #include "anyp/PortCfg.h"
  34 #include "base/RefCount.h"
  35 #include "comm/Connection.h"
  36 #include "HierarchyLogEntry.h"
  37 #include "http/ProtocolVersion.h"
  38 #include "HttpHeader.h"
  39 #include "HttpRequestMethod.h"
  40 #include "icp_opcode.h"
  41 #include "ip/Address.h"
  42 #include "LogTags.h"
  43 #include "MessageSizes.h"
  44 #include "Notes.h"
  45 #if ICAP_CLIENT
  46 #include "adaptation/icap/Elements.h"
  47 #endif
  48 #if USE_SSL
  49 #include "ssl/gadgets.h"
  50 #endif
  51
  52 /* forward decls */
  53 class HttpReply;
  54 class HttpRequest;
  55 class CustomLog;
  56
  57 class AccessLogEntry: public RefCountable
  58 {
  59
  60 public:
  61     typedef RefCount<AccessLogEntry> Pointer;
  62
  63     AccessLogEntry() : url(NULL), tcpClient(), reply(NULL), request(NULL),
  64             adapted_request(NULL) {}
  65     ~AccessLogEntry();
  66
  67     /// Fetch the client IP log string into the given buffer.
  68     /// Knows about several alternate locations of the IP
  69     /// including indirect forwarded-for IP if configured to log that
  70     void getLogClientIp(char *buf, size_t bufsz) const;
  71
  72     const char *url;
  73
  74     /// TCP/IP level details about the client connection
  75     Comm::ConnectionPointer tcpClient;
  76     // TCP/IP level details about the server or peer connection
  77     // are stored in hier.tcpServer
  78
  79     /** \brief This subclass holds log info for HTTP protocol
  80      * \todo Inner class declarations should be moved outside
  81      * \todo details of HTTP held in the parent class need moving into here.
  82      */
  83     class HttpDetails
  84     {
  85
  86     public:
  87         HttpDetails() : method(Http::METHOD_NONE), code(0), content_type(NULL),
  88                 timedout(false),
  89                 aborted(false),
  90                 clientRequestSz(),
  91                 clientReplySz() {}
  92
  93         HttpRequestMethod method;
  94         int code;
  95         const char *content_type;
  96         Http::ProtocolVersion version;
  97         bool timedout; ///< terminated due to a lifetime or I/O timeout
  98         bool aborted; ///< other abnormal termination (e.g., I/O error)
  99
 100         /// compute suffix for the status access.log field
 101         const char *statusSfx() const {
 102             return timedout ? "_TIMEDOUT" : (aborted ? "_ABORTED" : "");
 103         }
 104
 105         /// counters for the original request received from client
 106         // TODO calculate header and payload better (by parser)
 107         // XXX payload encoding overheads not calculated at all yet.
 108         MessageSizes clientRequestSz;
 109
 110         /// counters for the response sent to client
 111         // TODO calculate header and payload better (by parser)
 112         // XXX payload encoding overheads not calculated at all yet.
 113         MessageSizes clientReplySz;
 114
 115     } http;
 116
 117     /** \brief This subclass holds log info for ICP protocol
 118      * \todo Inner class declarations should be moved outside
 119      */
 120     class IcpDetails
 121     {
 122
 123     public:
 124         IcpDetails() : opcode(ICP_INVALID) {}
 125
 126         icp_opcode opcode;
 127     } icp;
 128
 129     /** \brief This subclass holds log info for HTCP protocol
 130      * \todo Inner class declarations should be moved outside
 131      */
 132     class HtcpDetails
 133     {
 134     public:
 135         HtcpDetails() : opcode(NULL) {};
 136
 137         const char *opcode;
 138     } htcp;
 139
 140 #if USE_SSL
 141     /// logging information specific to the SSL protocol
 142     class SslDetails
 143     {
 144     public:
 145         SslDetails();
 146
 147         const char *user; ///< emailAddress from the SSL client certificate
 148         int bumpMode; ///< whether and how the request was SslBumped
 149     } ssl;
 150 #endif
 151
 152     /** \brief This subclass holds log info for Squid internal stats
 153      * \todo Inner class declarations should be moved outside
 154      * \todo some details relevant to particular protocols need shuffling to other sub-classes
 155      * \todo this object field need renaming to 'squid' or something.
 156      */
 157     class CacheDetails
 158     {
 159
 160     public:
 161         CacheDetails() : caddr(),
 162                 highOffset(0),
 163                 objectSize(0),
 164                 code (LOG_TAG_NONE),
 165                 msec(0),
 166                 rfc931 (NULL),
 167                 extuser(NULL),
 168 #if USE_SSL
 169                 ssluser(NULL),
 170 #endif
 171                 port(NULL) {
 172             ;
 173         }
 174
 175         Ip::Address caddr;
 176         int64_t highOffset;
 177         int64_t objectSize;
 178         LogTags code;
 179         int msec;
 180         const char *rfc931;
 181         const char *extuser;
 182 #if USE_SSL
 183
 184         const char *ssluser;
 185         Ssl::X509_Pointer sslClientCert; ///< cert received from the client
 186 #endif
 187         AnyP::PortCfg *port;
 188
 189     } cache;
 190
 191     /** \brief This subclass holds log info for various headers in raw format
 192      * \todo shuffle this to the relevant protocol section.
 193      */
 194     class Headers
 195     {
 196
 197     public:
 198         Headers() : request(NULL),
 199                 adapted_request(NULL),
 200                 reply(NULL) {}
 201
 202         char *request; //< virgin HTTP request headers
 203
 204         char *adapted_request; //< HTTP request headers after adaptation and redirection
 205
 206         char *reply;
 207     } headers;
 208
 209 #if USE_ADAPTATION
 210     /** \brief This subclass holds general adaptation log info.
 211      * \todo Inner class declarations should be moved outside.
 212      */
 213     class AdaptationDetails
 214     {
 215
 216     public:
 217         AdaptationDetails(): last_meta(NULL) {}
 218
 219         /// image of the last ICAP response header or eCAP meta received
 220         char *last_meta;
 221     } adapt;
 222 #endif
 223
 224     // Why is this a sub-class and not a set of real "private:" fields?
 225     // It looks like its duplicating HTTPRequestMethod anyway!
 226     // TODO: shuffle this to the relevant protocol section OR replace with request->method
 227     class Private
 228     {
 229
 230     public:
 231         Private() : method_str(NULL) {}
 232
 233         const char *method_str;
 234     } _private;
 235     HierarchyLogEntry hier;
 236     HttpReply *reply;
 237     HttpRequest *request; //< virgin HTTP request
 238     HttpRequest *adapted_request; //< HTTP request after adaptation and redirection
 239
 240     /// key:value pairs set by squid.conf note directive and
 241     /// key=value pairs returned from URL rewrite/redirect helper
 242     NotePairs::Pointer notes;
 243
 244 #if ICAP_CLIENT
 245     /** \brief This subclass holds log info for ICAP part of request
 246      *  \todo Inner class declarations should be moved outside
 247      */
 248     class IcapLogEntry
 249     {
 250     public:
 251         IcapLogEntry() : reqMethod(Adaptation::methodNone), bytesSent(0), bytesRead(0),
 252                 bodyBytesRead(-1), request(NULL), reply(NULL),
 253                 outcome(Adaptation::Icap::xoUnknown), trTime(0),
 254                 ioTime(0), resStatus(Http::scNone), processingTime(0) {}
 255
 256         Ip::Address hostAddr; ///< ICAP server IP address
 257         String serviceName;        ///< ICAP service name
 258         String reqUri;             ///< ICAP Request-URI
 259         Adaptation::Icap::ICAP::Method reqMethod; ///< ICAP request method
 260         int64_t bytesSent;       ///< number of bytes sent to ICAP server so far
 261         int64_t bytesRead;       ///< number of bytes read from ICAP server so far
 262         /**
 263          * number of ICAP body bytes read from ICAP server or -1 for no encapsulated
 264          * message data in ICAP reply (eg 204 responses)
 265          */
 266         int64_t bodyBytesRead;
 267         HttpRequest* request;    ///< ICAP request
 268         HttpReply* reply;        ///< ICAP reply
 269
 270         Adaptation::Icap::XactOutcome outcome; ///< final transaction status
 271         /** \brief Transaction response time.
 272          * The timer starts when the ICAP transaction
 273          *  is created and stops when the result of the transaction is logged
 274          */
 275         int trTime;
 276         /** \brief Transaction I/O time.
 277          * The timer starts when the first ICAP request
 278          * byte is scheduled for sending and stops when the lastbyte of the
 279          * ICAP response is received.
 280          */
 281         int ioTime;
 282         Http::StatusCode resStatus;   ///< ICAP response status code
 283         int processingTime;      ///< total ICAP processing time in milliseconds
 284     }
 285     icap;
 286 #endif
 287 };
 288
 289 class ACLChecklist;
 290 class StoreEntry;
 291
 292 /* Should be in 'AccessLog.h' as the driver */
 293 void accessLogLogTo(CustomLog* log, AccessLogEntry::Pointer &al, ACLChecklist* checklist = NULL);
 294 void accessLogLog(AccessLogEntry::Pointer &, ACLChecklist * checklist);
 295 void accessLogRotate(void);
 296 void accessLogClose(void);
 297 void accessLogInit(void);
 298 const char *accessLogTime(time_t);
 299
 300 #endif /* SQUID_HTTPACCESSLOGENTRY_H */