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/IpAddress.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
  52     const char *url;
  53
  54     class HttpDetails
  55     {
  56
  57     public:
  58         HttpDetails() : method(METHOD_NONE), code(0), content_type(NULL),
  59                 timedout(false), aborted(false) {}
  60
  61         HttpRequestMethod method;
  62         int code;
  63         const char *content_type;
  64         HttpVersion version;
  65         bool timedout; ///< terminated due to a lifetime or I/O timeout
  66         bool aborted; ///< other abnormal termination (e.g., I/O error)
  67
  68         /// compute suffix for the status access.log field
  69         const char *statusSfx() const {
  70             return timedout ? "_TIMEDOUT" : (aborted ? "_ABORTED" : "");
  71         }
  72     } http;
  73
  74     class ICPDetails
  75     {
  76
  77     public:
  78         ICPDetails() : opcode(ICP_INVALID) {}
  79
  80         icp_opcode opcode;
  81     } icp;
  82
  83     class HtcpDetails
  84     {
  85     public:
  86         HtcpDetails() : opcode(NULL) {};
  87
  88         const char *opcode;
  89     } htcp;
  90
  91     class CacheDetails
  92     {
  93
  94     public:
  95         CacheDetails() : caddr(),
  96                 requestSize(0),
  97                 replySize(0),
  98                 requestHeadersSize(0),
  99                 replyHeadersSize(0),
 100                 highOffset(0),
 101                 objectSize(0),
 102                 code (LOG_TAG_NONE),
 103                 msec(0),
 104                 rfc931 (NULL),
 105                 authuser (NULL),
 106                 extuser(NULL)
 107 #if USE_SSL
 108                 ,ssluser(NULL)
 109 #endif
 110         {;
 111         }
 112
 113         IpAddress caddr;
 114         int64_t requestSize;
 115         int64_t replySize;
 116         int requestHeadersSize; ///< received, including request line
 117         int replyHeadersSize; ///< sent, including status line
 118         int64_t highOffset;
 119         int64_t objectSize;
 120         log_type code;
 121         int msec;
 122         const char *rfc931;
 123         const char *authuser;
 124         const char *extuser;
 125 #if USE_SSL
 126
 127         const char *ssluser;
 128 #endif
 129
 130     } cache;
 131
 132     class Headers
 133     {
 134
 135     public:
 136         Headers() : request(NULL),
 137 #if ICAP_CLIENT
 138                 icap(NULL),
 139 #endif
 140                 reply(NULL) {}
 141
 142         char *request;
 143
 144 #if ICAP_CLIENT
 145         char * icap;    ///< last matching ICAP response header.
 146 #endif
 147         char *reply;
 148     } headers;
 149
 150     // Why is this a sub-class and not a set of real "private:" fields?
 151     // It looks like its duplicating HTTPRequestMethod anyway!
 152     class Private
 153     {
 154
 155     public:
 156         Private() : method_str(NULL) {}
 157
 158         const char *method_str;
 159     } _private;
 160     HierarchyLogEntry hier;
 161     HttpReply *reply;
 162     HttpRequest *request;
 163
 164 #if ICAP_CLIENT
 165     /** \brief This subclass holds log info for ICAP part of request
 166      *  \todo Inner class declarations should be moved outside
 167      */
 168     class IcapLogEntry
 169     {
 170     public:
 171         IcapLogEntry():request(NULL),reply(NULL),outcome(Adaptation::Icap::xoUnknown),trTime(0),ioTime(0),resStatus(HTTP_STATUS_NONE) {}
 172
 173         IpAddress hostAddr; ///< ICAP server IP address
 174         String serviceName;        ///< ICAP service name
 175         String reqUri;             ///< ICAP Request-URI
 176         Adaptation::Icap::ICAP::Method reqMethod; ///< ICAP request method
 177         int64_t bytesSent;       ///< number of bytes sent to ICAP server so far
 178         int64_t bytesRead;       ///< number of bytes read from ICAP server so far
 179         HttpRequest* request;    ///< ICAP request
 180         HttpReply* reply;        ///< ICAP reply
 181
 182         Adaptation::Icap::XactOutcome outcome; ///< final transaction status
 183         /** \brief Transaction response time.
 184          * The timer starts when the ICAP transaction
 185          *  is created and stops when the result of the transaction is logged
 186          */
 187         int trTime;
 188         /** \brief Transaction I/O time.
 189          * The timer starts when the first ICAP request
 190          * byte is scheduled for sending and stops when the lastbyte of the
 191          * ICAP response is received.
 192          */
 193         int ioTime;
 194         http_status resStatus;   ///< ICAP response status code
 195         int processingTime;      ///< total ICAP processing time in milliseconds
 196     }
 197     icap;
 198 #endif
 199 };
 200
 201 class ACLChecklist;
 202 class StoreEntry;
 203 class logformat_token;
 204
 205 /* Should be in 'AccessLog.h' as the driver */
 206 extern void accessLogLogTo(customlog* log, AccessLogEntry* al, ACLChecklist* checklist = NULL);
 207 extern void accessLogLog(AccessLogEntry *, ACLChecklist * checklist);
 208 extern void accessLogRotate(void);
 209 extern void accessLogClose(void);
 210 extern void accessLogInit(void);
 211 extern void accessLogFreeMemory(AccessLogEntry * aLogEntry);
 212 extern const char *accessLogTime(time_t);
 213 extern int accessLogParseLogFormat(logformat_token ** fmt, char *def);
 214 extern void accessLogDumpLogFormat(StoreEntry * entry, const char *name, logformat * definitions);
 215 extern void accessLogFreeLogFormat(logformat_token ** fmt);
 216
 217 #endif /* SQUID_HTTPACCESSLOGENTRY_H */