#include <AccessLogEntry.h>

Inheritance diagram for AccessLogEntry:

Collaboration diagram for AccessLogEntry:

Classes
class	AdaptationDetails
	This subclass holds general adaptation log info. More...

class	CacheDetails
	This subclass holds log info for Squid internal stats. More...

class	Headers
	This subclass holds log info for various headers in raw format. More...

class	HtcpDetails
	This subclass holds log info for HTCP protocol. More...

class	HttpDetails
	This subclass holds log info for HTTP protocol. More...

class	IcapLogEntry
	This subclass holds log info for ICAP part of request. More...

class	IcpDetails
	This subclass holds log info for ICP protocol. More...

class	SslDetails
	logging information specific to the SSL protocol More...

Public Types
typedef RefCount< AccessLogEntry >	Pointer

Public Member Functions
	AccessLogEntry ()

	~AccessLogEntry ()

void	getLogClientIp (char *buf, size_t bufsz) const

const char *	getClientIdent () const
	Fetch the client IDENT string, or nil if none is available. More...

const char *	getExtUser () const
	Fetch the external ACL provided 'user=' string, or nil if none is available. More...

SBuf	getLogMethod () const
	Fetch the transaction method string (ICP opcode, HTCP opcode or HTTP method) More...

void	syncNotes (HttpRequest *request)

const SBuf *	effectiveVirginUrl () const

void	setVirginUrlForMissingRequest (const SBuf &vu)
	Remember Client URI (or equivalent) when there is no HttpRequest. More...

Public Attributes
SBuf	url

Comm::ConnectionPointer	tcpClient
	TCP/IP level details about the client connection. More...

class AccessLogEntry::HttpDetails	http

class AccessLogEntry::IcpDetails	icp

class AccessLogEntry::HtcpDetails	htcp

class AccessLogEntry::SslDetails	ssl

class AccessLogEntry::CacheDetails	cache

class AccessLogEntry::Headers	headers

class AccessLogEntry::AdaptationDetails	adapt

const char *	lastAclName = nullptr
	string for external_acl_type ACL format code More...

SBuf	lastAclData
	string for external_acl_type DATA format code More...

HierarchyLogEntry	hier

HttpReply *	reply = nullptr

HttpRequest *	request = nullptr

HttpRequest *	adapted_request = nullptr

NotePairs::Pointer	notes

class AccessLogEntry::IcapLogEntry	icap

Private Attributes
SBuf	virginUrlForMissingRequest_

Detailed Description

Definition at line 38 of file AccessLogEntry.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<AccessLogEntry> AccessLogEntry::Pointer

Definition at line 42 of file AccessLogEntry.h.

Constructor & Destructor Documentation

◆ AccessLogEntry()

AccessLogEntry::AccessLogEntry ( )

inline

Definition at line 44 of file AccessLogEntry.h.

References buf, getClientIdent(), getExtUser(), getLogClientIp(), getLogMethod(), request, syncNotes(), and ~AccessLogEntry().

◆ ~AccessLogEntry()

AccessLogEntry::~AccessLogEntry ( )

Definition at line 97 of file AccessLogEntry.cc.

References adapt, AccessLogEntry::Headers::adapted_request, adapted_request, headers, HTTPMSGUNLOCK(), icap, AccessLogEntry::AdaptationDetails::last_meta, lastAclName, AccessLogEntry::Headers::reply, reply, AccessLogEntry::IcapLogEntry::reply, AccessLogEntry::Headers::request, request, AccessLogEntry::IcapLogEntry::request, and safe_free.

Referenced by AccessLogEntry().

Member Function Documentation

◆ effectiveVirginUrl()

const SBuf * AccessLogEntry::effectiveVirginUrl ( ) const

Effective URI of the received client (or equivalent) HTTP request or, in rare cases where that information was not collected, a nil pointer. Receiving errors are represented by "error:..." URIs. Adaptations and redirections do not affect this URI.

Definition at line 121 of file AccessLogEntry.cc.

References HttpRequest::effectiveRequestUri(), SBuf::isEmpty(), request, and virginUrlForMissingRequest_.

Referenced by Format::Format::assemble().

◆ getClientIdent()

const char * AccessLogEntry::getClientIdent ( ) const

Definition at line 74 of file AccessLogEntry.cc.

References cache, AccessLogEntry::CacheDetails::rfc931, Comm::Connection::rfc931, and tcpClient.

Referenced by AccessLogEntry(), Format::Format::assemble(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), Log::Format::SquidIcap(), and Log::Format::SquidNative().

◆ getExtUser()

const char * AccessLogEntry::getExtUser ( ) const

Definition at line 86 of file AccessLogEntry.cc.

References cache, HttpRequest::extacl_user, AccessLogEntry::CacheDetails::extuser, request, String::size(), and String::termedBuf().

Referenced by AccessLogEntry(), Format::Format::assemble(), Log::Format::SquidIcap(), and Log::Format::SquidNative().

◆ getLogClientIp()

void AccessLogEntry::getLogClientIp	(	char *	buf,
		size_t	bufsz
	)		const

Fetch the client IP log string into the given buffer. Knows about several alternate locations of the IP including indirect forwarded-for IP if configured to log that

Definition at line 17 of file AccessLogEntry.cc.

References SquidConfig::Addrs, Ip::Address::applyMask(), cache, AccessLogEntry::CacheDetails::caddr, SquidConfig::client_netmask, Config, HttpRequest::indirect_client_addr, Ip::Address::isIPv4(), Ip::Address::isLocalhost(), Ip::Address::isNoAddr(), SquidConfig::log_uses_indirect_client, SquidConfig::onoff, Comm::Connection::remote, request, tcpClient, and Ip::Address::toStr().