FormatSquidNative.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 46 Access Log - Squid format */
10 
11 #include "squid.h"
12 #include "AccessLogEntry.h"
13 #include "format/Quoting.h"
14 #include "format/Token.h"
15 #include "globals.h"
16 #include "HttpRequest.h"
17 #include "log/File.h"
18 #include "log/Formats.h"
19 #include "SquidConfig.h"
20 
21 void
23 {
24  char hierHost[MAX_IPSTRLEN];
25 
26  const char *user = nullptr;
27 
28 #if USE_AUTH
29  if (al->request && al->request->auth_user_request != nullptr)
31 #endif
32 
33  if (!user)
35 
36 #if USE_OPENSSL
37  if (!user)
39 #endif
40 
41  if (user && !*user)
42  safe_free(user);
43 
44  char clientip[MAX_IPSTRLEN];
45  al->getLogClientIp(clientip, MAX_IPSTRLEN);
46 
47  const SBuf method(al->getLogMethod());
48 
49  logfilePrintf(logfile, "%9ld.%03d %6ld %s %s/%03d %" PRId64 " " SQUIDSBUFPH " " SQUIDSBUFPH " %s %s%s/%s %s%s",
50  (long int) current_time.tv_sec,
51  (int) current_time.tv_usec / 1000,
52  tvToMsec(al->cache.trTime),
53  clientip,
54  al->cache.code.c_str(),
55  al->http.code,
57  SQUIDSBUFPRINT(method),
58  SQUIDSBUFPRINT(al->url),
59  user ? user : dash_str,
60  al->hier.ping.timedout ? "TIMEOUT_" : "",
61  hier_code_str[al->hier.code],
62  al->hier.tcpServer != nullptr ? al->hier.tcpServer->remote.toStr(hierHost, sizeof(hierHost)) : "-",
63  al->http.content_type,
64  (Config.onoff.log_mime_hdrs?"":"\n"));
65 
66  safe_free(user);
67 
69  char *ereq = ::Format::QuoteMimeBlob(al->headers.request);
70  MemBuf mb;
71  mb.init();
72  al->packReplyHeaders(mb);
73  auto erep = ::Format::QuoteMimeBlob(mb.content());
74  logfilePrintf(logfile, " [%s] [%s]\n", ereq, erep);
75  safe_free(ereq);
76  safe_free(erep);
77  }
78 }
79 
int log_mime_hdrs
Definition: SquidConfig.h:286
char * QuoteMimeBlob(const char *header)
Definition: Quoting.cc:43
void init(mb_size_t szInit, mb_size_t szMax)
Definition: MemBuf.cc:93
Definition: SBuf.h:93
struct SquidConfig::@97 onoff
Auth::UserRequest::Pointer auth_user_request
Definition: HttpRequest.h:127
HierarchyLogEntry hier
char * QuoteUrlEncodeUsername(const char *name)
Definition: Quoting.cc:31
struct timeval trTime
The response time.
char * toStr(char *buf, const unsigned int blen, int force=AF_UNSPEC) const
Definition: Address.cc:812
class AccessLogEntry::HttpDetails http
void logfilePrintf(Logfile *lf, const char *fmt,...)
Definition: File.cc:114
const char * c_str() const
compute the status access.log field
Definition: LogTags.cc:75
#define MAX_IPSTRLEN
Length of buffer that needs to be allocated to old a null-terminated IP-string.
Definition: forward.h:25
HttpRequest * request
struct timeval current_time
the current UNIX time in timeval {seconds, microseconds} format
Definition: gadgets.cc:18
#define SQUIDSBUFPRINT(s)
Definition: SBuf.h:32
const char * username() const
Definition: UserRequest.cc:32
void SquidNative(const AccessLogEntryPointer &al, Logfile *logfile)
Native Squid Format Display.
Definition: MemBuf.h:23
#define safe_free(x)
Definition: xalloc.h:73
Ip::Address remote
Definition: Connection.h:149
const char * dash_str
class AccessLogEntry::CacheDetails cache
class AccessLogEntry::Headers headers
Definition: File.h:38
uint64_t messageTotal() const
total message size
Definition: MessageSizes.h:27
Comm::ConnectionPointer tcpServer
TCP/IP level details of the last peer/server connection.
const char * hier_code_str[]
char * content()
start of the added data
Definition: MemBuf.h:41
MessageSizes clientReplySz
counters for the response sent to client
void getLogClientIp(char *buf, size_t bufsz) const
void packReplyHeaders(MemBuf &mb) const
dump all reply headers (for sending or risky logging)
#define PRId64
Definition: types.h:104
long int tvToMsec(struct timeval &t)
Definition: gadgets.h:93
const char * getExtUser() const
Fetch the external ACL provided 'user=' string, or nil if none is available.
SBuf getLogMethod() const
Fetch the transaction method string (ICP opcode, HTCP opcode or HTTP method)
#define SQUIDSBUFPH
Definition: SBuf.h:31
class SquidConfig Config
Definition: SquidConfig.cc:12
int timedout
Definition: PingData.h:42

 

Introduction

Documentation

Support

Miscellaneous