#include <AccessLogEntry.h>

Inheritance diagram for AccessLogEntry:

Collaboration diagram for AccessLogEntry:

[legend]

Classes
class	AdaptationDetails
	This subclass holds general adaptation log info. TODO: Inner class declarations should be moved outside. More...

class	CacheDetails
	This subclass holds log info for Squid internal stats TODO: Inner class declarations should be moved outside TODO: some details relevant to particular protocols need shuffling to other sub-classes TODO: this object field need renaming to 'squid' or something. More...

class	Headers
	This subclass holds log info for various headers in raw format TODO: shuffle this to the relevant protocol section. More...

class	HtcpDetails
	This subclass holds log info for HTCP protocol TODO: Inner class declarations should be moved outside. More...

class	HttpDetails
	This subclass holds log info for HTTP protocol TODO: Inner class declarations should be moved outside TODO: details of HTTP held in the parent class need moving into here. More...

class	IcapLogEntry
	This subclass holds log info for ICAP part of request TODO: Inner class declarations should be moved outside. More...

class	IcpDetails
	This subclass holds log info for ICP protocol TODO: Inner class declarations should be moved outside. More...

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

Public Types
typedef RefCount< AccessLogEntry >	Pointer

Public Member Functions
	AccessLogEntry ()

virtual	~AccessLogEntry ()

virtual std::ostream &	detailCodeContext (std::ostream &os) const override
	appends human-friendly context description line(s) to a cache.log record More...

virtual ScopedId	codeContextGist () const override

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...

bool	hasLogMethod () const
	whether we know what the request method is More...

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

void	syncNotes (HttpRequest *request)

void	packReplyHeaders (MemBuf &mb) const
	dump all reply headers (for sending or risky logging) More...

const SBuf *	effectiveVirginUrl () const

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

const Error *	error () const

void	updateError (const Error &)
	sets (or updates the already stored) transaction error as needed More...

Static Public Member Functions
static const Pointer &	Current ()

static void	Reset ()
	forgets the current context, setting it to nil/unknown More...

static void	Reset (const Pointer)
	changes the current context; nil argument sets it to nil/unknown 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

HttpReplyPointer	reply

HttpRequest *	request = nullptr

HttpRequest *	adapted_request = nullptr

NotePairs::Pointer	notes

ProxyProtocol::HeaderPointer	proxyProtocolHeader
	see ConnStateData::proxyProtocolHeader_ More...

class AccessLogEntry::IcapLogEntry	icap

Static Private Member Functions
static void	ForgetCurrent ()

static void	Entering (const Pointer &codeCtx)

static void	Leaving ()

Private Attributes
Error	error_

SBuf	virginUrlForMissingRequest_

Detailed Description

Definition at line 40 of file AccessLogEntry.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<AccessLogEntry> AccessLogEntry::Pointer

Definition at line 44 of file AccessLogEntry.h.

Constructor & Destructor Documentation

◆ AccessLogEntry()

AccessLogEntry::AccessLogEntry ( )

Definition at line 101 of file AccessLogEntry.cc.

◆ ~AccessLogEntry()

AccessLogEntry::~AccessLogEntry ( )

virtual

Definition at line 103 of file AccessLogEntry.cc.

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

Member Function Documentation

◆ codeContextGist()

ScopedId AccessLogEntry::codeContextGist ( ) const

overridevirtual

Returns: a small, permanent ID of the current context gists persist forever and are suitable for passing to other SMP workers

Implements CodeContext.

Definition at line 124 of file AccessLogEntry.cc.

References HttpRequest::masterXaction, and request.

Referenced by htcpSpecifier::codeContextGist().

◆ Current()

const CodeContext::Pointer & CodeContext::Current ( )

staticinherited

Returns: the known global context or, to indicate unknown context, nil

Definition at line 33 of file CodeContext.cc.

References Instance().

Referenced by CallSubscription< Call_ >::callback(), CallBack(), CallContextCreator(), commStartHalfClosedMonitor(), CurrentCodeContextDetail(), HappyOrderEnforcer::enqueue(), CommQuotaQueue::enqueue(), StoreEntry::invokeHandlers(), CodeContext::Reset(), ScheduleCall(), tunnelDelayedClientRead(), and tunnelDelayedServerRead().

◆ detailCodeContext()

std::ostream & AccessLogEntry::detailCodeContext ( std::ostream & os ) const

overridevirtual

Implements CodeContext.

Definition at line 135 of file AccessLogEntry.cc.

References cache, AccessLogEntry::CacheDetails::caddr, effectiveVirginUrl(), Debug::Extra(), getLogMethod(), hasLogMethod(), SBuf::isEmpty(), Ip::Address::isNoAddr(), HttpRequest::masterXaction, request, tcpClient, and url.

Referenced by htcpSpecifier::detailCodeContext().

◆ 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 167 of file AccessLogEntry.cc.

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

Referenced by Format::Format::assemble(), and detailCodeContext().

◆ Entering()

void CodeContext::Entering ( const Pointer & codeCtx )

staticprivateinherited

Switches the current context to the given known context. Improves debugging output by replacing omni-directional "Reset" with directional "Entering".

Definition at line 54 of file CodeContext.cc.

References CodeContext::codeContextGist(), debugs, CodeContext::ForgetCurrent(), and Instance().

Referenced by CodeContext::Reset().

◆ error()

const Error * AccessLogEntry::error ( ) const

Returns: stored transaction error information (or nil)

Definition at line 179 of file AccessLogEntry.cc.

References HttpRequest::error, error_, and request.

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

◆ ForgetCurrent()

void CodeContext::ForgetCurrent ( )

staticprivateinherited

Forgets the current known context, possibly triggering its destruction. Preserves the gist of the being-forgotten context during its destruction. Knows nothing about the next context – the caller must set it.

Definition at line 42 of file CodeContext.cc.

References assert, FadingCodeContext::gist, and Instance().

Referenced by CodeContext::Entering(), and CodeContext::Leaving().

◆ getClientIdent()

const char * AccessLogEntry::getClientIdent ( ) const

Definition at line 78 of file AccessLogEntry.cc.

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

Referenced by 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 90 of file AccessLogEntry.cc.

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

Referenced by 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 19 of file AccessLogEntry.cc.

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