#include <HttpRequest.h>

Inheritance diagram for HttpRequest:

Collaboration diagram for HttpRequest:

Public Types
typedef RefCount< HttpRequest >	Pointer

enum	Sources { srcUnknown = 0, srcHttps = 1 << 0, srcFtps = 1 << 1, srcIcaps = 1 << 2, srcEcaps = 1 << 3, srcHttp = 1 << (16 + 0), srcFtp = 1 << (16 + 1), srcIcap = 1 << (16 + 2), srcEcap = 1 << (16 + 3), srcGopher = 1 << (16 + 14), srcWhois = 1 << (16 + 15), srcUnsafe = 0xFFFF0000, srcSafe = 0x0000FFFF }
	Who may have created or modified this message? More...

enum	ParseState { psReadyToParseStartLine = 0, psReadyToParseHeaders, psParsed, psError }
	parse state of HttpReply or HttpRequest More...

Public Member Functions
void *	operator new (size_t byteCount)

void	operator delete (void *address)

	HttpRequest (const MasterXaction::Pointer &)

	HttpRequest (const HttpRequestMethod &aMethod, AnyP::ProtocolType aProtocol, const char schemeImage, const char aUrlpath, const MasterXaction::Pointer &)

	~HttpRequest ()

virtual void	reset ()

void	initHTTP (const HttpRequestMethod &aMethod, AnyP::ProtocolType aProtocol, const char schemeImage, const char aUrlpath)

virtual HttpRequest *	clone () const

bool	maybeCacheable ()

bool	conditional () const
	has at least one recognized If-* header More...

bool	canHandle1xx () const
	whether the client is likely to be able to handle a 1xx reply More...

Adaptation::History::Pointer	adaptLogHistory () const
	Returns possibly nil history, creating it if adapt. logging is enabled. More...

Adaptation::History::Pointer	adaptHistory (bool createIfNone=false) const
	Returns possibly nil history, creating it if requested. More...

void	adaptHistoryImport (const HttpRequest &them)
	Makes their history ours, throwing on conflicts. More...

Adaptation::Icap::History::Pointer	icapHistory () const
	Returns possibly nil history, creating it if icap logging is enabled. More...

void	recordLookup (const Dns::LookupDetails &detail)

void	detailError (err_type aType, int aDetail)
	sets error detail if no earlier detail was available More...

void	clearError ()
	clear error details, useful for retries/repeats More...

void	manager (const CbcPointer< ConnStateData > &aMgr, const AccessLogEntryPointer &al)
	associates the request with a from-client connection manager More...

const SBuf &	effectiveRequestUri () const
	RFC 7230 section 5.5 - Effective Request URI. More...

bool	multipartRangeRequest () const

bool	parseFirstLine (const char start, const char end)

virtual bool	expectingBody (const HttpRequestMethod &unused, int64_t &) const

bool	bodyNibbled () const

int	prefixLen () const

void	swapOut (StoreEntry *e)

void	pack (Packable *p) const

ConnStateData *	pinnedConnection ()

const SBuf	storeId ()

void	ignoreRange (const char *reason)
	forgets about the cached Range header (for a reason) More...

int64_t	getRangeOffsetLimit ()

NotePairs::Pointer	notes ()

bool	hasNotes () const

void	packInto (Packable *, bool full_uri) const
	produce a message copy, except for a few connection-specific settings More...

void	setContentLength (int64_t)
	[re]sets Content-Length header and cached value More...

bool	persistent () const

void	putCc (const HttpHdrCc *otherCc)
	copies Cache-Control header to this message More...

bool	parse (const char buf, const size_t sz, bool eol, Http::StatusCode error)

bool	parseCharBuf (const char *buf, ssize_t end)

int	httpMsgParseStep (const char *buf, int len, int atEnd)

virtual int	httpMsgParseError ()

bool	parseHeader (Http1::Parser &)

void	firstLineBuf (MemBuf &)
	useful for debugging More...

Static Public Member Functions
static int	UseCount ()

static void	httpRequestPack (void obj, Packable p)

static HttpRequest *	FromUrl (const char *url, const MasterXaction::Pointer &, const HttpRequestMethod &method=Http::METHOD_GET)

Public Attributes
HttpRequestMethod	method

AnyP::Uri	url
	the request URI More...

Auth::UserRequest::Pointer	auth_user_request

String	store_id

RequestFlags	flags

HttpHdrRange *	range

time_t	ims

int	imslen

Ip::Address	client_addr

Ip::Address	indirect_client_addr

Ip::Address	my_addr

HierarchyLogEntry	hier

int	dnsWait
	sum of DNS lookup delays in milliseconds, for dt More...

err_type	errType

int	errDetail
	errType-specific detail about the transaction error More...

char *	peer_login

char *	peer_host

time_t	lastmod

SBuf	vary_headers
	The variant second-stage cache key. Generated from Vary header pattern for this request. More...

char *	peer_domain

String	myportname

String	tag

String	extacl_user

String	extacl_passwd

String	extacl_log

String	extacl_message

String	x_forwarded_for_iterator

String	etag
	A strong etag of the cached entry. Used for refreshing that entry. More...

bool	forcedBodyContinuation
	whether we have responded with HTTP 100 or FTP 150 already More...

CbcPointer< ConnStateData >	clientConnectionManager

CbcPointer< Downloader >	downloader
	The Downloader object which initiated the HTTP request if any. More...

MasterXaction::Pointer	masterXaction
	the master transaction this request belongs to. Never nil. More...

AnyP::ProtocolVersion	http_ver

HttpHeader	header

HttpHdrCc *	cache_control = nullptr

int	hdr_sz = 0

int64_t	content_length = 0

ParseState	pstate = Http::Message::psReadyToParseStartLine
	the current parsing state More...

BodyPipe::Pointer	body_pipe
	optional pipeline to receive message body More...

uint32_t	sources = 0
	The message sources. More...

Protected Member Functions
void	clean ()

void	init ()

virtual void	packFirstLineInto (Packable *p, bool full_uri) const

virtual bool	sanityCheckStartLine (const char buf, const size_t hdr_len, Http::StatusCode error)

virtual void	hdrCacheInit ()

virtual bool	inheritProperties (const Http::Message *)

Static Private Member Functions
static Mem::AllocatorProxy &	Pool ()

Private Attributes
Adaptation::History::Pointer	adaptHistory_
	per-HTTP transaction info More...

Adaptation::Icap::History::Pointer	icapHistory_
	per-HTTP transaction info More...

int64_t	rangeOffsetLimit

NotePairs::Pointer	theNotes

Detailed Description

Definition at line 47 of file HttpRequest.h.

Member Typedef Documentation

typedef RefCount<HttpRequest> HttpRequest::Pointer

Definition at line 49 of file HttpRequest.h.

Member Enumeration Documentation

enum Http::Message::ParseState

inherited

Enumerator
psReadyToParseStartLine
psReadyToParseHeaders
psParsed
psError

Definition at line 86 of file Message.h.

enum Http::Message::Sources

inherited

Enumerator
srcUnknown
srcHttps	https_port or bumped http_port tunnel; HTTPS server
srcFtps	ftps_port or SFTP server; currently unused
srcIcaps	Secure ICAP service.
srcEcaps	eCAP service that is considered secure; currently unused
srcHttp	http_port or HTTP server
srcFtp	ftp_port or FTP server
srcIcap	traditional ICAP service without encryption
srcEcap	eCAP service that uses insecure libraries/daemons
srcGopher	Gopher server.
srcWhois	Whois server.
srcUnsafe	Unsafe sources mask.
srcSafe	Safe sources mask.

Definition at line 28 of file Message.h.

Constructor & Destructor Documentation

HttpRequest::HttpRequest ( const MasterXaction::Pointer & mx )

Definition at line 41 of file HttpRequest.cc.

References assert, and init().

Referenced by clone(), and FromUrl().

HttpRequest::HttpRequest	(	const HttpRequestMethod &	aMethod,
		AnyP::ProtocolType	aProtocol,
		const char *	schemeImage,
		const char *	aUrlpath,
		const MasterXaction::Pointer &	mx
	)

Definition at line 49 of file HttpRequest.cc.

References assert, debugs, HERE(), init(), and initHTTP().

HttpRequest::~HttpRequest ( )

Definition at line 60 of file HttpRequest.cc.

References clean(), debugs, and HERE().

Member Function Documentation

Adaptation::History::Pointer HttpRequest::adaptHistory ( bool createIfNone = false ) const

Definition at line 413 of file HttpRequest.cc.

References adaptHistory_, debugs, and HERE().

Referenced by adaptLogHistory(), Format::Format::assemble(), inheritProperties(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Ecap::XactionRep::masterxSharedValue(), ACLAdaptationServiceStrategy::match(), Adaptation::Icap::ModXact::parseIcapHead(), Adaptation::Iterator::start(), Adaptation::Iterator::step(), Adaptation::Ecap::XactionRep::updateHistory(), Adaptation::Iterator::updatePlan(), and Ftp::Server::writeErrorReply().

void HttpRequest::adaptHistoryImport ( const HttpRequest & them )

Definition at line 430 of file HttpRequest.cc.

References adaptHistory_, and Must.

Adaptation::History::Pointer HttpRequest::adaptLogHistory ( ) const

Definition at line 424 of file HttpRequest.cc.

References adaptHistory(), and Log::TheConfig.

Referenced by Adaptation::Icap::ModXact::parseIcapHead(), prepareLogWithRequestDetails(), Adaptation::Ecap::XactionRep::start(), Adaptation::Ecap::XactionRep::swanSong(), and Adaptation::Ecap::XactionRep::updateHistory().

bool HttpRequest::bodyNibbled ( ) const

Definition at line 449 of file HttpRequest.cc.

References Http::Message::body_pipe, BodyPipe::consumedSize(), and NULL.

Referenced by FwdState::checkRetry(), and FwdState::reforward().

bool HttpRequest::canHandle1xx ( ) const

Definition at line 641 of file HttpRequest.cc.

References Http::EXPECT, HttpHeader::has(), Http::Message::header, Http::Message::http_ver, and Http::ProtocolVersion().

Referenced by HttpStateData::handle1xx().

void HttpRequest::clean ( )

protected

Definition at line 121 of file HttpRequest.cc.

References adaptHistory_, auth_user_request, Http::Message::body_pipe, Http::Message::cache_control, HttpHeader::clean(), String::clean(), AnyP::Uri::clear(), SBuf::clear(), etag, extacl_log, extacl_message, extacl_passwd, extacl_user, Http::Message::header, icapHistory_, myportname, NULL, range, tag, theNotes, url, and vary_headers.

Referenced by reset(), and ~HttpRequest().

void HttpRequest::clearError ( )

Definition at line 469 of file HttpRequest.cc.

References debugs, ERR_DETAIL_NONE, ERR_NONE, errDetail, errType, and HERE().

Referenced by Adaptation::Icap::ModXact::clearError(), FwdState::startConnectionOrFail(), and Adaptation::Iterator::step().

HttpRequest * HttpRequest::clone ( ) const

virtual

Implements Http::Message.

Definition at line 175 of file HttpRequest.cc.

References HttpHeader::append(), assert, Http::Message::body_pipe, errType, etag, extacl_log, extacl_message, Http::Message::hdr_sz, hdrCacheInit(), Http::Message::header, hier, Http::Message::http_ver, HttpRequest(), ims, imslen, inheritProperties(), lastmod, masterXaction, method, Http::Message::pstate, tag, url, and vary_headers.

Referenced by ClientRequestContext::clientRedirectDone().

bool HttpRequest::conditional ( ) const

Definition at line 578 of file HttpRequest.cc.

References flags, HttpHeader::has(), Http::Message::header, Http::IF_MATCH, Http::IF_NONE_MATCH, and RequestFlags::ims.

Referenced by clientReplyContext::cacheHit().

void HttpRequest::detailError	(	err_type	aType,
		int	aDetail
	)

Definition at line 455 of file HttpRequest.cc.

References debugs, errDetail, errType, and HERE().

Referenced by ErrorState::BuildHttpReply(), Adaptation::Icap::ModXact::detailError(), ClientHttpRequest::handleAdaptationBlock(), Client::handleAdaptationBlocked(), Client::handledEarlyAdaptationAbort(), ClientHttpRequest::noteBodyProducerAborted(), and ConnStateData::serveDelayedError().

const SBuf & HttpRequest::effectiveRequestUri ( ) const

Definition at line 672 of file HttpRequest.cc.

References AnyP::Uri::absolute(), AnyP::Uri::authority(), AnyP::Uri::getScheme(), HttpRequestMethod::id(), method, Http::METHOD_CONNECT, AnyP::PROTO_AUTHORITY_FORM, and url.

Referenced by Format::Format::assemble(), HttpStateData::buildRequestPrefix(), carpSelectParent(), ClientRequestContext::clientAccessCheckDone(), ClientRequestContext::clientRedirectDone(), ErrorState::Convert(), ClientHttpRequest::handleAdaptedHeader(), ClientRequestContext::hostHeaderVerifyFailed(), HttpStateData::httpBuildRequestHeader(), ACLUrlStrategy::match(), Client::maybePurgeOthers(), packFirstLineInto(), clientReplyContext::purgeAllCached(), clientReplyContext::purgeDoPurgeHead(), refreshCheck(), Ssl::ServerBump::ServerBump(), storeId(), PeerSelector::url(), urlCanonicalClean(), and Ftp::UrlWith2f().

bool HttpRequest::expectingBody	(	const HttpRequestMethod &	unused,
		int64_t &	theSize
	)		const

virtual

Implements Http::Message.

Definition at line 493 of file HttpRequest.cc.

References HttpHeader::chunked(), Http::Message::content_length, and Http::Message::header.

void Http::Message::firstLineBuf ( MemBuf & mb )

inherited

Definition at line 291 of file Message.cc.

HttpRequest * HttpRequest::FromUrl	(	const char *	url,
		const MasterXaction::Pointer &	mx,
		const HttpRequestMethod &	method = `Http::METHOD_GET`
	)

static

int64_t HttpRequest::getRangeOffsetLimit ( )

Definition at line 600 of file HttpRequest.cc.

References allow_t::allowed(), client_addr, Config, debugs, ACLChecklist::fastCheck(), HERE(), ACLFilledChecklist::my_addr, my_addr, NULL, rangeOffsetLimit, SquidConfig::rangeOffsetLimit, and ACLFilledChecklist::src_addr.

Referenced by Http::Stream::buildRangeHeader(), CheckQuickAbortIsReasonable(), and HttpStateData::decideIfWeDoRanges().

bool HttpRequest::hasNotes ( ) const

inline

Definition at line 233 of file HttpRequest.h.

References NotePairs::empty(), and theNotes.

Referenced by Http::One::Server::buildHttpRequest().

void HttpRequest::hdrCacheInit ( )

protectedvirtual

Reimplemented from Http::Message.

Definition at line 388 of file HttpRequest.cc.

References assert, HttpHeader::getRange(), Http::Message::hdrCacheInit(), Http::Message::header, and range.

Referenced by clone().

int Http::Message::httpMsgParseError ( )

virtualinherited

Reimplemented in HttpReply.

Definition at line 242 of file Message.cc.

Referenced by HttpReply::httpMsgParseError().

int Http::Message::httpMsgParseStep	(	const char *	buf,
		int	len,
		int	atEnd
	)

inherited

parses a 0-terminated buffer into Http::Message.

Return values

1	success
0	need more data (partial parse)
-1	parse error

Definition at line 169 of file Message.cc.

References assert, buf, httpMsgIsolateStart(), len, PROF_start, PROF_stop, Http::Message::psParsed, Http::Message::psReadyToParseHeaders, and Http::Message::psReadyToParseStartLine.

Referenced by MemStore::copyFromShmSlice().

static void HttpRequest::httpRequestPack	(	void *	obj,
		Packable *	p
	)

static

Adaptation::Icap::History::Pointer HttpRequest::icapHistory ( ) const

Definition at line 398 of file HttpRequest.cc.

References debugs, HERE(), icapHistory_, IcapLogfileStatus, LOG_ENABLE, and Log::TheConfig.

Referenced by Adaptation::AccessCheck::AccessCheck(), ClientHttpRequest::doCallouts(), Adaptation::Icap::ModXact::finalizeLogInfo(), inheritProperties(), ClientHttpRequest::noteAdaptationAclCheckDone(), prepareLogWithRequestDetails(), and Adaptation::Icap::ModXactLauncher::updateHistory().

void HttpRequest::ignoreRange ( const char * reason )

Definition at line 627 of file HttpRequest.cc.

References debugs, NULL, and range.

Referenced by clientInterpretRequestHeaders(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::setReplyToError(), clientReplyContext::setReplyToReply(), and clientReplyContext::setReplyToStoreEntry().

bool HttpRequest::inheritProperties ( const Http::Message * aMsg )

protectedvirtual

Implements Http::Message.

Definition at line 214 of file HttpRequest.cc.

References adaptHistory(), adaptHistory_, auth_user_request, client_addr, clientConnectionManager, RequestFlags::cloneAdaptationImmune(), dnsWait, downloader, errDetail, errType, extacl_passwd, extacl_user, flags, forcedBodyContinuation, icapHistory(), icapHistory_, indirect_client_addr, my_addr, myportname, Http::Message::sources, and theNotes.

Referenced by clone().

void HttpRequest::init ( void )

protected

Definition at line 75 of file HttpRequest.cc.

References adaptHistory_, auth_user_request, Http::Message::body_pipe, AnyP::Uri::clear(), client_addr, dnsWait, ERR_DETAIL_NONE, ERR_NONE, errDetail, errType, extacl_log, extacl_message, extacl_passwd, extacl_user, flags, forcedBodyContinuation, icapHistory_, ims, imslen, indirect_client_addr, lastmod, method, Http::METHOD_NONE, my_addr, myportname, NULL, null_string, peer_domain, peer_host, peer_login, Http::Message::psReadyToParseStartLine, Http::Message::pstate, range, rangeOffsetLimit, Ip::Address::setEmpty(), tag, url, and vary_headers.

Referenced by HttpRequest(), and reset().

void HttpRequest::initHTTP	(	const HttpRequestMethod &	aMethod,
		AnyP::ProtocolType	aProtocol,
		const char *	schemeImage,
		const char *	aUrlpath
	)

Definition at line 67 of file HttpRequest.cc.

References method, AnyP::Uri::path(), AnyP::Uri::setScheme(), and url.

Referenced by HttpRequest().

void HttpRequest::manager	(	const CbcPointer< ConnStateData > &	aMgr,
		const AccessLogEntryPointer &	al
	)

bool HttpRequest::maybeCacheable ( )

Whether response to this request is potentially cachable

Return values

false	Not cacheable.
true	Possibly cacheable. Response factors will determine.

Are responses to this request possible cacheable ? If false then no matter what the response must not be cached.

Definition at line 537 of file HttpRequest.cc.

References Http::Message::cache_control, flags, AnyP::Uri::getScheme(), gopherCachable(), HttpHdrCc::hasNoStore(), RequestFlags::hostVerified, RequestFlags::ignoreCc, RequestFlags::intercepted, RequestFlags::interceptTproxy, method, AnyP::PROTO_CACHE_OBJECT, AnyP::PROTO_GOPHER, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, HttpRequestMethod::respMaybeCacheable(), and url.

Referenced by clientInterpretRequestHeaders().

bool HttpRequest::multipartRangeRequest ( ) const

Definition at line 443 of file HttpRequest.cc.

References range, and HttpHdrRange::specs.

Referenced by clientReplyContext::buildReplyHeader(), HttpStateData::httpBuildRequestHeader(), and ClientHttpRequest::multipartRangeRequest().

NotePairs::Pointer HttpRequest::notes ( )

Returns: existing non-empty transaction annotations, creates and returns empty annotations otherwise

Definition at line 680 of file HttpRequest.cc.

References theNotes.

Referenced by Http::One::Server::buildHttpRequest(), ClientHttpRequest::doCallouts(), ClientHttpRequest::logRequest(), AccessLogEntry::syncNotes(), and UpdateRequestNotes().

void HttpRequest::operator delete ( void * address )

inline

Definition at line 49 of file HttpRequest.h.

void* HttpRequest::operator new ( size_t byteCount )

inline

Definition at line 49 of file HttpRequest.h.

void HttpRequest::pack ( Packable * p ) const

Definition at line 353 of file HttpRequest.cc.

References Packable::append(), Packable::appendf(), assert, Http::Message::header, Http::Message::http_ver, HttpRequestMethod::image(), AnyP::ProtocolVersion::major, method, AnyP::ProtocolVersion::minor, HttpHeader::packInto(), AnyP::Uri::path(), SQUIDSBUFPH, SQUIDSBUFPRINT, and url.

Referenced by Ftp::Server::handleRequest(), httpRequestPack(), and swapOut().

void HttpRequest::packFirstLineInto	(	Packable *	p,
		bool	full_uri
	)		const

protectedvirtual

Implements Http::Message.

Definition at line 477 of file HttpRequest.cc.

References Packable::appendf(), effectiveRequestUri(), Http::Message::http_ver, HttpRequestMethod::image(), AnyP::ProtocolVersion::major, method, AnyP::ProtocolVersion::minor, AnyP::Uri::path(), SQUIDSBUFPH, SQUIDSBUFPRINT, and url.

void Http::Message::packInto	(	Packable *	p,
		bool	full_uri
	)		const

inherited

Definition at line 274 of file Message.cc.

References Packable::append().

Referenced by Adaptation::Icap::ModXact::packHead().

bool Http::Message::parse	(	const char *	buf,
		const size_t	sz,
		bool	eol,
		Http::StatusCode *	error
	)

inherited

Definition at line 79 of file Message.cc.

References assert, Config, DBG_IMPORTANT, debugs, headersEnd(), int, SquidConfig::maxReplyHeaderSize, Http::scHeaderTooLarge, Http::scInvalidHeader, and Http::scNone.

Referenced by TunnelStateData::handleConnectResponse(), and Adaptation::Icap::Xaction::parseHttpMsg().

bool Http::Message::parseCharBuf	(	const char *	buf,
		ssize_t	end
	)

inherited

parseCharBuf() takes character buffer of HTTP headers (buf), which may not be NULL-terminated, and fills in an Http::Message structure. The parameter 'end' specifies the offset to the end of the reply headers. The caller may know where the end is, but is unable to NULL-terminate the buffer. This function returns true on success.

Definition at line 147 of file Message.cc.

References MemBuf::append(), MemBuf::buf, MemBuf::clean(), MemBuf::init(), MemBuf::size, and MemBuf::terminate().

Referenced by store_client::readBody(), and urnHandleReply().

bool HttpRequest::parseFirstLine	(	const char *	start,
		const char *	end
	)

virtual

Implements Http::Message.

Definition at line 295 of file HttpRequest.cc.

References DBG_IMPORTANT, debugs, findTrailingHTTPVersion(), Http::Message::http_ver, HttpRequestMethod::HttpRequestMethodXXX(), AnyP::ProtocolVersion::major, method, Http::METHOD_NONE, AnyP::ProtocolVersion::minor, AnyP::Uri::parse(), url, w_space, and xisspace.

bool Http::Message::parseHeader ( Http1::Parser & hp )

inherited

Definition at line 223 of file Message.cc.

References SBuf::c_str(), Http::One::Parser::headerBlockSize(), Http::One::Parser::messageHeaderSize(), Http::One::Parser::mimeHeader(), Http::Message::psError, and Http::Message::psParsed.

Referenced by Http::One::Server::buildHttpRequest(), and HttpStateData::processReplyHeader().

bool Http::Message::persistent ( ) const

inherited

Return values

true	the message sender asks to keep the connection open.
false	the message sender will close the connection.

Factors other than the headers may result in connection closure.

Definition at line 257 of file Message.cc.

References httpHeaderHasConnDir(), and Http::ProtocolVersion().

Referenced by clientReplyContext::buildReplyHeader(), clientSetKeepaliveFlag(), HttpReply::hdrCacheInit(), and HttpStateData::sendRequest().

ConnStateData * HttpRequest::pinnedConnection ( )

Definition at line 653 of file HttpRequest.cc.

References clientConnectionManager, CbcPointer< Cbc >::get(), NULL, ConnStateData::pinned, ConnStateData::pinning, and CbcPointer< Cbc >::valid().

Referenced by borrowPinnedConnection(), clientReplyContext::buildReplyHeader(), clientCheckPinning(), FwdState::connectStart(), FwdState::fail(), and PeerSelector::selectPinned().

static Mem::AllocatorProxy& HttpRequest::Pool ( )

inlinestaticprivate

Definition at line 49 of file HttpRequest.h.

int HttpRequest::prefixLen ( ) const

Definition at line 378 of file HttpRequest.cc.

References Http::Message::header, HttpRequestMethod::image(), HttpHeader::len, SBuf::length(), method, AnyP::Uri::path(), and url.

Referenced by peerDigestFetchSetStats(), and clientReplyContext::traceReply().

void Http::Message::putCc ( const HttpHdrCc * otherCc )

inherited

Definition at line 33 of file Message.cc.

References Http::CACHE_CONTROL.

Referenced by HttpReply::make304().

void HttpRequest::recordLookup ( const Dns::LookupDetails & detail )

Definition at line 586 of file HttpRequest.cc.

References debugs, dnsWait, and Dns::LookupDetails::wait.

Referenced by ClientRequestContext::hostHeaderIpVerify(), SourceDomainLookup::LookupDone(), DestinationDomainLookup::LookupDone(), and PeerSelector::noteLookup().

void HttpRequest::reset ( )

virtual

Implements Http::Message.

Definition at line 168 of file HttpRequest.cc.

References clean(), and init().

bool HttpRequest::sanityCheckStartLine	(	const char *	buf,
		const size_t	hdr_len,
		Http::StatusCode *	error
	)

protectedvirtual

Checks the first line of an HTTP request is valid currently just checks the request method is present.

NP: Other errors are left for detection later in the parse.

Implements Http::Message.

Definition at line 269 of file HttpRequest.cc.

References debugs, HERE(), HttpRequestMethod::HttpRequestMethodXXX(), Http::METHOD_NONE, and Http::scInvalidHeader.

Referenced by PrivateHttpRequest::doSanityCheckStartLine().

void Http::Message::setContentLength ( int64_t clen )

inherited

Definition at line 249 of file Message.cc.

References Http::CONTENT_LENGTH.

const SBuf HttpRequest::storeId ( )

Returns the current StoreID for the request as a nul-terminated char*. Always returns the current id for the request (either the effective request URI or modified ID by the helper).

Definition at line 661 of file HttpRequest.cc.

References debugs, effectiveRequestUri(), String::size(), store_id, and StringToSBuf().

Referenced by clientReplyContext::cacheHit(), ClientHttpRequest::doCallouts(), storeKeyPublicByRequestMethod(), and storeSwapMetaBuild().

void HttpRequest::swapOut ( StoreEntry * e )

Definition at line 343 of file HttpRequest.cc.

References assert, StoreEntry::buffer(), StoreEntry::flush(), and pack().

Referenced by clientReplyContext::traceReply().

static int HttpRequest::UseCount ( )

inlinestatic

Definition at line 49 of file HttpRequest.h.

Member Data Documentation

Adaptation::History::Pointer HttpRequest::adaptHistory_

mutableprivate

Definition at line 107 of file HttpRequest.h.

Referenced by adaptHistory(), adaptHistoryImport(), clean(), inheritProperties(), and init().

Auth::UserRequest::Pointer HttpRequest::auth_user_request

Definition at line 115 of file HttpRequest.h.

Referenced by Format::Format::assemble(), Auth::UserRequest::authenticate(), AuthenticateAcl(), authTryGetUser(), ConnStateData::buildFakeRequest(), clientReplyContext::buildReplyHeader(), ClientHttpRequest::calloutsError(), clean(), ClientRequestContext::clientAccessCheckDone(), clientProcessRequest(), constructHelperQuery(), ErrorState::Convert(), DelayId::DelayClient(), Auth::UserRequest::helperRequestKeyExtras(), ClientRequestContext::hostHeaderVerifyFailed(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), httpFixupAuthentication(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeUsernameHeader(), peerUserHashSelectParent(), Log::Format::SquidIcap(), Log::Format::SquidNative(), ClientHttpRequest::sslBumpEstablish(), statClientRequests(), Auth::UserRequest::tryToAuthenticateAndSetAuthUser(), and Adaptation::Ecap::XactionRep::usernameValue().

BodyPipe::Pointer Http::Message::body_pipe

inherited

HttpHdrCc* Http::Message::cache_control = nullptr

inherited

Definition at line 76 of file Message.h.

Referenced by clean(), clientInterpretRequestHeaders(), MimeIcon::created(), HttpReply::hdrCacheClean(), HttpReply::hdrExpirationTime(), HttpReply::make304(), maybeCacheable(), ClientHttpRequest::onlyIfCached(), refreshCheck(), and HttpStateData::reusableReply().

CbcPointer<ConnStateData> HttpRequest::clientConnectionManager

The client connection manager, if known; Used for any response actions needed directly to the client. ie 1xx forwarding or connection pinning state changes

Definition at line 218 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clientCheckPinning(), FwdState::completed(), FwdState::connectedToPeer(), copyResultsFromEntry(), FwdState::dispatch(), HttpStateData::handle1xx(), inheritProperties(), manager(), pinnedConnection(), clientReplyContext::processExpired(), clientReplyContext::processMiss(), HttpStateData::processReplyBody(), PeerSelector::resolveSelected(), ACLFilledChecklist::setRequest(), and switchToTunnel().

int HttpRequest::dnsWait

Definition at line 147 of file HttpRequest.h.

Referenced by Format::Format::assemble(), inheritProperties(), init(), prepareLogWithRequestDetails(), and recordLookup().

CbcPointer<Downloader> HttpRequest::downloader

Definition at line 221 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), and inheritProperties().

int HttpRequest::errDetail

Definition at line 150 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clearError(), detailError(), inheritProperties(), init(), prepareLogWithRequestDetails(), ConnStateData::serveDelayedError(), and Ftp::Server::writeErrorReply().

err_type HttpRequest::errType

Definition at line 149 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clearError(), clone(), detailError(), inheritProperties(), init(), ACLSquidErrorStrategy::match(), prepareLogWithRequestDetails(), ConnStateData::serveDelayedError(), ClientHttpRequest::updateCounters(), Ftp::Server::writeErrorReply(), and ClientHttpRequest::~ClientHttpRequest().

String HttpRequest::etag

Definition at line 180 of file HttpRequest.h.

Referenced by clean(), clone(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::processExpired(), clientReplyContext::restoreState(), and clientReplyContext::saveState().

String HttpRequest::extacl_log

Definition at line 171 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), clone(), copyResultsFromEntry(), and init().

String HttpRequest::extacl_message

Definition at line 173 of file HttpRequest.h.

Referenced by clean(), clone(), ErrorState::Convert(), copyResultsFromEntry(), and init().

String HttpRequest::extacl_passwd

Definition at line 169 of file HttpRequest.h.

Referenced by clean(), copyResultsFromEntry(), httpFixupAuthentication(), inheritProperties(), init(), and Adaptation::Icap::ModXact::makeRequestHeaders().

String HttpRequest::extacl_user

Definition at line 167 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), copyResultsFromEntry(), AccessLogEntry::getExtUser(), httpFixupAuthentication(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeRequestHeaders(), Adaptation::Icap::ModXact::makeUsernameHeader(), ACLExtUser::match(), prepareLogWithRequestDetails(), statClientRequests(), and Adaptation::Ecap::XactionRep::usernameValue().

RequestFlags HttpRequest::flags

Definition at line 129 of file HttpRequest.h.

bool HttpRequest::forcedBodyContinuation

Definition at line 183 of file HttpRequest.h.

Referenced by HttpStateData::handle1xx(), Ftp::Server::handleUploadRequest(), inheritProperties(), init(), and Http::One::Server::processParsedRequest().

int Http::Message::hdr_sz = 0

inherited

Definition at line 81 of file Message.h.

Referenced by StoreEntry::append(), CheckQuickAbortIsReasonable(), clone(), HttpReply::clone(), StoreEntry::contentLen(), MemObject::expectedReplySize(), Adaptation::Icap::ModXact::finalizeLogInfo(), TunnelStateData::handleConnectResponse(), MemObject::markEndOfReplyHeaders(), Adaptation::Icap::Xaction::parseHttpMsg(), clientReplyContext::processReplyAccess(), clientReplyContext::processReplyAccessResult(), MemObject::readAheadPolicyCanRead(), store_client::readBody(), MemStore::updateHeadersOrThrow(), and StoreEntry::validLength().

HttpHeader Http::Message::header

inherited

Definition at line 74 of file Message.h.

Referenced by StoreEntry::adjustVary(), Ftp::Gateway::appendSuccessHeader(), Format::Format::assemble(), assembleVaryKey(), Auth::UserRequest::authenticate(), ConnStateData::buildFakeRequest(), ErrorState::BuildHttpReply(), Http::One::Server::buildHttpRequest(), Http::Stream::buildRangeHeader(), clientReplyContext::buildReplyHeader(), Downloader::buildRequest(), ESIVarState::buildVary(), canHandle1xx(), htcpSpecifier::checkHit(), clean(), HttpReply::clean(), ClientRequestContext::clientAccessCheck(), clientBeginRequest(), clientCheckPinning(), clientGetMoreData(), clientIfRangeMatch(), clientInterpretRequestHeaders(), clientIsContentLengthValid(), clientProcessRequest(), clone(), HttpReply::clone(), Adaptation::Ecap::MessageRep::clone(), conditional(), Adaptation::Icap::Options::configure(), ErrorState::Convert(), MimeIcon::created(), Ftp::Relay::createHttpReply(), ErrorState::Dump(), Adaptation::Icap::ModXact::encapsulateHead(), ESIContextNew(), Adaptation::Icap::ModXact::estimateVirginBody(), HttpReply::expectingBody(), expectingBody(), Mgr::Action::fillEntry(), Adaptation::Icap::ModXact::finalizeLogInfo(), Ftp::Gateway::ftpAuthRequired(), ftpSendStor(), Ssl::ErrorDetailsManager::getErrorDetail(), Ftp::Server::handleFeatReply(), Ftp::Server::handleRequest(), StoreEntry::hasIfMatchEtag(), StoreEntry::hasIfNoneMatchEtag(), StoreEntry::hasOneOfEtags(), HttpReply::hdrCacheInit(), hdrCacheInit(), HttpReply::hdrExpirationTime(), ClientRequestContext::hostHeaderVerify(), ClientRequestContext::hostHeaderVerifyFailed(), htcpClrStore(), HttpStateData::httpBuildRequestHeader(), Log::Format::HttpdCombined(), httpMakeVaryMark(), Ftp::HttpReplyWrapper(), TemplateFile::loadFor(), Ftp::Gateway::loginFailed(), HttpReply::make304(), Adaptation::Icap::ModXact::makeRequestHeaders(), ACLHTTPReqHeaderStrategy::match(), ACLHTTPRepHeaderStrategy::match(), ACLRequestHeaderStrategy< header >::match(), ACLReplyHeaderStrategy< header >::match(), pack(), HttpReply::packHeadersInto(), CacheManager::ParseHeaders(), Ftp::Server::parseOneRequest(), Adaptation::Icap::OptXact::parseResponse(), peerDigestRequest(), prefixLen(), prepareLogWithRequestDetails(), Adaptation::Icap::ModXact::prepEchoing(), Ftp::PrintReply(), clientReplyContext::processConditional(), clientReplyContext::processExpired(), Http::One::Server::processParsedRequest(), HttpStateData::processReplyHeader(), purgeEntriesByHeader(), HttpReply::redirect(), HttpReply::removeStaleWarnings(), HttpStateData::reusableReply(), Ftp::Server::setDataCommand(), HttpReply::setHeaders(), UrnState::setUriResFromRequest(), Log::Format::SquidReferer(), Log::Format::SquidUserAgent(), Mgr::Inquirer::start(), CacheManager::Start(), HttpStateData::statusIfComplete(), StoreEntry::timestampsSet(), HttpReply::updateOnNotModified(), urlCheckRequest(), Adaptation::Ecap::XactionRep::useAdapted(), Adaptation::Ecap::XactionRep::useVirgin(), HttpReply::validatorsMatch(), varyEvaluateMatch(), Http::One::Server::writeControlMsgAndCall(), Ftp::Server::writeCustomReply(), Ftp::Server::writeErrorReply(), Ftp::Server::writeForwardedReply(), and Ftp::Server::writeForwardedReplyAndCall().

HierarchyLogEntry HttpRequest::hier

Definition at line 145 of file HttpRequest.h.

Referenced by Client::adjustBodyBytesRead(), clone(), StoreEntry::complete(), FwdState::completed(), FwdState::connectStart(), ErrorState::Convert(), ErrorState::Dump(), gopherReadReply(), TunnelStateData::handleConnectResponse(), PeerSelector::handlePath(), ACLHierCodeStrategy::match(), neighborsDigestSelect(), peerNoteDigestLookup(), peerSelect(), prepareLogWithRequestDetails(), HttpStateData::processReplyHeader(), TunnelStateData::readConnectResponseDone(), HttpStateData::readReply(), TunnelStateData::readServer(), PeerSelector::resolveSelected(), FwdState::retryOrBail(), TunnelStateData::sendError(), clientReplyContext::sendMoreData(), Client::sentRequestBody(), ConnStateData::serveDelayedError(), Client::serverComplete(), TunnelStateData::startConnecting(), switchToTunnel(), FwdState::syncHierNote(), StoreEntry::timestampsSet(), tunnelConnectDone(), tunnelConnectReqWriteDone(), tunnelServerClosed(), ClientHttpRequest::updateCounters(), TunnelStateData::writeServerDone(), and HttpStateData::wroteLast().

AnyP::ProtocolVersion Http::Message::http_ver

inherited

HTTP-Version field in the first line of the message. see RFC 7230 section 3.1

Definition at line 72 of file Message.h.

Referenced by Format::Format::assemble(), ErrorState::BuildHttpReply(), clientReplyContext::buildReplyHeader(), Downloader::buildRequest(), canHandle1xx(), clientBeginRequest(), clientProcessRequest(), ClientRequestContext::clientRedirectDone(), clientSetKeepaliveFlag(), clone(), HttpReply::clone(), ErrorState::Convert(), ErrorState::Dump(), Adaptation::Icap::ModXact::encapsulateHead(), HttpReply::hdrCacheInit(), htcpClear(), htcpQuery(), HttpStateData::httpBuildRequestHeader(), netdbExchangeState::netdbExchangeState(), pack(), packFirstLineInto(), parseFirstLine(), Ftp::Server::parseOneRequest(), prepareLogWithRequestDetails(), switchToTunnel(), and tunnelStart().

Adaptation::Icap::History::Pointer HttpRequest::icapHistory_

mutableprivate

Definition at line 110 of file HttpRequest.h.

Referenced by clean(), icapHistory(), inheritProperties(), and init().

time_t HttpRequest::ims

Definition at line 133 of file HttpRequest.h.

Referenced by clientInterpretRequestHeaders(), clone(), clientReplyContext::handleIMSReply(), init(), and clientReplyContext::processConditional().

int HttpRequest::imslen

Definition at line 135 of file HttpRequest.h.

Referenced by clientInterpretRequestHeaders(), clone(), clientReplyContext::handleIMSReply(), init(), and clientReplyContext::processConditional().

Ip::Address HttpRequest::indirect_client_addr

Definition at line 140 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), ClientRequestContext::clientAccessCheck(), clientBeginRequest(), clientFollowXForwardedForCheck(), Adaptation::Ecap::XactionRep::clientIpValue(), DelayId::DelayClient(), AccessLogEntry::getLogClientIp(), getOutgoingAddress(), inheritProperties(), init(), Adaptation::Icap::ModXact::makeRequestHeaders(), manager(), and ACLFilledChecklist::setRequest().

time_t HttpRequest::lastmod

Definition at line 156 of file HttpRequest.h.

Referenced by clone(), HttpStateData::httpBuildRequestHeader(), init(), clientReplyContext::processExpired(), clientReplyContext::restoreState(), and clientReplyContext::saveState().

MasterXaction::Pointer HttpRequest::masterXaction

Definition at line 224 of file HttpRequest.h.

Referenced by clone(), FindListeningPortAddress(), Acl::TransactionInitiator::match(), UrnState::setUriResFromRequest(), and Adaptation::Ecap::XactionRep::updateSources().

HttpRequestMethod HttpRequest::method

Definition at line 102 of file HttpRequest.h.

Ip::Address HttpRequest::my_addr

Definition at line 143 of file HttpRequest.h.

Referenced by Downloader::buildRequest(), clientBeginRequest(), DelayId::DelayClient(), ClientHttpRequest::doCallouts(), getRangeOffsetLimit(), inheritProperties(), init(), manager(), ACLFilledChecklist::setRequest(), and tunnelStart().

String HttpRequest::myportname

Definition at line 163 of file HttpRequest.h.

Referenced by clean(), inheritProperties(), init(), manager(), ACLMyPortNameStrategy::match(), and ConnStateData::postHttpsAccept().

char* HttpRequest::peer_domain

Definition at line 161 of file HttpRequest.h.

Referenced by copyOneHeaderFromClientsideRequestToUpstreamRequest(), FwdState::dispatch(), HttpStateData::httpBuildRequestHeader(), init(), switchToTunnel(), and tunnelConnectDone().

char* HttpRequest::peer_host

Definition at line 154 of file HttpRequest.h.

Referenced by httpFixupAuthentication(), init(), HttpStateData::sendRequest(), switchToTunnel(), and tunnelConnectDone().

char* HttpRequest::peer_login

Definition at line 152 of file HttpRequest.h.

Referenced by clientReplyContext::buildReplyHeader(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), FwdState::dispatch(), httpFixupAuthentication(), init(), switchToTunnel(), and tunnelConnectDone().

ParseState Http::Message::pstate = Http::Message::psReadyToParseStartLine

inherited

Definition at line 94 of file Message.h.

Referenced by clone(), HttpReply::clone(), MemStore::copyFromShmSlice(), init(), and HttpReply::init().

HttpHdrRange* HttpRequest::range

Definition at line 131 of file HttpRequest.h.

Referenced by Http::Stream::buildRangeHeader(), CheckQuickAbortIsReasonable(), clean(), clientInterpretRequestHeaders(), HttpStateData::decideIfWeDoRanges(), hdrCacheInit(), ignoreRange(), init(), ClientHttpRequest::mRangeCLen(), multipartRangeRequest(), and clientReplyContext::processReplyAccessResult().

int64_t HttpRequest::rangeOffsetLimit

mutableprivate

Definition at line 236 of file HttpRequest.h.

Referenced by getRangeOffsetLimit(), and init().

uint32_t Http::Message::sources = 0

inherited

Definition at line 99 of file Message.h.

Referenced by Ftp::Gateway::appendSuccessHeader(), ConnStateData::buildFakeRequest(), clientProcessRequest(), gopherReadReply(), HttpReply::inheritProperties(), inheritProperties(), Acl::ConnectionsEncrypted::match(), HttpStateData::processReplyHeader(), WhoisState::setReplyToOK(), Ftp::Relay::startDataDownload(), and Adaptation::Ecap::XactionRep::updateSources().

String HttpRequest::store_id

If defined, store_id_program mapped the request URL to this ID. Store uses this ID (and not the URL) to find and store entries, avoiding caching duplicate entries when different URLs point to "essentially the same" cachable resource.

Definition at line 127 of file HttpRequest.h.

Referenced by ClientRequestContext::clientStoreIdDone(), and storeId().

String HttpRequest::tag

Definition at line 165 of file HttpRequest.h.

Referenced by Format::Format::assemble(), clean(), clone(), copyResultsFromEntry(), DelayId::DelayClient(), init(), and ACLTagStrategy::match().

NotePairs::Pointer HttpRequest::theNotes

private

annotations added by the note directive and helpers and(or) by annotate_transaction/annotate_client ACLs.

Definition at line 240 of file HttpRequest.h.

Referenced by clean(), hasNotes(), inheritProperties(), and notes().

AnyP::Uri HttpRequest::url

Definition at line 103 of file HttpRequest.h.

Referenced by Format::Format::assemble(), ConnStateData::buildFakeRequest(), Http::One::Server::buildHttpRequest(), Downloader::buildRequest(), HttpStateData::buildRequestPrefix(), clientReplyContext::cacheHit(), carpSelectParent(), HttpStateData::checkDateSkew(), DestinationIPLookup::checkForAsync(), PeerSelector::checkNetdbDirect(), clean(), clientHierarchical(), clientInterpretRequestHeaders(), clientProcessRequest(), ClientRequestContext::clientRedirectDone(), clone(), FwdState::connectDone(), FwdState::connectStart(), HttpStateData::continueAfterParsingHeader(), ErrorState::Convert(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), ICP2State::created(), FwdState::dispatch(), doV2Query(), ErrorState::Dump(), effectiveRequestUri(), Adaptation::Icap::ModXact::encapsulateHead(), FromUrl(), ftpFail(), ftpReadType(), ftpSendType(), ftpSendUser(), ftpTrySlashHack(), getDefaultParent(), getFirstUpParent(), TunnelStateData::getHost(), getRoundRobinParent(), getWeightedRoundRobinParent(), gopher_request_parse(), gopherSendComplete(), PeerSelector::handleHtcpParentMiss(), PeerSelector::handleIcpParentMiss(), ClientRequestContext::hostHeaderVerify(), HttpStateData::httpBuildRequestHeader(), clientReplyContext::identifyFoundObject(), init(), initHTTP(), ConnStateData::initiateTunneledRequest(), internalStart(), ACLUrlPortStrategy::match(), ACLUrlPathStrategy::match(), ACLProtocolStrategy::match(), ACLUrlLoginStrategy::match(), ACLDestinationASNStrategy::match(), ACLDestinationDomainStrategy::match(), ACLServerNameStrategy::match(), ACLDestinationIP::match(), maybeCacheable(), neighborsHtcpReply(), neighborsUdpAck(), neighborsUdpPing(), netdbClosestParent(), netdbExchangeStart(), PeerSelector::noteIp(), PeerSelector::noteIps(), operator<<(), pack(), packFirstLineInto(), parseFirstLine(), peerAllowedToUse(), peerDigestRequest(), ConnStateData::pinConnection(), ConnStateData::postHttpsAccept(), prefixLen(), HttpStateData::processReplyBody(), HttpStateData::processReplyHeader(), clientReplyContext::purgeRequest(), PeerSelector::resolveSelected(), PeerSelector::selectAllParents(), PeerSelector::selectMore(), PeerSelector::selectSomeDirect(), PeerSelector::selectSomeNeighbor(), PeerSelector::selectSomeParent(), HttpStateData::sendRequest(), ConnStateData::serveDelayedError(), Ssl::ServerBump::ServerBump(), UrnState::setUriResFromRequest(), PeerPoolMgr::start(), FwdState::Start(), FwdState::startConnectionOrFail(), ConnStateData::switchToHttps(), testHttpRequest::testCreateFromUrl(), testHttpRequest::testIPv6HostColonBug(), urlCanonicalClean(), urlCanonicalFakeHttps(), urlCheckRequest(), urlMakeAbsolute(), Ftp::UrlWith2f(), ConnStateData::validatePinnedConnection(), ACLFilledChecklist::verifyAle(), Adaptation::Service::wants(), and whoisStart().

SBuf HttpRequest::vary_headers

Definition at line 159 of file HttpRequest.h.

Referenced by StoreEntry::adjustVary(), clean(), clone(), init(), clientReplyContext::processExpired(), clientReplyContext::purgeDoPurgeHead(), storeKeyPublicByRequestMethod(), and varyEvaluateMatch().

String HttpRequest::x_forwarded_for_iterator

Definition at line 176 of file HttpRequest.h.

Referenced by ClientRequestContext::clientAccessCheck(), and clientFollowXForwardedForCheck().

The documentation for this class was generated from the following files:

squid-cache.org

Optimising Web Delivery

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors