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 "HttpVersion.h"
  34 #include "HttpRequestMethod.h"
  35 #include "HierarchyLogEntry.h"
  36 #include "ip/Address.h"
  37 #include "HttpRequestMethod.h"
  38 #if ICAP_CLIENT
  39 #include "adaptation/icap/Elements.h"
  40 #endif
  41
  42 /* forward decls */
  43 class HttpReply;
  44 class HttpRequest;
  45
  46 class AccessLogEntry
  47 {
  48
  49 public:
  50     AccessLogEntry() : url(NULL) , reply(NULL), request(NULL),
  51             adapted_request(NULL) {}
  52
  53     const char *url;
  54
  55     /** \brief This subclass holds log info for HTTP protocol
  56      * \todo Inner class declarations should be moved outside
  57      * \todo details of HTTP held in the parent class need moving into here.
  58      */
  59     class HttpDetails
  60     {
  61
  62     public:
  63         HttpDetails() : method(METHOD_NONE), code(0), content_type(NULL),
  64                 timedout(false), aborted(false) {}
  65
  66         HttpRequestMethod method;
  67         int code;
  68         const char *content_type;
  69         HttpVersion version;
  70         bool timedout; ///< terminated due to a lifetime or I/O timeout
  71         bool aborted; ///< other abnormal termination (e.g., I/O error)
  72
  73         /// compute suffix for the status access.log field
  74         const char *statusSfx() const {
  75             return timedout ? "_TIMEDOUT" : (aborted ? "_ABORTED" : "");
  76         }
  77     } http;
  78
  79     /** \brief This subclass holds log info for ICP protocol
  80      * \todo Inner class declarations should be moved outside
  81      */
  82     class IcpDetails
  83     {
  84
  85     public:
  86         IcpDetails() : opcode(ICP_INVALID) {}
  87
  88         icp_opcode opcode;
  89     } icp;
  90
  91     /** \brief This subclass holds log info for HTCP protocol
  92      * \todo Inner class declarations should be moved outside
  93      */
  94     class HtcpDetails
  95     {
  96     public:
  97         HtcpDetails() : opcode(NULL) {};
  98
  99         const char *opcode;
 100     } htcp;
 101
 102     /** \brief This subclass holds log info for Squid internal stats
 103      * \todo Inner class declarations should be moved outside
 104      * \todo some details relevant to particular protocols need shuffling to other sub-classes
 105      * \todo this object field need renaming to 'squid' or something.
 106      */
 107     class CacheDetails
 108     {
 109
 110     public:
 111         CacheDetails() : caddr(),
 112                 requestSize(0),
 113                 replySize(0),
 114                 requestHeadersSize(0),
 115                 replyHeadersSize(0),
 116                 highOffset(0),
 117                 objectSize(0),
 118                 code (LOG_TAG_NONE),
 119                 msec(0),
 120                 rfc931 (NULL),
 121                 authuser (NULL),
 122                 extuser(NULL)
 123 #if USE_SSL
 124                 ,ssluser(NULL)
 125 #endif
 126         {;
 127         }
 128
 129         Ip::Address caddr;
 130         int64_t requestSize;
 131         int64_t replySize;
 132         int requestHeadersSize; ///< received, including request line
 133         int replyHeadersSize; ///< sent, including status line
 134         int64_t highOffset;
 135         int64_t objectSize;
 136         log_type code;
 137         int msec;
 138         const char *rfc931;
 139         const char *authuser;
 140         const char *extuser;
 141 #if USE_SSL
 142
 143         const char *ssluser;
 144 #endif
 145
 146     } cache;
 147
 148     /** \brief This subclass holds log info for various headers in raw format
 149      * \todo shuffle this to the relevant protocol section.
 150      */
 151     class Headers
 152     {
 153
 154     public:
 155         Headers() : request(NULL),
 156                 adapted_request(NULL),
 157
 158 #if USE_ADAPTATION
 159                 adapt_last(NULL),
 160 #endif
 161                 reply(NULL) {}
 162
 163         char *request; //< virgin HTTP request headers
 164
 165         char *adapted_request; //< HTTP request headers after adaptation and redirection
 166
 167
 168 #if USE_ADAPTATION
 169
 170         char *adapt_last; ///< last ICAP response header or eCAP meta received
 171 #endif
 172         char *reply;
 173     } headers;
 174
 175     // Why is this a sub-class and not a set of real "private:" fields?
 176     // It looks like its duplicating HTTPRequestMethod anyway!
 177     // TODO: shuffle this to the relevant protocol section OR replace with request->method
 178     class Private
 179     {
 180
 181     public:
 182         Private() : method_str(NULL) {}
 183
 184         const char *method_str;
 185     } _private;
 186     HierarchyLogEntry hier;
 187     HttpReply *reply;
 188     HttpRequest *request; //< virgin HTTP request
 189     HttpRequest *adapted_request; //< HTTP request after adaptation and redirection
 190
 191
 192 #if ICAP_CLIENT
 193     /** \brief This subclass holds log info for ICAP part of request
 194      *  \todo Inner class declarations should be moved outside
 195      */
 196     class IcapLogEntry
 197     {
 198     public:
 199         IcapLogEntry():bodyBytesRead(-1),request(NULL),reply(NULL),outcome(Adaptation::Icap::xoUnknown),trTime(0),ioTime(0),resStatus(HTTP_STATUS_NONE) {}
 200
 201         Ip::Address hostAddr; ///< ICAP server IP address
 202         String serviceName;        ///< ICAP service name
 203         String reqUri;             ///< ICAP Request-URI
 204         Adaptation::Icap::ICAP::Method reqMethod; ///< ICAP request method
 205         int64_t bytesSent;       ///< number of bytes sent to ICAP server so far
 206         int64_t bytesRead;       ///< number of bytes read from ICAP server so far
 207         /**
 208          * number of ICAP body bytes read from ICAP server or -1 for no encapsulated
 209          * message data in ICAP reply (eg 204 responses)
 210          */
 211         int64_t bodyBytesRead;
 212         HttpRequest* request;    ///< ICAP request
 213         HttpReply* reply;        ///< ICAP reply
 214
 215         Adaptation::Icap::XactOutcome outcome; ///< final transaction status
 216         /** \brief Transaction response time.
 217          * The timer starts when the ICAP transaction
 218          *  is created and stops when the result of the transaction is logged
 219          */
 220         int trTime;
 221         /** \brief Transaction I/O time.
 222          * The timer starts when the first ICAP request
 223          * byte is scheduled for sending and stops when the lastbyte of the
 224          * ICAP response is received.
 225          */
 226         int ioTime;
 227         http_status resStatus;   ///< ICAP response status code
 228         int processingTime;      ///< total ICAP processing time in milliseconds
 229     }
 230     icap;
 231 #endif
 232 };
 233
 234 class ACLChecklist;
 235 class StoreEntry;
 236 class logformat_token;
 237
 238 /* Should be in 'AccessLog.h' as the driver */
 239 extern void accessLogLogTo(customlog* log, AccessLogEntry* al, ACLChecklist* checklist = NULL);
 240 extern void accessLogLog(AccessLogEntry *, ACLChecklist * checklist);
 241 extern void accessLogRotate(void);
 242 extern void accessLogClose(void);
 243 extern void accessLogInit(void);
 244 extern void accessLogFreeMemory(AccessLogEntry * aLogEntry);
 245 extern const char *accessLogTime(time_t);
 246 extern int accessLogParseLogFormat(logformat_token ** fmt, char *def);
 247 extern void accessLogDumpLogFormat(StoreEntry * entry, const char *name, logformat * definitions);
 248 extern void accessLogFreeLogFormat(logformat_token ** fmt);
 249
 250 #endif /* SQUID_HTTPACCESSLOGENTRY_H */