#include <HttpHeader.h>

Inheritance diagram for HttpHeader:

Collaboration diagram for HttpHeader:

Public Member Functions
	HttpHeader ()

	HttpHeader (const http_hdr_owner_type owner)

	HttpHeader (const HttpHeader &other)

	~HttpHeader ()

HttpHeader &	operator= (const HttpHeader &other)

void	clean ()

void	append (const HttpHeader *src)

bool	update (HttpHeader const *fresh)

void	compact ()

int	parse (const char *header_start, size_t len)

int	parse (const char *buf, size_t buf_len, bool atEnd, size_t &hdr_sz)

void	packInto (Packable *p, bool mask_sensitive_info=false) const

HttpHeaderEntry *	getEntry (HttpHeaderPos *pos) const

HttpHeaderEntry *	findEntry (Http::HdrType id) const

int	delByName (const SBuf &name)

int	delByName (const char *name)

int	delById (Http::HdrType id)

void	delAt (HttpHeaderPos pos, int &headers_deleted)

void	refreshMask ()

void	addEntry (HttpHeaderEntry *e)

void	insertEntry (HttpHeaderEntry *e)

String	getList (Http::HdrType id) const

bool	getList (Http::HdrType id, String *s) const

bool	conflictingContentLength () const

String	getStrOrList (Http::HdrType id) const

String	getByName (const SBuf &name) const

String	getByName (const char *name) const

String	getById (Http::HdrType id) const

bool	getByIdIfPresent (Http::HdrType id, String *result) const

bool	hasNamed (const SBuf &s, String *value=0) const

bool	hasNamed (const char name, unsigned int namelen, String value=0) const

String	getByNameListMember (const char name, const char member, const char separator) const

String	getListMember (Http::HdrType id, const char *member, const char separator) const

int	has (Http::HdrType id) const

void	addVia (const AnyP::ProtocolVersion &ver, const HttpHeader *from=0)

void	putInt (Http::HdrType id, int number)

void	putInt64 (Http::HdrType id, int64_t number)

void	putTime (Http::HdrType id, time_t htime)

void	putStr (Http::HdrType id, const char *str)

void	putAuth (const char auth_scheme, const char realm)

void	putCc (const HttpHdrCc *cc)

void	putContRange (const HttpHdrContRange *cr)

void	putRange (const HttpHdrRange *range)

void	putSc (HttpHdrSc *sc)

void	putWarning (const int code, const char *const text)
	add a Warning header More...

void	putExt (const char name, const char value)

int	getInt (Http::HdrType id) const

int64_t	getInt64 (Http::HdrType id) const

time_t	getTime (Http::HdrType id) const

const char *	getStr (Http::HdrType id) const

const char *	getLastStr (Http::HdrType id) const

HttpHdrCc *	getCc () const

HttpHdrRange *	getRange () const

HttpHdrSc *	getSc () const

HttpHdrContRange *	getContRange () const

const char *	getAuth (Http::HdrType id, const char *auth_scheme) const

ETag	getETag (Http::HdrType id) const

TimeOrTag	getTimeOrTag (Http::HdrType id) const

int	hasListMember (Http::HdrType id, const char *member, const char separator) const

int	hasByNameListMember (const char name, const char member, const char separator) const

void	removeHopByHopEntries ()

bool	chunked () const
	whether message uses chunked Transfer-Encoding More...

Public Attributes
std::vector< HttpHeaderEntry * >	entries

HttpHeaderMask	mask

http_hdr_owner_type	owner

int	len

Protected Member Functions
void	removeConnectionHeaderEntries ()

bool	needUpdate (const HttpHeader *fresh) const
	check whether the fresh header has any new/changed updatable fields More...

bool	skipUpdateHeader (const Http::HdrType id) const

void	updateWarnings ()

Static Protected Member Functions
static bool	Isolate (const char parse_start, size_t l, const char blk_start, const char **blk_end)

Private Member Functions
HttpHeaderEntry *	findLastEntry (Http::HdrType id) const

Private Attributes
bool	conflictingContentLength_
	found different Content-Length fields More...

Detailed Description

Definition at line 71 of file HttpHeader.h.

Constructor & Destructor Documentation

HttpHeader::HttpHeader ( )

Definition at line 146 of file HttpHeader.cc.

References httpHeaderMaskInit(), and mask.

HttpHeader::HttpHeader ( const http_hdr_owner_type owner )

explicit

Definition at line 151 of file HttpHeader.cc.

References assert, debugs, hoEnd, hoNone, httpHeaderMaskInit(), mask, and owner.

HttpHeader::HttpHeader ( const HttpHeader & other )

Definition at line 158 of file HttpHeader.cc.

References httpHeaderMaskInit(), mask, and update().

HttpHeader::~HttpHeader ( )

Definition at line 164 of file HttpHeader.cc.

References clean().

Member Function Documentation

void HttpHeader::addEntry ( HttpHeaderEntry * e )

void HttpHeader::addVia	(	const AnyP::ProtocolVersion &	ver,
		const HttpHeader *	from = `0`
	)

Appends "this cache" information to VIA header field. Takes the initial VIA value from "from" parameter, if provided.

Definition at line 1010 of file HttpHeader.cc.

References SBuf::append(), SBuf::appendf(), buf, SBuf::c_str(), Config, delById(), getList(), SBuf::isEmpty(), SBuf::length(), AnyP::ProtocolVersion::major, AnyP::ProtocolVersion::minor, Must, SquidConfig::onoff, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, AnyP::PROTO_NONE, AnyP::PROTO_UNKNOWN, AnyP::ProtocolVersion::protocol, AnyP::ProtocolType_str, putStr(), String::SizeMaxXXX(), StringToSBuf(), ThisCache, Http::VIA, and SquidConfig::via.

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

void HttpHeader::append ( const HttpHeader * src )

Definition at line 232 of file HttpHeader.cc.

References addEntry(), assert, debugs, and entries.

Referenced by HttpRequest::clone(), HttpReply::clone(), and ESIVarState::ESIVarState().

bool HttpHeader::chunked ( ) const

inline

Definition at line 188 of file HttpHeader.h.

References has(), hasListMember(), and Http::TRANSFER_ENCODING.

Referenced by clientProcessRequest(), HttpReply::expectingBody(), HttpRequest::expectingBody(), parse(), and HttpStateData::processReplyHeader().

void HttpHeader::clean ( )

Definition at line 184 of file HttpHeader.cc.

References Http::any_valid_header(), assert, HttpHeaderStat::busyDestroyedCount, conflictingContentLength_, StatHist::count(), DBG_CRITICAL, debugs, HttpHeaderStat::destroyedCount, entries, HttpHeaderStat::fieldTypeDistr, hoEnd, hoNone, hoReply, httpHeaderMaskInit(), len, mask, owner, PROF_start, and PROF_stop.

Referenced by HttpStateData::buildRequestPrefix(), HttpRequest::clean(), HttpReply::clean(), clientPackRangeHdr(), htcpClear(), htcpHandleTstResponse(), htcpQuery(), htcpTstReply(), operator=(), parse(), ESIInclude::Start(), ESIVarState::~ESIVarState(), and ~HttpHeader().

void HttpHeader::compact ( )

Definition at line 717 of file HttpHeader.cc.

References entries.

Referenced by HttpReply::updateOnNotModified().

bool HttpHeader::conflictingContentLength ( ) const

inline

Definition at line 108 of file HttpHeader.h.

References conflictingContentLength_.

Referenced by clientIsContentLengthValid().

void HttpHeader::delAt	(	HttpHeaderPos	pos,
		int &	headers_deleted
	)

Definition at line 700 of file HttpHeader.cc.

References assert, entries, HttpHeaderInitPos, len, SBuf::length(), HttpHeaderEntry::name, NULL, String::size(), and HttpHeaderEntry::value.

Referenced by clientReplyContext::buildReplyHeader(), delById(), delByName(), httpHdrMangleList(), removeConnectionHeaderEntries(), removeHopByHopEntries(), and updateWarnings().

int HttpHeader::delById ( Http::HdrType id )

int HttpHeader::delByName ( const SBuf & name )

deletes all fields with a given name, if any.

Returns: #fields deleted

Definition at line 653 of file HttpHeader.cc.

References CBIT_SET, debugs, delAt(), getEntry(), HttpHeaderInitPos, httpHeaderMaskInit(), and mask.

Referenced by update().

int HttpHeader::delByName ( const char * name )

inline

Deprecated:: use SBuf method instead. performance regression: reallocates

Definition at line 100 of file HttpHeader.h.

References delByName().

Referenced by delByName().

HttpHeaderEntry * HttpHeader::findEntry ( Http::HdrType id ) const

Definition at line 608 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, entries, Http::HeaderLookupTable, mask, and NULL.

Referenced by clientReplyContext::buildReplyHeader(), getContRange(), getETag(), getInt(), getInt64(), getRange(), getStr(), getStrOrList(), getTime(), getTimeOrTag(), Ftp::Server::handleRequest(), HttpReply::make304(), packInto(), and Ftp::Relay::sendCommand().

HttpHeaderEntry * HttpHeader::findLastEntry ( Http::HdrType id ) const

private

Definition at line 633 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, entries, Http::HeaderLookupTable, mask, and NULL.

Referenced by getLastStr().

const char * HttpHeader::getAuth	(	Http::HdrType	id,
		const char *	auth_scheme
	)		const

Definition at line 1318 of file HttpHeader.cc.

References assert, base64_decode_final(), base64_decode_init(), base64_decode_update(), getStr(), NULL, and xisspace.

Referenced by Ftp::Gateway::checkAuth(), and CacheManager::ParseHeaders().

String HttpHeader::getById ( Http::HdrType id ) const

Definition at line 888 of file HttpHeader.cc.

References getByIdIfPresent().

bool HttpHeader::getByIdIfPresent	(	Http::HdrType	id,
		String *	result
	)		const

returns true iff a [possibly empty] field identified by id is there when returning true, also sets the result parameter (if it is not nil)

Definition at line 902 of file HttpHeader.cc.

References Http::BAD_HDR, getStrOrList(), and has().

Referenced by getById(), and hasNamed().

String HttpHeader::getByName ( const SBuf & name ) const

Definition at line 879 of file HttpHeader.cc.

References hasNamed().

Referenced by Format::Format::assemble(), assembleVaryKey(), Adaptation::Icap::Options::cfgIntHeader(), Adaptation::Icap::Options::cfgTransferList(), Adaptation::Icap::Options::configure(), getByNameListMember(), hasByNameListMember(), needUpdate(), Ssl::ErrorDetailFile::parse(), and Ftp::Server::writeErrorReply().

String HttpHeader::getByName ( const char * name ) const

Definition at line 870 of file HttpHeader.cc.

References hasNamed().

String HttpHeader::getByNameListMember	(	const char *	name,
		const char *	member,
		const char	separator
	)		const

Definition at line 948 of file HttpHeader.cc.

References String::append(), assert, getByName(), NULL, and strListGetItem().

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

HttpHdrCc * HttpHeader::getCc ( ) const

Definition at line 1234 of file HttpHeader.cc.

References Http::CACHE_CONTROL, CBIT_TEST, HttpHeaderStat::ccParsedCount, getList(), httpHdrCcUpdateStats(), httpHeaderNoteParsedEntry(), mask, NULL, owner, HttpHdrCc::parse(), PROF_start, and PROF_stop.

Referenced by HttpStateData::httpBuildRequestHeader().

HttpHdrContRange * HttpHeader::getContRange ( ) const

Definition at line 1304 of file HttpHeader.cc.

References Http::CONTENT_RANGE, findEntry(), httpHdrContRangeParseCreate(), httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, NULL, String::termedBuf(), and HttpHeaderEntry::value.

Referenced by HttpReply::hdrCacheInit().

HttpHeaderEntry * HttpHeader::getEntry ( HttpHeaderPos * pos ) const

Definition at line 589 of file HttpHeader.cc.

References assert, entries, HttpHeaderInitPos, and NULL.

Referenced by Format::Format::assemble(), clientReplyContext::buildReplyHeader(), clientCheckPinning(), delById(), delByName(), Adaptation::Icap::ModXact::encapsulateHead(), getList(), Ftp::Server::handleFeatReply(), hasNamed(), HttpStateData::httpBuildRequestHeader(), httpHdrMangleList(), packInto(), Ftp::PrintReply(), removeConnectionHeaderEntries(), removeHopByHopEntries(), update(), and updateWarnings().

ETag HttpHeader::getETag ( Http::HdrType id ) const

Definition at line 1357 of file HttpHeader.cc.

References assert, etagParseInit(), findEntry(), Http::ftETag, Http::HeaderLookupTable, NULL, String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by clientIfRangeMatch(), and StoreEntry::hasOneOfEtags().

int HttpHeader::getInt ( Http::HdrType id ) const

Definition at line 1160 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftInt, HttpHeaderEntry::getInt(), Http::HeaderLookupTable, and type.

Referenced by Ftp::Server::handleFeatReply(), Ftp::PrintReply(), StoreEntry::timestampsSet(), and Ftp::Server::writeForwardedReplyAndCall().

int64_t HttpHeader::getInt64 ( Http::HdrType id ) const

Definition at line 1173 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftInt64, HttpHeaderEntry::getInt64(), Http::HeaderLookupTable, and type.

Referenced by clientGetMoreData(), clientProcessRequest(), ftpSendStor(), HttpReply::hdrCacheInit(), and urlCheckRequest().

const char * HttpHeader::getLastStr ( Http::HdrType id ) const

Definition at line 1219 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findLastEntry(), Http::ftStr, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, NULL, String::termedBuf(), type, and HttpHeaderEntry::value.

String HttpHeader::getList ( Http::HdrType id ) const

bool HttpHeader::getList	(	Http::HdrType	id,
		String *	s
	)		const

Definition at line 789 of file HttpHeader.cc.

References assert, CBIT_TEST, debugs, entries, Http::HeaderLookupTable, mask, String::size(), strListAdd(), and String::termedBuf().

String HttpHeader::getListMember	(	Http::HdrType	id,
		const char *	member,
		const char	separator
	)		const

Definition at line 976 of file HttpHeader.cc.

References Http::any_registered_header(), String::append(), assert, String::clean(), getStrOrList(), NULL, and strListGetItem().

Referenced by ESIVariableCookie::eval().

HttpHdrRange * HttpHeader::getRange ( ) const

Definition at line 1263 of file HttpHeader.cc.

References findEntry(), httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, NULL, HttpHdrRange::ParseCreate(), Http::RANGE, Http::REQUEST_RANGE, and HttpHeaderEntry::value.

Referenced by clientInterpretRequestHeaders(), and HttpRequest::hdrCacheInit().

HttpHdrSc * HttpHeader::getSc ( ) const

Definition at line 1282 of file HttpHeader.cc.

References CBIT_TEST, HttpHeaderStat::ccParsedCount, getList(), httpHdrScParseCreate(), httpHeaderNoteParsedEntry(), mask, NULL, owner, sc, Http::SURROGATE_CONTROL, and HttpHdrSc::updateStats().

Referenced by HttpReply::hdrCacheInit().

const char * HttpHeader::getStr ( Http::HdrType id ) const

Definition at line 1203 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftStr, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, NULL, String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by Auth::UserRequest::authenticate(), ESIVariableUserAgent::ESIVariableUserAgent(), ESIVariableCookie::eval(), ESIVariableHost::eval(), ESIVariableReferer::eval(), ESIVariableUserAgent::eval(), getAuth(), HttpReply::hdrCacheInit(), ClientRequestContext::hostHeaderVerify(), ClientRequestContext::hostHeaderVerifyFailed(), Log::Format::HttpdCombined(), httpFixupAuthentication(), ACLRequestHeaderStrategy< header >::match(), ACLReplyHeaderStrategy< header >::match(), Ftp::PrintReply(), purgeEntriesByHeader(), HttpStateData::reusableReply(), Log::Format::SquidReferer(), Log::Format::SquidUserAgent(), CacheManager::Start(), and Ftp::Server::writeErrorReply().

String HttpHeader::getStrOrList ( Http::HdrType id ) const

Definition at line 853 of file HttpHeader.cc.

References findEntry(), getList(), Http::HeaderLookupTable, and HttpHeaderEntry::value.

Referenced by getByIdIfPresent(), getListMember(), hasListMember(), ACLHTTPHeaderData::match(), and HttpReply::validatorsMatch().

time_t HttpHeader::getTime ( Http::HdrType id ) const

Definition at line 1186 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftDate_1123, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, parse_rfc1123(), String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by clientInterpretRequestHeaders(), Adaptation::Icap::Options::configure(), HttpReply::hdrCacheInit(), and HttpReply::hdrExpirationTime().

TimeOrTag HttpHeader::getTimeOrTag ( Http::HdrType id ) const

Definition at line 1370 of file HttpHeader.cc.

References assert, etagParseInit(), findEntry(), Http::ftDate_1123_or_ETag, Http::HeaderLookupTable, NULL, parse_rfc1123(), ETag::str, TimeOrTag::tag, String::termedBuf(), TimeOrTag::time, type, TimeOrTag::valid, and HttpHeaderEntry::value.

Referenced by clientIfRangeMatch().

int HttpHeader::has ( Http::HdrType id ) const

Definition at line 1002 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, debugs, and mask.

Referenced by Http::Stream::buildRangeHeader(), clientReplyContext::buildReplyHeader(), HttpStateData::buildRequestPrefix(), HttpRequest::canHandle1xx(), chunked(), ClientRequestContext::clientAccessCheck(), clientCheckPinning(), clientInterpretRequestHeaders(), clientProcessRequest(), HttpRequest::conditional(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), ESIVariableUserAgent::ESIVariableUserAgent(), ESIVariableCookie::eval(), ESIVariableHost::eval(), ESIVariableLanguage::eval(), ESIVariableReferer::eval(), ESIVariableUserAgent::eval(), getByIdIfPresent(), Ftp::Server::handleRequest(), HttpReply::hdrExpirationTime(), HttpStateData::httpBuildRequestHeader(), httpFixupAuthentication(), ACLHTTPHeaderData::match(), Ftp::PrintReply(), clientReplyContext::processConditional(), clientReplyContext::processExpired(), Http::One::Server::processParsedRequest(), removeConnectionHeaderEntries(), Ftp::Relay::sendCommand(), CacheManager::Start(), varyEvaluateMatch(), Ftp::Server::writeCustomReply(), Ftp::Server::writeErrorReply(), Ftp::Server::writeForwardedReply(), and Ftp::Server::writeForwardedReplyAndCall().

int HttpHeader::hasByNameListMember	(	const char *	name,
		const char *	member,
		const char	separator
	)		const

Definition at line 1689 of file HttpHeader.cc.

References assert, getByName(), NULL, and strListGetItem().

Referenced by Adaptation::Icap::Options::configure().

int HttpHeader::hasListMember	(	Http::HdrType	id,
		const char *	member,
		const char	separator
	)		const

Definition at line 1665 of file HttpHeader.cc.

References Http::any_registered_header(), assert, getStrOrList(), NULL, and strListGetItem().

Referenced by chunked(), clientInterpretRequestHeaders(), Adaptation::Icap::Options::configure(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), and ESIVariableLanguage::eval().

bool HttpHeader::hasNamed	(	const SBuf &	s,
		String *	value = `0`
	)		const

returns true iff a [possibly empty] named field is there when returning true, also sets the value parameter (if it is not nil)

Definition at line 896 of file HttpHeader.cc.

References SBuf::length(), and SBuf::rawContent().

Referenced by getByName(), ACLHTTPHeaderData::match(), and needUpdate().

bool HttpHeader::hasNamed	(	const char *	name,
		unsigned int	namelen,
		String *	value = `0`
	)		const

Deprecated:: use SBuf method instead.

Definition at line 914 of file HttpHeader.cc.

References assert, Http::BAD_HDR, SBuf::caseCmp(), getByIdIfPresent(), getEntry(), Http::HeaderLookupTable, HttpHeaderInitPos, HttpHeaderEntry::id, Http::HeaderTableRecord::id, SBuf::length(), Http::HeaderLookupTable_t::lookup(), HttpHeaderEntry::name, Http::OTHER, strListAdd(), String::termedBuf(), and HttpHeaderEntry::value.

void HttpHeader::insertEntry ( HttpHeaderEntry * e )

Definition at line 768 of file HttpHeader.cc.

References Http::any_valid_header(), assert, CBIT_SET, CBIT_TEST, debugs, entries, headerStatsTable(), HttpHeaderEntry::id, len, SBuf::length(), mask, HttpHeaderEntry::name, String::size(), and HttpHeaderEntry::value.

bool HttpHeader::Isolate	(	const char **	parse_start,
		size_t	l,
		const char **	blk_start,
		const char **	blk_end
	)

staticprotected

either finds the end of headers or returns false If the end was found: *parse_start points to the first character after the header delimiter *blk_start points to the first header character (i.e. old parse_start value) *blk_end points to the first header delimiter character (CR or LF in CR?LF). If block starts where it ends, then there are no fields in the header.

Definition at line 322 of file HttpHeader.cc.

References assert, and headersEnd().

Referenced by parse().

bool HttpHeader::needUpdate ( const HttpHeader * fresh ) const

protected

Definition at line 246 of file HttpHeader.cc.

References entries, getByName(), hasNamed(), and skipUpdateHeader().

Referenced by update().

HttpHeader & HttpHeader::operator= ( const HttpHeader & other )

Definition at line 170 of file HttpHeader.cc.

References assert, clean(), conflictingContentLength_, len, owner, and update().